git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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