contrib/docs/latex/fl/cbupdatesmanagerbase.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % controlbar.h at 21/Jan/02 21:14:14
   4 %
   5
   6
   7 \section{\class{cbUpdatesManagerBase}}\label{cbupdatesmanagerbase}
   8
   9
  10 This class declares an abstract interface for optimized logic that should refresh
  11 areas of frame layout that actually need to be updated. This should be extended in future
  12 to implement a custom updating strategy.
  13
  14 \wxheading{Derived from}
  15
  16 \helpref{wxObject}{wxobject}
  17
  18 \wxheading{Include files}
  19
  20 <controlbar.h>
  21
  22 \wxheading{Data structures}
  23
  24 \latexignore{\rtfignore{\wxheading{Members}}}
  25
  26
  27 \membersection{cbUpdatesManagerBase::cbUpdatesManagerBase}\label{cbupdatesmanagerbasecbupdatesmanagerbase}
  28
  29 \func{}{cbUpdatesManagerBase}{\param{wxFrameLayout* }{pPanel}}
  30
  31 Constructor taking layout panel.
  32
  33
  34 \func{}{cbUpdatesManagerBase}{\void}
  35
  36 Default constructor
  37
  38
  39 \membersection{cbUpdatesManagerBase::\destruct{cbUpdatesManagerBase}}\label{cbupdatesmanagerbasedtor}
  40
  41 \func{}{\destruct{cbUpdatesManagerBase}}{\void}
  42
  43 Destructor.
  44
  45
  46 \membersection{cbUpdatesManagerBase::OnBarWillChange}\label{cbupdatesmanagerbaseonbarwillchange}
  47
  48 \func{void}{OnBarWillChange}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pInRow}, \param{cbDockPane* }{pInPane}}
  49
  50 This function receives a notification from the frame layout (in the order in which
  51 they would usually be invoked). Custom updates-managers may utilize
  52 these notifications to implement a more fine-grained updating strategy.
  53
  54
  55 \membersection{cbUpdatesManagerBase::OnFinishChanges}\label{cbupdatesmanagerbaseonfinishchanges}
  56
  57 \func{void}{OnFinishChanges}{\void}
  58
  59 This function receives a notification from the frame layout (in the order in which
  60 they would usually be invoked). Custom updates-managers may utilize
  61 these notifications to implement a more fine-grained updating strategy.
  62
  63
  64 \membersection{cbUpdatesManagerBase::OnPaneMarginsWillChange}\label{cbupdatesmanagerbaseonpanemarginswillchange}
  65
  66 \func{void}{OnPaneMarginsWillChange}{\param{cbDockPane* }{pPane}}
  67
  68 This function receives a notification from the frame layout (in the order in which
  69 they would usually be invoked). Custom updates-managers may utilize
  70 these notifications to implement a more fine-grained updating strategy.
  71
  72
  73 \membersection{cbUpdatesManagerBase::OnPaneWillChange}\label{cbupdatesmanagerbaseonpanewillchange}
  74
  75 \func{void}{OnPaneWillChange}{\param{cbDockPane* }{pPane}}
  76
  77 This function receives a notification from the frame layout (in the order in which
  78 they would usually be invoked). Custom updates-managers may utilize
  79 these notifications to implement a more fine-grained updating strategy.
  80
  81
  82 \membersection{cbUpdatesManagerBase::OnRowWillChange}\label{cbupdatesmanagerbaseonrowwillchange}
  83
  84 \func{void}{OnRowWillChange}{\param{cbRowInfo* }{pRow}, \param{cbDockPane* }{pInPane}}
  85
  86 This function receives a notification from the frame layout (in the order in which
  87 they would usually be invoked). Custom updates-managers may utilize
  88 these notifications to implement a more fine-grained updating strategy.
  89
  90
  91 \membersection{cbUpdatesManagerBase::OnStartChanges}\label{cbupdatesmanagerbaseonstartchanges}
  92
  93 \func{void}{OnStartChanges}{\void}
  94
  95 This function receives a notification from the frame layout (in the order in which
  96 they would usually be invoked). Custom updates-managers may utilize
  97 these notifications to implement a more fine-grained updating strategy.
  98
  99
 100 \membersection{cbUpdatesManagerBase::SetLayout}\label{cbupdatesmanagerbasesetlayout}
 101
 102 \func{void}{SetLayout}{\param{wxFrameLayout* }{pLayout}}
 103
 104 Sets the associated layout.
 105
 106
 107 \membersection{cbUpdatesManagerBase::UpdateNow}\label{cbupdatesmanagerbaseupdatenow}
 108
 109 \func{void}{UpdateNow}{\void}
 110
 111 Refreshes parts of the frame layout that need an update.
 112