docs/latex/wx/combopopup.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        combopopup.tex
   3 %% Purpose:     wxComboPopup docs
   4 %% Author:      Jaakko Salli
   5 %% Modified by:
   6 %% Created:
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) Jaakko Salli
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxComboPopup}}\label{wxcombopopup}
  13
  14 In order to use a custom popup with \helpref{wxComboCtrl}{wxcomboctrl},
  15 an interface class must be derived from wxComboPopup. For more information
  16 how to use it, see \helpref{Setting Custom Popup for wxComboCtrl}{wxcomboctrl}.
  17
  18 \wxheading{Include files}
  19
  20 <wx/combo.h>
  21
  22 \wxheading{Library}
  23
  24 \helpref{wxCore}{librarieslist}
  25
  26 \wxheading{See also}
  27
  28 \helpref{wxComboCtrl}{wxcomboctrl}
  29
  30 \latexignore{\rtfignore{\wxheading{Members}}}
  31
  32
  33 \membersection{wxComboPopup::wxComboPopup}\label{wxcombopopupwxcombopopup}
  34
  35 \func{}{wxComboPopup}{\void}
  36
  37 Default constructor. It is recommended that internal variables
  38 are prepared in \helpref{Init}{wxcombopopupinit} instead
  39 (because \helpref{m\_combo}{wxcombopopupmcombo} is not valid in constructor).
  40
  41
  42 \membersection{wxComboPopup::m\_combo}\label{wxcombopopupmcombo}
  43
  44 \member{wxComboCtrl}{m\_combo}
  45
  46 Parent \helpref{wxComboCtrl}{wxcomboctrl}. This is parameter has
  47 been prepared before \helpref{Init}{wxcombopopupinit} is called.
  48
  49
  50 \membersection{wxComboPopup::Create}\label{wxcombopopupcreate}
  51
  52 \func{bool}{Create}{\param{wxWindow* }{parent}}
  53
  54 The derived class must implement this to create the popup control.
  55
  56 \wxheading{Return value}
  57
  58 \true if the call succeeded, \false otherwise.
  59
  60
  61 \membersection{wxComboPopup::Dismiss}\label{wxcombopopupdismiss}
  62
  63 \func{void}{Dismiss}{\void}
  64
  65 Utility function that hides the popup.
  66
  67
  68 \membersection{wxComboPopup::GetAdjustedSize}\label{wxcombopopupgetadjustedsize}
  69
  70 \func{wxSize}{GetAdjustedSize}{\param{int }{minWidth}, \param{int }{prefHeight}, \param{int }{maxHeight}}
  71
  72 The derived class may implement this to return adjusted size
  73 for the popup control, according to the variables given.
  74
  75 \wxheading{Parameters}
  76
  77 \docparam{minWidth}{Preferred minimum width.}
  78 \docparam{prefHeight}{Preferred height. May be -1 to indicate
  79 no preference.}
  80 \docparam{maxWidth}{Max height for window, as limited by
  81 screen size.}
  82
  83 \wxheading{Remarks}
  84
  85 Called each time popup is about to be shown.
  86
  87
  88 \membersection{wxComboPopup::GetControl}\label{wxcombopopupgetcontrol}
  89
  90 \func{wxWindow*}{GetControl}{\void}
  91
  92 The derived class must implement this to return pointer
  93 to the associated control created in \helpref{Create}{wxcombopopupcreate}.
  94
  95
  96 \membersection{wxComboPopup::GetStringValue}\label{wxcombopopupgetstringvalue}
  97
  98 \constfunc{wxString}{GetStringValue}{\void}
  99
 100 The derived class must implement this to return
 101 string representation of the value.
 102
 103
 104 \membersection{wxComboPopup::Init}\label{wxcombopopupinit}
 105
 106 \func{void}{Init}{\void}
 107
 108 The derived class must implement this to initialize
 109 its internal variables. This method is called immediately
 110 after construction finishes. \helpref{m\_combo}{wxcombopopupmcombo}
 111 member variable has been initialized before the call.
 112
 113
 114 \membersection{wxComboPopup::IsCreated}\label{wxcombopopupiscreated}
 115
 116 \constfunc{bool}{IsCreated}{\void}
 117
 118 Utility method that returns \true if Create has been called.
 119
 120 Useful in conjunction with \helpref{LazyCreate}{wxcombopopuplazycreate}.
 121
 122
 123 \membersection{wxComboPopup::LazyCreate}\label{wxcombopopuplazycreate}
 124
 125 \func{bool}{LazyCreate}{\void}
 126
 127 The derived class may implement this to return
 128 \true if it wants to delay call to \helpref{Create}{wxcombopopupcreate}
 129 until the popup is shown for the first time. It is more
 130 efficient, but on the other hand it is often more convenient
 131 to have the control created immediately.
 132
 133 \wxheading{Remarks}
 134
 135 Base implementation returns \false.
 136
 137
 138 \membersection{wxComboPopup::OnComboDoubleClick}\label{wxcombopopuponcombodoubleclick}
 139
 140 \func{void}{OnComboDoubleClick}{\void}
 141
 142 The derived class may implement this to do something
 143 when the parent \helpref{wxComboCtrl}{wxcomboctrl} gets double-clicked.
 144
 145
 146 \membersection{wxComboPopup::OnComboKeyEvent}\label{wxcombopopuponcombokeyevent}
 147
 148 \func{void}{OnComboKeyEvent}{\param{wxKeyEvent\& }{event}}
 149
 150 The derived class may implement this to receive
 151 key events from the parent \helpref{wxComboCtrl}{wxcomboctrl}.
 152
 153 Events not handled should be skipped, as usual.
 154
 155
 156 \membersection{wxComboPopup::OnDismiss}\label{wxcombopopupondismiss}
 157
 158 \func{void}{OnDismiss}{\void}
 159
 160 The derived class may implement this to do
 161 special processing when popup is hidden.
 162
 163
 164 \membersection{wxComboPopup::OnPopup}\label{wxcombopopuponpopup}
 165
 166 \func{void}{OnPopup}{\void}
 167
 168 The derived class may implement this to do
 169 special processing when popup is shown.
 170
 171
 172 \membersection{wxComboPopup::PaintComboControl}\label{wxcombopopuppaintcombocontrol}
 173
 174 \func{void}{PaintComboControl}{\param{wxDC\& }{dc}, \param{const wxRect\& }{rect}}
 175
 176 The derived class may implement this to paint
 177 the parent \helpref{wxComboCtrl}{wxcomboctrl}.
 178
 179 Default implementation draws value as string.
 180
 181
 182 \membersection{wxComboPopup::SetStringValue}\label{wxcombopopupsetstringvalue}
 183
 184 \func{void}{SetStringValue}{\param{const wxString\& }{value}}
 185
 186 The derived class must implement this to receive
 187 string value changes from \helpref{wxComboCtrl}{wxcomboctrl}.
 188