Ship::Menu Class Reference

#include <Menu.h>

Inheritance diagram for Ship::Menu:

Collaboration diagram for Ship::Menu:

Public Member Functions
	Menu (const std::string &cVar, const std::string &name, uint8_t searchSidebarIndex_=0, UIWidgets::Colors menuThemeIndex_=UIWidgets::Colors::LightBlue)
virtual	~Menu ()
void	InitElement () override
void	DrawElement () override
void	UpdateElement () override
void	Draw () override
void	InsertSidebarSearch ()
void	RemoveSidebarSearch ()
void	UpdateWindowBackendObjects ()
void	MenuDrawItem (WidgetInfo &widget, uint32_t width, UIWidgets::Colors menuThemeIndex)
void	AddMenuEntry (std::string entryName, const char *entryCvar)
std::unordered_map< uint32_t, disabledInfo > &	GetDisabledMap ()

Protected Member Functions
uint32_t	DrawSearchResults (std::string &menuSearchText)
virtual void	ProcessReset ()

Protected Attributes
ImVec2	mOriginalSize
std::string	mName
uint32_t	mWindowFlags
std::unordered_map< std::string, MainMenuEntry >	menuEntries
std::vector< std::string >	menuOrder
ImGuiTextFilter	menuSearch
uint8_t	searchSidebarIndex
UIWidgets::Colors	defaultThemeIndex
std::shared_ptr< std::vector< Ship::WindowBackend > >	availableWindowBackends
std::unordered_map< Ship::WindowBackend, const char * >	availableWindowBackendsMap
Ship::WindowBackend	configWindowBackend
std::unordered_map< uint32_t, disabledInfo >	disabledMap
std::vector< disabledInfo >	disabledVector
const SidebarEntry	searchSidebarEntry

Private Attributes
bool	allowPopout = true
bool	popped
ImVec2	poppedSize
ImVec2	poppedPos
float	windowHeight
float	windowWidth

Constructor & Destructor Documentation

Menu()

Ship::Menu::Menu	(	const std::string &	cVar,
		const std::string &	name,
		uint8_t	searchSidebarIndex_ = 0,
		UIWidgets::Colors	menuThemeIndex_ = UIWidgets::Colors::LightBlue )

Here is the caller graph for this function:

~Menu()

virtual Ship::Menu::~Menu ( )

inlinevirtual

Member Function Documentation

AddMenuEntry()

void Ship::Menu::AddMenuEntry	(	std::string	entryName,
		const char *	entryCvar )

Here is the caller graph for this function:

Draw()

void Ship::Menu::Draw ( )

override

Here is the call graph for this function:

Here is the caller graph for this function:

DrawElement()

void Ship::Menu::DrawElement ( )

override

Here is the call graph for this function:

Here is the caller graph for this function:

DrawSearchResults()

uint32_t Ship::Menu::DrawSearchResults ( std::string & menuSearchText )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

GetDisabledMap()

std::unordered_map< uint32_t, disabledInfo > & Ship::Menu::GetDisabledMap

(

)

InitElement()

void Ship::Menu::InitElement ( )

override

Here is the call graph for this function:

Here is the caller graph for this function:

InsertSidebarSearch()

void Ship::Menu::InsertSidebarSearch

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

MenuDrawItem()

void Ship::Menu::MenuDrawItem	(	WidgetInfo &	widget,
		uint32_t	width,
		UIWidgets::Colors	menuThemeIndex )

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessReset()

virtual void Ship::Menu::ProcessReset ( )

inlineprotectedvirtual

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveSidebarSearch()

void Ship::Menu::RemoveSidebarSearch

(

)

Here is the call graph for this function:

UpdateElement()

void Ship::Menu::UpdateElement ( )

override

Here is the caller graph for this function:

UpdateWindowBackendObjects()

void Ship::Menu::UpdateWindowBackendObjects

(

)

Here is the caller graph for this function:

Field Documentation

allowPopout

bool Ship::Menu::allowPopout = true

private

availableWindowBackends

std::shared_ptr<std::vector<Ship::WindowBackend> > Ship::Menu::availableWindowBackends

protected

availableWindowBackendsMap

std::unordered_map<Ship::WindowBackend, const char*> Ship::Menu::availableWindowBackendsMap

protected

configWindowBackend

Ship::WindowBackend Ship::Menu::configWindowBackend

protected

defaultThemeIndex

UIWidgets::Colors Ship::Menu::defaultThemeIndex

protected

disabledMap

std::unordered_map<uint32_t, disabledInfo> Ship::Menu::disabledMap

protected

disabledVector

std::vector<disabledInfo> Ship::Menu::disabledVector

protected

menuEntries

std::unordered_map<std::string, MainMenuEntry> Ship::Menu::menuEntries

protected

menuOrder

std::vector<std::string> Ship::Menu::menuOrder

protected

menuSearch

ImGuiTextFilter Ship::Menu::menuSearch

protected

mName

std::string Ship::Menu::mName

protected

mOriginalSize

ImVec2 Ship::Menu::mOriginalSize

protected

mWindowFlags

uint32_t Ship::Menu::mWindowFlags

protected

popped

bool Ship::Menu::popped

private

poppedPos

ImVec2 Ship::Menu::poppedPos

private

poppedSize

ImVec2 Ship::Menu::poppedSize

private

searchSidebarEntry

const SidebarEntry Ship::Menu::searchSidebarEntry

protected

Initial value:

= {
        .columnCount = 1,
        .columnWidgets = { { { .name = "Sidebar Search",
                               .type = WIDGET_SEARCH,
                               .options = std::make_shared<UIWidgets::WidgetOptions>(UIWidgets::WidgetOptions{}.Tooltip(
                                   "Searches all menus for the given text, including tooltips.")) } } }
    }

searchSidebarIndex

uint8_t Ship::Menu::searchSidebarIndex

protected

windowHeight

float Ship::Menu::windowHeight

private

windowWidth

float Ship::Menu::windowWidth

private

---

The documentation for this class was generated from the following files:

• src/port/ui/Menu.h
• src/port/ui/Menu.cpp