wxPickerBase — wx v2.4.3.1

Search documentation of wx

# wxPickerBase (wx v2.4.3.1)

View Source

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:

- wxPB_USE_TEXTCTRL: Creates a text control to the left of the picker which is completely managed by this `wxPickerBase` class.

See: `wxColourPickerCtrl`

This class is derived, and can use functions, from:

- `wxControl`

- `wxWindow`

- `wxEvtHandler`

wxWidgets docs: wxPickerBase

# Summary

## Types

wxPickerBase()

## Functions

getInternalMargin(This)

Returns the margin (in pixel) between the picker and the text control.

getPickerCtrlProportion(This)

Returns the proportion value of the picker.

getTextCtrl(This)

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.

getTextCtrlProportion(This)

Returns the proportion value of the text control.

hasTextCtrl(This)

Returns true if this window has a valid text control (i.e. if the `wxPB\_USE\_TEXTCTRL` style was given when creating this control).

isPickerCtrlGrowable(This)

Returns true if the picker control is growable.

isTextCtrlGrowable(This)

Returns true if the text control is growable.

setInternalMargin(This, Margin)

Sets the margin (in pixel) between the picker and the text control.

setPickerCtrlGrowable(This)

Equivalent to `setPickerCtrlGrowable(This, [])`.

setPickerCtrlGrowable/2

Sets the picker control as growable when `grow` is true.

setPickerCtrlProportion(This, Prop)

Sets the proportion value of the picker.

setTextCtrlGrowable(This)

Equivalent to `setTextCtrlGrowable(This, [])`.

setTextCtrlGrowable/2

Sets the text control as growable when `grow` is true.

setTextCtrlProportion(This, Prop)

Sets the proportion value of the text control.

# Types

# wxPickerBase()

    -type wxPickerBase() :: wx:wx_object().

# Functions

# getInternalMargin(This)

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

# getPickerCtrlProportion(This)

    -spec getPickerCtrlProportion(This) -> integer() when This :: wxPickerBase().

Returns the proportion value of the picker.

# getTextCtrl(This)

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

# getTextCtrlProportion(This)

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

# hasTextCtrl(This)

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

# isPickerCtrlGrowable(This)

    -spec isPickerCtrlGrowable(This) -> boolean() when This :: wxPickerBase().

Returns true if the picker control is growable.

# isTextCtrlGrowable(This)

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

# setInternalMargin(This, Margin)

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

# setPickerCtrlGrowable(This)

    -spec setPickerCtrlGrowable(This) -> ok when This :: wxPickerBase().

Equivalent to `setPickerCtrlGrowable(This, [])`.

# setPickerCtrlGrowable/2

    -spec setPickerCtrlGrowable(This, [Option]) -> ok
                                   when This :: wxPickerBase(), Option :: {grow, boolean()}.

Sets the picker control as growable when `grow` is true.

# setPickerCtrlProportion(This, Prop)

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

# setTextCtrlGrowable(This)

    -spec setTextCtrlGrowable(This) -> ok when This :: wxPickerBase().

Equivalent to `setTextCtrlGrowable(This, [])`.

# setTextCtrlGrowable/2

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

# setTextCtrlProportion(This, Prop)

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