WidgetOptions Class Reference

#include <WidgetOptions.h>

Collaboration diagram for WidgetOptions:

Public Types
enum	WidgetMode { e_desktop , e_tablet , e_mobile , e_size }

Static Public Member Functions
static bool	IsTouchOptimized ()
static bool	IsFieldMode ()
static void	SetFieldMode (bool field_mode)
static WidgetMode	DefaultSystemWidgetMode ()
static void	ResetOptionsToDefaults ()

Static Public Attributes
static ApplicationOption< fltp08 >	ui_scale
static ApplicationOption< fltp08 >	font_scale
static ApplicationOption< fltp08 >	animation_scale
static Resource< fltp08 >	animation_quality
static ApplicationOption< bool >	global_allow_docking
static ApplicationOption< bool >	field_mode_fullscreen
static ApplicationOption< bool >	allow_windowable_windows
static ApplicationOption< Vector< WidgetMode::e_size, bool > >	field_mode
static ApplicationOption< WidgetMode >	widget_mode
static Resource< QWidget * >	new_window_parent
static std::function< bool(QWidget *widget, const PopupInfo &start, const PopupInfo &end)>	show_widget_function
static std::function< void(QWidget *widget, const PopupInfo &info)>	hide_widget_function
static std::function< void(bool relaunch, const PopupInfo &info)>	request_exit_function
static KeyEvent::KEY	unhandled_key = KeyEvent::KEY::VK_UNSPECIFIED
	The key event sent when the OS sends a key not recognized by the software.
static Resource< ProgressInfo * >	ui_log
	The default log for all UI events.
static TranslatedString	options_label = _t("Widget Settings")

Detailed Description

---

struct: WidgetOptions

Stores the options, added to the user settings, that control Widgets and low level UI options in the application. All options retained across application restart

Author: Tyler Parke

Date: 2023-01-16

Member Enumeration Documentation

WidgetMode

enum WidgetMode

Enumerator
e_desktop	UI layout, size, and workflow optimized for traditional desktop computers.
e_tablet
e_mobile	UI layout, size, and workflow optimized for mobile phones.
e_size

Member Function Documentation

DefaultSystemWidgetMode()

WidgetOptions::WidgetMode DefaultSystemWidgetMode ( )

static

IsFieldMode()

bool IsFieldMode ( )

static

IsTouchOptimized()

bool IsTouchOptimized ( )

static

ResetOptionsToDefaults()

void ResetOptionsToDefaults ( )

static

SetFieldMode()

void SetFieldMode ( bool field_mode )

static

Member Data Documentation

allow_windowable_windows

ApplicationOption< bool > allow_windowable_windows

static

animation_quality

Resource< fltp08 > animation_quality

static

animation_scale

ApplicationOption< fltp08 > animation_scale

static

field_mode

ApplicationOption< Vector< 3, bool > > field_mode

static

field_mode_fullscreen

ApplicationOption< bool > field_mode_fullscreen

static

font_scale

ApplicationOption< fltp08 > font_scale

static

global_allow_docking

ApplicationOption< bool > global_allow_docking

static

hide_widget_function

std::function< void(QWidget *widget, const PopupInfo &start_location)> hide_widget_function

static

new_window_parent

Resource< QWidget * > new_window_parent

static

options_label

TranslatedString options_label = _t("Widget Settings")

static

request_exit_function

std::function< void(bool relaunch, const PopupInfo &info)> request_exit_function

static

show_widget_function

std::function< bool(QWidget *widget, const PopupInfo &start_location, const PopupInfo &end_location)> show_widget_function

static

ui_log

Resource< ProgressInfo * > ui_log

static

The default log for all UI events.

ui_scale

ApplicationOption< fltp08 > ui_scale

static

unhandled_key

KeyEvent::KEY unhandled_key = KeyEvent::KEY::VK_UNSPECIFIED

static

The key event sent when the OS sends a key not recognized by the software.

widget_mode

ApplicationOption< WidgetOptions::WidgetMode > widget_mode

static

---

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

• Widgets/Headers/WidgetOptions.h
• Widgets/Source/WidgetOptions.cpp