#include <wx/combo.h>

Inheritance diagram for wxComboCtrl:

Detailed Description

A combo control is a generic combobox that allows totally custom popup.

In addition it has other customization features. For instance, position and size of the dropdown button can be changed.

Setting Custom Popup for wxComboCtrl

wxComboCtrl needs to be told somehow which control to use and this is done by SetPopupControl(). However, we need something more than just a wxControl in this method as, for example, we need to call SetStringValue("initial text value") and wxControl doesn't have such method. So we also need a wxComboPopup which is an interface which must be implemented by a control to be usable as a popup.

We couldn't derive wxComboPopup from wxControl as this would make it impossible to have a class deriving from a wxWidgets control and from it, so instead it is just a mix-in.

Here's a minimal sample of wxListView popup:

#include <wx/combo.h>
#include <wx/listctrl.h>
class wxListViewComboPopup : public wxListView, public wxComboPopup
{
public:
    // Initialize member variables
    virtual void Init()
    {
        m_value = -1;
    }
    // Create popup control
    virtual bool Create(wxWindow* parent)
    {
        return wxListView::Create(parent,1,wxPoint(0,0),wxDefaultSize);
    }
    // Return pointer to the created control
    virtual wxWindow *GetControl() { return this; }
    // Translate string into a list selection
    virtual void SetStringValue(const wxString& s)
    {
        int n = wxListView::FindItem(-1,s);
        if ( n >= 0 && n < wxListView::GetItemCount() )
            wxListView::Select(n);
    }
    // Get list selection as a string
    virtual wxString GetStringValue() const
    {
        if ( m_value >= 0 )
        return wxListView::GetItemText(m_value);
        return wxEmptyString;
    }
    // Do mouse hot-tracking (which is typical in list popups)
    void OnMouseMove(wxMouseEvent& event)
    {
        // TODO: Move selection to cursor
    }
    // On mouse left up, set the value and close the popup
    void OnMouseClick(wxMouseEvent& WXUNUSED(event))
    {
        m_value = wxListView::GetFirstSelected();
        // TODO: Send event as well
        Dismiss();
    }
protected:
    int m_value; // current item index
private:
    wxDECLARE_EVENT_TABLE();
};
wxBEGIN_EVENT_TABLE(wxListViewComboPopup, wxListView)
    EVT_MOTION(wxListViewComboPopup::OnMouseMove)
    EVT_LEFT_UP(wxListViewComboPopup::OnMouseClick)
wxEND_EVENT_TABLE()

Here's how you would create and populate it in a dialog constructor:

wxComboCtrl* comboCtrl = new wxComboCtrl(this, wxID_ANY, wxEmptyString);
wxListViewComboPopup* popupCtrl = new wxListViewComboPopup();
// It is important to call SetPopupControl() as soon as possible
comboCtrl->SetPopupControl(popupCtrl);
// Populate using wxListView methods
popupCtrl->InsertItem(popupCtrl->GetItemCount(), "First Item");
popupCtrl->InsertItem(popupCtrl->GetItemCount(), "Second Item");
popupCtrl->InsertItem(popupCtrl->GetItemCount(), "Third Item");

Styles

This class supports the following styles:

wxCB_READONLY:
Text will not be editable.
wxCB_SORT:
Sorts the entries in the list alphabetically.
wxTE_PROCESS_ENTER:
The control will generate the event wxEVT_TEXT_ENTER (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). Windows only.
wxCC_SPECIAL_DCLICK:
Double-clicking triggers a call to popup's OnComboDoubleClick. Actual behaviour is defined by a derived class. For instance, wxOwnerDrawnComboBox will cycle an item. This style only applies if wxCB_READONLY is used as well.
wxCC_STD_BUTTON:
Drop button will behave more like a standard push button.

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxCommandEvent& event)

Event macros for events emitted by this class:

EVT_TEXT(id, func):
Process a wxEVT_TEXT event, when the text changes.
EVT_TEXT_ENTER(id, func):
Process a wxEVT_TEXT_ENTER event, when RETURN is pressed in the combo control.
EVT_COMBOBOX_DROPDOWN(id, func):
Process a wxEVT_COMBOBOX_DROPDOWN event, which is generated when the popup window is shown (drops down).
EVT_COMBOBOX_CLOSEUP(id, func):
Process a wxEVT_COMBOBOX_CLOSEUP event, which is generated when the popup window of the combo control disappears (closes up). You should avoid adding or deleting items in this event.

Library: wxCore

Category: Controls

Appearance:

wxMSW Appearance

wxGTK Appearance

wxOSX Appearance

See Also: wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup, wxCommandEvent

Public Member Functions
	wxComboCtrl ()
	Default constructor.

	wxComboCtrl (wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxComboBoxNameStr)
	Constructor, creating and showing a combo control.

virtual	~wxComboCtrl ()
	Destructor, destroying the combo control.

virtual void	Copy ()
	Copies the selected text to the clipboard.

bool	Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxComboBoxNameStr)
	Creates the combo control for two-step construction.

virtual void	Cut ()
	Copies the selected text to the clipboard and removes the selection.

virtual void	Dismiss ()
	Dismisses the popup window.

void	EnablePopupAnimation (bool enable=true)
	Enables or disables popup animation, if any, depending on the value of the argument.

virtual bool	IsKeyPopupToggle (const wxKeyEvent &event) const
	Returns true if given key combination should toggle the popup.

virtual void	PrepareBackground (wxDC &dc, const wxRect &rect, int flags) const
	Prepare background of combo control or an item in a dropdown list in a way typical on platform.

bool	ShouldDrawFocus () const
	Returns true if focus indicator should be drawn in the control.

const wxBitmap &	GetBitmapDisabled () const
	Returns disabled button bitmap that has been set with SetButtonBitmaps().

const wxBitmap &	GetBitmapHover () const
	Returns button mouse hover bitmap that has been set with SetButtonBitmaps().

const wxBitmap &	GetBitmapNormal () const
	Returns default button bitmap that has been set with SetButtonBitmaps().

const wxBitmap &	GetBitmapPressed () const
	Returns depressed button bitmap that has been set with SetButtonBitmaps().

wxSize	GetButtonSize ()
	Returns current size of the dropdown button.

int	GetCustomPaintWidth () const
	Returns custom painted area in control.

virtual wxString	GetHint () const
	Returns the current hint string.

virtual long	GetInsertionPoint () const
	Returns the insertion point for the combo control's text field.

virtual long	GetLastPosition () const
	Returns the last position in the combo control text field.

wxPoint	GetMargins () const
	Returns the margins used by the control.

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

wxWindow *	GetPopupWindow () const
	Returns popup window containing the popup control.

wxTextCtrl *	GetTextCtrl () const
	Get the text control which is part of the combo control.

wxCoord	GetTextIndent () const
	Returns actual indentation in pixels.

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

virtual wxString	GetValue () const
	Returns text representation of the current value.

virtual void	HidePopup (bool generateEvent=false)
	Dismisses the popup window.

bool	IsPopupShown () const
	Returns true if the popup is currently shown.

bool	IsPopupWindowState (int state) const
	Returns true if the popup window is in the given state.

virtual void	OnButtonClick ()
	Implement in a derived class to define what happens on dropdown button click.

virtual void	Paste ()
	Pastes text from the clipboard to the text field.

virtual void	Popup ()
	Shows the popup portion of the combo control.

virtual void	Remove (long from, long to)
	Removes the text between the two positions in the combo control text field.

virtual void	Replace (long from, long to, const wxString &text)
	Replaces the text between two positions with the given text, in the combo control text field.

void	SetButtonBitmaps (const wxBitmap &bmpNormal, bool pushButtonBg=false, const wxBitmap &bmpPressed=wxNullBitmap, const wxBitmap &bmpHover=wxNullBitmap, const wxBitmap &bmpDisabled=wxNullBitmap)
	Sets custom dropdown button graphics.

void	SetButtonPosition (int width=-1, int height=-1, int side=wxRIGHT, int spacingX=0)
	Sets size and position of dropdown button.

void	SetCustomPaintWidth (int width)
	Set width, in pixels, of custom painted area in control without `wxCB_READONLY` style.

virtual bool	SetHint (const wxString &hint)
	Sets a hint shown in an empty unfocused combo control.

virtual void	SetInsertionPoint (long pos)
	Sets the insertion point in the text field.

virtual void	SetInsertionPointEnd ()
	Sets the insertion point at the end of the combo control text field.

void	SetPopupAnchor (int anchorSide)
	Set side of the control to which the popup will align itself.

void	SetPopupControl (wxComboPopup *popup)
	Set popup interface class derived from wxComboPopup.

void	SetPopupExtents (int extLeft, int extRight)
	Extends popup size horizontally, relative to the edges of the combo control.

void	SetPopupMaxHeight (int height)
	Sets preferred maximum height of the popup.

void	SetPopupMinWidth (int width)
	Sets minimum width of the popup.

virtual void	SetSelection (long from, long to)
	Selects the text between the two positions, in the combo control text field.

void	SetText (const wxString &value)
	Sets the text for the text field without affecting the popup.

void	SetTextCtrlStyle (int style)
	Set a custom window style for the embedded wxTextCtrl.

void	SetTextIndent (int 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.

virtual void	SetValue (const wxString &value)
	Sets the text for the combo control text field.

void	SetValueByUser (const wxString &value)
	Changes value of the control as if user had done it by selecting an item from a combo box drop-down list.

virtual void	ShowPopup ()
	Show the popup.

virtual void	Undo ()
	Undoes the last edit in the text field.

void	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.


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

bool	SetMargins (wxCoord left, wxCoord top=-1)
	Attempts to set the control margins.

Public Member Functions inherited from wxControl
	wxControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
	Constructs a control.

	wxControl ()
	Default constructor to allow 2-phase creation.

bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)

virtual void	Command (wxCommandEvent &event)
	Simulates the effect of the user issuing a command to the item.

wxString	GetLabel () const
	Returns the control's label, as it was passed to SetLabel().

wxString	GetLabelText () const
	Returns the control's label without mnemonics.

wxSize	GetSizeFromTextSize (int xlen, int ylen=-1) const
	Determine the size needed by the control to leave the given area for its text.

wxSize	GetSizeFromTextSize (const wxSize &tsize) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetLabel (const wxString &label)
	Sets the control's label.

void	SetLabelText (const wxString &text)
	Sets the control's label to exactly the given string.

bool	SetLabelMarkup (const wxString &markup)
	Sets the controls label to a string using markup.

Public Member Functions inherited from wxWindow
	wxWindow ()
	Default constructor.

	wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
	Constructs a window, which can be a child of a frame, dialog or any other non-control window.

virtual	~wxWindow ()
	Destructor.

bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)

virtual bool	AcceptsFocus () const
	This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn't need focus.

virtual bool	AcceptsFocusFromKeyboard () const
	This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard.

virtual bool	AcceptsFocusRecursively () const
	Overridden to indicate whether this window or one of its children accepts focus.

bool	IsFocusable () const
	Can this window itself have focus?

bool	CanAcceptFocus () const
	Can this window have focus right now?

bool	CanAcceptFocusFromKeyboard () const
	Can this window be assigned focus from keyboard right now?

virtual bool	HasFocus () const
	Returns true if the window (or in case of composite controls, its main child window) has focus.

virtual void	SetCanFocus (bool canFocus)
	This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).

virtual void	SetFocus ()
	This sets the window to receive keyboard input.

virtual void	SetFocusFromKbd ()
	This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

virtual void	AddChild (wxWindow *child)
	Adds a child window.

bool	DestroyChildren ()
	Destroys all children of a window.

wxWindow *	FindWindow (long id) const
	Find a child of this window, by id.

wxWindow *	FindWindow (const wxString &name) const
	Find a child of this window, by name.

wxWindowList &	GetChildren ()
	Returns a reference to the list of the window's children.

const wxWindowList &	GetChildren () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual void	RemoveChild (wxWindow *child)
	Removes a child window.

wxWindow *	GetGrandParent () const
	Returns the grandparent of a window, or NULL if there isn't one.

wxWindow *	GetNextSibling () const
	Returns the next window after this one among the parent's children or NULL if this window is the last child.

wxWindow *	GetParent () const
	Returns the parent of the window, or NULL if there is no parent.

wxWindow *	GetPrevSibling () const
	Returns the previous window before this one among the parent's children or NULL if this window is the first child.

bool	IsDescendant (wxWindowBase *win) const
	Check if the specified window is a descendant of this one.

virtual bool	Reparent (wxWindow *newParent)
	Reparents the window, i.e. the window will be removed from its current parent window (e.g.

virtual void	AlwaysShowScrollbars (bool hflag=true, bool vflag=true)
	Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

virtual int	GetScrollPos (int orientation) const
	Returns the built-in scrollbar position.

virtual int	GetScrollRange (int orientation) const
	Returns the built-in scrollbar range.

virtual int	GetScrollThumb (int orientation) const
	Returns the built-in scrollbar thumb size.

bool	CanScroll (int orient) const
	Returns true if this window can have a scroll bar in this orientation.

bool	HasScrollbar (int orient) const
	Returns true if this window currently has a scroll bar for this orientation.

virtual bool	IsScrollbarAlwaysShown (int orient) const
	Return whether a scrollbar is always shown.

virtual bool	ScrollLines (int lines)
	Scrolls the window by the given number of lines down (if lines is positive) or up.

virtual bool	ScrollPages (int pages)
	Scrolls the window by the given number of pages down (if pages is positive) or up.

virtual void	ScrollWindow (int dx, int dy, const wxRect *rect=NULL)
	Physically scrolls the pixels in the window and move child windows accordingly.

bool	LineUp ()
	Same as ScrollLines (-1).

bool	LineDown ()
	Same as ScrollLines (1).

bool	PageUp ()
	Same as ScrollPages (-1).

bool	PageDown ()
	Same as ScrollPages (1).

virtual void	SetScrollPos (int orientation, int pos, bool refresh=true)
	Sets the position of one of the built-in scrollbars.

virtual void	SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true)
	Sets the scrollbar properties of a built-in scrollbar.

bool	BeginRepositioningChildren ()
	Prepare for changing positions of multiple child windows.

void	EndRepositioningChildren ()
	Fix child window positions after setting all of them at once.

void	CacheBestSize (const wxSize &size) const
	Sets the cached best size value.

virtual wxSize	ClientToWindowSize (const wxSize &size) const
	Converts client area size size to corresponding window size.

virtual wxSize	WindowToClientSize (const wxSize &size) const
	Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

virtual void	Fit ()
	Sizes the window so that it fits around its subwindows.

virtual void	FitInside ()
	Similar to Fit(), but sizes the interior (virtual) size of a window.

wxSize	GetBestSize () const
	This functions returns the best acceptable minimal size for the window.

int	GetBestHeight (int width) const
	Returns the best height needed by this window if it had the given width.

int	GetBestWidth (int height) const
	Returns the best width needed by this window if it had the given height.

void	GetClientSize (int width, int height) const
	Returns the size of the window 'client area' in pixels.

wxSize	GetClientSize () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual wxSize	GetEffectiveMinSize () const
	Merges the window's best size into the min size and returns the result.

virtual wxSize	GetMaxClientSize () const
	Returns the maximum size of window's client area.

virtual wxSize	GetMaxSize () const
	Returns the maximum size of the window.

virtual wxSize	GetMinClientSize () const
	Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

virtual wxSize	GetMinSize () const
	Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

int	GetMinWidth () const
	Returns the horizontal component of window minimal size.

int	GetMinHeight () const
	Returns the vertical component of window minimal size.

int	GetMaxWidth () const
	Returns the horizontal component of window maximal size.

int	GetMaxHeight () const
	Returns the vertical component of window maximal size.

void	GetSize (int width, int height) const
	Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

wxSize	GetSize () const
	See the GetSize(int,int) overload for more info.

wxSize	GetVirtualSize () const
	This gets the virtual size of the window in pixels.

void	GetVirtualSize (int width, int height) const
	Like the other GetVirtualSize() overload but uses pointers instead.

virtual wxSize	GetBestVirtualSize () const
	Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

virtual double	GetContentScaleFactor () const
	Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen.

virtual wxSize	GetWindowBorderSize () const
	Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

virtual bool	InformFirstDirection (int direction, int size, int availableOtherDir)
	wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.

void	InvalidateBestSize ()
	Resets the cached best size value so it will be recalculated the next time it is needed.

void	PostSizeEvent ()
	Posts a size event to the window.

void	PostSizeEventToParent ()
	Posts a size event to the parent of this window.

virtual void	SendSizeEvent (int flags=0)
	This function sends a dummy size event to the window allowing it to re-layout its children positions.

void	SendSizeEventToParent (int flags=0)
	Safe wrapper for GetParent()->SendSizeEvent().

void	SetClientSize (int width, int height)
	This sets the size of the window client area in pixels.

void	SetClientSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetClientSize (const wxRect &rect)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetContainingSizer (wxSizer *sizer)
	This normally does not need to be called by user code.

void	SetInitialSize (const wxSize &size=wxDefaultSize)
	A smart SetSize that will fill in default size components with the window's best size values.

virtual void	SetMaxClientSize (const wxSize &size)
	Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

virtual void	SetMaxSize (const wxSize &size)
	Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

virtual void	SetMinClientSize (const wxSize &size)
	Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

virtual void	SetMinSize (const wxSize &size)
	Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

void	SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
	Sets the size of the window in pixels.

void	SetSize (const wxRect &rect)
	Sets the size of the window in pixels.

void	SetSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetSize (int width, int height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual void	SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
	Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

virtual void	SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetVirtualSize (int width, int height)
	Sets the virtual size of the window in pixels.

void	SetVirtualSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	Center (int dir=wxBOTH)
	A synonym for Centre().

void	CenterOnParent (int dir=wxBOTH)
	A synonym for CentreOnParent().

void	Centre (int direction=wxBOTH)
	Centres the window.

void	CentreOnParent (int direction=wxBOTH)
	Centres the window on its parent.

void	GetPosition (int x, int y) const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

wxPoint	GetPosition () const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

wxRect	GetRect () const
	Returns the position and size of the window as a wxRect object.

void	GetScreenPosition (int x, int y) const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one.

wxPoint	GetScreenPosition () const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one.

wxRect	GetScreenRect () const
	Returns the position and size of the window on the screen as a wxRect object.

virtual wxPoint	GetClientAreaOrigin () const
	Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)

wxRect	GetClientRect () const
	Get the client rectangle in window (i.e. client) coordinates.

void	Move (int x, int y, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.

void	Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.

void	SetPosition (const wxPoint &pt)
	A synonym for Centre().

void	ClientToScreen (int x, int y) const
	Converts to screen coordinates from coordinates relative to this window.

wxPoint	ClientToScreen (const wxPoint &pt) const
	Converts to screen coordinates from coordinates relative to this window.

wxPoint	ConvertDialogToPixels (const wxPoint &pt) const
	Converts a point or size from dialog units to pixels.

wxSize	ConvertDialogToPixels (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

wxPoint	ConvertPixelsToDialog (const wxPoint &pt) const
	Converts a point or size from pixels to dialog units.

wxSize	ConvertPixelsToDialog (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	ScreenToClient (int x, int y) const
	Converts from screen to client window coordinates.

wxPoint	ScreenToClient (const wxPoint &pt) const
	Converts from screen to client window coordinates.

virtual void	ClearBackground ()
	Clears the window by filling it with the current background colour.

void	Freeze ()
	Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

void	Thaw ()
	Re-enables window updating after a previous call to Freeze().

bool	IsFrozen () const
	Returns true if the window is currently frozen by a call to Freeze().

wxColour	GetBackgroundColour () const
	Returns the background colour of the window.

virtual wxBackgroundStyle	GetBackgroundStyle () const
	Returns the background style of the window.

virtual int	GetCharHeight () const
	Returns the character height for this window.

virtual int	GetCharWidth () const
	Returns the average character width for this window.

virtual wxVisualAttributes	GetDefaultAttributes () const
	Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

wxFont	GetFont () const
	Returns the font for this window.

wxColour	GetForegroundColour () const
	Returns the foreground colour of the window.

void	GetTextExtent (const wxString &string, int w, int h, int descent=NULL, int externalLeading=NULL, const wxFont *font=NULL) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

wxSize	GetTextExtent (const wxString &string) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

const wxRegion &	GetUpdateRegion () const
	Returns the region specifying which parts of the window have been damaged.

wxRect	GetUpdateClientRect () const
	Get the update rectangle bounding box in client coords.

virtual bool	HasTransparentBackground ()
	Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.

virtual void	Refresh (bool eraseBackground=true, const wxRect *rect=NULL)
	Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

void	RefreshRect (const wxRect &rect, bool eraseBackground=true)
	Redraws the contents of the given rectangle: only the area inside it will be repainted.

virtual void	Update ()
	Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

virtual bool	SetBackgroundColour (const wxColour &colour)
	Sets the background colour of the window.

virtual bool	SetBackgroundStyle (wxBackgroundStyle style)
	Sets the background style of the window.

virtual bool	IsTransparentBackgroundSupported (wxString *reason=NULL) const
	Checks whether using transparent background might work.

virtual bool	SetFont (const wxFont &font)
	Sets the font for this window.

virtual bool	SetForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window.

void	SetOwnBackgroundColour (const wxColour &colour)
	Sets the background colour of the window but prevents it from being inherited by the children of this window.

bool	InheritsBackgroundColour () const
	Return true if this window inherits the background colour from its parent.

bool	UseBgCol () const
	Return true if a background colour has been set for this window.

void	SetOwnFont (const wxFont &font)
	Sets the font of the window but prevents it from being inherited by the children of this window.

void	SetOwnForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

void	SetPalette (const wxPalette &pal)

virtual bool	ShouldInheritColours () const
	Return true from here to allow the colours of this window to be changed by InheritAttributes().

virtual void	SetThemeEnabled (bool enable)
	This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

virtual bool	GetThemeEnabled () const
	Clears the window by filling it with the current background colour.

virtual bool	CanSetTransparent ()
	Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

virtual bool	SetTransparent (wxByte alpha)
	Set the transparency of the window.

wxEvtHandler *	GetEventHandler () const
	Returns the event handler for this window.

bool	HandleAsNavigationKey (const wxKeyEvent &event)
	This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

bool	HandleWindowEvent (wxEvent &event) const
	Shorthand for:

bool	ProcessWindowEvent (wxEvent &event)
	Convenient wrapper for ProcessEvent().

bool	ProcessWindowEventLocally (wxEvent &event)
	Wrapper for wxEvtHandler::ProcessEventLocally().

wxEvtHandler *	PopEventHandler (bool deleteHandler=false)
	Removes and returns the top-most event handler on the event handler stack.

void	PushEventHandler (wxEvtHandler *handler)
	Pushes this event handler onto the event stack for the window.

bool	RemoveEventHandler (wxEvtHandler *handler)
	Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

void	SetEventHandler (wxEvtHandler *handler)
	Sets the event handler for this window.

virtual void	SetNextHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.

virtual void	SetPreviousHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.

long	GetExtraStyle () const
	Returns the extra style bits for the window.

virtual long	GetWindowStyleFlag () const
	Gets the window style that was passed to the constructor or Create() method.

long	GetWindowStyle () const
	See GetWindowStyleFlag() for more info.

bool	HasExtraStyle (int exFlag) const
	Returns true if the window has the given exFlag bit set in its extra styles.

bool	HasFlag (int flag) const
	Returns true if the window has the given flag bit set.

virtual void	SetExtraStyle (long exStyle)
	Sets the extra style bits for the window.

virtual void	SetWindowStyleFlag (long style)
	Sets the style of the window.

void	SetWindowStyle (long style)
	See SetWindowStyleFlag() for more info.

bool	ToggleWindowStyle (int flag)
	Turns the given flag on if it's currently turned off and vice versa.

void	MoveAfterInTabOrder (wxWindow *win)
	Moves this window in the tab navigation order after the specified win.

void	MoveBeforeInTabOrder (wxWindow *win)
	Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

bool	Navigate (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action starting from this window.

bool	NavigateIn (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action inside this window.

virtual void	Lower ()
	Lowers the window to the bottom of the window hierarchy (Z-order).

virtual void	Raise ()
	Raises the window to the top of the window hierarchy (Z-order).

bool	Hide ()
	Equivalent to calling wxWindow::Show(false).

virtual bool	HideWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function hides a window, like Hide(), but using a special visual effect if possible.

bool	IsEnabled () const
	Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

bool	IsExposed (int x, int y) const
	Returns true if the given point or rectangle area has been exposed since the last repaint.

bool	IsExposed (wxPoint &pt) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	IsExposed (int x, int y, int w, int h) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	IsExposed (wxRect &rect) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual bool	IsShown () const
	Returns true if the window is shown, false if it has been hidden.

virtual bool	IsShownOnScreen () const
	Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.

bool	Disable ()
	Disables the window.

virtual bool	Enable (bool enable=true)
	Enable or disable the window for user input.

virtual bool	Show (bool show=true)
	Shows or hides the window.

virtual bool	ShowWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function shows a window, like Show(), but using a special visual effect if possible.

wxString	GetHelpText () const
	Gets the help text to be used as context-sensitive help for this window.

void	SetHelpText (const wxString &helpText)
	Sets the help text to be used as context-sensitive help for this window.

virtual wxString	GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const
	Gets the help text to be used as context-sensitive help for this window.

wxToolTip *	GetToolTip () const
	Get the associated tooltip or NULL if none.

wxString	GetToolTipText () const
	Get the text of the associated tooltip or empty string if none.

void	SetToolTip (const wxString &tipString)
	Attach a tooltip to the window.

void	SetToolTip (wxToolTip *tip)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	UnsetToolTip ()
	Unset any existing tooltip.

int	GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition)
	This function shows a popup menu at the given position in this window and returns the selected id.

int	GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition)
	Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

bool	PopupMenu (wxMenu *menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual wxValidator *	GetValidator ()
	Validator functions.

virtual void	SetValidator (const wxValidator &validator)
	Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type.

virtual bool	TransferDataFromWindow ()
	Transfers values from child controls to data areas specified by their validators.

virtual bool	TransferDataToWindow ()
	Transfers values to child controls from data areas specified by their validators.

virtual bool	Validate ()
	Validates the current values of the child controls using their validators.

wxWindowID	GetId () const
	Returns the identifier of the window.

virtual wxLayoutDirection	GetLayoutDirection () const
	Returns the layout direction for this window, Note that `wxLayout_Default` is returned if layout direction is not supported.

virtual wxCoord	AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const
	Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

virtual wxString	GetName () const
	Returns the window's name.

wxWindowVariant	GetWindowVariant () const
	Returns the value previously passed to SetWindowVariant().

void	SetId (wxWindowID winid)
	Sets the identifier of the window.

virtual void	SetLayoutDirection (wxLayoutDirection dir)
	Sets the layout direction for this window.

virtual void	SetName (const wxString &name)
	Sets the window's name.

void	SetWindowVariant (wxWindowVariant variant)
	Chooses a different variant of the window display to use.

wxAcceleratorTable *	GetAcceleratorTable ()
	Gets the accelerator table for this window.

wxAccessible *	GetAccessible ()
	Returns the accessible object for this window, if any.

virtual void	SetAcceleratorTable (const wxAcceleratorTable &accel)
	Sets the accelerator table for this window.

void	SetAccessible (wxAccessible *accessible)
	Sets the accessible for this window.

bool	Close (bool force=false)
	This function simply generates a wxCloseEvent whose handler usually tries to close the window.

virtual bool	Destroy ()
	Destroys the window safely.

bool	IsBeingDeleted () const
	Returns true if this window is in process of being destroyed.

virtual wxDropTarget *	GetDropTarget () const
	Returns the associated drop target, which may be NULL.

virtual void	SetDropTarget (wxDropTarget *target)
	Associates a drop target with this window.

virtual void	DragAcceptFiles (bool accept)
	Enables or disables eligibility for drop file events (OnDropFiles).

wxSizer *	GetContainingSizer () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.

wxSizer *	GetSizer () const
	Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

void	SetSizer (wxSizer *sizer, bool deleteOld=true)
	Sets the window to have the given layout sizer.

void	SetSizerAndFit (wxSizer *sizer, bool deleteOld=true)
	This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size.

wxLayoutConstraints *	GetConstraints () const
	Returns a pointer to the window's layout constraints, or NULL if there are none.

void	SetConstraints (wxLayoutConstraints *constraints)
	Sets the window to have the given layout constraints.

virtual bool	Layout ()
	Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window.

void	SetAutoLayout (bool autoLayout)
	Determines whether the Layout() function will be called automatically when the window is resized.

bool	GetAutoLayout () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.

void	CaptureMouse ()
	Directs all mouse input to this window.

wxCaret *	GetCaret () const
	Returns the caret() associated with the window.

const wxCursor &	GetCursor () const
	Return the cursor associated with this window.

virtual bool	HasCapture () const
	Returns true if this window has the current mouse capture.

void	ReleaseMouse ()
	Releases mouse input captured with CaptureMouse().

void	SetCaret (wxCaret *caret)
	Sets the caret() associated with the window.

virtual bool	SetCursor (const wxCursor &cursor)
	Sets the window's cursor.

virtual void	WarpPointer (int x, int y)
	Moves the pointer to the given position on the window.

wxHitTest	HitTest (wxCoord x, wxCoord y) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

wxHitTest	HitTest (const wxPoint &pt) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

wxBorder	GetBorder (long flags) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

wxBorder	GetBorder () const
	Get border for the flags of this window.

virtual void	DoUpdateWindowUI (wxUpdateUIEvent &event)
	Does the window-specific updating after processing the update event.

virtual WXWidget	GetHandle () const
	Returns the platform-specific handle of the physical window.

virtual bool	HasMultiplePages () const
	This method should be overridden to return true if this window has multiple pages.

virtual void	InheritAttributes ()
	This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.

virtual void	InitDialog ()
	Sends an `wxEVT_INIT_DIALOG` event, whose handler usually transfers data to the dialog via validators.

virtual bool	IsDoubleBuffered () const
	Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.

void	SetDoubleBuffered (bool on)
	Turn on or off double buffering of the window if the system supports it.

virtual bool	IsRetained () const
	Returns true if the window is retained, false otherwise.

bool	IsThisEnabled () const
	Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

virtual bool	IsTopLevel () const
	Returns true if the given window is a top-level one.

virtual void	OnInternalIdle ()
	This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class.

virtual bool	SendIdleEvents (wxIdleEvent &event)
	Send idle event to window and all subwindows.

virtual bool	RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode)
	Registers a system wide hotkey.

virtual bool	UnregisterHotKey (int hotkeyId)
	Unregisters a system wide hotkey.

virtual void	UpdateWindowUI (long flags=wxUPDATE_UI_NONE)
	This function sends one or more wxUpdateUIEvent to the window.

Public Member Functions inherited from wxEvtHandler
	wxEvtHandler ()
	Constructor.

virtual	~wxEvtHandler ()
	Destructor.

template<typename T , typename T1 , ... >
void	CallAfter (void(T::*method)(T1,...), T1 x1,...)
	Asynchronously call the given method.

template<typename T >
void	CallAfter (const T &functor)
	Asynchronously call the given functor.

bool	ProcessEventLocally (wxEvent &event)
	Try to process the event in this handler and all those chained to it.

bool	SafelyProcessEvent (wxEvent &event)
	Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

void	ProcessPendingEvents ()
	Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a `wxCHECK` will fail.

void	DeletePendingEvents ()
	Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

virtual bool	SearchEventTable (wxEventTable &table, wxEvent &event)
	Searches the event table, executing an event handler function if an appropriate one is found.

void	Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	Connects the given function dynamically with the event handler, id and event type.

void	Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

void	Connect (wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

bool	Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.

bool	Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

bool	Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

template<typename EventTag , typename Functor >
void	Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Binds the given function, functor or method dynamically with the event.

template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
void	Bind (const EventTag &eventType, void(Class::method)(EventArg &), EventHandler handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.

template<typename EventTag , typename Functor >
bool	Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.

template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
bool	Unbind (const EventTag &eventType, void(Class::method)(EventArg &), EventHandler handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.

void *	GetClientData () const
	Returns user-supplied client data.

wxClientData *	GetClientObject () const
	Returns a pointer to the user-supplied client data object.

void	SetClientData (void *data)
	Sets user-supplied client data.

void	SetClientObject (wxClientData *data)
	Set the client data object.

bool	GetEvtHandlerEnabled () const
	Returns true if the event handler is enabled, false otherwise.

wxEvtHandler *	GetNextHandler () const
	Returns the pointer to the next handler in the chain.

wxEvtHandler *	GetPreviousHandler () const
	Returns the pointer to the previous handler in the chain.

void	SetEvtHandlerEnabled (bool enabled)
	Enables or disables the event handler.

void	Unlink ()
	Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

bool	IsUnlinked () const
	Returns true if the next and the previous handler pointers of this event handler instance are NULL.

Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.

	wxObject (const wxObject &other)
	Copy ctor.

virtual	~wxObject ()
	Destructor.

virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.

bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.

void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.

void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.

void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.

void	UnShare ()
	This is the same of AllocExclusive() but this method is public.

void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

Public Member Functions inherited from wxTextEntry
virtual void	AppendText (const wxString &text)
	Appends the text to the end of the text control.

bool	AutoComplete (const wxArrayString &choices)
	Call this function to enable auto-completion of the text typed in a single-line text control using the given choices.

bool	AutoComplete (wxTextCompleter *completer)
	Enable auto-completion using the provided completer object.

bool	AutoCompleteFileNames ()
	Call this function to enable auto-completion of the text typed in a single-line text control using all valid file system paths.

bool	AutoCompleteDirectories ()
	Call this function to enable auto-completion of the text using the file system directories.

virtual bool	CanCopy () const
	Returns true if the selection can be copied to the clipboard.

virtual bool	CanCut () const
	Returns true if the selection can be cut to the clipboard.

virtual bool	CanPaste () const
	Returns true if the contents of the clipboard can be pasted into the text control.

virtual bool	CanRedo () const
	Returns true if there is a redo facility available and the last operation can be redone.

virtual bool	CanUndo () const
	Returns true if there is an undo facility available and the last operation can be undone.

virtual void	ChangeValue (const wxString &value)
	Sets the new text control value.

virtual void	Clear ()
	Clears the text in the control.

virtual wxString	GetRange (long from, long to) const
	Returns the string containing the text starting in the positions from and up to to in the control.

virtual void	GetSelection (long from, long to) const
	Gets the current selection span.

virtual wxString	GetStringSelection () const
	Gets the text currently selected in the control.

virtual bool	IsEditable () const
	Returns true if the controls contents may be edited by user (note that it always can be changed by the program).

virtual bool	IsEmpty () const
	Returns true if the control is currently empty.

virtual void	Redo ()
	If there is a redo facility and the last operation can be redone, redoes the last operation.

virtual void	SetEditable (bool editable)
	Makes the text item editable or read-only, overriding the wxTE_READONLY flag.

virtual void	SetMaxLength (unsigned long len)
	This function sets the maximum number of characters the user can enter into the control.

virtual void	SelectAll ()
	Selects all text in the control.

virtual void	SelectNone ()
	Deselects selected text in the control.

wxPoint	GetMargins () const
	Returns the margins used by the control.

virtual void	WriteText (const wxString &text)
	Writes the text into the text control at the current insertion position.

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

bool	SetMargins (wxCoord left, wxCoord top=-1)
	Attempts to set the control margins.

Static Public Member Functions
static int	GetFeatures ()
	Returns features supported by wxComboCtrl.

Static Public Member Functions inherited from wxControl
static wxString	GetLabelText (const wxString &label)
	Returns the given label string without mnemonics ("&" characters).

static wxString	RemoveMnemonics (const wxString &str)
	Returns the given str string without mnemonics ("&" characters).

static wxString	EscapeMnemonics (const wxString &text)
	Escapes the special mnemonics characters ("&") in the given string.

static wxString	Ellipsize (const wxString &label, const wxDC &dc, wxEllipsizeMode mode, int maxWidth, int flags=wxELLIPSIZE_FLAGS_DEFAULT)
	Replaces parts of the label string with ellipsis, if needed, so that it fits into maxWidth pixels if possible.

Static Public Member Functions inherited from wxWindow
static wxVisualAttributes	GetClassDefaultAttributes (wxWindowVariant variant=wxWINDOW_VARIANT_NORMAL)
	Returns the default font and colours which are used by the control.

static wxWindow *	FindFocus ()
	Finds the window or control which currently has the keyboard focus.

static wxWindow *	FindWindowById (long id, const wxWindow *parent=0)
	Find the first window with the given id.

static wxWindow *	FindWindowByLabel (const wxString &label, const wxWindow *parent=0)
	Find a window by its label.

static wxWindow *	FindWindowByName (const wxString &name, const wxWindow *parent=0)
	Find a window by its name (as given in a window constructor or Create() function call).

static wxWindow *	GetCapture ()
	Returns the currently captured window.

static wxWindowID	NewControlId (int count=1)
	Create a new ID or range of IDs that are not currently in use.

static void	UnreserveControlId (wxWindowID id, int count=1)
	Unreserve an ID or range of IDs that was reserved by NewControlId().

Static Public Member Functions inherited from wxEvtHandler
static void	AddFilter (wxEventFilter *filter)
	Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

static void	RemoveFilter (wxEventFilter *filter)
	Remove a filter previously installed with AddFilter().

Protected Member Functions
virtual bool	AnimateShow (const wxRect &rect, int flags)
	This member function is not normally called in application code.

virtual void	DoSetPopupControl (wxComboPopup *popup)
	This member function is not normally called in application code.

virtual void	DoShowPopup (const wxRect &rect, int flags)
	This member function is not normally called in application code.

Additional Inherited Members
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

wxComboCtrl::wxComboCtrl ( )

Default constructor.

wxComboCtrl::wxComboCtrl	(	wxWindow *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxString &	value = `wxEmptyString`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `0`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `wxComboBoxNameStr`
	)

Constructor, creating and showing a combo control.

Parameters

parent	Parent window. Must not be NULL.
id	Window identifier. The value wxID_ANY indicates a default value.
value	Initial selection string. An empty string indicates no selection.
pos	Window position. If wxDefaultPosition is specified then a default position is chosen.
size	Window size. If wxDefaultSize is specified then the window is sized appropriately.
style	Window style. See wxComboCtrl.
validator	Window validator.
name	Window name.

See Also: Create(), wxValidator

virtual wxComboCtrl::~wxComboCtrl ( )

virtual

Destructor, destroying the combo control.

Member Function Documentation

virtual bool wxComboCtrl::AnimateShow	(	const wxRect &	rect,
		int	flags
	)

protectedvirtual

This member function is not normally called in application code.

Instead, it can be implemented in a derived class to create a custom popup animation.

The parameters are the same as those for DoShowPopup().

Returns: true if animation finishes before the function returns, false otherwise. In the latter case you need to manually call DoShowPopup() after the animation ends.

virtual void wxComboCtrl::Copy ( )

virtual

Copies the selected text to the clipboard.

Reimplemented from wxTextEntry.

bool wxComboCtrl::Create	(	wxWindow *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxString &	value = `wxEmptyString`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `0`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `wxComboBoxNameStr`
	)

Creates the combo control for two-step construction.

Derived classes should call or replace this function. See wxComboCtrl() for further details.

virtual void wxComboCtrl::Cut ( )

virtual

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

Reimplemented from wxTextEntry.

virtual void wxComboCtrl::Dismiss ( )

virtual

Dismisses the popup window.

Notice that calling this function will generate a wxEVT_COMBOBOX_CLOSEUP event.

Since: 2.9.2

virtual void wxComboCtrl::DoSetPopupControl ( wxComboPopup * popup )

protectedvirtual

This member function is not normally called in application code.

Instead, it can be implemented in a derived class to return default wxComboPopup, in case popup is NULL.

Note: If you have implemented OnButtonClick() to do something else than show the popup, then DoSetPopupControl() must always set popup to NULL.

virtual void wxComboCtrl::DoShowPopup	(	const wxRect &	rect,
		int	flags
	)

protectedvirtual

This member function is not normally called in application code.

Instead, it must be called in a derived class to make sure popup is properly shown after a popup animation has finished (but only if AnimateShow() did not finish the animation within its function scope).

Parameters

rect Position to show the popup window at, in screen coordinates.

flags

Combination of any of the following:

wxComboCtrl::ShowAbove	Popup is shown above the control instead of below.
wxComboCtrl::CanDeferShow	Showing the popup can be deferred to happen sometime after ShowPopup() has finished. In this case, AnimateShow() must return false.

void wxComboCtrl::EnablePopupAnimation ( bool enable = true )

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

const wxBitmap& wxComboCtrl::GetBitmapDisabled ( ) const

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

Returns: A reference to the disabled state bitmap.

const wxBitmap& wxComboCtrl::GetBitmapHover ( ) const

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

Returns: A reference to the mouse hover state bitmap.

const wxBitmap& wxComboCtrl::GetBitmapNormal ( ) const

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

Returns: A reference to the normal state bitmap.

const wxBitmap& wxComboCtrl::GetBitmapPressed ( ) const

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

Returns: A reference to the depressed state bitmap.

wxSize wxComboCtrl::GetButtonSize ( )

Returns current size of the dropdown button.

int wxComboCtrl::GetCustomPaintWidth ( ) const

Returns custom painted area in control.

See Also: SetCustomPaintWidth().

static int wxComboCtrl::GetFeatures ( )

static

Returns features supported by wxComboCtrl.

If needed feature is missing, you need to instead use wxGenericComboCtrl, which however may lack a native look and feel (but otherwise sports identical API).

Returns: Value returned is a combination of the flags defined in wxComboCtrlFeatures.

virtual wxString wxComboCtrl::GetHint ( ) const

virtual

Returns the current hint string.

See SetHint() for more information about hints.

Since: 2.9.1

Reimplemented from wxTextEntry.

virtual long wxComboCtrl::GetInsertionPoint ( ) const

virtual

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

Note: Under Windows, this function always returns 0 if the combo control doesn't have the focus.

Reimplemented from wxTextEntry.

virtual long wxComboCtrl::GetLastPosition ( ) const

virtual

Returns the last position in the combo control text field.

Reimplemented from wxTextEntry.

wxPoint wxComboCtrl::GetMargins ( ) const

Returns the margins used by the control.

The x field of the returned point is the horizontal margin and the y field is the vertical one.

Remarks: If given margin cannot be accurately determined, its value will be set to -1.

See Also: SetMargins()

Since: 2.9.1

wxComboPopup* wxComboCtrl::GetPopupControl ( )

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

wxWindow* wxComboCtrl::GetPopupWindow ( ) const

Returns popup window containing the popup control.

wxTextCtrl* wxComboCtrl::GetTextCtrl ( ) const

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

wxCoord wxComboCtrl::GetTextIndent ( ) const

Returns actual indentation in pixels.

Deprecated:: Use GetMargins() instead.

const wxRect& wxComboCtrl::GetTextRect ( ) const

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

virtual wxString wxComboCtrl::GetValue ( ) const

virtual

Returns text representation of the current value.

For writable combo control it always returns the value in the text field.

Reimplemented from wxTextEntry.

virtual void wxComboCtrl::HidePopup ( bool generateEvent = false )

virtual

Dismisses the popup window.

Parameters

generateEvent Set this to true in order to generate wxEVT_COMBOBOX_CLOSEUP event.

Deprecated:: Use Dismiss() instead.

virtual bool wxComboCtrl::IsKeyPopupToggle ( const wxKeyEvent & event ) const

virtual

Returns true if given key combination should toggle the popup.

bool wxComboCtrl::IsPopupShown ( ) const

Returns true if the popup is currently shown.

bool wxComboCtrl::IsPopupWindowState ( int state ) const

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

Possible values are:

wxComboCtrl::Hidden	Popup window is hidden.
wxComboCtrl::Animating	Popup window is being shown, but the popup animation has not yet finished.
wxComboCtrl::Visible	Popup window is fully visible.

virtual void wxComboCtrl::OnButtonClick ( )

virtual

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

Default action is to show the popup.

Note: If you implement this to do something else than show the popup, you must then also implement DoSetPopupControl() to always return NULL.

virtual void wxComboCtrl::Paste ( )

virtual

Pastes text from the clipboard to the text field.

Reimplemented from wxTextEntry.

virtual void wxComboCtrl::Popup ( )

virtual

Shows the popup portion of the combo control.

Notice that calling this function will generate a wxEVT_COMBOBOX_DROPDOWN event.

Since: 2.9.2

virtual void wxComboCtrl::PrepareBackground	(	wxDC &	dc,
		const wxRect &	rect,
		int	flags
	)		const

virtual

Prepare background of combo control or an item in a dropdown list in a way typical on platform.

This includes painting the focus/disabled background and setting the clipping region.

Unless you plan to paint your own focus indicator, you should always call this in your wxComboPopup::PaintComboControl implementation. In addition, it sets pen and text colour to what looks good and proper against the background.

flags: wxRendererNative flags: wxCONTROL_ISSUBMENU: is drawing a list item instead of combo control wxCONTROL_SELECTED: list item is selected wxCONTROL_DISABLED: control/item is disabled

virtual void wxComboCtrl::Remove	(	long	from,
		long	to
	)

virtual

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

Parameters

from	The first position.
to	The last position.

Reimplemented from wxTextEntry.

virtual void wxComboCtrl::Replace	(	long	from,
		long	to,
		const wxString &	text
	)

virtual

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

Parameters

from	The first position.
to	The second position.
text	The text to insert.

Reimplemented from wxTextEntry.

void wxComboCtrl::SetButtonBitmaps	(	const wxBitmap &	bmpNormal,
		bool	pushButtonBg = `false`,
		const wxBitmap &	bmpPressed = `wxNullBitmap`,
		const wxBitmap &	bmpHover = `wxNullBitmap`,
		const wxBitmap &	bmpDisabled = `wxNullBitmap`
	)

Sets custom dropdown button graphics.

Parameters

bmpNormal	Default button image.
pushButtonBg	If true, blank push button background is painted below the image.
bmpPressed	Depressed button image.
bmpHover	Button image when mouse hovers above it. This should be ignored on platforms and themes that do not generally draw different kind of button on mouse hover.
bmpDisabled	Disabled button image.

void wxComboCtrl::SetButtonPosition	(	int	width = `-1`,
		int	height = `-1`,
		int	side = `wxRIGHT`,
		int	spacingX = `0`
	)

Sets size and position of dropdown button.

Parameters

width	Button width. Value = 0 specifies default.
height	Button height. Value = 0 specifies default.
side	Indicates which side the button will be placed. Value can be wxLEFT or wxRIGHT.
spacingX	Horizontal spacing around the button. Default is 0.

void wxComboCtrl::SetCustomPaintWidth ( int width )

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

In read-only wxOwnerDrawnComboBox, this is used to indicate area that is not covered by the focus rectangle.

virtual bool wxComboCtrl::SetHint ( const wxString & hint )

virtual

Sets a hint shown in an empty unfocused combo control.

Notice that hints are known as cue banners under MSW or placeholder strings under OS X.

See Also: wxTextEntry::SetHint()

Since: 2.9.1

Reimplemented from wxTextEntry.

virtual void wxComboCtrl::SetInsertionPoint ( long pos )

virtual

Sets the insertion point in the text field.

Parameters

pos	The new insertion point.

Reimplemented from wxTextEntry.

virtual void wxComboCtrl::SetInsertionPointEnd ( )

virtual

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

Reimplemented from wxTextEntry.

bool wxComboCtrl::SetMargins ( const wxPoint & pt )

Attempts to set the control margins.

When margins are given as wxPoint, x indicates the left and y the top margin. Use -1 to indicate that an existing value should be used.

Returns: true if setting of all requested margins was successful.

Since: 2.9.1

bool wxComboCtrl::SetMargins	(	wxCoord	left,
		wxCoord	top = `-1`
	)

Attempts to set the control margins.

When margins are given as wxPoint, x indicates the left and y the top margin. Use -1 to indicate that an existing value should be used.

Returns: true if setting of all requested margins was successful.

Since: 2.9.1

void wxComboCtrl::SetPopupAnchor ( int anchorSide )

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

Valid values are wxLEFT, wxRIGHT and 0. The default value 0 means that the most appropriate side is used (which, currently, is always wxLEFT).

void wxComboCtrl::SetPopupControl ( wxComboPopup * popup )

Set popup interface class derived from wxComboPopup.

This method should be called as soon as possible after the control has been created, unless OnButtonClick() has been overridden.

void wxComboCtrl::SetPopupExtents	(	int	extLeft,
		int	extRight
	)

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

Parameters

extLeft	How many pixel to extend beyond the left edge of the control. Default is 0.
extRight	How many pixel to extend beyond the right edge of the control. Default is 0.

Remarks: Popup minimum width may override arguments. It is up to the popup to fully take this into account.

void wxComboCtrl::SetPopupMaxHeight ( int height )

Sets preferred maximum height of the popup.

Remarks: Value -1 indicates the default.

void wxComboCtrl::SetPopupMinWidth ( int width )

Sets minimum width of the popup.

If wider than combo control, it will extend to the left.

Remarks: Value -1 indicates the default. Also, popup implementation may choose to ignore this.

virtual void wxComboCtrl::SetSelection	(	long	from,
		long	to
	)

virtual

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

Parameters

from	The first position.
to	The second position.

Reimplemented from wxTextEntry.

void wxComboCtrl::SetText ( const wxString & value )

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

Thus, unlike SetValue(), it works equally well with combo control using wxCB_READONLY style.

void wxComboCtrl::SetTextCtrlStyle ( int style )

Set a custom window style for the embedded wxTextCtrl.

Usually you will need to use this during two-step creation, just before Create(). For example:

wxComboCtrl* comboCtrl = new wxComboCtrl();
// Let's make the text right-aligned
comboCtrl->SetTextCtrlStyle(wxTE_RIGHT);
comboCtrl->Create(parent, wxID_ANY, wxEmptyString);

void wxComboCtrl::SetTextIndent ( int 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.

Value -1 can be given to indicate platform default.

Deprecated:: Use SetMargins() instead.

virtual void wxComboCtrl::SetValue ( const wxString & value )

virtual

Sets the text for the combo control text field.

Note: For a combo control with wxCB_READONLY style the string must be accepted by the popup (for instance, exist in the dropdown list), otherwise the call to SetValue() is ignored.

Reimplemented from wxTextEntry.

void wxComboCtrl::SetValueByUser ( const wxString & value )

Changes value of the control as if user had done it by selecting an item from a combo box drop-down list.

bool wxComboCtrl::ShouldDrawFocus ( ) const

Returns true if focus indicator should be drawn in the control.

virtual void wxComboCtrl::ShowPopup ( )

virtual

Show the popup.

Deprecated:: Use Popup() instead.

virtual void wxComboCtrl::Undo ( )

virtual

Undoes the last edit in the text field.

Windows only.

Reimplemented from wxTextEntry.

void wxComboCtrl::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.

This alternative popup window is usually a wxDialog, and as such, when it is shown, its parent top-level window will appear as if the focus has been lost from it.

Detailed Description

Setting Custom Popup for wxComboCtrl

Styles

Events emitted by this class

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation