wxpickerbase

base abstract class for all pickers which support an auxiliary text control. this class handles all positioning and sizing of the text control like a an horizontal wxboxsizer would do, with the text control on the left of the picker button. the proportion (see wxsizer documentation for more info about proportion values) of the picker control defaults to 1 when there isn't a text control associated (see wxpb_use_textctrl style) and to 0 otherwise.

derived from

wxcontrol
wxwindow
wxevthandler
wxobject

include files

<wx/pickerbase.h>

window styles

see also

wxcolourpickerctrl

members

wxpickerbase::setinternalmargin
wxpickerbase::getinternalmargin
wxpickerbase::settextctrlproportion
wxpickerbase::setpickerctrlproportion
wxpickerbase::gettextctrlproportion
wxpickerbase::getpickerctrlproportion
wxpickerbase::hastextctrl
wxpickerbase::gettextctrl
wxpickerbase::istextctrlgrowable
wxpickerbase::setpickerctrlgrowable
wxpickerbase::settextctrlgrowable
wxpickerbase::ispickerctrlgrowable

wxpickerbase::setinternalmargin

void setinternalmargin(intmargin)

sets the margin (in pixel) between the picker and the text control. this function can be used only when hastextctrl returns true.

wxpickerbase::getinternalmargin

int getinternalmargin() const

returns the margin (in pixel) between the picker and the text control. this function can be used only when hastextctrl returns true.

wxpickerbase::settextctrlproportion

void settextctrlproportion(intprop)

sets the proportion value of the text control. look at the overview of wxpickerbase for more details about this. this function can be used only when hastextctrl returns true.

wxpickerbase::setpickerctrlproportion

void setpickerctrlproportion(intprop)

sets the proportion value of the picker. look at the overview of wxpickerbase for more details about this.

wxpickerbase::gettextctrlproportion

int gettextctrlproportion() const

returns the proportion value of the text control. this function can be used only when hastextctrl returns true.

wxpickerbase::getpickerctrlproportion

int getpickerctrlproportion() const

returns the proportion value of the picker.

wxpickerbase::hastextctrl

bool hastextctrl() const

returns true if this window has a valid text control (i.e. if the wxpb_use_textctrl style was given when creating this control).

wxpickerbase::gettextctrl

wxtextctrl * gettextctrl()

returns a pointer to the text control handled by this window or null if the wxpb_use_textctrl style was not specified when this control was created. very important: the contents of the text control could be containing an invalid representation of the entity which can be chosen through the picker (e.g. the user entered an invalid colour syntax because of a typo). thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. wxcolourpickerctrl::getcolour, wxfilepickerctrl::getpath, etc).

wxpickerbase::istextctrlgrowable

bool istextctrlgrowable() const

returns true if the text control is growable. this function can be used only when hastextctrl returns true.

wxpickerbase::setpickerctrlgrowable

void setpickerctrlgrowable(bool grow = true)

sets the picker control as growable when grow is true.

wxpickerbase::settextctrlgrowable

void settextctrlgrowable(bool grow = true)

sets the text control as growable when grow is true. this function can be used only when hastextctrl returns true.

wxpickerbase::ispickerctrlgrowable

bool ispickerctrlgrowable() const

returns true if the picker control is growable.