wx.ComboPopup Class Reference

Inheritance diagram for wx.ComboPopup:

wx.Object

List of all members.

Public Member Functions

 ComboPopup ()
 ComboPopup (Window control)
void Dismiss ()
virtual
System.Drawing.Size 
GetAdjustedSize (int minWidth, int prefHeight, int maxHeight)
abstract string GetStringValue ()
virtual void Init ()
bool IsCreated ()
virtual bool LazyCreate ()
virtual void OnComboDoubleClick ()
virtual void OnComboKeyEvent (KeyEvent evt)
virtual void PaintComboControl (DC dc, System.Drawing.Rectangle rect)
virtual void SetStringValue (string value)

Protected Member Functions

override void CallDTor ()
abstract bool Create (Window parent)
virtual void OnDismiss ()
virtual void OnPopup ()

Protected Attributes

Window _control

Properties

ComboCtrl ComboControl [get]
Window PopupControl [get]
string StringValue [get, set]


Detailed Description

This interface declares those methods which are required by popups of a ComboCtrl. Please note, that in contrast to the original wxWidgets class hierarchy, this is not intended as a base class that shall be inherited together with wx.Control. In contrast, the control shall be a member of this. Refer to wx.DatePicker for an example.

Constructor & Destructor Documentation

wx.ComboPopup.ComboPopup ( Window  control  ) 

CTor already defining a control that will be poped up.

Parameters:
control is the control that will be shown on popup. Please note, that this is required to implement 2 step contruction since that parent will be delivered calling Create(), not earlier.

wx.ComboPopup.ComboPopup (  ) 

CTor creating a sceleton without defining an instance for the popup window. If you use this, use Create() to create the PopupControl.


Member Function Documentation

override void wx.ComboPopup.CallDTor (  )  [protected, virtual]

This will be called by Dispose() to delete the C++ object. Overload this if you have to use another DTor.

Reimplemented from wx.Object.

abstract bool wx.ComboPopup.Create ( Window  parent  )  [protected, pure virtual]

Create the popup child control. Implementors shall set _control. Return true for success.

void wx.ComboPopup.Dismiss (  ) 

Hides the popup.

virtual System.Drawing.Size wx.ComboPopup.GetAdjustedSize ( int  minWidth,
int  prefHeight,
int  maxHeight 
) [virtual]

Return final size of popup. Called on every popup, just prior to OnShow.

Parameters:
minWidth is the preferred minimum width for window
prefHeight is the preferred height. Only applies if larger than 0,
maxHeight is the max. height for window, as limited by screen size and should only be rounded down, if necessary.

abstract string wx.ComboPopup.GetStringValue (  )  [pure virtual]

Gets displayed string representation of the value.

virtual void wx.ComboPopup.Init (  )  [virtual]

This is called immediately after construction finishes. m_combo member variable has been initialized before the call.

bool wx.ComboPopup.IsCreated (  ) 

Returns true if Create() has been called.

virtual bool wx.ComboPopup.LazyCreate (  )  [virtual]

Return true if you want delay call to Create until the popup is shown for the first time. It is more efficient, but note that it is often more convenient to have the control created immediately. Default returns false.

virtual void wx.ComboPopup.OnComboDoubleClick (  )  [virtual]

Implement if you need to support special action when user double-clicks on the parent wx.ComboCtrl.

virtual void wx.ComboPopup.OnComboKeyEvent ( KeyEvent  evt  )  [virtual]

Receives key events from the parent wxComboCtrl. Events not handled should be skipped, as usual.

virtual void wx.ComboPopup.OnDismiss (  )  [protected, virtual]

Called when popup is dismissed.

virtual void wx.ComboPopup.OnPopup (  )  [protected, virtual]

Called immediately after the popup is shown.

virtual void wx.ComboPopup.PaintComboControl ( DC  dc,
System.Drawing.Rectangle  rect 
) [virtual]

This is called to custom paint in the combo control itself (ie. not the popup). Default implementation draws value as string.

virtual void wx.ComboPopup.SetStringValue ( string  value  )  [virtual]

Called just prior to displaying popup. Default implementation does nothing.


Member Data Documentation

Window wx.ComboPopup._control [protected]

Load this with the popup control that will be shown on popup. This may either be set by a CTor or by an implementation of Create().


Property Documentation

ComboCtrl wx.ComboPopup.ComboControl [get]

This is the combo box that will popup this.

Window wx.ComboPopup.PopupControl [get]

The control that will be shown on popup.

string wx.ComboPopup.StringValue [get, set]

Synonym for GetStringValue() and SetStringValue() .


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads