← Back to branch summary

~ubuntu-branches/ubuntu/maverick/wxwidgets2.8/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/html/wx/wx_wxhelpprovider.html

  • Committer: Bazaar Package Importer
  • Author(s): Devid Filoni
  • Date: 2008-06-30 22:02:17 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20080630220217-vag3tkfp91t0453d
Tags: 2.8.8.0-0ubuntu1
https://launchpad.net/bugs/244355
https://launchpad.net/bugs/242164
https://launchpad.net/bugs/211553
https://launchpad.net/bugs/236876
* New upstream version, based on the upstream tarball
  wxPython-src-2.8.8.0.tar.bz2, remove upstream debian dir (LP: #244355).
* Add debian/watch file, LP: #242164.
* Edit get-orig-source target to provide a .orig.tar.gz with the same md5 for
  each .orig.tar.gz generated.
* debian/rules: remove get-orig-source from .PHONY target.
* debian/control.in: add python-wxtools in python-wxgtk=V=U Suggests field.
* Do not apply fix_from_upstream_svn_r52465 patch, not needed.
* Regenerate octave_oct, tcl_tk_tcl patches for the new version.
* Fix spelling-error-in-description lintian warning.
* Fix depends-on-obsolete-package lintian error.
* Fix executable-not-elf-or-script lintian warnings.
* Fix script-not-executable lintian warnings.
* Fix missing-dependency-on-libc lintian error.
* Fix dbg-package-missing-depends lintian warnings.
* Fix package-contains-empty-directory lintian warnings.
* Fix manpage-has-errors-from-man lintian warning.
* Fix image-file-in-usr-lib lintian warnings:
  - add editra_pixmaps patch
  - add xrced_bitmaps patch
* Fix unused-override lintian info.
* Fix malformed-override lintian errors.
* Fix extra-license-file lintian warnings.
* Install upstream wx.pth instead of generated file links (LP: #211553).
* Add editra.png, pyshell.png (encoded using uuencode) icons, LP: #236876:
  - debian/rules: use uudecode to decode .png icons.
* Add a new pyshell.xpm icon.
* Fix doc-base-file-references-missing-file lintian error.
* Fix doc-base-unknown-section lintian warning.
* Fix ruby-script-but-no-ruby-dep lintian errors.
* Fix wish-script-but-no-wish-dep lintian errors.
* Fix missing-dep-for-interpreter errors.
* Bump Standards-Version to 3.8.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/wx/wx_wxhelpprovider.html
43
43
<A NAME="wxhelpprovideraddhelp"></A>
44
44
<H3>wxHelpProvider::AddHelp</H3>
45
45
<P>
46
 
<B>void</B> <B>AddHelp</B>(<B>wxWindowBase* </B><I>window</I>, <B>const <A HREF="wx_wxstring.html#wxstring">wxString</A>& </B></B><I>text</I>)<P>
 
46
<B>virtual void</B> <B>AddHelp</B>(<B>wxWindowBase* </B><I>window</I>, <B>const <A HREF="wx_wxstring.html#wxstring">wxString</A>& </B></B><I>text</I>)<P>
47
47
Associates the text with the given window or id. Although all help
48
48
providers have these functions to allow making <A HREF="wx_wxwindow.html#wxwindowsethelptext">wxWindow::SetHelpText</A> 
49
49
work, not all of them implement the functions.<P>
 
50
<B>virtual void</B> <B>AddHelp</B>(<B>wxWindowID </B><I>id</I>, <B>const <A HREF="wx_wxstring.html#wxstring">wxString</A>& </B></B><I>text</I>)<P>
 
51
This version associates the given text with all windows with this id.
 
52
May be used to set the same help string for all Cancel buttons in
 
53
the application, for example.<P>
50
54
 
51
55
 
52
56
<HR>
53
57
<A NAME="wxhelpproviderget"></A>
54
58
<H3>wxHelpProvider::Get</H3>
55
59
<P>
56
 
<B><A HREF="wx_wxhelpprovider.html#wxhelpprovider">wxHelpProvider</A>*</B> </B> <B>Get</B>()<P>
 
60
<B>static <A HREF="wx_wxhelpprovider.html#wxhelpprovider">wxHelpProvider</A>*</B> </B> <B>Get</B>()<P>
 
61
Returns pointer to help provider instance.<P>
57
62
Unlike some other classes, the help provider is not created on demand.
58
 
This must be explicitly done by the application.<P>
 
63
This must be explicitly done by the application using
 
64
<A HREF="wx_wxhelpprovider.html#wxhelpproviderset">Set</A>.<P>
59
65
 
60
66
 
61
67
<HR>
62
68
<A NAME="wxhelpprovidergethelp"></A>
63
69
<H3>wxHelpProvider::GetHelp</H3>
64
70
<P>
65
 
<B><A HREF="wx_wxstring.html#wxstring">wxString</A></B> </B> <B>GetHelp</B>(<B>const wxWindowBase* </B><I>window</I>)<P>
 
71
<B>virtual <A HREF="wx_wxstring.html#wxstring">wxString</A></B> </B> <B>GetHelp</B>(<B>const wxWindowBase* </B><I>window</I>)<P>
66
72
Gets the help string for this window. Its interpretation is dependent on the help provider
67
73
except that empty string always means that no help is associated with
68
74
the window.<P>
69
 
<B>void</B> <B>AddHelp</B>(<B>wxWindowID </B><I>id</I>, <B>const <A HREF="wx_wxstring.html#wxstring">wxString</A>& </B></B><I>text</I>)<P>
70
 
This version associates the given text with all windows with this id.
71
 
May be used to set the same help string for all Cancel buttons in
72
 
the application, for example.<P>
73
75
 
74
76
 
75
77
<HR>
76
78
<A NAME="wxhelpproviderremovehelp"></A>
77
79
<H3>wxHelpProvider::RemoveHelp</H3>
78
80
<P>
79
 
<B>void</B> <B>RemoveHelp</B>(<B>wxWindowBase* </B><I>window</I>)<P>
80
 
Removes the association between the window pointer and the help text. This is
81
 
called by the wxWindow destructor. Without this, the table of help strings will fill up
82
 
and when window pointers are reused, the wrong help string will be found.<P>
 
81
<B>virtual void</B> <B>RemoveHelp</B>(<B>wxWindowBase* </B><I>window</I>)<P>
 
82
Removes the association between the window pointer and the help text, if it
 
83
was previously set using <A HREF="wx_wxhelpprovider.html#wxhelpprovideraddhelp">AddHelp</A>. This is
 
84
called by the wxWindow destructor. Without this, the table of help strings will
 
85
fill up and when window pointers are reused, the wrong help string will be
 
86
found.<P>
 
87
Note that this method may be called even for windows that don't have any
 
88
associated help text. If that happens, its implementation should simply do
 
89
nothing.<P>
83
90
 
84
91
 
85
92
<HR>
86
93
<A NAME="wxhelpproviderset"></A>
87
94
<H3>wxHelpProvider::Set</H3>
88
95
<P>
89
 
<B><A HREF="wx_wxhelpprovider.html#wxhelpprovider">wxHelpProvider</A>*</B> </B> <B>Set</B>(<B><A HREF="wx_wxhelpprovider.html#wxhelpprovider">wxHelpProvider</A>* </B></B><I>helpProvider</I>)<P>
 
96
<B>static <A HREF="wx_wxhelpprovider.html#wxhelpprovider">wxHelpProvider</A>*</B> </B> <B>Set</B>(<B><A HREF="wx_wxhelpprovider.html#wxhelpprovider">wxHelpProvider</A>* </B></B><I>helpProvider</I>)<P>
90
97
Get/set the current, application-wide help provider. Returns
91
98
the previous one.<P>
92
99
 
95
102
<A NAME="wxhelpprovidershowhelpatpoint"></A>
96
103
<H3>wxHelpProvider::ShowHelpAtPoint</H3>
97
104
<P>
98
 
<B>bool</B> <B>ShowHelpAtPoint</B>(<B>wxWindowBase* </B><I>window</I>, <B>const <A HREF="wx_wxpoint.html#wxpoint">wxPoint</A></B></B><I>point</I>, <B>wxHelpEvent::Origin </B><I>origin</I>)<P>
 
105
<B>virtual bool</B> <B>ShowHelpAtPoint</B>(<B>wxWindowBase* </B><I>window</I>, <B>const <A HREF="wx_wxpoint.html#wxpoint">wxPoint</A></B></B><I>point</I>, <B>wxHelpEvent::Origin </B><I>origin</I>)<P>
99
106
This function may be overridden to show help for the window when it should
100
107
depend on the position inside the window, By default this method forwards to 
101
108
<A HREF="wx_wxhelpprovider.html#wxhelpprovidershowhelp">ShowHelp</A>, so it is enough to only implement
119
126
<A NAME="wxhelpprovidershowhelp"></A>
120
127
<H3>wxHelpProvider::ShowHelp</H3>
121
128
<P>
122
 
<B>bool</B> <B>ShowHelp</B>(<B>wxWindowBase* </B><I>window</I>)<P>
 
129
<B>virtual bool</B> <B>ShowHelp</B>(<B>wxWindowBase* </B><I>window</I>)<P>
123
130
Shows help for the given window. Override this function if the help doesn't
124
131
depend on the exact position inside the window, otherwise you need to override 
125
132
<A HREF="wx_wxhelpprovider.html#wxhelpprovidershowhelpatpoint">ShowHelpAtPoint</A>.<P>