User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.0

Expand All
Contract All

Table of Contents

# wxToolBar

### MODULE

wxToolBar

### MODULE SUMMARY

See external documentation: wxToolBar.

### DESCRIPTION

See external documentation: wxToolBar.

This class is derived (and can use functions) from:
wxControl
wxWindow
wxEvtHandler

### DATA TYPES

wxToolBar()

  An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

### EXPORTS

addControl(This, Control) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Control = wxControl() (see module wxControl)

See external documentation.

addSeparator(This) -> wx_object() (see module wx)

Types:

This = wxToolBar()

See external documentation.

addTool(This, Tool) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Tool = wx_object() (see module wx)

See external documentation.

addTool(This, Toolid, Bitmap) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Bitmap = wxBitmap() (see module wxBitmap)

Equivalent to addTool(This, Toolid, Bitmap, []).

addTool(This, Toolid, Label, Bitmap) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)

See external documentation.
Also:
addTool(This, Toolid, Bitmap, BmpDisabled) -> wx:wx_object() when
This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap();
(This, Toolid, Bitmap, [Option]) -> wx:wx_object() when
This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(),
Option :: {shortHelpString, unicode:chardata()}
| {longHelpString, unicode:chardata()}.

Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

addTool(This, Toolid, Label, Bitmap, BmpDisabled) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)
BmpDisabled = wxBitmap() (see module wxBitmap)

See external documentation.
Also:
addTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx_object() when
This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(),
Option :: {shortHelp, unicode:chardata()}
| {kind, wx:wx_enum()};
(This, Toolid, Bitmap, BmpDisabled, [Option]) -> wx:wx_object() when
This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(),
Option :: {toggle, boolean()}
| {clientData, wx:wx_object()}
| {shortHelpString, unicode:chardata()}
| {longHelpString, unicode:chardata()}.

Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

addTool(This, Toolid, Bitmap, BmpDisabled, Toggle, XPos) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Bitmap = wxBitmap() (see module wxBitmap)
BmpDisabled = wxBitmap() (see module wxBitmap)
Toggle = boolean()
XPos = integer()

See external documentation.
Also:
addTool(This, Toolid, Label, Bitmap, BmpDisabled, [Option]) -> wx:wx_object() when
This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(),
Option :: {kind, wx:wx_enum()}
| {shortHelp, unicode:chardata()}
| {longHelp, unicode:chardata()}
| {data, wx:wx_object()}.

Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

addTool(This, Toolid, Bitmap, BmpDisabled, Toggle, XPos, Option::[Option]) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Bitmap = wxBitmap() (see module wxBitmap)
BmpDisabled = wxBitmap() (see module wxBitmap)
Toggle = boolean()
XPos = integer()
Option = {yPos, integer()} | {clientData, wx_object() (see module wx)} | {shortHelp, chardata() (see module unicode)} | {longHelp, chardata() (see module unicode)}

See external documentation.

addCheckTool(This, Toolid, Label, Bitmap) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)

Equivalent to addCheckTool(This, Toolid, Label, Bitmap, []).

addCheckTool(This, Toolid, Label, Bitmap, Option::[Option]) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)
Option = {bmpDisabled, wxBitmap() (see module wxBitmap)} | {shortHelp, chardata() (see module unicode)} | {longHelp, chardata() (see module unicode)} | {data, wx_object() (see module wx)}

See external documentation.

addRadioTool(This, Toolid, Label, Bitmap) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)

Equivalent to addRadioTool(This, Toolid, Label, Bitmap, []).

addRadioTool(This, Toolid, Label, Bitmap, Option::[Option]) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)
Option = {bmpDisabled, wxBitmap() (see module wxBitmap)} | {shortHelp, chardata() (see module unicode)} | {longHelp, chardata() (see module unicode)} | {data, wx_object() (see module wx)}

See external documentation.

deleteTool(This, Toolid) -> boolean()

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

deleteToolByPos(This, Pos) -> boolean()

Types:

This = wxToolBar()
Pos = integer()

See external documentation.

enableTool(This, Toolid, Enable) -> ok

Types:

This = wxToolBar()
Toolid = integer()
Enable = boolean()

See external documentation.

findById(This, Toolid) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

findControl(This, Toolid) -> wxControl() (see module wxControl)

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

findToolForPosition(This, X, Y) -> wx_object() (see module wx)

Types:

This = wxToolBar()
X = integer()
Y = integer()

See external documentation.

getToolSize(This) -> {W::integer(), H::integer()}

Types:

This = wxToolBar()

See external documentation.

getToolBitmapSize(This) -> {W::integer(), H::integer()}

Types:

This = wxToolBar()

See external documentation.

getMargins(This) -> {W::integer(), H::integer()}

Types:

This = wxToolBar()

See external documentation.

getToolEnabled(This, Toolid) -> boolean()

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

getToolLongHelp(This, Toolid) -> charlist() (see module unicode)

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

getToolPacking(This) -> integer()

Types:

This = wxToolBar()

See external documentation.

getToolPos(This, Id) -> integer()

Types:

This = wxToolBar()
Id = integer()

See external documentation.

getToolSeparation(This) -> integer()

Types:

This = wxToolBar()

See external documentation.

getToolShortHelp(This, Toolid) -> charlist() (see module unicode)

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

getToolState(This, Toolid) -> boolean()

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

insertControl(This, Pos, Control) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Pos = integer()
Control = wxControl() (see module wxControl)

See external documentation.

insertSeparator(This, Pos) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Pos = integer()

See external documentation.

insertTool(This, Pos, Tool) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Pos = integer()
Tool = wx_object() (see module wx)

See external documentation.

insertTool(This, Pos, Toolid, Bitmap) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Pos = integer()
Toolid = integer()
Bitmap = wxBitmap() (see module wxBitmap)

Equivalent to insertTool(This, Pos, Toolid, Bitmap, []).

insertTool(This, Pos, Toolid, Label, Bitmap) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Pos = integer()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)

See external documentation.
Also:
insertTool(This, Pos, Toolid, Bitmap, [Option]) -> wx:wx_object() when
This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(),
Option :: {bmpDisabled, wxBitmap:wxBitmap()}
| {toggle, boolean()}
| {clientData, wx:wx_object()}
| {shortHelp, unicode:chardata()}
| {longHelp, unicode:chardata()}.

Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

insertTool(This, Pos, Toolid, Label, Bitmap, Option::[Option]) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Pos = integer()
Toolid = integer()
Label = chardata() (see module unicode)
Bitmap = wxBitmap() (see module wxBitmap)
Option = {bmpDisabled, wxBitmap() (see module wxBitmap)} | {kind, wx_enum() (see module wx)} | {shortHelp, chardata() (see module unicode)} | {longHelp, chardata() (see module unicode)} | {clientData, wx_object() (see module wx)}

See external documentation.
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

realize(This) -> boolean()

Types:

This = wxToolBar()

See external documentation.

removeTool(This, Toolid) -> wx_object() (see module wx)

Types:

This = wxToolBar()
Toolid = integer()

See external documentation.

setMargins(This, X, Y) -> ok

Types:

This = wxToolBar()
X = integer()
Y = integer()

See external documentation.

setToolBitmapSize(This, Size) -> ok

Types:

This = wxToolBar()
Size = {W::integer(), H::integer()}

See external documentation.

setToolLongHelp(This, Toolid, HelpString) -> ok

Types:

This = wxToolBar()
Toolid = integer()
HelpString = chardata() (see module unicode)

See external documentation.

setToolPacking(This, Packing) -> ok

Types:

This = wxToolBar()
Packing = integer()

See external documentation.

setToolShortHelp(This, Id, HelpString) -> ok

Types:

This = wxToolBar()
Id = integer()
HelpString = chardata() (see module unicode)

See external documentation.

setToolSeparation(This, Separation) -> ok

Types:

This = wxToolBar()
Separation = integer()

See external documentation.

toggleTool(This, Toolid, Toggle) -> ok

Types:

This = wxToolBar()
Toolid = integer()
Toggle = boolean()

See external documentation.