contrib/docs/latex/fl/cbbarhintsplugin.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % barhintspl.h at 21/Jan/02 21:14:18
   4 %
   5
   6
   7 \section{\class{cbBarHintsPlugin}}\label{cbbarhintsplugin}
   8
   9
  10 This class intercepts bar-decoration and sizing events, and draws 3D hints
  11 around fixed and flexible bars, similar to those in Microsoft DevStudio 6.x
  12
  13 \wxheading{Derived from}
  14
  15 \helpref{cbPluginBase}{cbpluginbase}
  16
  17 \wxheading{Include files}
  18
  19 <barhintspl.h>
  20
  21 \wxheading{Data structures}
  22
  23 \latexignore{\rtfignore{\wxheading{Members}}}
  24
  25
  26 \membersection{cbBarHintsPlugin::cbBarHintsPlugin}\label{cbbarhintsplugincbbarhintsplugin}
  27
  28 \func{}{cbBarHintsPlugin}{\void}
  29
  30 Default constructor.
  31
  32
  33 \func{}{cbBarHintsPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
  34
  35 Constructor, taking parent frame and pane mask flag.
  36
  37
  38 \membersection{cbBarHintsPlugin::\destruct{cbBarHintsPlugin}}\label{cbbarhintsplugindtor}
  39
  40 \func{}{\destruct{cbBarHintsPlugin}}{\void}
  41
  42 Destructor.
  43
  44
  45 \membersection{cbBarHintsPlugin::CreateBoxes}\label{cbbarhintsplugincreateboxes}
  46
  47 \func{void}{CreateBoxes}{\void}
  48
  49 Helper function: creates close and collapse boxes.
  50
  51
  52 \membersection{cbBarHintsPlugin::DoDrawHint}\label{cbbarhintsplugindodrawhint}
  53
  54 \func{void}{DoDrawHint}{\param{wxDC\& }{dc}, \param{wxRect\& }{rect}, \param{int }{pos}, \param{int }{boxOfs}, \param{int }{grooveOfs}, \param{bool }{isFixed}}
  55
  56 Helper function: draws a hint.
  57
  58
  59 \membersection{cbBarHintsPlugin::Draw3DBox}\label{cbbarhintsplugindraw3dbox}
  60
  61 \func{void}{Draw3DBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
  62
  63 Helper function: draws a 3D box.
  64
  65
  66 \membersection{cbBarHintsPlugin::DrawCloseBox}\label{cbbarhintsplugindrawclosebox}
  67
  68 \func{void}{DrawCloseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
  69
  70 Helper function: draws a close box.
  71
  72
  73 \membersection{cbBarHintsPlugin::DrawCollapseBox}\label{cbbarhintsplugindrawcollapsebox}
  74
  75 \func{void}{DrawCollapseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{atLeft}, \param{bool }{disabled}, \param{bool }{pressed}}
  76
  77 Helper function: draws a collapse box.
  78
  79
  80 \membersection{cbBarHintsPlugin::DrawGrooves}\label{cbbarhintsplugindrawgrooves}
  81
  82 \func{void}{DrawGrooves}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{int }{length}}
  83
  84 Helper function: draws grooves.
  85
  86
  87 \membersection{cbBarHintsPlugin::ExcludeHints}\label{cbbarhintspluginexcludehints}
  88
  89 \func{void}{ExcludeHints}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}}
  90
  91 Helper function.
  92
  93
  94 \membersection{cbBarHintsPlugin::GetHintsLayout}\label{cbbarhintsplugingethintslayout}
  95
  96 \func{void}{GetHintsLayout}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}, \param{int\& }{boxOfs}, \param{int\& }{grooveOfs}, \param{int\& }{pos}}
  97
  98 Helper function: gets the layout of a hint.
  99
 100
 101 \membersection{cbBarHintsPlugin::HitTestHints}\label{cbbarhintspluginhittesthints}
 102
 103 \func{int}{HitTestHints}{\param{cbBarInfo\& }{info}, \param{const wxPoint\& }{pos}}
 104
 105 Helper function: returns information about the hint under the given position.
 106
 107
 108 \membersection{cbBarHintsPlugin::OnDrawBarDecorations}\label{cbbarhintspluginondrawbardecorations}
 109
 110 \func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
 111
 112 Handles a plugin event.
 113
 114
 115 \membersection{cbBarHintsPlugin::OnInitPlugin}\label{cbbarhintspluginoninitplugin}
 116
 117 \func{void}{OnInitPlugin}{\void}
 118
 119 Called to initialize this plugin.
 120
 121
 122 \membersection{cbBarHintsPlugin::OnLeftDown}\label{cbbarhintspluginonleftdown}
 123
 124 \func{void}{OnLeftDown}{\param{cbLeftDownEvent\& }{event}}
 125
 126 Handles a plugin event.
 127
 128
 129 \membersection{cbBarHintsPlugin::OnLeftUp}\label{cbbarhintspluginonleftup}
 130
 131 \func{void}{OnLeftUp}{\param{cbLeftUpEvent\& }{event}}
 132
 133 Handles a plugin event.
 134
 135
 136 \membersection{cbBarHintsPlugin::OnMotion}\label{cbbarhintspluginonmotion}
 137
 138 \func{void}{OnMotion}{\param{cbMotionEvent\& }{event}}
 139
 140 Handles a plugin event.
 141
 142
 143 \membersection{cbBarHintsPlugin::OnSizeBarWindow}\label{cbbarhintspluginonsizebarwindow}
 144
 145 \func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
 146
 147 Handles a plugin event.
 148
 149
 150 \membersection{cbBarHintsPlugin::SetGrooveCount}\label{cbbarhintspluginsetgroovecount}
 151
 152 \func{void}{SetGrooveCount}{\param{int }{nGrooves}}
 153
 154 Set the number of grooves to be shown in the pane.
 155