wxStdDialogButtonSizer — wx v2.4.3.1

Search documentation of wx

# wxStdDialogButtonSizer (wx v2.4.3.1)

View Source

This class creates button layouts which conform to the standard button spacing and ordering defined by the platform or toolkit's user interface guidelines (if such things exist).

By using this class, you can ensure that all your standard dialogs look correct on all major platforms. Currently it conforms to the Windows, GTK+ and macOS human interface guidelines.

When there aren't interface guidelines defined for a particular platform or toolkit, `wxStdDialogButtonSizer` reverts to the Windows implementation.

To use this class, first add buttons to the sizer by calling `addButton/2` (or `setAffirmativeButton/2`, `setNegativeButton/2` or `setCancelButton/2`) and then call Realize in order to create the actual button layout used. Other than these special operations, this sizer works like any other sizer.

If you add a button with wxID_SAVE, on macOS the button will be renamed to "Save" and the wxID_NO button will be renamed to "Don't Save" in accordance with the macOS Human Interface Guidelines.

See:

- `wxSizer`

- Overview sizer

- `wxDialog:createButtonSizer/2`

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

- `wxBoxSizer`

- `wxSizer`

wxWidgets docs: wxStdDialogButtonSizer

# Summary

## Types

wxStdDialogButtonSizer()

## Functions

addButton(This, Button)

Adds a button to the `wxStdDialogButtonSizer`.

destroy(This)

Destroys the object

new()

Constructor for a `wxStdDialogButtonSizer`.

realize(This)

Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.

setAffirmativeButton(This, Button)

Sets the affirmative button for the sizer.

setCancelButton(This, Button)

Sets the cancel button for the sizer.

setNegativeButton(This, Button)

Sets the negative button for the sizer.

# Types

# wxStdDialogButtonSizer()

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

# Functions

# addButton(This, Button)

    -spec addButton(This, Button) -> ok when This :: wxStdDialogButtonSizer(), Button :: wxButton:wxButton().

Adds a button to the `wxStdDialogButtonSizer`.

The `button` must have one of the following identifiers:

- wxID_OK

- wxID_YES

- wxID_SAVE

- wxID_APPLY

- wxID_CLOSE

- wxID_NO

- wxID_CANCEL

- wxID_HELP

- wxID_CONTEXT_HELP

# destroy(This)

    -spec destroy(This :: wxStdDialogButtonSizer()) -> ok.

Destroys the object

# new()

    -spec new() -> wxStdDialogButtonSizer().

Constructor for a `wxStdDialogButtonSizer`.

# realize(This)

    -spec realize(This) -> ok when This :: wxStdDialogButtonSizer().

Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.

# setAffirmativeButton(This, Button)

    -spec setAffirmativeButton(This, Button) -> ok
                                  when This :: wxStdDialogButtonSizer(), Button :: wxButton:wxButton().

Sets the affirmative button for the sizer.

This allows you to use identifiers other than the standard identifiers outlined above.

# setCancelButton(This, Button)

    -spec setCancelButton(This, Button) -> ok
                             when This :: wxStdDialogButtonSizer(), Button :: wxButton:wxButton().

Sets the cancel button for the sizer.

This allows you to use identifiers other than the standard identifiers outlined above.

# setNegativeButton(This, Button)

    -spec setNegativeButton(This, Button) -> ok
                               when This :: wxStdDialogButtonSizer(), Button :: wxButton:wxButton().

Sets the negative button for the sizer.

This allows you to use identifiers other than the standard identifiers outlined above.