Skip to content

Commit b0257d2

Browse files
lijy91lijy91
committed
Refactor variable names for consistency
Renamed variables in examples, macOS, and Windows platform code to use snake_case for improved consistency and readability. Updated documentation and code comments to match the new naming convention.
1 parent c5ec8af commit b0257d2

File tree

6 files changed

+283
-283
lines changed

6 files changed

+283
-283
lines changed

‎examples/menu_example/main.cpp‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,40 @@ int main() {
1515
std::cout << "Created menu with ID: " << menu->id << std::endl;
1616

1717
// Create menu items with different types
18-
auto fileItem =
18+
auto file_item =
1919
std::make_shared<MenuItem>("New File", MenuItemType::Normal);
20-
auto separatorItem =
20+
auto separator_item =
2121
std::make_shared<MenuItem>("", MenuItemType::Separator);
22-
auto checkboxItem =
22+
auto checkbox_item =
2323
std::make_shared<MenuItem>("Word Wrap", MenuItemType::Checkbox);
24-
auto radioItem1 =
24+
auto radio_item1 =
2525
std::make_shared<MenuItem>("View Mode 1", MenuItemType::Radio);
26-
auto radioItem2 =
26+
auto radio_item2 =
2727
std::make_shared<MenuItem>("View Mode 2", MenuItemType::Radio);
28-
auto exitItem = std::make_shared<MenuItem>("Exit", MenuItemType::Normal);
28+
auto exit_item = std::make_shared<MenuItem>("Exit", MenuItemType::Normal);
2929

3030
// Set up radio group
31-
radioItem1->SetRadioGroup(1);
32-
radioItem2->SetRadioGroup(1);
33-
radioItem1->SetState(MenuItemState::Checked);
31+
radio_item1->SetRadioGroup(1);
32+
radio_item2->SetRadioGroup(1);
33+
radio_item1->SetState(MenuItemState::Checked);
3434

3535
// Set keyboard accelerators
36-
fileItem->SetAccelerator(
36+
file_item->SetAccelerator(
3737
KeyboardAccelerator("N", KeyboardAccelerator::Ctrl));
38-
exitItem->SetAccelerator(
38+
exit_item->SetAccelerator(
3939
KeyboardAccelerator("Q", KeyboardAccelerator::Ctrl));
4040

4141
// Add event listeners using the new event system
4242
std::cout << "Setting up event listeners..." << std::endl;
4343

4444
// Listen to menu item selection events
45-
fileItem->AddListener<MenuItemClickedEvent>(
45+
file_item->AddListener<MenuItemClickedEvent>(
4646
[](const MenuItemClickedEvent& event) {
4747
std::cout << "[EVENT] Menu item clicked: " << event.GetItemText()
4848
<< " (ID: " << event.GetItemId() << ")" << std::endl;
4949
});
5050

51-
checkboxItem->AddListener<MenuItemClickedEvent>(
51+
checkbox_item->AddListener<MenuItemClickedEvent>(
5252
[](const MenuItemClickedEvent& event) {
5353
std::cout << "[EVENT] Checkbox item clicked: " << event.GetItemText()
5454
<< " (ID: " << event.GetItemId()
@@ -57,19 +57,19 @@ int main() {
5757

5858
// Note: State management is now handled by the application
5959

60-
radioItem1->AddListener<MenuItemClickedEvent>(
60+
radio_item1->AddListener<MenuItemClickedEvent>(
6161
[](const MenuItemClickedEvent& event) {
6262
std::cout << "[EVENT] Radio item 1 clicked: ID " << event.GetItemId()
6363
<< " - Handle state manually" << std::endl;
6464
});
6565

66-
radioItem2->AddListener<MenuItemClickedEvent>(
66+
radio_item2->AddListener<MenuItemClickedEvent>(
6767
[](const MenuItemClickedEvent& event) {
6868
std::cout << "[EVENT] Radio item 2 clicked: ID " << event.GetItemId()
6969
<< " - Handle state manually" << std::endl;
7070
});
7171

72-
exitItem->AddListener<MenuItemClickedEvent>(
72+
exit_item->AddListener<MenuItemClickedEvent>(
7373
[](const MenuItemClickedEvent& event) {
7474
std::cout << "[EVENT] Exit item clicked: " << event.GetItemText()
7575
<< std::endl;
@@ -86,14 +86,14 @@ int main() {
8686
});
8787

8888
// Add items to menu
89-
menu->AddItem(fileItem);
90-
menu->AddItem(separatorItem);
91-
menu->AddItem(checkboxItem);
89+
menu->AddItem(file_item);
90+
menu->AddItem(separator_item);
91+
menu->AddItem(checkbox_item);
9292
menu->AddSeparator();
93-
menu->AddItem(radioItem1);
94-
menu->AddItem(radioItem2);
93+
menu->AddItem(radio_item1);
94+
menu->AddItem(radio_item2);
9595
menu->AddSeparator();
96-
menu->AddItem(exitItem);
96+
menu->AddItem(exit_item);
9797

9898
std::cout << "Menu created with " << menu->GetItemCount() << " items"
9999
<< std::endl;
@@ -102,19 +102,19 @@ int main() {
102102
std::cout << "\n=== Testing Programmatic Event Triggering ===" << std::endl;
103103

104104
std::cout << "Triggering file item..." << std::endl;
105-
fileItem->Trigger();
105+
file_item->Trigger();
106106

107107
std::cout << "Triggering checkbox item..." << std::endl;
108-
checkboxItem->Trigger();
108+
checkbox_item->Trigger();
109109

110110
std::cout << "Triggering checkbox item again..." << std::endl;
111-
checkboxItem->Trigger();
111+
checkbox_item->Trigger();
112112

113113
std::cout << "Switching radio button..." << std::endl;
114-
radioItem2->Trigger();
114+
radio_item2->Trigger();
115115

116116
std::cout << "Triggering exit item..." << std::endl;
117-
exitItem->Trigger();
117+
exit_item->Trigger();
118118

119119
// Open menu as context menu (this may not work in console applications)
120120
std::cout << "\n=== Attempting to Open Context Menu ===" << std::endl;
@@ -133,52 +133,52 @@ int main() {
133133
// Demonstrate submenu
134134
std::cout << "\n=== Testing Submenu ===" << std::endl;
135135
auto submenu = std::make_shared<Menu>();
136-
auto submenuItem1 =
136+
auto submenu_item1 =
137137
std::make_shared<MenuItem>("Submenu Item 1", MenuItemType::Normal);
138-
auto submenuItem2 =
138+
auto submenu_item2 =
139139
std::make_shared<MenuItem>("Submenu Item 2", MenuItemType::Normal);
140140

141-
submenuItem1->AddListener<MenuItemClickedEvent>(
141+
submenu_item1->AddListener<MenuItemClickedEvent>(
142142
[](const MenuItemClickedEvent& event) {
143143
std::cout << "[EVENT] Submenu item clicked: " << event.GetItemText()
144144
<< std::endl;
145145
});
146146

147-
submenuItem2->AddListener<MenuItemClickedEvent>(
147+
submenu_item2->AddListener<MenuItemClickedEvent>(
148148
[](const MenuItemClickedEvent& event) {
149149
std::cout << "[EVENT] Submenu item clicked: " << event.GetItemText()
150150
<< std::endl;
151151
});
152152

153-
submenu->AddItem(submenuItem1);
154-
submenu->AddItem(submenuItem2);
153+
submenu->AddItem(submenu_item1);
154+
submenu->AddItem(submenu_item2);
155155

156-
auto submenuParent =
156+
auto submenu_parent =
157157
std::make_shared<MenuItem>("Tools", MenuItemType::Submenu);
158-
submenuParent->SetSubmenu(submenu);
158+
submenu_parent->SetSubmenu(submenu);
159159

160160
// Add submenu event listeners
161-
submenuParent->AddListener<MenuItemSubmenuOpenedEvent>(
161+
submenu_parent->AddListener<MenuItemSubmenuOpenedEvent>(
162162
[](const MenuItemSubmenuOpenedEvent& event) {
163163
std::cout << "[EVENT] Submenu opened: ID " << event.GetItemId()
164164
<< std::endl;
165165
});
166166

167-
submenuParent->AddListener<MenuItemSubmenuClosedEvent>(
167+
submenu_parent->AddListener<MenuItemSubmenuClosedEvent>(
168168
[](const MenuItemSubmenuClosedEvent& event) {
169169
std::cout << "[EVENT] Submenu closed: ID " << event.GetItemId()
170170
<< std::endl;
171171
});
172172

173-
menu->AddItem(submenuParent);
173+
menu->AddItem(submenu_parent);
174174

175175
std::cout << "Added submenu with " << submenu->GetItemCount() << " items"
176176
<< std::endl;
177177

178178
// Test submenu items
179179
std::cout << "Triggering submenu items..." << std::endl;
180-
submenuItem1->Trigger();
181-
submenuItem2->Trigger();
180+
submenu_item1->Trigger();
181+
submenu_item2->Trigger();
182182

183183
std::cout << "\n=== Event System Demo Complete ===" << std::endl;
184184
std::cout << "This example demonstrates:" << std::endl;

‎src/menu.h‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -487,29 +487,29 @@ class MenuItem : public EventEmitter, public NativeObjectProvider {
487487
* @example
488488
* ```cpp
489489
* // Create a file menu
490-
* auto fileMenu = std::make_shared<Menu>();
490+
* auto file_menu = std::make_shared<Menu>();
491491
*
492492
* // Add items to the menu
493-
* auto newItem = std::make_shared<MenuItem>("New", MenuItemType::Normal);
494-
* newItem->SetAccelerator(KeyboardAccelerator("N", KeyboardAccelerator::Ctrl));
495-
* fileMenu->AddItem(newItem);
493+
* auto new_item = std::make_shared<MenuItem>("New", MenuItemType::Normal);
494+
* new_item->SetAccelerator(KeyboardAccelerator("N", KeyboardAccelerator::Ctrl));
495+
* file_menu->AddItem(new_item);
496496
*
497-
* auto openItem = std::make_shared<MenuItem>("Open", MenuItemType::Normal);
498-
* openItem->SetAccelerator(KeyboardAccelerator("O",
499-
* KeyboardAccelerator::Ctrl)); fileMenu->AddItem(openItem);
497+
* auto open_item = std::make_shared<MenuItem>("Open", MenuItemType::Normal);
498+
* open_item->SetAccelerator(KeyboardAccelerator("O",
499+
* KeyboardAccelerator::Ctrl)); file_menu->AddItem(open_item);
500500
*
501-
* fileMenu->AddSeparator();
501+
* file_menu->AddSeparator();
502502
*
503-
* auto exitItem = std::make_shared<MenuItem>("Exit", MenuItemType::Normal);
504-
* fileMenu->AddItem(exitItem);
503+
* auto exit_item = std::make_shared<MenuItem>("Exit", MenuItemType::Normal);
504+
* file_menu->AddItem(exit_item);
505505
*
506506
* // Listen to menu events
507-
* fileMenu->AddListener<MenuOpenedEvent>([](const MenuOpenedEvent& event) {
507+
* file_menu->AddListener<MenuOpenedEvent>([](const MenuOpenedEvent& event) {
508508
* std::cout << "Menu opened" << std::endl;
509509
* });
510510
*
511511
* // Open as context menu
512-
* fileMenu->Open(100, 100);
512+
* file_menu->Open(100, 100);
513513
* ```
514514
*/
515515
class Menu : public EventEmitter, public NativeObjectProvider {

0 commit comments

Comments
 (0)