rose::UnsavedDialog Class Reference

A Dialog specialized to guard the exit path. More...

#include <PopupWindow.h>

Inheritance diagram for rose::UnsavedDialog:

Collaboration diagram for rose::UnsavedDialog:

Public Member Functions
	UnsavedDialog (UnsavedDialog &&)=delete
	UnsavedDialog (const UnsavedDialog &)=delete
UnsavedDialog &	operator= (UnsavedDialog &&)=delete
UnsavedDialog &	operator= (const UnsavedDialog &)=delete
	UnsavedDialog (shared_ptr< Rose > parent)
	Construct a PopupWindow which covers the entire screen. More...
	UnsavedDialog (shared_ptr< Rose > parent, const Position &position)
	Construct a Window of specified position. More...
	UnsavedDialog (shared_ptr< Rose > parent, const Position &pos, const Size &size)
	Construct a Window of specified position and size. More...
void	initializeComposite () override
	See Widget::initializeComposite()
Public Member Functions inherited from rose::Dialog
	Dialog (const PopupWindow &)=delete
	Dialog (PopupWindow &&)=delete
	Dialog (const Position< int > &position)
std::string_view	nodeId () const noexcept override
void	addedToContainer () override
	Called when a Node is added to a Container. More...
template<class WidgetClass >
void	addWidget (std::shared_ptr< WidgetClass > widget)
	Dialog (Dialog &&)=delete
	Dialog (const Dialog &)=delete
Dialog &	operator= (Dialog &&)=delete
Dialog &	operator= (const Dialog &)=delete
	Dialog (shared_ptr< Rose > parent)
	Construct a PopupWindow which covers the entire screen. More...
	Dialog (shared_ptr< Rose > parent, const Position &position)
	Construct a Window of specified position. More...
	Dialog (shared_ptr< Rose > parent, const Position &pos, const Size &size)
	Construct a Window of specified position and size. More...
void	initializeComposite () override
	See Widget::initializeComposite()
void	createActionButton (const DialogActionButton &dialogActionButton) override
	Create a DialogActionButton. More...
void	setButtonSlot (shared_ptr< Slot< Button::SignalType >> &buttonSlot, bool dismissAll) override
	See Widget::setButtonSlot() More...
Public Member Functions inherited from rose::PopupWindow
	PopupWindow (const PopupWindow &)=delete
	PopupWindow (PopupWindow &&)=delete
PopupWindow &	operator= (const PopupWindow &)=delete
PopupWindow &	operator= (PopupWindow &&)=delete
Rectangle	layout (gm::Context &context, const Rectangle &screenRect) override
	Layout the visual.
constexpr bool	removePopup () const noexcept
	PopupWindow (PopupWindow &&)=delete
	PopupWindow (const PopupWindow &)=delete
PopupWindow &	operator= (PopupWindow &&)=delete
PopupWindow &	operator= (const PopupWindow &)=delete
	PopupWindow (shared_ptr< Rose > parent)
	Construct a PopupWindow which covers the entire screen. More...
	PopupWindow (shared_ptr< Rose > parent, const Position &position)
	Construct a Window of specified position. More...
	PopupWindow (shared_ptr< Rose > parent, const Position &pos, const Size &size)
	Construct a Window of specified position and size. More...
void	initializeComposite () override
	See Widget::initializeComposite()
Rectangle	widgetLayout (sdl::Renderer &renderer, Rectangle available, uint layoutStage) override
void	setTitle (const std::string &text) override
	Set the value of the Window Title. More...
bool	mouseDragEvent (const Position &mousePos, const Position &rel, int button, int modifiers) override
	Handle a mouse drag event (default implementation: do nothing)
Public Member Functions inherited from rose::Popup
	Popup (Popup &&)=delete
	Popup (const Popup &)=delete
Popup &	operator= (Popup &&)=delete
Popup &	operator= (const Popup &)=delete
	Popup (const shared_ptr< Rose > &parent)
	Construct a Popup which covers the entire screen or as determined by the size of its children. More...
	Popup (const shared_ptr< Rose > &parent, const Position &position)
	Construct a Window of specified position. More...
	Popup (const shared_ptr< Rose > &parent, const Position &pos, const Size &minimumSize)
	Construct a Window of specified position and size. More...
void	initializeComposite () override
	See Widget::initializeComposite()
Rectangle	widgetLayout (sdl::Renderer &renderer, Rectangle available, uint layoutStage) override
	See Widget::widgetLayout()
void	draw (sdl::Renderer &renderer, Rectangle parentRect) override
	See Widget::draw()
void	addChild (const std::shared_ptr< Widget > &widget) override
	Add a child Widget to the container that will be managing children. More...
template<class C >
void	setActionButtons (C actionButtonList)
	Create the DialogActionButton objects. More...
Public Member Functions inherited from rose::Window
std::string_view	nodeId () const noexcept override
bool	isModal () const
void	add (const std::shared_ptr< Node > &node) override
	Add a Manager to the Window. More...
void	draw (gm::Context &context, const Position< int > &containerPosition) override
	Draw the contents of the Window.
bool	baseTextureNeeded (const Position< int > &containerPosition)
void	generateBaseTexture (gm::Context &context, const Position< int > &containerPosition)
	Create a Texture for the Window that can be drawn over by animations. More...
void	drawBaseTexture (gm::Context &context, const Position< int > &containerPosition)
	Draw the base texture for the window. More...
Rectangle	layout (gm::Context &context, const Rectangle &screenRect) override
	Layout the contents of the Window.
std::shared_ptr< Widget >	pointerWidget (const Position< int > &position)
	The the Widget which contains the Position.
std::shared_ptr< Screen >	getScreen ()
	Get the Screen which supports the Window.
std::shared_ptr< Screen >	getScreen () const
	Get the Screen which support the const Window.
Public Member Functions inherited from rose::Visual
void	setScreenRectangle (const Position< int > &containerPosition)
	Compute the screen rectangle from the Container screen Position. More...
Rectangle	getScreenRectangle (const Position< int > &containerPosition) const
	Get the rectangle occupied by the Visual. More...
Position< int >	drawPadding (const Position< int > &containerPosition)
	Pad the drawing location.
Rectangle	layoutPadding (const Rectangle &screenRect)
	Pad the layout.
void	setSize (const Size &size)
	Set preferred Size.
Size	getSize () const
	Get the preferred size.
void	setPosition (const Position< int > &position)
	Set preferred Position.
Position< int >	getPosition () const
	Get the preferred Position.
void	setPadding (const Padding &padding)
	Set Padding.
void	setScreenRectangle (const Rectangle &screenRect)
	Set Screen Rectangle.
constexpr bool	isVisible () const noexcept
	Check visibility.
void	setVisible (bool visible) noexcept
	Set visibility.
void	setLayoutHint (const LayoutHint &hint)
	Add a LayoutHint.
std::optional< int >	getAttachmentHint (LayoutHint::Attachment attachment)
	Get an AttachmentHint value given a LayoutHint::Attachment. More...
std::optional< int >	getGridHint (LayoutHint::GridLayoutHint gridLayoutHint)
	Get a GridLayoutHint value given a LayoutHint::GridLayoutHint. More...
template<size_t HintClass>
std::optional< const ValueMap >	getHintMap () const
SemanticGesture	supportedSemanticGestures () const
	Get supported SemanticGestures.
Public Member Functions inherited from rose::Container
void	remove (const std::shared_ptr< Node > &node)
Public Member Functions inherited from rose::Node
	Node (const std::shared_ptr< Container > &container)
	Create a node and add it to a Container. More...
void	setId (const Id &nodeId) noexcept
	Set Id.
std::string_view	getId () const
	Get Id.
IdPath	getIdPath () const
	Get the Id Path.
std::shared_ptr< Container >	container ()
std::shared_ptr< Container >	container () const
template<typename C >
std::shared_ptr< C >	containerAs ()
template<typename C >
std::shared_ptr< C >	containerAs () const
std::shared_ptr< const Node >	getNode () const
	Get a const std::shared_ptr to this node. More...
std::shared_ptr< Node >	getNode ()
	Get a std::shared_ptr to this node. More...
template<typename NodeType >
std::shared_ptr< const Node >	getNode () const
	Get a std::shared_ptr<const NodeType> to this node. More...
template<typename NodeType >
std::shared_ptr< NodeType >	getNode ()
	Get a std::shared_ptr<NodeType> to this node. More...
std::shared_ptr< Node >	remove ()

Static Protected Attributes
static constexpr std::string_view	mTitle = "Discard Changes?"
static constexpr std::string_view	mMessage = "You have unsaved changes, discard them?"
static constexpr std::array< DialogActionButton, 2 >	mActionButtons

Additional Inherited Members
Public Types inherited from rose::Visual
using	ValueMap = std::map< int, int >
	The std::map type for each hint class.
Public Types inherited from rose::Node
using	NodePtr = std::shared_ptr< Node >
Static Public Member Functions inherited from rose::Node
template<typename NodeType >
static std::shared_ptr< NodeType >	create ()
	Create a Node with no arguments. More...
template<typename NodeType , typename ... Args>
static std::shared_ptr< NodeType >	create (Args ... args)
	Create a Node with arguments. More...
template<typename NodeType , typename ContainerType , typename ... Args>
static std::shared_ptr< NodeType >	add (ContainerType container, Args ... args)
	Create a Node with arguments and add to a Container. More...
Public Attributes inherited from rose::Visual
std::map< size_t, ValueMap >	mHintsMap {}
	The std::map of hint class to ValueMap.
Static Public Attributes inherited from rose::Dialog
static constexpr std::string_view	id = "Dialog"
Static Public Attributes inherited from rose::PopupWindow
static constexpr std::string_view	id = "PopupWindow"
Static Public Attributes inherited from rose::Window
static constexpr std::string_view	id = "Window"
Static Public Attributes inherited from rose::Container
static constexpr std::string_view	id = "Container"
Static Public Attributes inherited from rose::Node
static constexpr std::string_view	id = "Node"
Protected Attributes inherited from rose::Dialog
ImageId	mBadgeId {}
	The ImageId of the Dialog badge.
std::shared_ptr< Row >	mMessageRow
	The area where the Dialog badge and message are held.
std::shared_ptr< Row >	mButtonRow
	The area where the Dialog ActionButtons are held.
Protected Attributes inherited from rose::PopupWindow
std::shared_ptr< Frame >	mContentFrame {}
bool	mRemovePopup {false}
std::string	mWindowTitle {}
	The title of the window.
std::shared_ptr< Label >	mTitle
	The Window Title Label.
Protected Attributes inherited from rose::Popup
Size	mMinimumSize
	The minimum size requests for the popup if supported by derived types.
std::shared_ptr< Frame >	mFrame
	The Window Frame.
std::shared_ptr< Column >	mColumn
	A container for the Window Title gadget and the window Container.
std::shared_ptr< Slot< Button::SignalType > >	mActionButtonRx {}
	The slot to receive action button signals.
std::shared_ptr< Slot< Button::SignalType > >	mDismissButtonRx {}
	The slot to close the menu.
Protected Attributes inherited from rose::Window
bool	mModalWindow {}
gm::Texture	mBaseTexture {}
	The base texture which animations draw over.
Protected Attributes inherited from rose::Visual
SemanticGesture	mSemanticGesture {}
Position< int >	mPos {}
	Position relative to the container, arrived at by layout.
Size	mSize {}
	The size on screen, arrived at by layout.
Position< int >	mPreferredPos {}
	The preferred position.
Size	mPreferredSize {}
	The preferred size.
Rectangle	mScreenRect {}
	The screen Rectangle computed at drawing time.
Padding	mPadding {}
	Immediately around the Visual, used for separation and alignment.
State	mState {}
	The object state Id string.
bool	mVisible {true}
	If true the object is visible.
Protected Attributes inherited from rose::Node
std::weak_ptr< Container >	mContainer {}
	The Container that holds the Node. More...
Id	mId {}

Detailed Description

A Dialog specialized to guard the exit path.

Constructor & Destructor Documentation

UnsavedDialog() [1/3]

rose::UnsavedDialog::UnsavedDialog ( shared_ptr< Rose >  parent )

explicit

Construct a PopupWindow which covers the entire screen.

Parameters

parent

the Rose application object.

UnsavedDialog() [2/3]

rose::UnsavedDialog::UnsavedDialog	(	shared_ptr< Rose >	parent,
		const Position &	position
	)

Construct a Window of specified position.

The position is clamped to be inside the screen.

Parameters

parent	the Rose application object.
position	the Window size.

UnsavedDialog() [3/3]

rose::UnsavedDialog::UnsavedDialog	(	shared_ptr< Rose >	parent,
		const Position &	pos,
		const Size &	size
	)

Construct a Window of specified position and size.

Parameters

parent	the Rose application object.
pos	the Window position
size	the Window size.

Member Data Documentation

mActionButtons

constexpr std::array<DialogActionButton,2> rose::UnsavedDialog::mActionButtons

staticprotected

Initial value:

= {
                DialogActionButton{ActionButtonOk, DialogOk },
                DialogActionButton{ActionButtonCancel, DialogCancel }
        }

---

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

• src0/PopupWindow.h
• src0/PopupWindow.cpp