User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.99

Expand All
Contract All

Table of Contents

# wxMenu

### MODULE

wxMenu

### MODULE SUMMARY

See external documentation: wxMenu.

### DESCRIPTION

See external documentation: wxMenu.

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

### DATA TYPES

wxMenu()

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

Types:

Option = {style, integer()}

See external documentation.

append(This::wxMenu(), Item::wxMenuItem() (see module wxMenuItem)) -> wxMenuItem() (see module wxMenuItem)

See external documentation.

append(This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem() (see module wxMenuItem)

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

append(This::wxMenu(), Itemid::integer(), Text::string(), X::wxMenu() | term()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.
Alternatives:

append(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu()) -> append(This,Itemid,Text,Submenu, [])

append(This::wxMenu(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem()
Option = {help, string()} | {kind, WxItemKind}
WxItemKind = integer()
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

append(This::wxMenu(), Itemid::integer(), Text::string(), X::string() | wxMenu(), X::bool() | term()) -> ok | wxMenuItem() (see module wxMenuItem)

See external documentation.
Alternatives:

append(This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok

append(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem()
Option = {help, string()}

appendCheckItem(This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem() (see module wxMenuItem)

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

appendCheckItem(This::wxMenu(), Itemid::integer(), Text::string(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {help, string()}

See external documentation.

appendRadioItem(This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem() (see module wxMenuItem)

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

appendRadioItem(This::wxMenu(), Itemid::integer(), Text::string(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {help, string()}

See external documentation.

appendSeparator(This::wxMenu()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.

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

See external documentation.

check(This::wxMenu(), Itemid::integer(), Check::bool()) -> ok

See external documentation.

delete(This::wxMenu(), X::integer() | term()) -> bool()

See external documentation.
Alternatives:

delete(This::wxMenu(), Itemid::integer()) -> bool()

delete(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> bool()

Destroy(This::wxMenu(), X::integer() | term()) -> bool()

See external documentation.
Alternatives:

'Destroy'(This::wxMenu(), Itemid::integer()) -> bool()

'Destroy'(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> bool()

enable(This::wxMenu(), Itemid::integer(), Enable::bool()) -> ok

See external documentation.

findItem(This::wxMenu(), X::integer() | string()) -> wxMenuItem() (see module wxMenuItem) | integer()

See external documentation.
Alternatives:

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

findItem(This::wxMenu(), Item::string()) -> integer()

findItemByPosition(This::wxMenu(), Position::integer()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.

getHelpString(This::wxMenu(), Itemid::integer()) -> string()

See external documentation.

getLabel(This::wxMenu(), Itemid::integer()) -> string()

See external documentation.

getMenuItemCount(This::wxMenu()) -> integer()

See external documentation.

getMenuItems(This::wxMenu()) -> [wxMenuItem() (see module wxMenuItem)]

See external documentation.

getTitle(This::wxMenu()) -> string()

See external documentation.

insert(This::wxMenu(), Pos::integer(), X::integer() | term()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.
Alternatives:

insert(This::wxMenu(), Pos::integer(), Itemid::integer()) -> insert(This,Pos,Itemid, [])

insert(This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem()

insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {text, string()} | {help, string()} | {kind, WxItemKind}
WxItemKind = integer()

See external documentation.
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Submenu::wxMenu()) -> wxMenuItem() (see module wxMenuItem)

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

insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), X::string() | wxMenu(), X::bool() | term()) -> ok | wxMenuItem() (see module wxMenuItem)

See external documentation.
Alternatives:

insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok

insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem()
Option = {help, string()}

insertCheckItem(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string()) -> wxMenuItem() (see module wxMenuItem)

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

insertCheckItem(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {help, string()}

See external documentation.

insertRadioItem(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string()) -> wxMenuItem() (see module wxMenuItem)

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

insertRadioItem(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {help, string()}

See external documentation.

insertSeparator(This::wxMenu(), Pos::integer()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.

isChecked(This::wxMenu(), Itemid::integer()) -> bool()

See external documentation.

isEnabled(This::wxMenu(), Itemid::integer()) -> bool()

See external documentation.

prepend(This::wxMenu(), X::integer() | term()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.
Alternatives:

prepend(This::wxMenu(), Itemid::integer()) -> prepend(This,Itemid, [])

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

prepend(This::wxMenu(), Itemid::integer(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {text, string()} | {help, string()} | {kind, WxItemKind}
WxItemKind = integer()

See external documentation.
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX

prepend(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu()) -> wxMenuItem() (see module wxMenuItem)

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

prepend(This::wxMenu(), Itemid::integer(), Text::string(), X::string() | wxMenu(), X::bool() | term()) -> ok | wxMenuItem() (see module wxMenuItem)

See external documentation.
Alternatives:

prepend(This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok

prepend(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem()
Option = {help, string()}

prependCheckItem(This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem() (see module wxMenuItem)

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

prependCheckItem(This::wxMenu(), Itemid::integer(), Text::string(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {help, string()}

See external documentation.

prependRadioItem(This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem() (see module wxMenuItem)

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

prependRadioItem(This::wxMenu(), Itemid::integer(), Text::string(), Options::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

Option = {help, string()}

See external documentation.

prependSeparator(This::wxMenu()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.

remove(This::wxMenu(), X::integer() | term()) -> wxMenuItem() (see module wxMenuItem)

See external documentation.
Alternatives:

remove(This::wxMenu(), Itemid::integer()) -> wxMenuItem:wxMenuItem()

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

setHelpString(This::wxMenu(), Itemid::integer(), HelpString::string()) -> ok

See external documentation.

setLabel(This::wxMenu(), Itemid::integer(), Label::string()) -> ok

See external documentation.

setTitle(This::wxMenu(), Title::string()) -> ok

See external documentation.

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

Destroys this object, do not use object again