Enumerations
enum	rose::DataType : int { Unset, Char, Int, Real, String }
	Encode expected data types.

enum	rose::SignalTokenValues : uint32_t { rose::DialogOk, rose::DialogSave, rose::DialogCancel, rose::DialogClose, rose::ExitDialogOk, rose::ExitDialogCancel, rose::RadioUndetermined, rose::FirstUserSignalToken }
	These are the signal tokens used by built-in Widgets that transmit Signals with SignalTokens. More...

enum	rose::ActionButtonType { rose::ActionButtonOk, rose::ActionButtonCancel, rose::ActionButtonClose, rose::ActionButtonSave }
	Types of Dialog action buttons. More...

enum	rose::ButtonSetState : bool { rose::ButtonOff = false, rose::ButtonOn = true }
	A type alias for bool to set the button state. More...

enum	rose::ButtonType { rose::ButtonType::Label, rose::ButtonType::PushButton, rose::ToggleButton, rose::NormalButton, rose::CancelButton, rose::OkButton, rose::ToggleButton, rose::ToggleButton, rose::ToggleButton, rose::RadioButton, rose::TabButton, rose::MenuCascade }

enum	rose::CacheError : uint32_t { rose::CacheErrorNone = 0, rose::CacheErrorNotFound = 1, rose::CacheErrorWrite = 2, rose::CacheErrorRead = 3, rose::CacheErrorOffset = 10 }
	Error values return by the cache. More...

enum	rose::CascadeButtonType { rose::CascadeButtonType::Unset, rose::CascadeButtonType::CascadeDown, rose::CascadeButtonType::CascadeRight }
	The type of CascadeButton. More...

enum	rose::Gradient { rose::None, rose::Gradient::DarkToLight, rose::Gradient::LightToDark, rose::Gradient::GreenToRed, rose::Gradient::RedToGreen, rose::Gradient::GreenYellowRed, rose::Gradient::RedYellowGreen }

enum	rose::Modality { rose::NotModal, rose::Ephemeral, rose::Modal }
	The Modality of a transient Window, a Popup or derivative. More...

enum	rose::Manip { rose::Manip::Parent }
	Widget manipulators without arguments. More...

enum	rose::Orientation { Horizontal, Vertical, rose::Orientation::Unset, rose::Orientation::Horizontal, rose::Orientation::Vertical, rose::Orientation::Both }

enum	rose::RoseImageId : size_t { rose::RoseImageInvalid = 0, rose::IconCancel, rose::IconHelp, rose::IconInfo, rose::IconCheck, rose::IconAlert, rose::IconLock, rose::IconUpBold, rose::IconUpOpenBig, rose::IconLeft, rose::IconRight, rose::IconLeftDir, rose::IconRightDir, rose::IconUpDir, rose::IconDownDir, rose::IconToEnd, rose::IconBack, rose::IconLevelDown, IconLevelUp, rose::Icon1Dot, rose::Icon2Dots, rose::Icon3Dots, rose::IconKeyboard, rose::IconGlobe, rose::IconNetwork, rose::IconRocket, rose::IconLocation, rose::IconCompass, rose::IconCamera, ScaleNeedleUp, ScaleNeedleUp, ScaleNeedleDown, ScaleNeedleDown, ScaleNeedleLeft, ScaleNeedleLeft, ScaleNeedleRight, ScaleNeedleRight, IconTarget, IconTarget, IconTargetRed, IconTargetGreen, IconTargetYellow, rose::BevelOutRoundCorners, BevelOutRoundCorners, rose::BevelInRoundCorners, BevelInRoundCorners, rose::NotchOutRoundCorners, NotchOutRoundCorners, rose::NotchInRoundCorners, NotchInRoundCorners, rose::CenterRoundBaseColor, CenterRoundBaseColor, rose::CenterRoundInvertColor, CenterRoundInvertColor, rose::CenterRoundRedColor, CenterRoundRedColor, rose::CenterRoundGreenColor, CenterRoundGreenColor, rose::CenterRoundBlueColor, CenterRoundBlueColor, rose::CenterRoundYellowColor, CenterRoundYellowColor, rose::BevelOutSquareCorners, BevelOutSquareCorners, rose::BevelInSquareCorners, BevelInSquareCorners, rose::NotchOutSquareCorners, NotchOutSquareCorners, rose::NotchInSquareCorners, NotchInSquareCorners, rose::CenterSquareBaseColor, CenterSquareBaseColor, rose::CenterSquareInvertColor, CenterSquareInvertColor }
	Identifiers for Textures created by the Rose object and available from the Rose ImageRepository. More...

enum	rose::UseBorder { rose::None, rose::BevelOut, rose::BevelIn, rose::NotchOut, rose::NotchIn, rose::None, rose::None, rose::None, rose::None, rose::BevelOut, rose::BevelOut, rose::BevelOut, rose::BevelIn, rose::BevelIn, rose::BevelIn, rose::NotchOut, rose::NotchOut, rose::NotchOut, rose::NotchIn, rose::NotchIn, rose::NotchIn }

enum	rose::HorizontalAlignment { rose::HorizontalAlignment::Unset, rose::HorizontalAlignment::Center, rose::HorizontalAlignment::Left, rose::HorizontalAlignment::Right }
	Horizontal alignment values. More...

enum	rose::VerticalAlignment { rose::VerticalAlignment::Unset, rose::VerticalAlignment::Center, rose::VerticalAlignment::Top, rose::VerticalAlignment::Bottom }
	Vertical alignment values. More...

enum	rose::LabelHorizontalAlignment { rose::LabelHorizontalAlignment::Unset, rose::LabelHorizontalAlignment::Center, rose::LabelHorizontalAlignment::Left, rose::LabelHorizontalAlignment::Right }
	Label text horizontal alignment. More...

enum	rose::LabelVerticalAlignment { rose::LabelVerticalAlignment::Unset, rose::LabelVerticalAlignment::Center, rose::LabelVerticalAlignment::Top, rose::LabelVerticalAlignment::Bottom, rose::LabelVerticalAlignment::Baseline }

enum	rose::BorderStyle { rose::BorderStyle::Unset, rose::None, rose::BevelOut, rose::BevelIn, rose::NotchOut, rose::NotchIn, rose::BorderStyle::Unset, rose::BorderStyle::None, rose::BorderStyle::Bevel, rose::BorderStyle::BevelIn, rose::BorderStyle::Notch, rose::BorderStyle::TabTop, rose::BorderStyle::TabLeft, rose::BorderStyle::TabPage }

enum	rose::CornerStyle { rose::CornerStyle::Unset, rose::CornerStyle::Square, rose::CornerStyle::Round, rose::CornerStyle::Unset, rose::CornerStyle::Square, rose::CornerStyle::Round }

enum	rose::DrawBackground { rose::DrawBackground::Unset, rose::DrawBackground::None, rose::DrawBackground::Widget }
	Determine if the Widget should draw its own background, if supported. More...

enum	rose::WidgetSize { rose::VariableSize, rose::FixedSize }
	An enumeration to encode how a widget size should be dealt with by a managing container. More...

enum	rose::ButtonType { rose::ButtonType::Label, rose::ButtonType::PushButton, rose::ToggleButton, rose::NormalButton, rose::CancelButton, rose::OkButton, rose::ToggleButton, rose::ToggleButton, rose::ToggleButton, rose::RadioButton, rose::TabButton, rose::MenuCascade }
	The button type. More...

enum	rose::Orientation { Horizontal, Vertical, rose::Orientation::Unset, rose::Orientation::Horizontal, rose::Orientation::Vertical, rose::Orientation::Both }
	Possible values for Widget orientation. More...

enum	rose::UseBorder { rose::None, rose::BevelOut, rose::BevelIn, rose::NotchOut, rose::NotchIn, rose::None, rose::None, rose::None, rose::None, rose::BevelOut, rose::BevelOut, rose::BevelOut, rose::BevelIn, rose::BevelIn, rose::BevelIn, rose::NotchOut, rose::NotchOut, rose::NotchOut, rose::NotchIn, rose::NotchIn, rose::NotchIn }
	The type of border to draw. More...

enum	rose::BorderStyle { rose::BorderStyle::Unset, rose::None, rose::BevelOut, rose::BevelIn, rose::NotchOut, rose::NotchIn, rose::BorderStyle::Unset, rose::BorderStyle::None, rose::BorderStyle::Bevel, rose::BorderStyle::BevelIn, rose::BorderStyle::Notch, rose::BorderStyle::TabTop, rose::BorderStyle::TabLeft, rose::BorderStyle::TabPage }
	The types of border supported. More...

enum	rose::CornerStyle { rose::CornerStyle::Unset, rose::CornerStyle::Square, rose::CornerStyle::Round, rose::CornerStyle::Unset, rose::CornerStyle::Square, rose::CornerStyle::Round }
	Types of corners supported. More...

Functions
template<typename EnumClassType >
bool	rose::unset (EnumClassType value)
	Determine if an enumerated value is unset. More...

Detailed Description

Enumeration Type Documentation

◆ ActionButtonType

enum rose::ActionButtonType

Types of Dialog action buttons.

The ActionButtonType implies the Button badge and Label.

Enumerator
ActionButtonOk	Acknowledge the message or authorize the action described in the dialog.
ActionButtonCancel	Cancel the action described in the dialog.
ActionButtonClose	Close the dialog.
ActionButtonSave	Save changes made.

◆ BorderStyle [1/2]

enum rose::BorderStyle

strong

The types of border supported.

Enumerator
Unset	Not set to a valid value.
None	No border.
BevelOut	A beveled out border.
BevelIn	A beveled in border.
NotchOut	A notch out border.
NotchIn	A notch in border.
Unset	Not set to a valid value.
None	No border.
Bevel	A beveled out border.
BevelIn	A beveled in border.
Notch	A notch border.
TabTop	TabButton border, tabs on top.
TabLeft	TabButton border, tabs on left.
TabPage	TabPage border.

◆ BorderStyle [2/2]

enum rose::BorderStyle

strong

Enumerator
Unset	Not set to a valid value.
None	No border.
BevelOut	A beveled out border.
BevelIn	A beveled in border.
NotchOut	A notch out border.
NotchIn	A notch in border.
Unset	Not set to a valid value.
None	No border.
Bevel	A beveled out border.
BevelIn	A beveled in border.
Notch	A notch border.
TabTop	TabButton border, tabs on top.
TabLeft	TabButton border, tabs on left.
TabPage	TabPage border.

◆ ButtonSetState

enum rose::ButtonSetState : bool

A type alias for bool to set the button state.

Enumerator
ButtonOff	Button off.
ButtonOn	Button on.

◆ ButtonType [1/2]

enum rose::ButtonType

strong

The button type.

The action type of the button.

Determines how buttons respond to user interaction.

Enumerator
Label	A button without any button semantics but can be inverted and animated.
PushButton	When pressed and released signals an action.
ToggleButton	When pressed and released changes state from Active to Inactive or back.
NormalButton	A normal push button.
CancelButton	A normal button with a cancel badge.
OkButton	A normal button with a check badge.
ToggleButton	A toggle button.
ToggleButton	When pressed and released changes state from Active to Inactive or back.
ToggleButton	When pressed and released changes state from Active to Inactive or back.
RadioButton	A radio button.
TabButton	A Tab widget button.
MenuCascade	A Cascade Button, treated as a NormalButton.

◆ ButtonType [2/2]

enum rose::ButtonType

Enumerator
Label	A button without any button semantics but can be inverted and animated.
PushButton	When pressed and released signals an action.
ToggleButton	When pressed and released changes state from Active to Inactive or back.
NormalButton	A normal push button.
CancelButton	A normal button with a cancel badge.
OkButton	A normal button with a check badge.
ToggleButton	A toggle button.
ToggleButton	When pressed and released changes state from Active to Inactive or back.
ToggleButton	When pressed and released changes state from Active to Inactive or back.
RadioButton	A radio button.
TabButton	A Tab widget button.
MenuCascade	A Cascade Button, treated as a NormalButton.

◆ CacheError

enum rose::CacheError : uint32_t

Error values return by the cache.

Enumerator
CacheErrorNone	No error.
CacheErrorNotFound	Cache item not found.
CacheErrorWrite	Could not write to cache store.
CacheErrorRead	Could not read from cache store.
CacheErrorOffset	Offset for additional errors.

◆ CascadeButtonType

enum rose::CascadeButtonType

strong

The type of CascadeButton.

This determines the behaviour of the CascadeButton and associated menu.

Enumerator
Unset	Not set to a valid value.
CascadeDown	Post the associated menu below.
CascadeRight	Post the associated menu to the right.

◆ CornerStyle [1/2]

enum rose::CornerStyle

strong

Types of corners supported.

Enumerator
Unset	Not set to a valid value.
Square	Square corners.
Round	Round corners.
Unset	Not set to a valid value.
Square	Square corners.
Round	Round corners.

◆ CornerStyle [2/2]

enum rose::CornerStyle

strong

Enumerator
Unset	Not set to a valid value.
Square	Square corners.
Round	Round corners.
Unset	Not set to a valid value.
Square	Square corners.
Round	Round corners.

◆ DrawBackground

enum rose::DrawBackground

strong

Determine if the Widget should draw its own background, if supported.

Enumerator
Unset	Not set to a valid value.
None	Do not draw the background.
Widget	Draw the background.

◆ Gradient

enum rose::Gradient

strong

Enumerator
None	No background.
DarkToLight	Black at LowerBound, White at UpperBound.
LightToDark	White at LowerBound, Black at UpperBound.
GreenToRed	Green at LowerBound, Red at UpperBound.
RedToGreen	Red at LowerBound, Green at UpperBound.
GreenYellowRed	Green at LowerBound, through Yellow, to Red at UpperBound.
RedYellowGreen	Red at LowerBound, through Yellow, to Green at UpperBound.

◆ HorizontalAlignment

enum rose::HorizontalAlignment

strong

Horizontal alignment values.

Enumerator
Unset	Not set to a valid value.
Center	Center the aligned content horizontally.
Left	Left align the content.
Right	Right align the content.

◆ LabelHorizontalAlignment

enum rose::LabelHorizontalAlignment

strong

Label text horizontal alignment.

Enumerator
Unset	Not set to a valid value.
Center	Center align the label text horizontally.
Left	Left align the label text.
Right	Right align the label text.

◆ LabelVerticalAlignment

enum rose::LabelVerticalAlignment

strong

Enumerator
Unset	Not set to a valid value.
Center	Center align the label text.
Top	Top align the the label Text.
Bottom	Bottom align the label text.
Baseline	Allign the text with a common baseline.

◆ Manip

enum rose::Manip

strong

Widget manipulators without arguments.

Enumerator
Parent	Return the parent of the Widget.

◆ Modality

enum rose::Modality

The Modality of a transient Window, a Popup or derivative.

Enumerator
NotModal	Not modal, interactions with elements outside the container are allowed.
Ephemeral	Not modal, but interactions outside the container cause it to close.
Modal	Modal, no interactions outsie the container are allowed while it is open.

◆ Orientation [1/2]

enum rose::Orientation

strong

Possible values for Widget orientation.

Enumerator
Unset	Not set to a valid value.
Horizontal	Horizontal orientation.
Vertical	Vertical orientation.
Both	Both axis – for Elastic.

◆ Orientation [2/2]

enum rose::Orientation

strong

Enumerator
Unset	Not set to a valid value.
Horizontal	Horizontal orientation.
Vertical	Vertical orientation.
Both	Both axis – for Elastic.

◆ RoseImageId

enum rose::RoseImageId : size_t

Identifiers for Textures created by the Rose object and available from the Rose ImageRepository.

Enumerator
RoseImageInvalid	Invalid image ID.
IconCancel	Cancel the action, close a window, answer no, etc.
IconHelp	Provide help.
IconInfo	Provide information.
IconCheck	Approve the action, answer yes, etc.
IconAlert	Alert the user to an error, unusual or unexpected occurrence.
IconLock	Closed Lock Icon.
IconUpBold	Bold Up Arrow.
IconUpOpenBig	Up Chevron Big.
IconLeft	Left Arrow.
IconRight	Right Arrow.
IconLeftDir	Left facing Triangle.
IconRightDir	Right facing Triangle.
IconUpDir	Up facing Triangle.
IconDownDir	Down facing Triangle.
IconToEnd	Forward to end.
IconBack	Back.
IconLevelDown	Carriage Return.
Icon1Dot	One Dot.
Icon2Dots	Two Dots.
Icon3Dots	Three Dots.
IconKeyboard	Keyboard.
IconGlobe	Globe.
IconNetwork	Sphere with encircling lines.
IconRocket	Rocket ship.
IconLocation	POI Icon.
IconCompass	Compass.
IconCamera	Camera.
BevelOutRoundCorners	Sheet of round corners beveled out.
BevelInRoundCorners	Sheet of round corners beveled in.
NotchOutRoundCorners	Sheet of round corners notched out.
NotchInRoundCorners	Sheet of round corners notched in.
CenterRoundBaseColor	Center for the round corners in theme base color.
CenterRoundInvertColor	Center for the round corners in theme invert color.
CenterRoundRedColor	Center for the round corners in red hue.
CenterRoundGreenColor	Center for the round corners in green hue.
CenterRoundBlueColor	Center for the round corners in blue hue.
CenterRoundYellowColor	Center for the round corners in yellow hue.
BevelOutSquareCorners	Sheet of square corners beveled out.
BevelInSquareCorners	Sheet of square corners beveled in.
NotchOutSquareCorners	Sheet of square corners notched out.
NotchInSquareCorners	Sheet of square corners notched in.
CenterSquareBaseColor	Center for the square corners in theme base color.
CenterSquareInvertColor	Center for the square corners in theme invert color.

◆ SignalTokenValues

enum rose::SignalTokenValues : uint32_t

These are the signal tokens used by built-in Widgets that transmit Signals with SignalTokens.

Enumerator
DialogOk	General Dialog Ok Action Button.
DialogSave	Save data entered in the dialog.
DialogCancel	General Dialog Cancel Action Button.
DialogClose	Close the dialog.
ExitDialogOk	ExitDialog Ok ActionButton.
ExitDialogCancel	ExitDialog Cancel ActionButton.
RadioUndetermined	RadioBehavior state is undetermined.
FirstUserSignalToken	The value that can be used for the first SignalToken of a user application.

◆ UseBorder [1/2]

enum rose::UseBorder

The type of border to draw.

Enumerator
None	No border.
BevelOut	A beveled border that gives the illusion the frame stands up from the display.
BevelIn	A beveled border that gives the illusion the frame is sunk into the display.
NotchOut	A notched border that looks like a ridge surrounding the frame.
NotchIn	A notched border that looks like a trench surrounding the frame.
None	No border.
None	No border.
None	No border.
None	No background.
BevelOut	A beveled border that gives the illusion the frame stands up from the display.
BevelOut	A beveled out border.
BevelOut	A beveled out border.
BevelIn	A beveled border that gives the illusion the frame is sunk into the display.
BevelIn	A beveled in border.
BevelIn	A beveled in border.
NotchOut	A notched border that looks like a ridge surrounding the frame.
NotchOut	A notch out border.
NotchOut	A notch out border.
NotchIn	A notched border that looks like a trench surrounding the frame.
NotchIn	A notch in border.
NotchIn	A notch in border.

◆ UseBorder [2/2]

enum rose::UseBorder

Enumerator
None	No border.
BevelOut	A beveled border that gives the illusion the frame stands up from the display.
BevelIn	A beveled border that gives the illusion the frame is sunk into the display.
NotchOut	A notched border that looks like a ridge surrounding the frame.
NotchIn	A notched border that looks like a trench surrounding the frame.
None	No border.
None	No border.
None	No border.
None	No background.
BevelOut	A beveled border that gives the illusion the frame stands up from the display.
BevelOut	A beveled out border.
BevelOut	A beveled out border.
BevelIn	A beveled border that gives the illusion the frame is sunk into the display.
BevelIn	A beveled in border.
BevelIn	A beveled in border.
NotchOut	A notched border that looks like a ridge surrounding the frame.
NotchOut	A notch out border.
NotchOut	A notch out border.
NotchIn	A notched border that looks like a trench surrounding the frame.
NotchIn	A notch in border.
NotchIn	A notch in border.

◆ VerticalAlignment

enum rose::VerticalAlignment

strong

Vertical alignment values.

Enumerator
Unset	Not set to a valid value.
Center	Center the aligned content vertically.
Top	Top align the content.
Bottom	Bottom align the content.

◆ WidgetSize

enum rose::WidgetSize

An enumeration to encode how a widget size should be dealt with by a managing container.

Enumerator
VariableSize	The widget can vary in size.
FixedSize	The widget is fixed in size.

Function Documentation

◆ unset()

template<typename EnumClassType >

bool rose::unset ( EnumClassType value )

inline

Determine if an enumerated value is unset.

When a value is unset it may be set from the application theme defaults or a widget specific default action may be taken.

Template Parameters

EnumClassType The enumeration type

Parameters

value The enumerated value.

Returns: True if the value is "unset".

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ActionButtonType

◆ BorderStyle [1/2]

◆ BorderStyle [2/2]

◆ ButtonSetState

◆ ButtonType [1/2]

◆ ButtonType [2/2]

◆ CacheError

◆ CascadeButtonType

◆ CornerStyle [1/2]

◆ CornerStyle [2/2]

◆ DrawBackground

◆ Gradient

◆ HorizontalAlignment

◆ LabelHorizontalAlignment

◆ LabelVerticalAlignment

◆ Manip

◆ Modality

◆ Orientation [1/2]

◆ Orientation [2/2]

◆ RoseImageId

◆ SignalTokenValues

◆ UseBorder [1/2]

◆ UseBorder [2/2]

◆ VerticalAlignment

◆ WidgetSize

Function Documentation

◆ unset()