Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.8


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()}

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

Types:

Option = {style, integer()}

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

Types:

This = wxMenu()

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

Types:

This = wxMenu()
Itemid = integer()

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

Types:

This = wxMenu()
Itemid = integer()
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()
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:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()

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

Types:

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

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

Types:

This = wxMenu()
Itemid = integer()

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

Types:

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

appendSeparator(This) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()

break(This) -> ok

Types:

This = wxMenu()

check(This, Itemid, Check) -> ok

Types:

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

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

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

Types:

This = wxMenu()
Itemid = integer()

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

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

Types:

This = wxMenu()
Position = integer()

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

Types:

This = wxMenu()
Itemid = integer()

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

Types:

This = wxMenu()
Itemid = integer()

getMenuItemCount(This) -> integer()

Types:

This = wxMenu()

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

Types:

This = wxMenu()

getTitle(This) -> unicode:charlist()

Types:

This = wxMenu()

insert(This, Pos, Itemid) -> wxMenuItem: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, 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()
Submenu = wxMenu()

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

Types:

This = wxMenu()
Pos = integer()
Itemid = integer()
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:wxMenuItem()

Types:

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

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

Types:

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

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

Types:

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

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

Types:

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

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

Types:

This = wxMenu()
Pos = integer()

isChecked(This, Itemid) -> boolean()

Types:

This = wxMenu()
Itemid = integer()

isEnabled(This, Itemid) -> boolean()

Types:

This = wxMenu()
Itemid = integer()

prepend(This, Itemid) -> wxMenuItem: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, 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()
Submenu = wxMenu()

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

Types:

This = wxMenu()
Itemid = integer()
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:wxMenuItem()

Types:

This = wxMenu()
Itemid = integer()

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

Types:

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

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

Types:

This = wxMenu()
Itemid = integer()

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

Types:

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

prependSeparator(This) -> wxMenuItem:wxMenuItem()

Types:

This = wxMenu()

remove(This, Itemid) -> wxMenuItem: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 = unicode:chardata()

setLabel(This, Itemid, Label) -> ok

Types:

This = wxMenu()
Itemid = integer()

setTitle(This, Title) -> ok

Types:

This = wxMenu()

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

Destroys this object, do not use object again