WidgetOptions Class Reference

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. More...

#include <WidgetOptions.h>

Collaboration diagram for WidgetOptions:

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

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

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

Detailed Description

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.

---

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()

static WidgetMode DefaultSystemWidgetMode ( )

static

IsFieldMode()

static bool IsFieldMode ( )

static

IsTouchOptimized()

static bool IsTouchOptimized ( )

static

ResetOptionsToDefaults()

static void ResetOptionsToDefaults ( )

static

SetFieldMode()

static 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<WidgetMode::e_size, 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& info)> hide_widget_function

static

new_window_parent

Resource<QWidget*> new_window_parent

static

options_label

TranslatedString options_label

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, const PopupInfo& end)> 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

static

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

widget_mode

ApplicationOption<WidgetMode> widget_mode

static

---

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

• Widgets/Headers/WidgetOptions.h