Scroll to navigation

wxMenu(3erl) Erlang Module Definition wxMenu(3erl)

NAME

wxMenu - See external documentation: wxMenu.

DESCRIPTION

See external documentation: wxMenu.

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

DATA TYPES

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

new() -> wxMenu()

Equivalent to new([]).

new(Options::[Option]) -> wxMenu()

Types:

Option = {style, integer()}

See external documentation.

new(Title, Options::[Option]) -> wxMenu()

Types:

Title = unicode:chardata()
Option = {style, integer()}

See external documentation.

append(This, Item) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Item = wxMenuItem:wxMenuItem()

See external documentation.

append(This, Itemid, Text) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()

Equivalent to append(This, Itemid, Text, []).

append(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem()
append(This, Itemid, Text, Submenu::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Submenu = wxMenu()
This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Option = {help, unicode:chardata()} | {kind, wx:wx_enum()}

See external documentation.
Also:
append(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when
This::wxMenu(), Itemid::integer(), Text::unicode:chardata(),
Option :: {'help', unicode:chardata()}
| {'kind', wx:wx_enum()}.

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

append(This, Itemid, Text, Help, IsCheckable) -> ok
append(This, Itemid, Text, Submenu, IsCheckable::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Help = unicode:chardata()
IsCheckable = boolean()
This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Submenu = wxMenu()
Option = {help, unicode:chardata()}

See external documentation.
Also:
append(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
Option :: {'help', unicode:chardata()}.

appendCheckItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()

Equivalent to appendCheckItem(This, Itemid, Text, []).

appendCheckItem(This, Itemid, Text, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Option = {help, unicode:chardata()}

See external documentation.

appendRadioItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()

Equivalent to appendRadioItem(This, Itemid, Text, []).

appendRadioItem(This, Itemid, Text, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Option = {help, unicode:chardata()}

See external documentation.

appendSeparator(This) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()

See external documentation.

break(This) -> ok

Types:

This = wxMenu()

See external documentation.

check(This, Itemid, Check) -> ok

Types:

This = wxMenu()
Itemid = integer()
Check = boolean()

See external documentation.

delete(This, Itemid) -> boolean()
delete(This, Item) -> boolean()

Types:

This = wxMenu()
Itemid = integer()
This = wxMenu()
Item = wxMenuItem:wxMenuItem()

See external documentation.
Also:
delete(This, Item) -> boolean() when
This::wxMenu(), Item::wxMenuItem:wxMenuItem().

Destroy(This, Itemid) -> boolean()
Destroy(This, Item) -> boolean()

Types:

This = wxMenu()
Itemid = integer()
This = wxMenu()
Item = wxMenuItem:wxMenuItem()

See external documentation.
Also:
'Destroy'(This, Item) -> boolean() when
This::wxMenu(), Item::wxMenuItem:wxMenuItem().

enable(This, Itemid, Enable) -> ok

Types:

This = wxMenu()
Itemid = integer()
Enable = boolean()

See external documentation.

findItem(This, Itemid) -> wxMenuItem:wxMenuItem()
findItem(This, Item) -> integer()

Types:

This = wxMenu()
Itemid = integer()
This = wxMenu()
Item = unicode:chardata()

See external documentation.
Also:
findItem(This, Item) -> integer() when
This::wxMenu(), Item::unicode:chardata().

findItemByPosition(This, Position) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Position = integer()

See external documentation.

getHelpString(This, Itemid) -> unicode:charlist()

Types:

This = wxMenu()
Itemid = integer()

See external documentation.

getLabel(This, Itemid) -> unicode:charlist()

Types:

This = wxMenu()
Itemid = integer()

See external documentation.

getMenuItemCount(This) -> integer()

Types:

This = wxMenu()

See external documentation.

getMenuItems(This) -> [wxMenuItem:wxMenuItem()]

Types:

This = wxMenu()

See external documentation.

getTitle(This) -> unicode:charlist()

Types:

This = wxMenu()

See external documentation.

insert(This, Pos, Itemid) -> wxMenuItem:wxMenuItem()
insert(This, Pos, Item) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
This = wxMenu()
Pos = integer()
Item = wxMenuItem:wxMenuItem()

See external documentation.
Also:
insert(This, Pos, Item) -> wxMenuItem:wxMenuItem() when
This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem().

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

insert(This, Pos, Itemid, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Option = {text, unicode:chardata()} | {help, unicode:chardata()} | {kind, wx:wx_enum()}

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

insert(This, Pos, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = unicode:chardata()
Submenu = wxMenu()

Equivalent to insert(This, Pos, Itemid, Text, Submenu, []).

insert(This, Pos, Itemid, Text, Help, IsCheckable) -> ok
insert(This, Pos, Itemid, Text, Submenu, IsCheckable::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = unicode:chardata()
Help = unicode:chardata()
IsCheckable = boolean()
This = wxMenu()
Pos = integer()
Itemid = integer()
Text = unicode:chardata()
Submenu = wxMenu()
Option = {help, unicode:chardata()}

See external documentation.
Also:
insert(This, Pos, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
Option :: {'help', unicode:chardata()}.

insertCheckItem(This, Pos, Itemid, Text) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = unicode:chardata()

Equivalent to insertCheckItem(This, Pos, Itemid, Text, []).

insertCheckItem(This, Pos, Itemid, Text, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = unicode:chardata()
Option = {help, unicode:chardata()}

See external documentation.

insertRadioItem(This, Pos, Itemid, Text) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = unicode:chardata()

Equivalent to insertRadioItem(This, Pos, Itemid, Text, []).

insertRadioItem(This, Pos, Itemid, Text, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = unicode:chardata()
Option = {help, unicode:chardata()}

See external documentation.

insertSeparator(This, Pos) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Pos = integer()

See external documentation.

isChecked(This, Itemid) -> boolean()

Types:

This = wxMenu()
Itemid = integer()

See external documentation.

isEnabled(This, Itemid) -> boolean()

Types:

This = wxMenu()
Itemid = integer()

See external documentation.

prepend(This, Itemid) -> wxMenuItem:wxMenuItem()
prepend(This, Item) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
This = wxMenu()
Item = wxMenuItem:wxMenuItem()

See external documentation.
Also:
prepend(This, Item) -> wxMenuItem:wxMenuItem() when
This::wxMenu(), Item::wxMenuItem:wxMenuItem().

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

prepend(This, Itemid, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Option = {text, unicode:chardata()} | {help, unicode:chardata()} | {kind, wx:wx_enum()}

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

prepend(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Submenu = wxMenu()

Equivalent to prepend(This, Itemid, Text, Submenu, []).

prepend(This, Itemid, Text, Help, IsCheckable) -> ok
prepend(This, Itemid, Text, Submenu, IsCheckable::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Help = unicode:chardata()
IsCheckable = boolean()
This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Submenu = wxMenu()
Option = {help, unicode:chardata()}

See external documentation.
Also:
prepend(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
Option :: {'help', unicode:chardata()}.

prependCheckItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()

Equivalent to prependCheckItem(This, Itemid, Text, []).

prependCheckItem(This, Itemid, Text, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Option = {help, unicode:chardata()}

See external documentation.

prependRadioItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()

Equivalent to prependRadioItem(This, Itemid, Text, []).

prependRadioItem(This, Itemid, Text, Options::[Option]) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
Text = unicode:chardata()
Option = {help, unicode:chardata()}

See external documentation.

prependSeparator(This) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()

See external documentation.

remove(This, Itemid) -> wxMenuItem:wxMenuItem()
remove(This, Item) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()
This = wxMenu()
Item = wxMenuItem:wxMenuItem()

See external documentation.
Also:
remove(This, Item) -> wxMenuItem:wxMenuItem() when
This::wxMenu(), Item::wxMenuItem:wxMenuItem().

setHelpString(This, Itemid, HelpString) -> ok

Types:

This = wxMenu()
Itemid = integer()
HelpString = unicode:chardata()

See external documentation.

setLabel(This, Itemid, Label) -> ok

Types:

This = wxMenu()
Itemid = integer()
Label = unicode:chardata()

See external documentation.

setTitle(This, Title) -> ok

Types:

This = wxMenu()
Title = unicode:chardata()

See external documentation.

destroy(This::wxMenu()) -> ok

Destroys this object, do not use object again

AUTHORS

<>

wx 1.9.2