Version: 3.1.0
wxOwnerDrawnComboBox Class Reference

#include <wx/odcombo.h>

+ Inheritance diagram for wxOwnerDrawnComboBox:

Detailed Description

wxOwnerDrawnComboBox is a combobox with owner-drawn list items.

In essence, it is a wxComboCtrl with wxVListBox popup and wxControlWithItems interface.

Implementing item drawing and measuring is similar to wxVListBox. Application needs to subclass wxOwnerDrawnComboBox and implement OnDrawItem(), OnMeasureItem() and OnMeasureItemWidth().

Styles

This class supports the following styles:

  • wxODCB_DCLICK_CYCLES:
    Double-clicking cycles item if wxCB_READONLY is also used. Synonymous with wxCC_SPECIAL_DCLICK.
  • wxODCB_STD_CONTROL_PAINT:
    Control itself is not custom painted using OnDrawItem. Even if this style is not used, writable wxOwnerDrawnComboBox is never custom painted unless SetCustomPaintWidth() is called.
See Also
wxComboCtrl window styles and Window Styles.

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_COMBOBOX(id, func):
    Process a wxEVT_COMBOBOX event, when an item on the list is selected. Note that calling GetValue() returns the new value of selection.
See Also
Events emitted by wxComboCtrl.

Library:  wxAdvanced
Category:  Controls
Appearance:
appear-ownerdrawncombobox-msw.png
wxMSW Appearance
appear-ownerdrawncombobox-gtk.png
wxGTK Appearance
appear-ownerdrawncombobox-mac.png
wxOSX Appearance
See Also
wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent

Public Member Functions

 wxOwnerDrawnComboBox ()
 Default constructor.
 
 wxOwnerDrawnComboBox (wxWindow *parent, wxWindowID id, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, int n=0, const wxString choices[]=NULL, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name="comboBox")
 Constructor, creating and showing a owner-drawn combobox.
 
 wxOwnerDrawnComboBox (wxWindow *parent, wxWindowID id, const wxString &value, const wxPoint &pos, const wxSize &size, const wxArrayString &choices, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name="comboBox")
 Constructor, creating and showing a owner-drawn combobox.
 
virtual ~wxOwnerDrawnComboBox ()
 Destructor, destroying the owner-drawn combobox.
 
bool IsEmpty () const
 IsEmpty() is not available in this class.
 
bool IsListEmpty () const
 Returns true if the list of combobox choices is empty.
 
bool IsTextEmpty () const
 Returns true if the text of the combobox is empty.
 
virtual int GetWidestItem ()
 Returns index to the widest item in the list.
 
virtual int GetWidestItemWidth ()
 Returns width of the widest item in the list.
 
bool Create (wxWindow *parent, wxWindowID id, 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 combobox for two-step construction.
 
bool Create (wxWindow *parent, wxWindowID id, const wxString &value, const wxPoint &pos, const wxSize &size, int n, const wxString choices[], long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxComboBoxNameStr)
 Creates the combobox for two-step construction.
 
bool Create (wxWindow *parent, wxWindowID id, const wxString &value, const wxPoint &pos, const wxSize &size, const wxArrayString &choices, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxComboBoxNameStr)
 Creates the combobox for two-step construction.
 
- Public Member Functions inherited from wxComboCtrl
 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 wxBitmapGetBitmapDisabled () const
 Returns disabled button bitmap that has been set with SetButtonBitmaps().
 
const wxBitmapGetBitmapHover () const
 Returns button mouse hover bitmap that has been set with SetButtonBitmaps().
 
const wxBitmapGetBitmapNormal () const
 Returns default button bitmap that has been set with SetButtonBitmaps().
 
const wxBitmapGetBitmapPressed () 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.
 
wxComboPopupGetPopupControl ()
 Returns current popup interface that has been set with SetPopupControl().
 
wxWindowGetPopupWindow () const
 Returns popup window containing the popup control.
 
wxTextCtrlGetTextCtrl () const
 Get the text control which is part of the combo control.
 
wxCoord GetTextIndent () const
 Returns actual indentation in pixels.
 
const wxRectGetTextRect () 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.
 
wxWindowFindWindow (long id) const
 Find a child of this window, by id.
 
wxWindowFindWindow (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
 Returns a const reference to the list of the window's children.
 
virtual void RemoveChild (wxWindow *child)
 Removes a child window.
 
wxWindowGetGrandParent () const
 Returns the grandparent of a window, or NULL if there isn't one.
 
wxWindowGetNextSibling () const
 Returns the next window after this one among the parent's children or NULL if this window is the last child.
 
wxWindowGetParent () const
 Returns the parent of the window, or NULL if there is no parent.
 
wxWindowGetPrevSibling () 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 wxRegionGetUpdateRegion () 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.
 
wxEvtHandlerGetEventHandler () 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().
 
wxEvtHandlerPopEventHandler (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.
 
wxToolTipGetToolTip () 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 wxValidatorGetValidator ()
 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.
 
wxAcceleratorTableGetAcceleratorTable ()
 Gets the accelerator table for this window.
 
wxAccessibleGetAccessible ()
 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 wxDropTargetGetDropTarget () 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).
 
wxSizerGetContainingSizer () const
 Returns the sizer of which this window is a member, if any, otherwise NULL.
 
wxSizerGetSizer () 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.
 
wxLayoutConstraintsGetConstraints () 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.
 
wxCaretGetCaret () const
 Returns the caret() associated with the window.
 
const wxCursorGetCursor () 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
 Return where the given point lies, exactly.
 
wxHitTest HitTest (const 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.
 
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.
 
wxClientDataGetClientObject () 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.
 
wxEvtHandlerGetNextHandler () const
 Returns the pointer to the next handler in the chain.
 
wxEvtHandlerGetPreviousHandler () 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 wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
 
wxObjectRefDataGetRefData () 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 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.
 
- Public Member Functions inherited from wxItemContainer
void Clear ()
 Removes all items from the control.
 
void Delete (unsigned int n)
 Deletes an item from the control.
 
wxClientDataDetachClientObject (unsigned int n)
 Returns the client object associated with the given item and transfers its ownership to the caller.
 
bool HasClientData () const
 Returns true, if either untyped data (void*) or object data (wxClientData*) is associated with the items of the control.
 
bool HasClientObjectData () const
 Returns true, if object data is associated with the items of the control.
 
bool HasClientUntypedData () const
 Returns true, if untyped data (void*) is associated with the items of the control.
 
int Append (const wxString &item)
 Appends item into the control.
 
int Append (const wxString &item, void *clientData)
 Appends item into the control.
 
int Append (const wxString &item, wxClientData *clientData)
 Appends item into the control.
 
int Append (const wxArrayString &items)
 Appends several items at once into the control.
 
template<typename T >
int Append (const std::vector< T > &items)
 Appends several items at once into the control.
 
int Append (const wxArrayString &items, void **clientData)
 Appends several items at once into the control.
 
int Append (const wxArrayString &items, wxClientData **clientData)
 Appends several items at once into the control.
 
int Append (unsigned int n, const wxString *items)
 Appends several items at once into the control.
 
int Append (unsigned int n, const wxString *items, void **clientData)
 Appends several items at once into the control.
 
int Append (unsigned int n, const wxString *items, wxClientData **clientData)
 Appends several items at once into the control.
 
void * GetClientData (unsigned int n) const
 Returns a pointer to the client data associated with the given item (if any).
 
wxClientDataGetClientObject (unsigned int n) const
 Returns a pointer to the client data associated with the given item (if any).
 
void SetClientData (unsigned int n, void *data)
 Associates the given untyped client data pointer with the given item.
 
void SetClientObject (unsigned int n, wxClientData *data)
 Associates the given typed client data pointer with the given item: the data object will be deleted when the item is deleted (either explicitly by using Delete() or implicitly when the control itself is destroyed).
 
int Insert (const wxString &item, unsigned int pos)
 Inserts item into the control.
 
int Insert (const wxString &item, unsigned int pos, void *clientData)
 Inserts item into the control.
 
int Insert (const wxString &item, unsigned int pos, wxClientData *clientData)
 Inserts item into the control.
 
int Insert (const wxArrayString &items, unsigned int pos)
 Inserts several items at once into the control.
 
template<typename T >
int Insert (const std::vector< T > &items)
 Inserts several items at once into the control.
 
int Insert (const wxArrayString &items, unsigned int pos, void **clientData)
 Inserts several items at once into the control.
 
int Insert (const wxArrayString &items, unsigned int pos, wxClientData **clientData)
 Inserts several items at once into the control.
 
int Insert (unsigned int n, const wxString *items, unsigned int pos)
 Inserts several items at once into the control.
 
int Insert (unsigned int n, const wxString *items, unsigned int pos, void **clientData)
 Inserts several items at once into the control.
 
int Insert (unsigned int n, const wxString *items, unsigned int pos, wxClientData **clientData)
 Inserts several items at once into the control.
 
void Set (const wxArrayString &items)
 Replaces the current control contents with the given items.
 
template<typename T >
void Set (const std::vector< T > &items)
 Replaces the current control contents with the given items.
 
void Set (const wxArrayString &items, void **clientData)
 Replaces the current control contents with the given items.
 
void Set (const wxArrayString &items, wxClientData **clientData)
 Replaces the current control contents with the given items.
 
void Set (unsigned int n, const wxString *items)
 Replaces the current control contents with the given items.
 
void Set (unsigned int n, const wxString *items, void **clientData)
 Replaces the current control contents with the given items.
 
void Set (unsigned int n, const wxString *items, wxClientData **clientData)
 Replaces the current control contents with the given items.
 
- Public Member Functions inherited from wxItemContainerImmutable
 wxItemContainerImmutable ()
 Constructor.
 
virtual unsigned int GetCount () const =0
 Returns the number of items in the control.
 
bool IsEmpty () const
 Returns true if the control is empty or false if it has some items.
 
virtual wxString GetString (unsigned int n) const =0
 Returns the label of the item with the given index.
 
wxArrayString GetStrings () const
 Returns the array of the labels of all items in the control.
 
virtual void SetString (unsigned int n, const wxString &string)=0
 Sets the label for the given item.
 
virtual int FindString (const wxString &string, bool caseSensitive=false) const
 Finds an item whose label matches the given string.
 
virtual void SetSelection (int n)=0
 Sets the selection to the given item n or removes the selection entirely if n == wxNOT_FOUND.
 
virtual int GetSelection () const =0
 Returns the index of the selected item or wxNOT_FOUND if no item is selected.
 
bool SetStringSelection (const wxString &string)
 Selects the item with the specified string in the control.
 
virtual wxString GetStringSelection () const
 Returns the label of the selected item or an empty string if no item is selected.
 
void Select (int n)
 This is the same as SetSelection() and exists only because it is slightly more natural for controls which support multiple selection.
 

Protected Member Functions

virtual void OnDrawBackground (wxDC &dc, const wxRect &rect, int item, int flags) const
 This method is used to draw the items background and, maybe, a border around it.
 
virtual void OnDrawItem (wxDC &dc, const wxRect &rect, int item, int flags) const
 The derived class may implement this function to actually draw the item with the given index on the provided DC.
 
virtual wxCoord OnMeasureItem (size_t item) const
 The derived class may implement this method to return the height of the specified item (in pixels).
 
virtual wxCoord OnMeasureItemWidth (size_t item) const
 The derived class may implement this method to return the width of the specified item (in pixels).
 
- Protected Member Functions inherited from wxComboCtrl
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

- Static Public Member Functions inherited from wxComboCtrl
static int GetFeatures ()
 Returns features supported by wxComboCtrl.
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data.
 

Constructor & Destructor Documentation

wxOwnerDrawnComboBox::wxOwnerDrawnComboBox ( )

Default constructor.

wxOwnerDrawnComboBox::wxOwnerDrawnComboBox ( wxWindow parent,
wxWindowID  id,
const wxString value = wxEmptyString,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
int  n = 0,
const wxString  choices[] = NULL,
long  style = 0,
const wxValidator validator = wxDefaultValidator,
const wxString name = "comboBox" 
)

Constructor, creating and showing a owner-drawn combobox.

Parameters
parentParent window. Must not be NULL.
idWindow identifier. The value wxID_ANY indicates a default value.
valueInitial selection string. An empty string indicates no selection.
posWindow position.
sizeWindow size. If wxDefaultSize is specified then the window is sized appropriately.
nNumber of strings with which to initialise the control.
choicesAn array of strings with which to initialise the control.
styleWindow style. See wxOwnerDrawnComboBox.
validatorWindow validator.
nameWindow name.
See Also
Create(), wxValidator
wxOwnerDrawnComboBox::wxOwnerDrawnComboBox ( wxWindow parent,
wxWindowID  id,
const wxString value,
const wxPoint pos,
const wxSize size,
const wxArrayString choices,
long  style = 0,
const wxValidator validator = wxDefaultValidator,
const wxString name = "comboBox" 
)

Constructor, creating and showing a owner-drawn combobox.

Parameters
parentParent window. Must not be NULL.
idWindow identifier. The value wxID_ANY indicates a default value.
valueInitial selection string. An empty string indicates no selection.
posWindow position.
sizeWindow size. If wxDefaultSize is specified then the window is sized appropriately.
choicesAn array of strings with which to initialise the control.
styleWindow style. See wxOwnerDrawnComboBox.
validatorWindow validator.
nameWindow name.
See Also
Create(), wxValidator
virtual wxOwnerDrawnComboBox::~wxOwnerDrawnComboBox ( )
virtual

Destructor, destroying the owner-drawn combobox.

Member Function Documentation

bool wxOwnerDrawnComboBox::Create ( wxWindow parent,
wxWindowID  id,
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 combobox for two-step construction.

See wxOwnerDrawnComboBox() for further details.

Remarks
Derived classes should call or replace this function.
bool wxOwnerDrawnComboBox::Create ( wxWindow parent,
wxWindowID  id,
const wxString value,
const wxPoint pos,
const wxSize size,
int  n,
const wxString  choices[],
long  style = 0,
const wxValidator validator = wxDefaultValidator,
const wxString name = wxComboBoxNameStr 
)

Creates the combobox for two-step construction.

See wxOwnerDrawnComboBox() for further details.

Remarks
Derived classes should call or replace this function.
bool wxOwnerDrawnComboBox::Create ( wxWindow parent,
wxWindowID  id,
const wxString value,
const wxPoint pos,
const wxSize size,
const wxArrayString choices,
long  style = 0,
const wxValidator validator = wxDefaultValidator,
const wxString name = wxComboBoxNameStr 
)

Creates the combobox for two-step construction.

See wxOwnerDrawnComboBox() for further details.

Remarks
Derived classes should call or replace this function.
virtual int wxOwnerDrawnComboBox::GetWidestItem ( )
virtual

Returns index to the widest item in the list.

virtual int wxOwnerDrawnComboBox::GetWidestItemWidth ( )
virtual

Returns width of the widest item in the list.

bool wxOwnerDrawnComboBox::IsEmpty ( ) const
virtual

IsEmpty() is not available in this class.

This method is documented here only to notice that it can't be used with this class because of the ambiguity between the methods with the same name inherited from wxItemContainer and wxTextEntry base classes.

Because of this, any attempt to call it results in a compilation error and you should use either IsListEmpty() or IsTextEmpty() depending on what exactly do you want to test.

Reimplemented from wxTextEntry.

bool wxOwnerDrawnComboBox::IsListEmpty ( ) const

Returns true if the list of combobox choices is empty.

Use this method instead of (not available in this class) IsEmpty() to test if the list of items is empty.

Since
3.1.0
bool wxOwnerDrawnComboBox::IsTextEmpty ( ) const

Returns true if the text of the combobox is empty.

Use this method instead of (not available in this class) IsEmpty() to test if the text currently entered into the combobox is empty.

Since
3.1.0
virtual void wxOwnerDrawnComboBox::OnDrawBackground ( wxDC dc,
const wxRect rect,
int  item,
int  flags 
) const
protectedvirtual

This method is used to draw the items background and, maybe, a border around it.

The base class version implements a reasonable default behaviour which consists in drawing the selected item with the standard background colour and drawing a border around the item if it is either selected or current.

Remarks
flags has the same meaning as with OnDrawItem().
virtual void wxOwnerDrawnComboBox::OnDrawItem ( wxDC dc,
const wxRect rect,
int  item,
int  flags 
) const
protectedvirtual

The derived class may implement this function to actually draw the item with the given index on the provided DC.

If function is not implemented, the item text is simply drawn, as if the control was a normal combobox.

Parameters
dcThe device context to use for drawing
rectThe bounding rectangle for the item being drawn (DC clipping region is set to this rectangle before calling this function)
itemThe index of the item to be drawn
flagsA combination of the wxOwnerDrawnComboBoxPaintingFlags enumeration values.
virtual wxCoord wxOwnerDrawnComboBox::OnMeasureItem ( size_t  item) const
protectedvirtual

The derived class may implement this method to return the height of the specified item (in pixels).

The default implementation returns text height, as if this control was a normal combobox.

virtual wxCoord wxOwnerDrawnComboBox::OnMeasureItemWidth ( size_t  item) const
protectedvirtual

The derived class may implement this method to return the width of the specified item (in pixels).

If -1 is returned, then the item text width is used.

The default implementation returns -1.