An undecorated window that is transient by nature. More...

#include <PopupWindow.h>

Inheritance diagram for rose::Popup:

Collaboration diagram for rose::Popup:

Public Member Functions
	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...

virtual void	createActionButton (const DialogActionButton &dialogActionButton)
	Create a DialogActionButton on derivatives of Popup that support them. More...

virtual void	setButtonSlot (shared_ptr< Slot< Button::SignalType >> &buttonSlot, bool dismissAll)
	See Widget::setButtonSlot() 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.

virtual void	addedToContainer ()
	Called when a Node is added to a Container. More...

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

Protected Attributes
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 {}

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::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"

Detailed Description

An undecorated window that is transient by nature.

Constructor & Destructor Documentation

◆ Popup() [1/3]

rose::Popup::Popup ( const shared_ptr< Rose > & parent )

explicit

Construct a Popup which covers the entire screen or as determined by the size of its children.

Parameters

parent the Rose application object.

◆ Popup() [2/3]

rose::Popup::Popup	(	const 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 Position.

◆ Popup() [3/3]

rose::Popup::Popup	(	const shared_ptr< Rose > &	parent,
		const Position &	pos,
		const Size &	minimumSize
	)

Construct a Window of specified position and size.

Parameters

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

Member Function Documentation

◆ addChild()

void rose::Popup::addChild ( const std::shared_ptr< Widget > & widget )

inlineoverride

Add a child Widget to the container that will be managing children.

Parameters

widget The new child Widget.

◆ createActionButton()

virtual void rose::Popup::createActionButton ( const DialogActionButton & dialogActionButton )

inlinevirtual

Create a DialogActionButton on derivatives of Popup that support them.

The default is to do nothing.

Parameters

dialogActionButton The data structure that describes the button.

Reimplemented in rose::Dialog.

◆ setActionButtons()

template<class C >

void rose::Popup::setActionButtons ( C actionButtonList )

inline

Create the DialogActionButton objects.

Iterate through actionButtonList calling the virtual function createActionButton for each item.

Template Parameters

C	The type of container with DialogActionButton data.

Parameters

actionButtonList The DialogActionButton container

◆ setButtonSlot()

virtual void rose::Popup::setButtonSlot	(	shared_ptr< Slot< Button::SignalType >> &	buttonSlot,
		bool	dismissAll
	)

inlinevirtual

See Widget::setButtonSlot()

If buttons have been created, they are disconnected from all slots before being connected to buttonSlot.

Parameters

buttonSlot

Reimplemented in rose::Dialog.

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

src0/PopupWindow.h
src0/PopupWindow.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Popup() [1/3]

◆ Popup() [2/3]

◆ Popup() [3/3]

Member Function Documentation

◆ addChild()

◆ createActionButton()

◆ setActionButtons()

◆ setButtonSlot()