![]() |
xtd - Reference Guide
0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
|
#include <main_menu.h>
Represents the menu structure of a form.
Constructors | |
main_menu () | |
Initialize a new instance of main_menu class. More... | |
main_menu (const std::vector< menu_item_ref > &menu_items) | |
Initialize a new instance of main_menu class. More... | |
Methods | |
static std::unique_ptr< xtd::forms::main_menu > | create_standard_items (std::vector< std::unique_ptr< menu_item >> &menu_items, const xtd::event_handler &on_click) |
A factory to create a main menu with specified on click event handler. More... | |
static std::unique_ptr< xtd::forms::main_menu > | create_standard_items (std::vector< std::unique_ptr< menu_item >> &menu_items, const xtd::drawing::size &image_size, const xtd::event_handler &on_click) |
A factory to create a main menu with specified image size and on click event handler. More... | |
static std::unique_ptr< xtd::forms::main_menu > | create_standard_items (std::vector< std::unique_ptr< menu_item >> &menu_items, const xtd::ustring &theme, const xtd::event_handler &on_click) |
A factory to create a main menu with specified theme and on click event handler. More... | |
static std::unique_ptr< xtd::forms::main_menu > | create_standard_items (std::vector< std::unique_ptr< menu_item >> &menu_items, const xtd::ustring &theme, const xtd::drawing::size &size, const xtd::event_handler &on_click) |
A factory to create a main menu with specified theme, image size and on click event handler. More... | |
static std::unique_ptr< xtd::forms::main_menu > | create_standard_items (std::vector< std::unique_ptr< menu_item >> &menu_items, const xtd::forms::theme_images &theme, const xtd::drawing::size &size, const xtd::event_handler &on_click) |
A factory to create a main menu with specified theme, image size and on click event handler. More... | |
Protected methods | |
intptr_t | create_menu_handle () override |
Creates a new handle to the Menu. More... | |
void | destroy_menu_handle (intptr_t handle) override |
Destroys the handle to the Menu. More... | |
void | on_item_added (size_t pos, menu_item_ref item) override |
void | on_item_removed (size_t pos, menu_item_ref item) override |
Additional Inherited Members | |
![]() | |
using | menu_item_collection = layout::arranged_element_collection< menu_item_ref > |
Represents a collection of menu_item objects. More... | |
![]() | |
static constexpr const int | find_handle = 0 |
Specifies that the find_menu_item(int32_t, intptr_t) method should search for a handle. More... | |
static constexpr const int | find_shortcut = 1 |
Specifies that the find_menu_item(int32_t, intptr_t) method should search for a shortcut. More... | |
![]() | |
intptr_t | handle () const |
Gets a value representing the window handle for the menu. More... | |
virtual bool | is_parent () const |
Gets a value indicating whether this menu contains any menu items. More... | |
const menu_item & | mdi_list_item () const |
Gets a value indicating the menu_item that is used to display a list of multiple document interface (MDI) child forms. More... | |
const menu_item_collection & | menu_items () const |
Gets a value indicating the collection of menu_item objects associated with the menu. More... | |
menu_item_collection & | menu_items () |
Gets a value indicating the collection of menu_item objects associated with the menu. More... | |
menu & | menu_items (const menu_item_collection &value) |
Sets a value indicating the collection of menu_item objects associated with the menu. More... | |
const xtd::ustring & | name () const |
Gets the name of the menu. More... | |
menu & | name (const xtd::ustring &value) |
Sets the name of the menu. More... | |
std::any | tag () const |
Gets user-defined data associated with the control. More... | |
menu & | tag (std::any value) |
Sets user-defined data associated with the control. More... | |
bool | equals (const menu &) const noexcept override |
bool | equals (const object &) const noexcept override |
Indicates whether the current object is equal to another object of the same type. More... | |
std::optional< std::reference_wrapper< context_menu > > | get_context_menu () const |
Gets the context_menu that contains this menu. More... | |
std::optional< std::reference_wrapper< main_menu > > | get_main_menu () const |
Gets the main_menu that contains this menu. More... | |
virtual void | merge_menu (const menu &menu_src) |
Merges the MenuItem objects of one menu with the current menu. More... | |
xtd::ustring | to_string () const noexcept override |
Returns a string that represents the menu control. More... | |
![]() | |
object ()=default | |
Create a new instance of the ultimate base class object. More... | |
virtual size_t | get_hash_code () const noexcept |
Serves as a hash function for a particular type. More... | |
template<typename object_t > | |
std::unique_ptr< object_t > | memberwise_clone () const |
Gets the type of the current instance. More... | |
![]() | |
virtual bool | equals (const menu &) const noexcept=0 |
Indicates whether the current object is equal to another object of the same type. More... | |
![]() | |
static bool | equals (const object &object_a, const object &object_b) noexcept |
Determines whether the specified object instances are considered equal. More... | |
static bool | reference_equals (const object &object_a, const object &object_b) noexcept |
Determines whether the specified object instances are the same instance. More... | |
![]() | |
friend | menu_item |
![]() | |
menu () | |
Initializes a new instance of the Menu class. More... | |
menu (const menu_item_collection &items) | |
Initializes a new instance of the Menu class. More... | |
void | clone_menu (const menu &menu_src) |
Copies the menu that is passed as a parameter to the current menu. More... | |
![]() | |
component ()=default | |
Initialises a new instance of the component class. More... | |
virtual bool | can_raise_events () const |
Gets a value indicating whether the component can raise an event. More... | |
bool | design_mode () const |
Gets a value that indicates whether the component is currently in design mode. More... | |
xtd::forms::main_menu::main_menu | ( | ) |
Initialize a new instance of main_menu class.
|
explicit |
|
overrideprotectedvirtual |
Creates a new handle to the Menu.
Implements xtd::forms::menu.
|
static |
A factory to create a main menu with specified on click event handler.
menu_items | an array xtd::forms::menu_item which will contain the created menu items. |
on_click | an event handler to respond on lick event. |
Position | menu item |
---|---|
0 | file |
1 | file new |
2 | file open |
3 | file separator1 |
4 | file save |
5 | file save_as |
6 | file separator2 |
7 | file print |
8 | file print_preview |
9 | file separator3 |
10 | file exit |
11 | edit |
12 | edit undo |
13 | edit redo |
14 | edit separator1 |
15 | edit cut |
16 | edit copy |
17 | edit paste |
18 | edit separator2 |
19 | edit select_all |
20 | tools |
21 | tools customize |
22 | tools options |
23 | help |
24 | help contents |
25 | help index |
26 | help search |
27 | help separator1 |
28 | help about |
|
static |
A factory to create a main menu with specified image size and on click event handler.
menu_items | an array xtd::forms::menu_item which will contain the created menu items. |
image_size | A xtd::drawing::size that represent the menu item image size. |
on_click | an event handler to respond on lick event. |
Position | menu item |
---|---|
0 | file |
1 | file new |
2 | file open |
3 | file separator1 |
4 | file save |
5 | file save_as |
6 | file separator2 |
7 | file print |
8 | file print_preview |
9 | file separator3 |
10 | file exit |
11 | edit |
12 | edit undo |
13 | edit redo |
14 | edit separator1 |
15 | edit cut |
16 | edit copy |
17 | edit paste |
18 | edit separator2 |
19 | edit select_all |
20 | tools |
21 | tools customize |
22 | tools options |
23 | help |
24 | help contents |
25 | help index |
26 | help search |
27 | help separator1 |
28 | help about |
|
static |
A factory to create a main menu with specified theme and on click event handler.
menu_items | an array xtd::forms::menu_item which will contain the created menu items. |
theme | The theme of menu item image. |
on_click | an event handler to respond on lick event. |
Position | menu item |
---|---|
0 | file |
1 | file new |
2 | file open |
3 | file separator1 |
4 | file save |
5 | file save_as |
6 | file separator2 |
7 | file print |
8 | file print_preview |
9 | file separator3 |
10 | file exit |
11 | edit |
12 | edit undo |
13 | edit redo |
14 | edit separator1 |
15 | edit cut |
16 | edit copy |
17 | edit paste |
18 | edit separator2 |
19 | edit select_all |
20 | tools |
21 | tools customize |
22 | tools options |
23 | help |
24 | help contents |
25 | help index |
26 | help search |
27 | help separator1 |
28 | help about |
|
static |
A factory to create a main menu with specified theme, image size and on click event handler.
menu_items | an array xtd::forms::menu_item which will contain the created menu items. |
theme | The theme of menu item image. |
image_size | A xtd::drawing::size that represent the menu item image size. |
on_click | an event handler to respond on lick event. |
Position | menu item |
---|---|
0 | file |
1 | file new |
2 | file open |
3 | file separator1 |
4 | file save |
5 | file save_as |
6 | file separator2 |
7 | file print |
8 | file print_preview |
9 | file separator3 |
10 | file exit |
11 | edit |
12 | edit undo |
13 | edit redo |
14 | edit separator1 |
15 | edit cut |
16 | edit copy |
17 | edit paste |
18 | edit separator2 |
19 | edit select_all |
20 | tools |
21 | tools customize |
22 | tools options |
23 | help |
24 | help contents |
25 | help index |
26 | help search |
27 | help separator1 |
28 | help about |
|
static |
A factory to create a main menu with specified theme, image size and on click event handler.
menu_items | an array xtd::forms::menu_item which will contain the created menu items. |
theme | The theme of menu item image. |
image_size | A xtd::drawing::size that represent the menu item image size. |
on_click | an event handler to respond on lick event. |
Position | menu item |
---|---|
0 | file |
1 | file new |
2 | file open |
3 | file separator1 |
4 | file save |
5 | file save_as |
6 | file separator2 |
7 | file print |
8 | file print_preview |
9 | file separator3 |
10 | file exit |
11 | edit |
12 | edit undo |
13 | edit redo |
14 | edit separator1 |
15 | edit cut |
16 | edit copy |
17 | edit paste |
18 | edit separator2 |
19 | edit select_all |
20 | tools |
21 | tools customize |
22 | tools options |
23 | help |
24 | help contents |
25 | help index |
26 | help search |
27 | help separator1 |
28 | help about |
|
overrideprotectedvirtual |
Destroys the handle to the Menu.
handle | A handle to the menu. |
Reimplemented from xtd::forms::menu.