QskPopup

Inherits from QskControl, QskQuickItem, QskSkinnable, QQuickItem

Public Types

	Name
enum	PopupFlag { DeleteOnClose = 1 « 0, CloseOnPressOutside = 1 « 1}

Public Slots

	Name
void	open()
void	close()
void	setOpen(bool on)

Public Signals

	Name
void	opened()
void	closed()
void	openChanged(bool )
void	fadingChanged(bool )
void	modalChanged(bool )
void	overlayChanged(bool )
void	priorityChanged(uint )
void	faderEffectChanged(bool )

Public Functions

	Name
	QskPopup(QQuickItem * parent =nullptr)
	~QskPopup() override
void	setPopupFlags(PopupFlags flags)
PopupFlags	popupFlags() const
void	setPopupFlag(PopupFlag flag, bool on =true)
bool	testPopupFlag(PopupFlag flag) const
void	setModal(bool on =true)
bool	isModal() const
void	setOverlay(bool on =true)
void	resetOverlay()
bool	hasOverlay() const
void	setPriority(uint priority)
uint	priority() const
void	setFaderEffect(bool on)
bool	hasFaderEffect() const
QskAspect	faderAspect() const
void	setFaderAspect(QskAspect aspect)
virtual QRectF	overlayRect() const
bool	isOpen() const
bool	isFading() const

Protected Functions

	Name
void	aboutToShow() override
bool	event(QEvent * event) override
void	focusInEvent(QFocusEvent * event) override
void	focusOutEvent(QFocusEvent * event) override
void	windowChangeEvent(QskWindowChangeEvent * event) override
void	itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData & value) override
virtual QQuickItem *	focusSuccessor() const
bool	isTransitionAccepted(QskAspect aspect) const override
void	grabFocus(bool on)

Public Properties

	Name
bool	open
bool	modal
bool	overlay
bool	faderEffect
uint	priority

Public Attributes

	Name
const QskAspect::Subcontrol	Overlay
const QskAspect::State	Closed

Additional inherited members

Public Types inherited from QskControl

	Name
enum	LayoutHint { RetainSizeWhenHidden, LayoutWhenHidden}

Public Slots inherited from QskControl

	Name
void	setLocale(const QLocale & locale)

Public Signals inherited from QskControl

	Name
void	backgroundChanged()
void	marginsChanged(const QMarginsF & )
void	focusIndicatorRectChanged()
void	localeChanged(const QLocale & )
void	focusPolicyChanged()
void	wheelEnabledChanged()

Public Functions inherited from QskControl

	Name
	QskControl(QQuickItem * parent =nullptr)
	~QskControl() override
void	setMargins(qreal margin)
void	setMargins(qreal left, qreal top, qreal right, qreal bottom)
void	setMargins(const QMarginsF & margins)
void	resetMargins()
QMarginsF	margins() const
void	setBackgroundColor(const QColor & color)
void	setBackground(const QskGradient & gradient)
void	resetBackground()
QskGradient	background() const
QRectF	contentsRect() const
QRectF	layoutRect() const
virtual QRectF	layoutRectForSize(const QSizeF & size) const
virtual QRectF	gestureRect() const
virtual QRectF	focusIndicatorRect() const
virtual QRectF	focusIndicatorClipRect() const
QRectF	subControlRect(QskAspect::Subcontrol subControl) const
QRectF	subControlRect(const QSizeF & size, QskAspect::Subcontrol subControl) const
QRectF	subControlContentsRect(QskAspect::Subcontrol subControl) const
QRectF	subControlContentsRect(const QSizeF & size, QskAspect::Subcontrol subControl) const
void	setAutoFillBackground(bool on)
bool	autoFillBackground() const
void	setAutoLayoutChildren(bool on)
bool	autoLayoutChildren() const
void	setWheelEnabled(bool on)
bool	isWheelEnabled() const
void	setFocusPolicy(Qt::FocusPolicy policy)
Qt::FocusPolicy	focusPolicy() const
void	setSizePolicy(QskSizePolicy::Policy horizontalPolicy, QskSizePolicy::Policy verticalPolicy)
void	setSizePolicy(QskSizePolicy policy)
void	setSizePolicy(Qt::Orientation orientation, QskSizePolicy::Policy policy)
QskSizePolicy	sizePolicy() const
QskSizePolicy::Policy	sizePolicy(Qt::Orientation orientation) const
void	setLayoutAlignmentHint(Qt::Alignment alignment)
Qt::Alignment	layoutAlignmentHint() const
void	setLayoutHint(LayoutHint flag, bool on =true)
bool	testLayoutHint(LayoutHint hint) const
void	setLayoutHints(LayoutHints hints)
LayoutHints	layoutHints() const
bool	isVisibleToLayout() const
void	setMinimumSize(const QSizeF & size)
void	setMinimumSize(qreal width, qreal height)
void	setMinimumWidth(qreal width)
void	setMinimumHeight(qreal height)
void	setMaximumSize(const QSizeF & size)
void	setMaximumSize(qreal width, qreal height)
void	setMaximumWidth(qreal width)
void	setMaximumHeight(qreal height)
void	setPreferredSize(const QSizeF & size)
void	setPreferredSize(qreal width, qreal height)
void	setPreferredWidth(qreal width)
void	setPreferredHeight(qreal height)
void	setFixedSize(const QSizeF & size)
void	setFixedSize(qreal width, qreal height)
void	setFixedWidth(qreal width)
void	setFixedHeight(qreal height)
void	setExplicitSizeHint(Qt::SizeHint whichHint, const QSizeF & size)
void	setExplicitSizeHint(Qt::SizeHint whichHint, qreal width, qreal height)
void	resetExplicitSizeHint(Qt::SizeHint whichHint)
QSizeF	minimumSize() const
QSizeF	maximumSize() const
QSizeF	preferredSize() const
QSizeF	explicitSizeHint(Qt::SizeHint whichHint) const
QSizeF	implicitSizeHint(Qt::SizeHint whichHint, const QSizeF & constraint) const
QSizeF	sizeHint() const
qreal	heightForWidth(qreal width) const
qreal	widthForHeight(qreal height) const
QSizeF	effectiveSizeHint(Qt::SizeHint which, const QSizeF & constraint =QSizeF()) const
QSizeF	sizeConstraint(Qt::SizeHint which, const QSizeF & constraint =QSizeF()) const
QSizeF	sizeConstraint() const
QLocale	locale() const
void	resetLocale()
QVector< QskAspect::Subcontrol >	subControls() const
QRectF	subControlRect(const QRectF & , QskAspect::Subcontrol ) Calculate position and size of a subControl.
QRectF	subControlContentsRect(const QRectF & , QskAspect::Subcontrol ) Calculate the inner rectangle for subControl.

Protected Functions inherited from QskControl

	Name
virtual void	gestureEvent(QskGestureEvent * )
void	hoverEnterEvent(QHoverEvent * event) override
void	hoverLeaveEvent(QHoverEvent * event) override
bool	childMouseEventFilter(QQuickItem * item, QEvent * event) override
virtual bool	gestureFilter(QQuickItem * , QEvent * )
void	geometryChange(const QRectF & newGeometry, const QRectF & oldGeometry) override
void	initSizePolicy(QskSizePolicy::Policy horizontalPolicy, QskSizePolicy::Policy verticalPolicy)
virtual void	updateResources()
virtual void	updateLayout()
virtual QSizeF	contentsSizeHint(Qt::SizeHint which, const QSizeF & constraint) const
virtual QSizeF	layoutSizeHint(Qt::SizeHint which, const QSizeF & constraint) const

Public Properties inherited from QskControl

	Name
QLocale	locale
bool	autoFillBackground
bool	autoLayoutChildren
Qt::FocusPolicy	focusPolicy
bool	wheelEnabled
bool	visibleToLayout
QskMargins	margins
QskGradient	background
QskSizePolicy	sizePolicy
QSizeF	minimumSize
QSizeF	maximumSize
QSizeF	preferredSize
QSizeF	sizeConstraint

Public Attributes inherited from QskControl

	Name
const QskAspect::State	Disabled
const QskAspect::State	Hovered
const QskAspect::State	Focused

Public Types inherited from QskQuickItem

	Name
enum	UpdateFlag { DeferredUpdate, DeferredPolish, DeferredLayout, CleanupOnVisibility, PreferRasterForTextures, DebugForceBackground}

Public Slots inherited from QskQuickItem

	Name
void	setGeometry(const QRectF & rect)
void	setHidden(bool on)
void	setDisabled(bool on)
void	resetImplicitSize()

Public Signals inherited from QskQuickItem

	Name
void	itemFlagsChanged()
void	updateFlagsChanged(UpdateFlags )

Public Functions inherited from QskQuickItem

	Name
	~QskQuickItem() override
const char *	className() const
bool	isVisibleTo(const QQuickItem * ancestor) const
bool	isVisibleToParent() const
bool	hasChildItems() const
QRectF	rect() const
QSizeF	implicitSize() const
void	setGeometry(qreal x, qreal y, qreal width, qreal height)
void	setGeometry(const QPointF & pos, const QSizeF & size)
QRectF	geometry() const
void	setPosition(qreal x, qreal y)
void	setSize(qreal width, qreal height)
void	setPolishOnResize(bool on)
bool	polishOnResize() const
void	setTransparentForPositioner(bool on)
bool	isTransparentForPositioner() const
void	setTabFence(bool on)
bool	isTabFence() const
void	setLayoutMirroring(bool on, bool childrenInherit =false)
void	resetLayoutMirroring()
bool	layoutMirroring() const
void	resetUpdateFlags()
UpdateFlags	updateFlags() const
Q_INVOKABLE void	setUpdateFlag(UpdateFlag flag, bool on =true)
Q_INVOKABLE void	resetUpdateFlag(UpdateFlag flag)
Q_INVOKABLE bool	testUpdateFlag(UpdateFlag flag) const
void	classBegin() override
void	componentComplete() override
void	releaseResources() override
bool	isPolishScheduled() const
bool	isUpdateNodeScheduled() const
bool	isInitiallyPainted() const
bool	maybeUnresized() const

Protected Functions inherited from QskQuickItem

	Name
	QskQuickItem(QskQuickItemPrivate & dd, QQuickItem * parent =nullptr)
virtual void	changeEvent(QEvent * )
virtual void	geometryChangeEvent(QskGeometryChangeEvent * )
void	mouseUngrabEvent() override
void	touchUngrabEvent() override
void	geometryChange(const QRectF & newGeometry, const QRectF & oldGeometry) override

Public Properties inherited from QskQuickItem

	Name
QRectF	geometry
QRectF	rect
bool	transparentForPositioners
bool	tabFence
bool	polishOnResize
bool	visibleToParent
bool	hasChildItems
bool	initiallyPainted
UpdateFlags	updateFlags

Public Functions inherited from QskSkinnable

	Name
	QskSkinnable()
virtual	~QskSkinnable()
void	setSkinlet(const QskSkinlet * skinlet) Set an individual skinlet to render/display the content.
const QskSkinlet *	skinlet() const
QFont	effectiveFont(QskAspect aspect) const
QskColorFilter	effectiveGraphicFilter(QskAspect aspect) const
void	setSubcontrolProxy(QskAspect::Subcontrol subControl, QskAspect::Subcontrol proxy)
void	resetSubcontrolProxy(QskAspect::Subcontrol subcontrol)
QskAspect::Subcontrol	subcontrolProxy(QskAspect::Subcontrol subControl) const
bool	setAnimationHint(QskAspect aspect, QskAnimationHint hint)
QskAnimationHint	animationHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const
bool	setSkinHint(QskAspect aspect, const QVariant & hint) Insert a hint into the local hint table.
bool	resetSkinHint(QskAspect aspect) Remove a hint from the local hint table.
QskAnimationHint	effectiveAnimation(QskAspect::Type type, QskAspect::Subcontrol subControl, QskAspect::States states, QskSkinHintStatus * status =nullptr) const
QVariant	effectiveSkinHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Find the value for a specific aspect.
virtual QskAspect::Placement	effectivePlacement() const
QskSkinHintStatus	hintStatus(QskAspect aspect) const
QRectF	subControlRect(const QRectF & contentsRect, QskAspect::Subcontrol subControl) const Calculate position and size of a subControl.
QRectF	subControlContentsRect(const QRectF & contentsRect, QskAspect::Subcontrol subControl) const Calculate the inner rectangle for subControl.
QSizeF	outerBoxSize(QskAspect aspect, const QSizeF & innerBoxSize) const Calculate the size, when being expanded by paddings, indentations.
QSizeF	innerBoxSize(QskAspect aspect, const QSizeF & outerBoxSize) const Calculate the size, with paddings, indentations being subtracted.
QRectF	innerBox(QskAspect aspect, const QRectF & outerBox) const Calculate the rectangle, whith paddings, indentations being subtracted.
QRectF	outerBox(QskAspect aspect, const QRectF & innerBox) const Calculate the rectangle, when being expanded by paddings, indentations.
QMarginsF	innerPadding(QskAspect aspect, const QSizeF & outerBoxSize) const Calculate the padding from attributes for the given aspect.
const QskSkinlet *	effectiveSkinlet() const
QskSkin *	effectiveSkin() const
void	startTransition(QskAspect aspect, QskAnimationHint animationHint, QVariant from, QVariant to)
QskAspect::Subcontrol	effectiveSubcontrol(QskAspect::Subcontrol subControl) const
QskControl *	controlCast()
const QskControl *	controlCast() const
virtual QskControl *	owningControl() const =0
virtual const QMetaObject *	metaObject() const =0
void	debug(QskAspect aspect) const
void	debug(QskAspect::State state) const
void	debug(QDebug debug, QskAspect aspect) const
void	debug(QDebug debug, QskAspect::State state) const
void	setSkinStates(QskAspect::States newStates)
void	setSkinStateFlag(QskAspect::State stateFlag, bool on =true)
void	addSkinStates(QskAspect::States states)
void	clearSkinStates(QskAspect::States states)
void	replaceSkinStates(QskAspect::States newStates)
bool	hasSkinState(QskAspect::State state) const
QskAspect::States	skinStates() const
const char *	skinStatesAsPrintable() const
const char *	skinStatesAsPrintable(QskAspect::States states) const
bool	setColor(QskAspect aspect, Qt::GlobalColor color) Sets a color hint.
bool	setColor(QskAspect aspect, QRgb rgb) Sets a color hint.
bool	setColor(QskAspect aspect, const QColor & color) Sets a color hint.
bool	resetColor(QskAspect aspect) Removes a color hint from the local table.
QColor	color(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a color hint.
bool	setMetric(QskAspect aspect, qreal metric) Sets a metric hint.
bool	resetMetric(QskAspect aspect) Removes a metric hint from the local table.
qreal	metric(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a metric hint.
bool	setFlagHint(QskAspect aspect, int flag) Sets a flag hint.
bool	resetFlagHint(QskAspect aspect) Removes a flag hint from the local table.
int	flagHint(QskAspect aspect) const Retrieves a flag hint.
template <typename T > T	flagHint(QskAspect aspect, T defaultValue =T()) const Retrieves a flag hint.
bool	setStrutSizeHint(QskAspect aspect, const QSizeF & size) Sets a metric hint.
bool	setStrutSizeHint(QskAspect aspect, qreal width, qreal height) Sets a strut size hint.
bool	resetStrutSizeHint(QskAspect aspect) Removes a strut size hint from the local table.
QSizeF	strutSizeHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a strut size hint.
bool	setMarginHint(QskAspect aspect, qreal margins) Sets a margin hint.
bool	setMarginHint(QskAspect aspect, const QMarginsF & margins) Sets a margin hint.
bool	resetMarginHint(QskAspect aspect) Removes a margin hint from the local table.
QMarginsF	marginHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a margin hint.
bool	setPaddingHint(QskAspect aspect, qreal padding) Sets a padding hint.
bool	setPaddingHint(QskAspect aspect, const QMarginsF & padding) Sets a padding hint.
bool	resetPaddingHint(QskAspect aspect) Removes a padding hint from the local table.
QMarginsF	paddingHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a padding hint.
bool	setGradientHint(QskAspect aspect, const QskGradient & gradient) Sets a gradient as color hint.
QskGradient	gradientHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a color hint as gradient.
bool	setBoxShapeHint(QskAspect aspect, const QskBoxShapeMetrics & shape) Sets a shape hint.
bool	resetBoxShapeHint(QskAspect aspect) Removes a shape hint from the local table.
QskBoxShapeMetrics	boxShapeHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a shape hint.
bool	setBoxBorderMetricsHint(QskAspect aspect, const QskBoxBorderMetrics & border) Sets a border metrics hint.
bool	resetBoxBorderMetricsHint(QskAspect aspect) Removes a border metrics hint from the local table.
QskBoxBorderMetrics	boxBorderMetricsHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a border hint.
bool	setBoxBorderColorsHint(QskAspect aspect, const QskBoxBorderColors & colors) Sets a border colors hint.
bool	resetBoxBorderColorsHint(QskAspect aspect) Removes a border colors hint from the local table.
QskBoxBorderColors	boxBorderColorsHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves border colors hint.
bool	setArcMetricsHint(QskAspect aspect, const QskArcMetrics & arc)
bool	resetArcMetricsHint(QskAspect aspect)
QskArcMetrics	arcMetricsHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const
bool	setSpacingHint(QskAspect aspect, qreal spacing) Sets a spacing hint.
bool	resetSpacingHint(QskAspect aspect) Removes a spacing hint from the local table.
qreal	spacingHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a spacing hint.
bool	setAlignmentHint(QskAspect aspect, Qt::Alignment alignment) Sets an alignment hint.
bool	resetAlignmentHint(QskAspect aspect) Removes an alignment hint from the local table.
Qt::Alignment	alignmentHint(QskAspect aspect, Qt::Alignment defaultAlignment =Qt::Alignment()) const Retrieves an alignment hint.
bool	setFontRoleHint(QskAspect aspect, int role) Sets a font role hint.
bool	resetFontRoleHint(QskAspect aspect) Removes a font role hint from the local table.
int	fontRoleHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const Retrieves a font role hint.
bool	setGraphicRoleHint(QskAspect aspect, int role) Sets a graphic role hint.
bool	resetGraphicRoleHint(QskAspect aspect) Removes a graphic role hint from the local table.
int	graphicRoleHint(QskAspect aspect, QskSkinHintStatus * status =nullptr) const A Retrieves a graphic role hint.

Protected Functions inherited from QskSkinnable

	Name
virtual void	updateNode(QSGNode * parentNode)
virtual QskAspect::Subcontrol	substitutedSubcontrol(QskAspect::Subcontrol subControl) const
QskSkinHintTable &	hintTable() Accessor for local skin hint table.
const QskSkinHintTable &	hintTable() const Accessor for local skin hint table.

Public Types Documentation

enum PopupFlag

Enumerator	Value	Description
DeleteOnClose	1 « 0
CloseOnPressOutside	1 « 1

Public Slots Documentation

slot open

void open()

slot close

void close()

slot setOpen

void setOpen(
    bool on
)

Public Signals Documentation

signal opened

void opened()

signal closed

void closed()

signal openChanged

void openChanged(
    bool 
)

signal fadingChanged

void fadingChanged(
    bool 
)

signal modalChanged

void modalChanged(
    bool 
)

signal overlayChanged

void overlayChanged(
    bool 
)

signal priorityChanged

void priorityChanged(
    uint 
)

signal faderEffectChanged

void faderEffectChanged(
    bool 
)

Public Functions Documentation

function QskPopup

QskPopup(
    QQuickItem * parent =nullptr
)

function ~QskPopup

~QskPopup() override

function setPopupFlags

void setPopupFlags(
    PopupFlags flags
)

function popupFlags

PopupFlags popupFlags() const

function setPopupFlag

void setPopupFlag(
    PopupFlag flag,
    bool on =true
)

function testPopupFlag

bool testPopupFlag(
    PopupFlag flag
) const

function setModal

void setModal(
    bool on =true
)

function isModal

bool isModal() const

function setOverlay

void setOverlay(
    bool on =true
)

function resetOverlay

void resetOverlay()

function hasOverlay

bool hasOverlay() const

function setPriority

void setPriority(
    uint priority
)

function priority

uint priority() const

function setFaderEffect

void setFaderEffect(
    bool on
)

function hasFaderEffect

bool hasFaderEffect() const

function faderAspect

QskAspect faderAspect() const

function setFaderAspect

void setFaderAspect(
    QskAspect aspect
)

function overlayRect

virtual QRectF overlayRect() const

function isOpen

bool isOpen() const

function isFading

bool isFading() const

Protected Functions Documentation

function aboutToShow

void aboutToShow() override

function event

bool event(
    QEvent * event
) override

function focusInEvent

void focusInEvent(
    QFocusEvent * event
) override

function focusOutEvent

void focusOutEvent(
    QFocusEvent * event
) override

function windowChangeEvent

void windowChangeEvent(
    QskWindowChangeEvent * event
) override

function itemChange

void itemChange(
    QQuickItem::ItemChange change,
    const QQuickItem::ItemChangeData & value
) override

function focusSuccessor

virtual QQuickItem * focusSuccessor() const

function isTransitionAccepted

bool isTransitionAccepted(
    QskAspect aspect
) const override

function grabFocus

void grabFocus(
    bool on
)

Public Property Documentation

property open

bool open;

bool modal;

property overlay

bool overlay;

property faderEffect

bool faderEffect;

property priority

uint priority;

Public Attributes Documentation

variable Overlay

static const QskAspect::Subcontrol Overlay;

variable Closed

static const QskAspect::State Closed;

Updated on 28 July 2023 at 14:02:28 CEST