Removed old classes and functions

[wxWidgets.git] / contrib / docs / latex / fl / cbbarhintsplugin.tex

diff --git a/contrib/docs/latex/fl/cbbarhintsplugin.tex b/contrib/docs/latex/fl/cbbarhintsplugin.tex
index 40177916c6fecf12d832b3c40417b3a7287c73a9..13a3cbf001a7c56480c70c7ce3aff53f606833f9 100644 (file)
--- a/contrib/docs/latex/fl/cbbarhintsplugin.tex
+++ b/contrib/docs/latex/fl/cbbarhintsplugin.tex
@@ -1,19 +1,23 @@
 %
 % automatically generated by HelpGen $Revision$ from
 %
 % automatically generated by HelpGen $Revision$ from

-% barhintspl.h at 05/Jan/02 22:50:56
+% barhintspl.h at 21/Jan/02 21:14:18

 %
 
 
 \section{\class{cbBarHintsPlugin}}\label{cbbarhintsplugin}
 
 
 %
 
 
 \section{\class{cbBarHintsPlugin}}\label{cbbarhintsplugin}
 
 

-Intercepts bar-decoration and sizing events, draws 3d-hints
-   around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x
- 
+This class intercepts bar-decoration and sizing events, and draws 3D hints
+around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x
+

 \wxheading{Derived from}
 
 \helpref{cbPluginBase}{cbpluginbase}
 
 \wxheading{Derived from}
 
 \helpref{cbPluginBase}{cbpluginbase}
 

+\wxheading{Include files}
+
+<wx/fl/barhintspl.h>
+

 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}


@@ -23,95 +27,129 @@ Intercepts bar-decoration and sizing events, draws 3d-hints
 
 \func{}{cbBarHintsPlugin}{\void}
 
 
 \func{}{cbBarHintsPlugin}{\void}
 

+Default constructor.
+

 
 \func{}{cbBarHintsPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
 
 
 \func{}{cbBarHintsPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
 

+Constructor, taking parent frame and pane mask flag.
+

 
 \membersection{cbBarHintsPlugin::\destruct{cbBarHintsPlugin}}\label{cbbarhintsplugindtor}
 
 \func{}{\destruct{cbBarHintsPlugin}}{\void}
 
 
 \membersection{cbBarHintsPlugin::\destruct{cbBarHintsPlugin}}\label{cbbarhintsplugindtor}
 
 \func{}{\destruct{cbBarHintsPlugin}}{\void}
 

+Destructor.
+

 
 \membersection{cbBarHintsPlugin::CreateBoxes}\label{cbbarhintsplugincreateboxes}
 
 \func{void}{CreateBoxes}{\void}
 
 
 \membersection{cbBarHintsPlugin::CreateBoxes}\label{cbbarhintsplugincreateboxes}
 
 \func{void}{CreateBoxes}{\void}
 

+Helper function: creates close and collapse boxes.
+

 
 \membersection{cbBarHintsPlugin::DoDrawHint}\label{cbbarhintsplugindodrawhint}
 
 \func{void}{DoDrawHint}{\param{wxDC\& }{dc}, \param{wxRect\& }{rect}, \param{int }{pos}, \param{int }{boxOfs}, \param{int }{grooveOfs}, \param{bool }{isFixed}}
 
 
 \membersection{cbBarHintsPlugin::DoDrawHint}\label{cbbarhintsplugindodrawhint}
 
 \func{void}{DoDrawHint}{\param{wxDC\& }{dc}, \param{wxRect\& }{rect}, \param{int }{pos}, \param{int }{boxOfs}, \param{int }{grooveOfs}, \param{bool }{isFixed}}
 

+Helper function: draws a hint.
+

 
 \membersection{cbBarHintsPlugin::Draw3DBox}\label{cbbarhintsplugindraw3dbox}
 
 \func{void}{Draw3DBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
 
 
 \membersection{cbBarHintsPlugin::Draw3DBox}\label{cbbarhintsplugindraw3dbox}
 
 \func{void}{Draw3DBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
 

-drawing helpers
+Helper function: draws a 3D box.

 
 
 \membersection{cbBarHintsPlugin::DrawCloseBox}\label{cbbarhintsplugindrawclosebox}
 
 \func{void}{DrawCloseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
 
 
 
 \membersection{cbBarHintsPlugin::DrawCloseBox}\label{cbbarhintsplugindrawclosebox}
 
 \func{void}{DrawCloseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
 

+Helper function: draws a close box.
+

 
 \membersection{cbBarHintsPlugin::DrawCollapseBox}\label{cbbarhintsplugindrawcollapsebox}
 
 \func{void}{DrawCollapseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{atLeft}, \param{bool }{disabled}, \param{bool }{pressed}}
 
 
 \membersection{cbBarHintsPlugin::DrawCollapseBox}\label{cbbarhintsplugindrawcollapsebox}
 
 \func{void}{DrawCollapseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{atLeft}, \param{bool }{disabled}, \param{bool }{pressed}}
 

+Helper function: draws a collapse box.
+

 
 \membersection{cbBarHintsPlugin::DrawGrooves}\label{cbbarhintsplugindrawgrooves}
 
 \func{void}{DrawGrooves}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{int }{length}}
 
 
 \membersection{cbBarHintsPlugin::DrawGrooves}\label{cbbarhintsplugindrawgrooves}
 
 \func{void}{DrawGrooves}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{int }{length}}
 

+Helper function: draws grooves.
+

 
 \membersection{cbBarHintsPlugin::ExcludeHints}\label{cbbarhintspluginexcludehints}
 
 \func{void}{ExcludeHints}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}}
 
 
 \membersection{cbBarHintsPlugin::ExcludeHints}\label{cbbarhintspluginexcludehints}
 
 \func{void}{ExcludeHints}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}}
 

+Helper function.
+

 
 \membersection{cbBarHintsPlugin::GetHintsLayout}\label{cbbarhintsplugingethintslayout}
 
 \func{void}{GetHintsLayout}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}, \param{int\& }{boxOfs}, \param{int\& }{grooveOfs}, \param{int\& }{pos}}
 
 
 \membersection{cbBarHintsPlugin::GetHintsLayout}\label{cbbarhintsplugingethintslayout}
 
 \func{void}{GetHintsLayout}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}, \param{int\& }{boxOfs}, \param{int\& }{grooveOfs}, \param{int\& }{pos}}
 

+Helper function: gets the layout of a hint.
+

 
 \membersection{cbBarHintsPlugin::HitTestHints}\label{cbbarhintspluginhittesthints}
 
 \func{int}{HitTestHints}{\param{cbBarInfo\& }{info}, \param{const wxPoint\& }{pos}}
 
 
 \membersection{cbBarHintsPlugin::HitTestHints}\label{cbbarhintspluginhittesthints}
 
 \func{int}{HitTestHints}{\param{cbBarInfo\& }{info}, \param{const wxPoint\& }{pos}}
 

+Helper function: returns information about the hint under the given position.
+

 
 \membersection{cbBarHintsPlugin::OnDrawBarDecorations}\label{cbbarhintspluginondrawbardecorations}
 
 \func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
 
 
 \membersection{cbBarHintsPlugin::OnDrawBarDecorations}\label{cbbarhintspluginondrawbardecorations}
 
 \func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
 

+Handles a plugin event.
+

 
 \membersection{cbBarHintsPlugin::OnInitPlugin}\label{cbbarhintspluginoninitplugin}
 
 \func{void}{OnInitPlugin}{\void}
 
 
 \membersection{cbBarHintsPlugin::OnInitPlugin}\label{cbbarhintspluginoninitplugin}
 
 \func{void}{OnInitPlugin}{\void}
 

+Called to initialize this plugin.
+

 
 \membersection{cbBarHintsPlugin::OnLeftDown}\label{cbbarhintspluginonleftdown}
 
 \func{void}{OnLeftDown}{\param{cbLeftDownEvent\& }{event}}
 
 
 \membersection{cbBarHintsPlugin::OnLeftDown}\label{cbbarhintspluginonleftdown}
 
 \func{void}{OnLeftDown}{\param{cbLeftDownEvent\& }{event}}
 

+Handles a plugin event.
+

 
 \membersection{cbBarHintsPlugin::OnLeftUp}\label{cbbarhintspluginonleftup}
 
 \func{void}{OnLeftUp}{\param{cbLeftUpEvent\& }{event}}
 
 
 \membersection{cbBarHintsPlugin::OnLeftUp}\label{cbbarhintspluginonleftup}
 
 \func{void}{OnLeftUp}{\param{cbLeftUpEvent\& }{event}}
 

+Handles a plugin event.
+

 
 \membersection{cbBarHintsPlugin::OnMotion}\label{cbbarhintspluginonmotion}
 
 \func{void}{OnMotion}{\param{cbMotionEvent\& }{event}}
 
 
 \membersection{cbBarHintsPlugin::OnMotion}\label{cbbarhintspluginonmotion}
 
 \func{void}{OnMotion}{\param{cbMotionEvent\& }{event}}
 

+Handles a plugin event.
+

 
 \membersection{cbBarHintsPlugin::OnSizeBarWindow}\label{cbbarhintspluginonsizebarwindow}
 
 \func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
 
 
 \membersection{cbBarHintsPlugin::OnSizeBarWindow}\label{cbbarhintspluginonsizebarwindow}
 
 \func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
 

-handlers of plugin-events
+Handles a plugin event.

 
 
 \membersection{cbBarHintsPlugin::SetGrooveCount}\label{cbbarhintspluginsetgroovecount}
 
 \func{void}{SetGrooveCount}{\param{int }{nGrooves}}
 
 
 
 \membersection{cbBarHintsPlugin::SetGrooveCount}\label{cbbarhintspluginsetgroovecount}
 
 \func{void}{SetGrooveCount}{\param{int }{nGrooves}}
 

+Set the number of grooves to be shown in the pane.
+