User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.99.2

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

Types:

Option = {style, integer()}

See external documentation.

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

Types:

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

See external documentation.

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

Types:

This = wxMenu()
Item = wxMenuItem() (see module wxMenuItem)

See external documentation.

append(This, Itemid, Text) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)

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

append(This, Itemid, Text, Submenu) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)
Submenu = wxMenu()

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

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)
Help = chardata() (see module unicode)
IsCheckable = boolean()

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() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)

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

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

Types:

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

See external documentation.

appendRadioItem(This, Itemid, Text) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)

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

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

Types:

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

See external documentation.

appendSeparator(This) -> wxMenuItem() (see module 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()

Types:

This = wxMenu()
Itemid = integer()

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

Destroy(This, Itemid) -> boolean()

Types:

This = wxMenu()
Itemid = integer()

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() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()

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

findItemByPosition(This, Position) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Position = integer()

See external documentation.

getHelpString(This, Itemid) -> charlist() (see module unicode)

Types:

This = wxMenu()
Itemid = integer()

See external documentation.

getLabel(This, Itemid) -> charlist() (see module unicode)

Types:

This = wxMenu()
Itemid = integer()

See external documentation.

getMenuItemCount(This) -> integer()

Types:

This = wxMenu()

See external documentation.

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

Types:

This = wxMenu()

See external documentation.

getTitle(This) -> charlist() (see module unicode)

Types:

This = wxMenu()

See external documentation.

insert(This, Pos, Itemid) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()

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, Option::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

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

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

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

Types:

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

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

insert(This, Pos, Itemid, Text, Help, IsCheckable) -> ok

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = chardata() (see module unicode)
Help = chardata() (see module unicode)
IsCheckable = boolean()

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() (see module wxMenuItem)

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = chardata() (see module unicode)

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

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

Types:

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

See external documentation.

insertRadioItem(This, Pos, Itemid, Text) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
Text = chardata() (see module unicode)

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

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

Types:

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

See external documentation.

insertSeparator(This, Pos) -> wxMenuItem() (see module 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() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()

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, Option::[Option]) -> wxMenuItem() (see module wxMenuItem)

Types:

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

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

prepend(This, Itemid, Text, Submenu) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)
Submenu = wxMenu()

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

prepend(This, Itemid, Text, Help, IsCheckable) -> ok

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)
Help = chardata() (see module unicode)
IsCheckable = boolean()

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() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)

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

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

Types:

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

See external documentation.

prependRadioItem(This, Itemid, Text) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()
Text = chardata() (see module unicode)

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

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

Types:

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

See external documentation.

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

Types:

This = wxMenu()

See external documentation.

remove(This, Itemid) -> wxMenuItem() (see module wxMenuItem)

Types:

This = wxMenu()
Itemid = integer()

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 = chardata() (see module unicode)

See external documentation.

setLabel(This, Itemid, Label) -> ok

Types:

This = wxMenu()
Itemid = integer()
Label = chardata() (see module unicode)

See external documentation.

setTitle(This, Title) -> ok

Types:

This = wxMenu()
Title = chardata() (see module unicode)

See external documentation.

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

Destroys this object, do not use object again