View Source wxPickerBase (wx v2.4.2)
Functions for wxPickerBase class
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.
Styles
This class supports the following styles:
See: wxColourPickerCtrl
This class is derived (and can use functions) from: wxControl wxWindow
wxEvtHandler
wxWidgets docs: wxPickerBase
Summary
Functions
Returns the margin (in pixel) between the picker and the text control.
Returns the proportion value of the picker.
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.
Returns the proportion value of the text control.
Returns true if this window has a valid text control (i.e. if the
wxPB_USE_TEXTCTRL style was given when creating this control).
Returns true if the picker control is growable.
Returns true if the text control is growable.
Sets the margin (in pixel) between the picker and the text control.
Sets the picker control as growable when grow is true.
Sets the proportion value of the picker.
Sets the text control as growable when grow is true.
Sets the proportion value of the text control.
Types
-type wxPickerBase() :: wx:wx_object().
Functions
-spec getInternalMargin(This) -> integer() when This :: wxPickerBase().
Returns the margin (in pixel) between the picker and the text control.
This function can be used only when hasTextCtrl/1 returns true.
-spec getPickerCtrlProportion(This) -> integer() when This :: wxPickerBase().
Returns the proportion value of the picker.
-spec getTextCtrl(This) -> wxTextCtrl:wxTextCtrl() when This :: wxPickerBase().
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.
Remark: The contents of the text control could be an invalid representation of
the entity which can be chosen through the picker (e.g. when the user enters 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/1, wxFilePickerCtrl:getPath/1,
etc).
-spec getTextCtrlProportion(This) -> integer() when This :: wxPickerBase().
Returns the proportion value of the text control.
This function can be used only when hasTextCtrl/1 returns true.
-spec hasTextCtrl(This) -> boolean() when This :: wxPickerBase().
Returns true if this window has a valid text control (i.e. if the
wxPB_USE_TEXTCTRL style was given when creating this control).
-spec isPickerCtrlGrowable(This) -> boolean() when This :: wxPickerBase().
Returns true if the picker control is growable.
-spec isTextCtrlGrowable(This) -> boolean() when This :: wxPickerBase().
Returns true if the text control is growable.
This function can be used only when hasTextCtrl/1 returns true.
-spec setInternalMargin(This, Margin) -> ok when This :: wxPickerBase(), Margin :: integer().
Sets the margin (in pixel) between the picker and the text control.
This function can be used only when hasTextCtrl/1 returns true.
-spec setPickerCtrlGrowable(This) -> ok when This :: wxPickerBase().
-spec setPickerCtrlGrowable(This, [Option]) -> ok when This :: wxPickerBase(), Option :: {grow, boolean()}.
Sets the picker control as growable when grow is true.
-spec setPickerCtrlProportion(This, Prop) -> ok when This :: wxPickerBase(), Prop :: integer().
Sets the proportion value of the picker.
Look at the detailed description of wxPickerBase for more info.
-spec setTextCtrlGrowable(This) -> ok when This :: wxPickerBase().
-spec setTextCtrlGrowable(This, [Option]) -> ok when This :: wxPickerBase(), Option :: {grow, boolean()}.
Sets the text control as growable when grow is true.
This function can be used only when hasTextCtrl/1 returns true.
-spec setTextCtrlProportion(This, Prop) -> ok when This :: wxPickerBase(), Prop :: integer().
Sets the proportion value of the text control.
Look at the detailed description of wxPickerBase for more info.
This function can be used only when hasTextCtrl/1 returns true.