NDEVRRibbonOptions

Public Types
enum	RibbonVisibleOption { e_visible , e_not_visible , e_default }
	Controls whether a ribbon element is visible, hidden, or uses the default behavior. More...

Public Member Functions
bool	showAbout () const
	Whether the about button should be shown.
bool	showColorTheme () const
	Whether the color theme toggle should be shown.
bool	showDrawActions () const
	Whether the draw actions ribbon tab should be shown.
bool	showEditActions () const
	Whether the edit actions ribbon tab should be shown.
bool	showExit () const
	Whether the exit button should be shown.
bool	showFileActions () const
	Whether the file actions ribbon section should be shown.
bool	showHomeGeneral () const
	Whether the home/general ribbon section should be shown.
bool	showLayers () const
	Whether the layers section should be shown.
bool	showLog () const
	Whether the log button should be shown.
bool	showMainButton () const
	Whether the main icon button should be shown.
bool	showMeasureActions () const
	Whether the measure actions ribbon tab should be shown.
bool	showProjectBrowser () const
	Whether the project browser button should be shown.
bool	showSave () const
	Whether the save button should be shown.
bool	showSaveAs () const
	Whether the save-as button should be shown.
bool	showViewActions () const
	Whether the view actions ribbon tab should be shown.
bool	showWidgetMode () const
	Whether the widget mode toggle should be shown.
bool	showWifi () const
	Whether the wifi button should be shown.

Static Public Member Functions
static bool	ShouldShow (RibbonVisibleOption option, bool default_option)
	Determines whether a ribbon element should be shown given its option and the default.

Public Attributes
RibbonVisibleOption	about_visible = RibbonVisibleOption::e_default
	Whether or not to show the about button with application information.
RibbonVisibleOption	draw_actions_visible = RibbonVisibleOption::e_default
	Whether or not to show draw actions tab (Note that draw functionality must be enabled).
RibbonVisibleOption	edit_actions_visible = RibbonVisibleOption::e_default
	Whether or not to show draw edit actions tab (Note that draw functionality must be enabled).
RibbonVisibleOption	exit_visible = RibbonVisibleOption::e_default
	Whether or not to show the close/exit button.
RibbonVisibleOption	file_actions_visible = RibbonVisibleOption::e_default
	Whether or not to show file settings on the home tab.
RibbonVisibleOption	home_general_visible = RibbonVisibleOption::e_default
	Whether or not to show general settings on the home tab.
RibbonVisibleOption	layers_visible = RibbonVisibleOption::e_default
	Whether or not to show layers (Note that layers functionality must be enabled).
RibbonVisibleOption	light_theme_visible = RibbonVisibleOption::e_default
	Whether or not to show the color theme button.
RibbonVisibleOption	log_visible = RibbonVisibleOption::e_default
	Whether or not to show the log button for application logs.
RibbonVisibleOption	main_button_visible = RibbonVisibleOption::e_default
	Whether or not to show the rounded main button on the far left.
RibbonVisibleOption	measure_actions_visible = RibbonVisibleOption::e_default
	Whether or not to show measurement actions tab (Note that measure functionality must be enabled).
RibbonVisibleOption	project_browser_visible = RibbonVisibleOption::e_default
	Whether or not to show the browse button for the native file browser.
RibbonVisibleOption	save_as_visible = RibbonVisibleOption::e_default
	Whether or not to show the save-as button.
RibbonVisibleOption	save_visible = RibbonVisibleOption::e_default
	Whether or not to show the save button.
RibbonVisibleOption	touch_theme_visible = RibbonVisibleOption::e_default
	Whether or not to show the touch theme button which changes the application mode.
RibbonVisibleOption	view_actions_visible = RibbonVisibleOption::e_not_visible
	Whether or not to show view actions tab which controls aspects of the UI.
RibbonVisibleOption	wifi_visible = RibbonVisibleOption::e_default
	Whether or not to show the wifi button.

Detailed Description

---

Struct: NDEVRRibbonOptions

The options for the Ribbon that typically appears on the top of the window or, in touch mode, to the side of the window. Controls the behavior of the ribbon

Author: Tyler Parke

Date: 2023-01-16

Definition at line 73 of file NDEVRRibbon.h.

Member Enumeration Documentation

RibbonVisibleOption

enum NDEVRRibbonOptions::RibbonVisibleOption

Controls whether a ribbon element is visible, hidden, or uses the default behavior.

Enumerator
e_visible	The element is always visible.
e_not_visible	The element is always hidden.
e_default	The element uses the default visibility based on application state.

Definition at line 78 of file NDEVRRibbon.h.

Member Function Documentation

ShouldShow()

bool NDEVRRibbonOptions::ShouldShow ( RibbonVisibleOption option, bool default_option )

static

Determines whether a ribbon element should be shown given its option and the default.

Parameters

[in]	option	The visibility option for the element.
[in]	default_option	The default visibility when option is e_default.

Returns

True if the element should be shown.

---

The documentation for this struct was generated from the following file:

• NDEVR/Headers/NDEVRRibbon.h