menubar.h File Reference

#include <string>
#include "components/resources/engine_globals/globals.h"

Go to the source code of this file.

Classes
struct	BlamMenubarItem
	Structure representing a menu bar item. More...
struct	BlamMenubar
	Structure representing the menu bar. More...

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::Settings
	Blam::Settings::Menubar
	Namespace for things related to the imgui menu bar.

Macros
#define	BLAM
#define	MENUBAR_FILE   "menu_bar_init.xml"
	The filename of the menu bar layout. More...

Enumerations
enum	BlamMenubarItemType {   BlamMenubarItemType::Menu, BlamMenubarItemType::MenuItem, BlamMenubarItemType::Label, BlamMenubarItemType::Separator,   BlamMenubarItemType::Undefined }
	Enumerator containing all possible types of menu bar items. More...
enum	BlamMenubarItemVariableType { BlamMenubarItemVariableType::Unimplemented, BlamMenubarItemVariableType::Command, BlamMenubarItemVariableType::Global, BlamMenubarItemVariableType::UndefinedVariable }
	Enumerator containing all possible types of menu bar item variables. More...

Functions
BLAM void	Blam::Settings::Menubar::LoadMenubarLayout ()
	Loads the menu bar data from disk. More...
BLAM void	Blam::Settings::Menubar::ReloadMenubar ()
	Reloads the menu bar data from disk. More...
BLAM void	Blam::Settings::Menubar::ReleaseMenubar ()
	Releases the menu bar resources from memory. More...
BLAM BlamMenubar *	Blam::Settings::Menubar::GetMenuBar ()
	Retrieves the menu bar data. More...

Macro Definition Documentation

BLAM

#define BLAM

MENUBAR_FILE

#define MENUBAR_FILE   "menu_bar_init.xml"

The filename of the menu bar layout.

Enumeration Type Documentation

BlamMenubarItemType

enum BlamMenubarItemType

strong

Enumerator containing all possible types of menu bar items.

This enum refers to the general type of item as it displays in the menu.

Enumerator
Menu	A submenu within the menu.
MenuItem	A standard menu item.
Label	A non-clickable text label.
Separator	A separator item.
Undefined	Fallback item type in the event no valid type is found.

BlamMenubarItemVariableType

enum BlamMenubarItemVariableType

strong

Enumerator containing all possible types of menu bar item variables.

This enum is only checked for menu items with BlamMenubarItemType::MenuItem type. It is used to alter the behavior upon selecting the item.

Enumerator
Unimplemented	Indicates the menu item is a placeholder item intended for future use.
Command	Indicates the menu item will execute a command upon being clicked.
Global	Indicates the menu item will modify an engine global.
UndefinedVariable	Fallback item type in the event no valid type is found.