contrib/docs/latex/fl/dynamictoolbar.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % dyntbar.h at 05/Jan/02 22:50:56
   4 %
   5
   6
   7 \section{\class{wxDynamicToolBar}}\label{wxdynamictoolbar}
   8
   9
  10 class manages containment and layouting of tool-windows
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{wxToolBarBase}{wxtoolbarbase}
  15
  16 \wxheading{Data structures}
  17
  18 \latexignore{\rtfignore{\wxheading{Members}}}
  19
  20
  21 \membersection{wxDynamicToolBar::wxDynamicToolBar}\label{wxdynamictoolbarwxdynamictoolbar}
  22
  23 \func{}{wxDynamicToolBar}{\void}
  24
  25
  26 \func{}{wxDynamicToolBar}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const long }{style = wxNO\_BORDER}, \param{const int }{orientation = wxVERTICAL}, \param{const int }{RowsOrColumns = 1}, \param{const wxString\& }{name = wxToolBarNameStr}}
  27
  28
  29 \membersection{wxDynamicToolBar::\destruct{wxDynamicToolBar}}\label{wxdynamictoolbardtor}
  30
  31 \func{}{\destruct{wxDynamicToolBar}}{\void}
  32
  33
  34 \membersection{wxDynamicToolBar::AddSeparator}\label{wxdynamictoolbaraddseparator}
  35
  36 \func{void}{AddSeparator}{\param{wxWindow* }{pSepartorWnd = NULL}}
  37
  38
  39 \membersection{wxDynamicToolBar::AddTool}\label{wxdynamictoolbaraddtool}
  40
  41 \func{void}{AddTool}{\param{int }{toolIndex}, \param{wxWindow* }{pToolWindow}, \param{const wxSize\& }{size = wxDefaultSize}}
  42
  43 overridables
  44
  45
  46 \func{void}{AddTool}{\param{int }{toolIndex}, \param{const wxString\& }{imageFileName}, \param{wxBitmapType }{imageFileType = wxBITMAP\_TYPE\_BMP}, \param{const wxString\& }{labelText = ""}, \param{bool }{alignTextRight = FALSE}, \param{bool }{isFlat = TRUE}}
  47
  48
  49 \func{void}{AddTool}{\param{int }{toolIndex}, \param{wxBitmap }{labelBmp}, \param{const wxString\& }{labelText = ""}, \param{bool }{alignTextRight = FALSE}, \param{bool }{isFlat = TRUE}}
  50
  51
  52 \func{wxToolBarToolBase*}{AddTool}{\param{const int }{toolIndex}, \param{const wxBitmap\& }{bitmap}, \param{const wxBitmap\& }{pushedBitmap = wxNullBitmap}, \param{const bool }{toggle = FALSE}, \param{const long }{xPos = -1}, \param{const long }{yPos = -1}, \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{helpString1 = ""}, \param{const wxString\& }{helpString2 = ""}}
  53
  54 method from wxToolBarBase (for compatibility), only
  55 first two arguments are valid
  56
  57
  58 \membersection{wxDynamicToolBar::Create}\label{wxdynamictoolbarcreate}
  59
  60 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const long }{style = wxNO\_BORDER}, \param{const int }{orientation = wxVERTICAL}, \param{const int }{RowsOrColumns = 1}, \param{const wxString\& }{name = wxToolBarNameStr}}
  61
  62
  63 \membersection{wxDynamicToolBar::CreateDefaulLayout}\label{wxdynamictoolbarcreatedefaullayout}
  64
  65 \func{LayoutManagerBase*}{CreateDefaulLayout}{\void}
  66
  67
  68 \membersection{wxDynamicToolBar::CreateTool}\label{wxdynamictoolbarcreatetool}
  69
  70 \func{wxToolBarToolBase*}{CreateTool}{\param{wxControl* }{control}}
  71
  72
  73 \func{wxToolBarToolBase*}{CreateTool}{\param{int }{id}, \param{const wxBitmap\& }{bitmap1}, \param{const wxBitmap\& }{bitmap2}, \param{bool }{toggle}, \param{wxObject* }{clientData}, \param{const wxString\& }{shortHelpString}, \param{const wxString\& }{longHelpString}}
  74
  75 the functions to create toolbar tools
  76
  77
  78 \membersection{wxDynamicToolBar::DoDeleteTool}\label{wxdynamictoolbardodeletetool}
  79
  80 \func{bool}{DoDeleteTool}{\param{size\_t }{pos}, \param{wxToolBarToolBase* }{tool}}
  81
  82 the tool is still in m\_tools list when this function is called, it will
  83 only be deleted from it if it succeeds
  84
  85
  86 \membersection{wxDynamicToolBar::DoEnableTool}\label{wxdynamictoolbardoenabletool}
  87
  88 \func{void}{DoEnableTool}{\param{wxToolBarToolBase* }{tool}, \param{bool }{enable}}
  89
  90 called when the tools enabled flag changes
  91
  92
  93 \membersection{wxDynamicToolBar::DoInsertTool}\label{wxdynamictoolbardoinserttool}
  94
  95 \func{bool}{DoInsertTool}{\param{size\_t }{pos}, \param{wxToolBarToolBase* }{tool}}
  96
  97
  98 \membersection{wxDynamicToolBar::DoSetToggle}\label{wxdynamictoolbardosettoggle}
  99
 100 \func{void}{DoSetToggle}{\param{wxToolBarToolBase* }{tool}, \param{bool }{toggle}}
 101
 102 called when the tools "can be toggled" flag changes
 103
 104
 105 \membersection{wxDynamicToolBar::DoToggleTool}\label{wxdynamictoolbardotoggletool}
 106
 107 \func{void}{DoToggleTool}{\param{wxToolBarToolBase* }{tool}, \param{bool }{toggle}}
 108
 109 called when the tool is toggled
 110
 111
 112 \membersection{wxDynamicToolBar::DrawSeparator}\label{wxdynamictoolbardrawseparator}
 113
 114 \func{void}{DrawSeparator}{\param{wxDynToolInfo\& }{info}, \param{wxDC\& }{dc}}
 115
 116 the default implementation draws shaded line
 117
 118
 119 \membersection{wxDynamicToolBar::EnableTool}\label{wxdynamictoolbarenabletool}
 120
 121 \func{void}{EnableTool}{\param{const int }{toolIndex}, \param{const bool }{enable = TRUE}}
 122
 123
 124 \membersection{wxDynamicToolBar::FindToolForPosition}\label{wxdynamictoolbarfindtoolforposition}
 125
 126 \constfunc{wxToolBarToolBase*}{FindToolForPosition}{\param{wxCoord }{x}, \param{wxCoord }{y}}
 127
 128 stuff from the 2.1.15
 129
 130
 131 \membersection{wxDynamicToolBar::GetPreferredDim}\label{wxdynamictoolbargetpreferreddim}
 132
 133 \func{void}{GetPreferredDim}{\param{const wxSize\& }{givenDim}, \param{wxSize\& }{prefDim}}
 134
 135
 136 \membersection{wxDynamicToolBar::GetToolInfo}\label{wxdynamictoolbargettoolinfo}
 137
 138 \func{wxDynToolInfo*}{GetToolInfo}{\param{int }{toolIndex}}
 139
 140
 141 \membersection{wxDynamicToolBar::Layout}\label{wxdynamictoolbarlayout}
 142
 143 \func{bool}{Layout}{\void}
 144
 145 see definitions of orientation types
 146
 147
 148 \membersection{wxDynamicToolBar::OnEraseBackground}\label{wxdynamictoolbaronerasebackground}
 149
 150 \func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{event}}
 151
 152
 153 \membersection{wxDynamicToolBar::OnPaint}\label{wxdynamictoolbaronpaint}
 154
 155 \func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
 156
 157
 158 \membersection{wxDynamicToolBar::OnSize}\label{wxdynamictoolbaronsize}
 159
 160 \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
 161
 162 event handlers
 163
 164
 165 \membersection{wxDynamicToolBar::Realize}\label{wxdynamictoolbarrealize}
 166
 167 \func{bool}{Realize}{\void}
 168
 169 overriden from wxToolBarBase
 170
 171
 172 \membersection{wxDynamicToolBar::RemveTool}\label{wxdynamictoolbarremvetool}
 173
 174 \func{void}{RemveTool}{\param{int }{toolIndex}}
 175
 176
 177 \membersection{wxDynamicToolBar::SetLayout}\label{wxdynamictoolbarsetlayout}
 178
 179 \func{void}{SetLayout}{\param{LayoutManagerBase* }{pLayout}}
 180
 181
 182 \membersection{wxDynamicToolBar::SizeToolWindows}\label{wxdynamictoolbarsizetoolwindows}
 183
 184 \func{void}{SizeToolWindows}{\void}
 185