wxComboCtrl

Implements methods from the following classes

• wxTextEntry
• wxControl

Methods

• wxComboCtrl
  Default constructor.
• AnimateShow
  This member function is not normally called in application code.
• Copy
  Copies the selected text to the clipboard.
• Create
  Creates the combo control for two-step construction.
• Cut
  Copies the selected text to the clipboard and removes the selection.
• Dismiss
  Dismisses the popup window.
• DoSetPopupControl
  This member function is not normally called in application code.
• DoShowPopup
  This member function is not normally called in application code.
• EnablePopupAnimation
  Enables or disables popup animation, if any, depending on the value of the argument.
• GetBitmapDisabled
  Returns disabled button bitmap that has been set with SetButtonBitmaps().
• GetBitmapHover
  Returns button mouse hover bitmap that has been set with SetButtonBitmaps().
• GetBitmapNormal
  Returns default button bitmap that has been set with SetButtonBitmaps().
• GetBitmapPressed
  Returns depressed button bitmap that has been set with SetButtonBitmaps().
• GetButtonSize
  Returns current size of the dropdown button.
• GetCustomPaintWidth
  Returns custom painted area in control.
• GetHint
  Returns the current hint string.
• GetInsertionPoint
  Returns the insertion point for the combo control's text field.
• GetLastPosition
  Returns the last position in the combo control text field.
• GetMargins
  Returns the margins used by the control.
• GetPopupControl
  Returns current popup interface that has been set with SetPopupControl().
• GetPopupWindow
  Returns popup window containing the popup control.
• GetTextCtrl
  Get the text control which is part of the combo control.
• GetTextIndent
  Returns actual indentation in pixels.
• GetTextRect
  Returns area covered by the text field (includes everything except borders and the dropdown button).
• GetValue
  Returns text representation of the current value.
• HidePopup
  Dismisses the popup window.
• IsPopupShown
  Returns true if the popup is currently shown.
• IsPopupWindowState
  Returns true if the popup window is in the given state.
• OnButtonClick
  Implement in a derived class to define what happens on dropdown button click.
• Paste
  Pastes text from the clipboard to the text field.
• Popup
  Shows the popup portion of the combo control.
• Remove
  Removes the text between the two positions in the combo control text field.
• Replace
  Replaces the text between two positions with the given text, in the combo control text field.
• SetButtonBitmaps
  Sets custom dropdown button graphics.
• SetButtonPosition
  Sets size and position of dropdown button.
• SetCustomPaintWidth
  Set width, in pixels, of custom painted area in control without wxCB_READONLY style.
• SetHint
  Sets a hint shown in an empty unfocused combo control.
• SetInsertionPoint
  Sets the insertion point in the text field.
• SetInsertionPointEnd
  Sets the insertion point at the end of the combo control text field.
• SetMargins
  Attempts to set the control margins.
• SetPopupAnchor
  Set side of the control to which the popup will align itself.
• SetPopupControl
  Set popup interface class derived from wxComboPopup.
• SetPopupExtents
  Extends popup size horizontally, relative to the edges of the combo control.
• SetPopupMaxHeight
  Sets preferred maximum height of the popup.
• SetPopupMinWidth
  Sets minimum width of the popup.
• SetSelection
  Selects the text between the two positions, in the combo control text field.
• SetText
  Sets the text for the text field without affecting the popup.
• SetTextCtrlStyle
  Set a custom window style for the embedded wxTextCtrl.
• SetTextIndent
  This will set the space in pixels between left edge of the control and the text, regardless whether control is read-only or not.
• SetValue
  Sets the text for the combo control text field.
• ShowPopup
  Show the popup.
• Undo
  Undoes the last edit in the text field.
• UseAltPopupWindow
  Enable or disable usage of an alternative popup window, which guarantees ability to focus the popup control, and allows common native controls to function normally.

Static Methods

• GetFeatures
  Returns features supported by wxComboCtrl.

wxComboCtrl

wxComboCtrl ( )

Default constructor.
wxComboCtrl ( wxWindow &$parent, integer $id=wxID_ANY, string $value=wxEmptyString, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style, wxValidator $validator=wxDefaultValidator, string $name=wxComboBoxNameStr )

Constructor, creating and showing a combo control.

AnimateShow

bool AnimateShow ( wxRect $rect, integer $flags )

This member function is not normally called in application code.

Copy

Copy ( )

Copies the selected text to the clipboard.

Create

bool Create ( wxWindow &$parent, integer $id=wxID_ANY, string $value=wxEmptyString, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style, wxValidator $validator=wxDefaultValidator, string $name=wxComboBoxNameStr )

Creates the combo control for two-step construction.

Cut

Cut ( )

Copies the selected text to the clipboard and removes the selection.

Dismiss

Dismiss ( )

Dismisses the popup window.

DoSetPopupControl

DoSetPopupControl ( wxComboPopup &$popup )

This member function is not normally called in application code.

DoShowPopup

DoShowPopup ( wxRect $rect, integer $flags )

This member function is not normally called in application code.

EnablePopupAnimation

EnablePopupAnimation ( bool $enable=true )

Enables or disables popup animation, if any, depending on the value of the argument.

GetBitmapDisabled

wxBitmap GetBitmapDisabled ( )

Returns disabled button bitmap that has been set with SetButtonBitmaps().

GetBitmapHover

wxBitmap GetBitmapHover ( )

Returns button mouse hover bitmap that has been set with SetButtonBitmaps().

GetBitmapNormal

wxBitmap GetBitmapNormal ( )

Returns default button bitmap that has been set with SetButtonBitmaps().

GetBitmapPressed

wxBitmap GetBitmapPressed ( )

Returns depressed button bitmap that has been set with SetButtonBitmaps().

GetButtonSize

wxSize GetButtonSize ( )

Returns current size of the dropdown button.

GetCustomPaintWidth

integer GetCustomPaintWidth ( )

Returns custom painted area in control.

GetFeatures

static integer GetFeatures ( )

Returns features supported by wxComboCtrl.

GetHint

string GetHint ( )

Returns the current hint string.

GetInsertionPoint

integer GetInsertionPoint ( )

Returns the insertion point for the combo control's text field.

GetLastPosition

integer GetLastPosition ( )

Returns the last position in the combo control text field.

GetMargins

wxPoint GetMargins ( )

Returns the margins used by the control.

GetPopupControl

wxComboPopup& GetPopupControl ( )

Returns current popup interface that has been set with SetPopupControl().

GetPopupWindow

wxWindow& GetPopupWindow ( )

Returns popup window containing the popup control.

GetTextCtrl

wxTextCtrl& GetTextCtrl ( )

Get the text control which is part of the combo control.

GetTextIndent

integer GetTextIndent ( )

Returns actual indentation in pixels.

GetTextRect

wxRect GetTextRect ( )

Returns area covered by the text field (includes everything except borders and the dropdown button).

GetValue

string GetValue ( )

Returns text representation of the current value.

HidePopup

HidePopup ( bool $generateEvent=false )

Dismisses the popup window.

IsPopupShown

bool IsPopupShown ( )

Returns true if the popup is currently shown.

IsPopupWindowState

bool IsPopupWindowState ( integer $state )

Returns true if the popup window is in the given state.

OnButtonClick

OnButtonClick ( )

Implement in a derived class to define what happens on dropdown button click.

Paste

Paste ( )

Pastes text from the clipboard to the text field.

Popup

Popup ( )

Shows the popup portion of the combo control.

Remove

Remove ( integer $from, integer $to )

Removes the text between the two positions in the combo control text field.

Replace

Replace ( integer $from, integer $to, string $text )

Replaces the text between two positions with the given text, in the combo control text field.

SetButtonBitmaps

SetButtonBitmaps ( wxBitmap $bmpNormal, bool $pushButtonBg=false, wxBitmap $bmpPressed=wxNullBitmap, wxBitmap $bmpHover=wxNullBitmap, wxBitmap $bmpDisabled=wxNullBitmap )

Sets custom dropdown button graphics.

SetButtonPosition

SetButtonPosition ( integer $width=-1, integer $height=-1, integer $side=wxRIGHT, integer $spacingX )

Sets size and position of dropdown button.

SetCustomPaintWidth

SetCustomPaintWidth ( integer $width )

Set width, in pixels, of custom painted area in control without wxCB_READONLY style.

SetHint

bool SetHint ( string $hint )

Sets a hint shown in an empty unfocused combo control.

SetInsertionPoint

SetInsertionPoint ( integer $pos )

Sets the insertion point in the text field.

SetInsertionPointEnd

SetInsertionPointEnd ( )

Sets the insertion point at the end of the combo control text field.

SetMargins

bool SetMargins ( integer $left, integer $top=-1 )

Attempts to set the control margins.
bool SetMargins ( wxPoint $pt )

Attempts to set the control margins.

SetPopupAnchor

SetPopupAnchor ( integer $anchorSide )

Set side of the control to which the popup will align itself.

SetPopupControl

SetPopupControl ( wxComboPopup &$popup )

Set popup interface class derived from wxComboPopup.

SetPopupExtents

SetPopupExtents ( integer $extLeft, integer $extRight )

Extends popup size horizontally, relative to the edges of the combo control.

SetPopupMaxHeight

SetPopupMaxHeight ( integer $height )

Sets preferred maximum height of the popup.

SetPopupMinWidth

SetPopupMinWidth ( integer $width )

Sets minimum width of the popup.

SetSelection

SetSelection ( integer $from, integer $to )

Selects the text between the two positions, in the combo control text field.

SetText

SetText ( string $value )

Sets the text for the text field without affecting the popup.

SetTextCtrlStyle

SetTextCtrlStyle ( integer $style )

Set a custom window style for the embedded wxTextCtrl.

SetTextIndent

SetTextIndent ( integer $indent )

This will set the space in pixels between left edge of the control and the text, regardless whether control is read-only or not.

SetValue

SetValue ( string $value )

Sets the text for the combo control text field.

ShowPopup

ShowPopup ( )

Show the popup.

Undo

Undo ( )

Undoes the last edit in the text field.

UseAltPopupWindow

UseAltPopupWindow ( bool $enable=true )

Enable or disable usage of an alternative popup window, which guarantees ability to focus the popup control, and allows common native controls to function normally.