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 BoxSizer would do, with the text control on the left of the picker button.
The proportion (see Sizer documentation for more info about proportion values) of the picker control defaults to 1 when there isn’t a text control associated (see PB_USE_TEXTCTRL style) and to 0 otherwise.
This class supports the following styles:
See also
__init__ | |
CreateBase | |
GetInternalMargin | Returns the margin (in pixel) between the picker and the text control. |
GetPickerCtrl | Returns the native implementation of the real picker control. |
GetPickerCtrlProportion | Returns the proportion value of the picker. |
GetPickerStyle | |
GetTextCtrl | Returns a pointer to the text control handled by this window or None if the PB_USE_TEXTCTRL style was not specified when this control was created. |
GetTextCtrlProportion | Returns the proportion value of the text control. |
GetTextCtrlStyle | |
HasTextCtrl | Returns True if this window has a valid text control (i.e. |
IsPickerCtrlGrowable | Returns True if the picker control is growable. |
IsTextCtrlGrowable | Returns True if the text control is growable. |
PostCreation | |
SetInternalMargin | Sets the margin (in pixel) between the picker and the text control. |
SetPickerCtrl | |
SetPickerCtrlGrowable | Sets the picker control as growable when grow is True. |
SetPickerCtrlProportion | Sets the proportion value of the picker. |
SetTextCtrl | |
SetTextCtrlGrowable | Sets the text control as growable when grow is True. |
SetTextCtrlProportion | Sets the proportion value of the text control. |
UpdatePickerFromTextCtrl | |
UpdateTextCtrlFromPicker |
Base abstract class for all pickers which support an auxiliary text control.
Possible constructors:
PickerBase()
Parameters: | |
---|---|
Return type: | bool |
Returns the margin (in pixel) between the picker and the text control.
This function can be used only when HasTextCtrl returns True.
Return type: | int |
---|
Returns the native implementation of the real picker control.
Return type: | Control |
---|
Note
The returned control in the generic implementation of FilePickerCtrl, DirPickerCtrl, FontPickerCtrl and ColourPickerCtrl is a specialized Button class so that you can change its label doing, e.g.:
if wx.Platform == '__WXMSW__':
# wxMSW is one of the platforms where the generic implementation
# of wx.FilePickerCtrl is used...
pButt = myFilePickerCtrl.GetPickerCtrl()
if pButt is not None:
pButt.SetLabel('Custom browse string')
Returns the proportion value of the picker.
Return type: | int |
---|
Parameters: | style (long) – |
---|---|
Return type: | long |
Returns a pointer to the text control handled by this window or None if the PB_USE_TEXTCTRL style was not specified when this control was created.
Return type: | TextCtrl |
---|
Note
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. ColourPickerCtrl.GetColour , FilePickerCtrl.GetPath , etc).
Returns the proportion value of the text control.
This function can be used only when HasTextCtrl returns True.
Return type: | int |
---|
Parameters: | style (long) – |
---|---|
Return type: | long |
Returns True if this window has a valid text control (i.e.
if the PB_USE_TEXTCTRL style was given when creating this control).
Return type: | bool |
---|
Returns True if the picker control is growable.
Return type: | bool |
---|
Returns True if the text control is growable.
This function can be used only when HasTextCtrl returns True.
Return type: | bool |
---|
Sets the margin (in pixel) between the picker and the text control.
This function can be used only when HasTextCtrl returns True.
Parameters: | margin (int) – |
---|
Sets the picker control as growable when grow is True.
Parameters: | grow (bool) – |
---|
Sets the proportion value of the picker.
Look at the detailed description of PickerBase for more info.
Parameters: | prop (int) – |
---|
Sets the text control as growable when grow is True.
This function can be used only when HasTextCtrl returns True.
Parameters: | grow (bool) – |
---|
Sets the proportion value of the text control.
Look at the detailed description of PickerBase for more info.
This function can be used only when HasTextCtrl returns True.
Parameters: | prop (int) – |
---|
See GetInternalMargin and SetInternalMargin
See GetPickerCtrl and SetPickerCtrl
See GetTextCtrl and SetTextCtrl