wxErlang

Reference Manual

Version 1.8.3

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:wx_object()

Types

This = wxToolBar()

addSeparator(This) -> wx:wx_object()

Types

This = wxToolBar()

addTool(This, Tool) -> wx:wx_object()

Types

This = wxToolBar()

addTool(This, Toolid, Bitmap) -> wx:wx_object()

Types

This = wxToolBar()
Toolid = integer()

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

Types

This = wxToolBar()
Toolid = integer()

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:wx_object()

Types

This = wxToolBar()
Toolid = integer()
BmpDisabled = wxBitmap: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:wx_object()

Types

This = wxToolBar()
Toolid = integer()
BmpDisabled = wxBitmap: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, Options::[Option]) -> wx:wx_object()

Types

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

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

Types

This = wxToolBar()
Toolid = integer()

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

Types

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

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

Types

This = wxToolBar()
Toolid = integer()

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

Types

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

addStretchableSpace(This) -> wx:wx_object()

Types

This = wxToolBar()

insertStretchableSpace(This, Pos) -> wx:wx_object()

Types

This = wxToolBar()
Pos = integer()

deleteTool(This, Toolid) -> boolean()

Types

This = wxToolBar()
Toolid = integer()

deleteToolByPos(This, Pos) -> boolean()

Types

This = wxToolBar()
Pos = integer()

enableTool(This, Toolid, Enable) -> ok

Types

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

findById(This, Toolid) -> wx:wx_object()

Types

This = wxToolBar()
Toolid = integer()

findControl(This, Toolid) -> wxControl:wxControl()

Types

This = wxToolBar()
Toolid = integer()

findToolForPosition(This, X, Y) -> wx:wx_object()

Types

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

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

Types

This = wxToolBar()

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

Types

This = wxToolBar()

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

Types

This = wxToolBar()

getToolEnabled(This, Toolid) -> boolean()

Types

This = wxToolBar()
Toolid = integer()

getToolLongHelp(This, Toolid) -> unicode:charlist()

Types

This = wxToolBar()
Toolid = integer()

getToolPacking(This) -> integer()

Types

This = wxToolBar()

getToolPos(This, Id) -> integer()

Types

This = wxToolBar()
Id = integer()

getToolSeparation(This) -> integer()

Types

This = wxToolBar()

getToolShortHelp(This, Toolid) -> unicode:charlist()

Types

This = wxToolBar()
Toolid = integer()

getToolState(This, Toolid) -> boolean()

Types

This = wxToolBar()
Toolid = integer()

insertControl(This, Pos, Control) -> wx:wx_object()

Types

This = wxToolBar()
Pos = integer()

insertSeparator(This, Pos) -> wx:wx_object()

Types

This = wxToolBar()
Pos = integer()

insertTool(This, Pos, Tool) -> wx:wx_object()

Types

This = wxToolBar()
Pos = integer()

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

Types

This = wxToolBar()
Pos = integer()
Toolid = integer()

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

Types

This = wxToolBar()
Pos = integer()
Toolid = integer()

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, Options::[Option]) -> wx:wx_object()

Types

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

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

realize(This) -> boolean()

Types

This = wxToolBar()

removeTool(This, Toolid) -> wx:wx_object()

Types

This = wxToolBar()
Toolid = integer()

setMargins(This, X, Y) -> ok

Types

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

setToolBitmapSize(This, Size) -> ok

Types

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

setToolLongHelp(This, Toolid, HelpString) -> ok

Types

This = wxToolBar()
Toolid = integer()
HelpString = unicode:chardata()

setToolPacking(This, Packing) -> ok

Types

This = wxToolBar()
Packing = integer()

setToolShortHelp(This, Id, HelpString) -> ok

Types

This = wxToolBar()
Id = integer()
HelpString = unicode:chardata()

setToolSeparation(This, Separation) -> ok

Types

This = wxToolBar()
Separation = integer()

toggleTool(This, Toolid, Toggle) -> ok

Types

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