contrib/docs/latex/fl/cbhintanimationplugin.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % hintanimpl.h at 21/Jan/02 21:14:18
   4 %
   5
   6
   7 \section{\class{cbHintAnimationPlugin}}\label{cbhintanimationplugin}
   8
   9
  10 A plugin to draw animated hints when the user drags a pane.
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{cbPluginBase}{cbpluginbase}
  15
  16 \wxheading{Include files}
  17
  18 <hintanimpl.h>
  19
  20 \wxheading{Data structures}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24
  25 \membersection{cbHintAnimationPlugin::cbHintAnimationPlugin}\label{cbhintanimationplugincbhintanimationplugin}
  26
  27 \func{}{cbHintAnimationPlugin}{\void}
  28
  29 Default constructor.
  30
  31
  32 \func{}{cbHintAnimationPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
  33
  34 Constructor, taking a layout panel and pane mask.
  35
  36
  37 \membersection{cbHintAnimationPlugin::\destruct{cbHintAnimationPlugin}}\label{cbhintanimationplugindtor}
  38
  39 \func{}{\destruct{cbHintAnimationPlugin}}{\void}
  40
  41 Destructor.
  42
  43
  44 \membersection{cbHintAnimationPlugin::DoDrawHintRect}\label{cbhintanimationplugindodrawhintrect}
  45
  46 \func{void}{DoDrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
  47
  48 Internal function for drawing a hint rectangle.
  49
  50
  51 \membersection{cbHintAnimationPlugin::DrawHintRect}\label{cbhintanimationplugindrawhintrect}
  52
  53 \func{void}{DrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
  54
  55 Internal function for drawing a hint rectangle.
  56
  57
  58 \membersection{cbHintAnimationPlugin::EraseHintRect}\label{cbhintanimationpluginerasehintrect}
  59
  60 \func{void}{EraseHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
  61
  62 Internal function for erasing a hint rectangle.
  63
  64
  65 \membersection{cbHintAnimationPlugin::FinishTracking}\label{cbhintanimationpluginfinishtracking}
  66
  67 \func{void}{FinishTracking}{\void}
  68
  69 Internal function for finishing tracking.
  70
  71
  72 \membersection{cbHintAnimationPlugin::OnDrawHintRect}\label{cbhintanimationpluginondrawhintrect}
  73
  74 \func{void}{OnDrawHintRect}{\param{cbDrawHintRectEvent\& }{event}}
  75
  76 Event handler respoding to hint draw events.
  77
  78
  79 \membersection{cbHintAnimationPlugin::RectToScr}\label{cbhintanimationpluginrecttoscr}
  80
  81 \func{void}{RectToScr}{\param{wxRect\& }{frameRect}, \param{wxRect\& }{scrRect}}
  82
  83 Internal function for translating coordinates.
  84
  85
  86 \membersection{cbHintAnimationPlugin::StartTracking}\label{cbhintanimationpluginstarttracking}
  87
  88 \func{void}{StartTracking}{\void}
  89
  90 speed is constant. Default: TRUE
  91 TBD:: get/set methods for above members
  92 Internal function for starting tracking.
  93