contrib/docs/latex/fl/cbbarhintsplugin.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % barhintspl.h at 05/Jan/02 22:50:56
   4 %
   5
   6
   7 \section{\class{cbBarHintsPlugin}}\label{cbbarhintsplugin}
   8
   9
  10 Intercepts bar-decoration and sizing events, 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{Data structures}
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21
  22 \membersection{cbBarHintsPlugin::cbBarHintsPlugin}\label{cbbarhintsplugincbbarhintsplugin}
  23
  24 \func{}{cbBarHintsPlugin}{\void}
  25
  26
  27 \func{}{cbBarHintsPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
  28
  29
  30 \membersection{cbBarHintsPlugin::\destruct{cbBarHintsPlugin}}\label{cbbarhintsplugindtor}
  31
  32 \func{}{\destruct{cbBarHintsPlugin}}{\void}
  33
  34
  35 \membersection{cbBarHintsPlugin::CreateBoxes}\label{cbbarhintsplugincreateboxes}
  36
  37 \func{void}{CreateBoxes}{\void}
  38
  39
  40 \membersection{cbBarHintsPlugin::DoDrawHint}\label{cbbarhintsplugindodrawhint}
  41
  42 \func{void}{DoDrawHint}{\param{wxDC\& }{dc}, \param{wxRect\& }{rect}, \param{int }{pos}, \param{int }{boxOfs}, \param{int }{grooveOfs}, \param{bool }{isFixed}}
  43
  44
  45 \membersection{cbBarHintsPlugin::Draw3DBox}\label{cbbarhintsplugindraw3dbox}
  46
  47 \func{void}{Draw3DBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
  48
  49 drawing helpers
  50
  51
  52 \membersection{cbBarHintsPlugin::DrawCloseBox}\label{cbbarhintsplugindrawclosebox}
  53
  54 \func{void}{DrawCloseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{pressed}}
  55
  56
  57 \membersection{cbBarHintsPlugin::DrawCollapseBox}\label{cbbarhintsplugindrawcollapsebox}
  58
  59 \func{void}{DrawCollapseBox}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{bool }{atLeft}, \param{bool }{disabled}, \param{bool }{pressed}}
  60
  61
  62 \membersection{cbBarHintsPlugin::DrawGrooves}\label{cbbarhintsplugindrawgrooves}
  63
  64 \func{void}{DrawGrooves}{\param{wxDC\& }{dc}, \param{const wxPoint\& }{pos}, \param{int }{length}}
  65
  66
  67 \membersection{cbBarHintsPlugin::ExcludeHints}\label{cbbarhintspluginexcludehints}
  68
  69 \func{void}{ExcludeHints}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}}
  70
  71
  72 \membersection{cbBarHintsPlugin::GetHintsLayout}\label{cbbarhintsplugingethintslayout}
  73
  74 \func{void}{GetHintsLayout}{\param{wxRect\& }{rect}, \param{cbBarInfo\& }{info}, \param{int\& }{boxOfs}, \param{int\& }{grooveOfs}, \param{int\& }{pos}}
  75
  76
  77 \membersection{cbBarHintsPlugin::HitTestHints}\label{cbbarhintspluginhittesthints}
  78
  79 \func{int}{HitTestHints}{\param{cbBarInfo\& }{info}, \param{const wxPoint\& }{pos}}
  80
  81
  82 \membersection{cbBarHintsPlugin::OnDrawBarDecorations}\label{cbbarhintspluginondrawbardecorations}
  83
  84 \func{void}{OnDrawBarDecorations}{\param{cbDrawBarDecorEvent\& }{event}}
  85
  86
  87 \membersection{cbBarHintsPlugin::OnInitPlugin}\label{cbbarhintspluginoninitplugin}
  88
  89 \func{void}{OnInitPlugin}{\void}
  90
  91
  92 \membersection{cbBarHintsPlugin::OnLeftDown}\label{cbbarhintspluginonleftdown}
  93
  94 \func{void}{OnLeftDown}{\param{cbLeftDownEvent\& }{event}}
  95
  96
  97 \membersection{cbBarHintsPlugin::OnLeftUp}\label{cbbarhintspluginonleftup}
  98
  99 \func{void}{OnLeftUp}{\param{cbLeftUpEvent\& }{event}}
 100
 101
 102 \membersection{cbBarHintsPlugin::OnMotion}\label{cbbarhintspluginonmotion}
 103
 104 \func{void}{OnMotion}{\param{cbMotionEvent\& }{event}}
 105
 106
 107 \membersection{cbBarHintsPlugin::OnSizeBarWindow}\label{cbbarhintspluginonsizebarwindow}
 108
 109 \func{void}{OnSizeBarWindow}{\param{cbSizeBarWndEvent\& }{event}}
 110
 111 handlers of plugin-events
 112
 113
 114 \membersection{cbBarHintsPlugin::SetGrooveCount}\label{cbbarhintspluginsetgroovecount}
 115
 116 \func{void}{SetGrooveCount}{\param{int }{nGrooves}}
 117