wxToolBar(3)

MODULE
wxToolBar - See external documentation: wxToolBar.

DESCRIPTION

See external documentation: wxToolBar <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html>.

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::wxToolBar(), Control::wxControl() (see module wxControl)) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddcontrol>.

addSeparator(This::wxToolBar()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddseparator>.

addTool(This::wxToolBar(), Tool::wx() (see module wx)) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddtool>.

addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap() (see module wxBitmap)) -> wx() (see module wx)

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

addTool(This::wxToolBar(), Toolid::integer(), X::string() | term(), X::term()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddtool>.
     Alternatives:

    addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap()) -> addTool(This, Toolid, Label, Bitmap, [])

    addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap()) -> addTool(This, Toolid, Bitmap, BmpDisabled, [])

    addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx()
     Option = {shortHelpString, string()} | {longHelpString, string()}

addTool(This::wxToolBar(), Toolid::integer(), X::string() | term(), X::term(), X::term()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddtool>.
     Alternatives:

    addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap()) -> addTool(This, Toolid, Label, Bitmap, BmpDisabled, [])

    addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx()
     Option = {shortHelp, string()} | {kind, WxItemKind}
     WxItemKind = integer()
     WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

    addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), [Option]) -> wx:wx()
     Option = {toggle, bool()} | {clientData, wx:wx()} | {shortHelpString, string()} | {longHelpString, string()}

addTool(This::wxToolBar(), Toolid::integer(), X::term() | string(), X::term(), X::bool() | term(), X::integer() | term()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddtool>.
     Alternatives:

    addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), Toggle::bool(), XPos::integer()) -> addTool(This, Toolid, Bitmap, BmpDisabled, Toggle, XPos, [])

    addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), [Option]) -> wx:wx()
     Option = {kind, WxItemKind} | {shortHelp, string()} | {longHelp, string()} | {data, wx:wx()}
     WxItemKind = integer()
     WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap() (see module wxBitmap), BmpDisabled::wxBitmap() (see module wxBitmap), Toggle::bool(), XPos::integer(), Options::[Option]) -> wx() (see module wx)

    Types
        Option = {yPos, integer()} | {clientData, wx() (see module wx)} | {shortHelp, string()} | {longHelp, string()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddtool>.

addCheckTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap() (see module wxBitmap)) -> wx() (see module wx)

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

addCheckTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap() (see module wxBitmap), Options::[Option]) -> wx() (see module wx)

    Types
        Option = {bmpDisabled, wxBitmap() (see module wxBitmap)} | {shortHelp, string()} | {longHelp, string()} | {data, wx() (see module wx)}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddchecktool>.

addRadioTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap() (see module wxBitmap)) -> wx() (see module wx)

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

addRadioTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap() (see module wxBitmap), Options::[Option]) -> wx() (see module wx)

    Types
        Option = {bmpDisabled, wxBitmap() (see module wxBitmap)} | {shortHelp, string()} | {longHelp, string()} | {data, wx() (see module wx)}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbaraddradiotool>.

deleteTool(This::wxToolBar(), Toolid::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbardeletetool>.

deleteToolByPos(This::wxToolBar(), Pos::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbardeletetoolbypos>.

enableTool(This::wxToolBar(), Toolid::integer(), Enable::bool()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarenabletool>.

findById(This::wxToolBar(), Toolid::integer()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarfindbyid>.

findControl(This::wxToolBar(), Toolid::integer()) -> wxControl() (see module wxControl)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarfindcontrol>.

findToolForPosition(This::wxToolBar(), X::integer(), Y::integer()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarfindtoolforposition>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolsize>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolbitmapsize>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargetmargins>.

getToolEnabled(This::wxToolBar(), Toolid::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolenabled>.

getToolLongHelp(This::wxToolBar(), Toolid::integer()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoollonghelp>.

getToolPacking(This::wxToolBar()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolpacking>.

getToolPos(This::wxToolBar(), Id::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolpos>.

getToolSeparation(This::wxToolBar()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolseparation>.

getToolShortHelp(This::wxToolBar(), Toolid::integer()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolshorthelp>.

getToolState(This::wxToolBar(), Toolid::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbargettoolstate>.

insertControl(This::wxToolBar(), Pos::integer(), Control::wxControl() (see module wxControl)) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarinsertcontrol>.

insertSeparator(This::wxToolBar(), Pos::integer()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarinsertseparator>.

insertTool(This::wxToolBar(), Pos::integer(), Tool::wx() (see module wx)) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarinserttool>.

insertTool(This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap() (see module wxBitmap)) -> wx() (see module wx)

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

insertTool(This::wxToolBar(), Pos::integer(), Toolid::integer(), X::string() | term(), X::term()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarinserttool>.
     Alternatives:

    insertTool(This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap()) -> insertTool(This, Pos, Toolid, Label, Bitmap, [])

    insertTool(This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx()
     Option = {bmpDisabled, wxBitmap:wxBitmap()} | {toggle, bool()} | {clientData, wx:wx()} | {shortHelp, string()} | {longHelp, string()}

insertTool(This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::string(), Bitmap::wxBitmap() (see module wxBitmap), Options::[Option]) -> wx() (see module wx)

    Types
        Option = {bmpDisabled, wxBitmap() (see module wxBitmap)} | {kind, WxItemKind} | {shortHelp, string()} | {longHelp, string()} | {clientData, wx() (see module wx)}
        WxItemKind = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarinserttool>.
     WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

realize(This::wxToolBar()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarrealize>.

removeTool(This::wxToolBar(), Toolid::integer()) -> wx() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarremovetool>.

setMargins(This::wxToolBar(), X::integer(), Y::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarsetmargins>.

setToolBitmapSize(This::wxToolBar(), Size::{W::integer(), H::integer()}) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarsettoolbitmapsize>.

setToolLongHelp(This::wxToolBar(), Toolid::integer(), HelpString::string()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarsettoollonghelp>.

setToolPacking(This::wxToolBar(), Packing::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarsettoolpacking>.

setToolShortHelp(This::wxToolBar(), Id::integer(), HelpString::string()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarsettoolshorthelp>.

setToolSeparation(This::wxToolBar(), Separation::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbarsettoolseparation>.

toggleTool(This::wxToolBar(), Toolid::integer(), Toggle::bool()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtoolbar.html#wxtoolbartoggletool>.