wxWidgets/contrib/docs/latex/fl/cbbarhintsplugin.tex
2002-01-05 22:59:59 +00:00

118 lines
3.5 KiB
TeX

%
% automatically generated by HelpGen $Revision$ from
% barhintspl.h at 05/Jan/02 22:50:56
%
\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
\wxheading{Derived from}
\helpref{cbPluginBase}{cbpluginbase}
\wxheading{Data structures}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{cbBarHintsPlugin::cbBarHintsPlugin}\label{cbbarhintsplugincbbarhintsplugin}
\func{}{cbBarHintsPlugin}{\void}
\func{}{cbBarHintsPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
\membersection{cbBarHintsPlugin::\destruct{cbBarHintsPlugin}}\label{cbbarhintsplugindtor}
\func{}{\destruct{cbBarHintsPlugin}}{\void}
\membersection{cbBarHintsPlugin::CreateBoxes}\label{cbbarhintsplugincreateboxes}
\func{void}{CreateBoxes}{\void}
\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::Draw3DBox}\label{cbbarhintsplugindraw3dbox}
\func{void}{Draw3DBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
drawing helpers
\membersection{cbBarHintsPlugin::DrawCloseBox}\label{cbbarhintsplugindrawclosebox}
\func{void}{DrawCloseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \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}}
\membersection{cbBarHintsPlugin::DrawGrooves}\label{cbbarhintsplugindrawgrooves}
\func{void}{DrawGrooves}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{int }{length}}
\membersection{cbBarHintsPlugin::ExcludeHints}\label{cbbarhintspluginexcludehints}
\func{void}{ExcludeHints}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}}
\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::HitTestHints}\label{cbbarhintspluginhittesthints}
\func{int}{HitTestHints}{\param{cbBarInfo\& }{info}, \param{const wxPoint\& }{pos}}
\membersection{cbBarHintsPlugin::OnDrawBarDecorations}\label{cbbarhintspluginondrawbardecorations}
\func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
\membersection{cbBarHintsPlugin::OnInitPlugin}\label{cbbarhintspluginoninitplugin}
\func{void}{OnInitPlugin}{\void}
\membersection{cbBarHintsPlugin::OnLeftDown}\label{cbbarhintspluginonleftdown}
\func{void}{OnLeftDown}{\param{cbLeftDownEvent\& }{event}}
\membersection{cbBarHintsPlugin::OnLeftUp}\label{cbbarhintspluginonleftup}
\func{void}{OnLeftUp}{\param{cbLeftUpEvent\& }{event}}
\membersection{cbBarHintsPlugin::OnMotion}\label{cbbarhintspluginonmotion}
\func{void}{OnMotion}{\param{cbMotionEvent\& }{event}}
\membersection{cbBarHintsPlugin::OnSizeBarWindow}\label{cbbarhintspluginonsizebarwindow}
\func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
handlers of plugin-events
\membersection{cbBarHintsPlugin::SetGrooveCount}\label{cbbarhintspluginsetgroovecount}
\func{void}{SetGrooveCount}{\param{int }{nGrooves}}