Base class of all UI objects. More...

#include <AUI/View/AView.h>

Public Member Functions#
auto	enabled () const
	Whether view is enabled (i.e., reacts to user).

auto	position () const
	Top left corner's position relative to top left corner's position of the parent AView.

auto	size () const
	Size, including content area, border and padding.

auto	expanding () const
	Expansion coefficient. Hints layout manager how much this AView should be extended relative to other AViews in the same container.

auto	visibility () const
	Visibility value.

void	redraw ()
	Request window manager to redraw this AView.

AWindowBase *	getWindow () const
	Determines window which this AView belongs to.

virtual void	drawStencilMask (ARenderContext ctx)

virtual void	render (ARenderContext ctx)
	Draws this AView. Noone should call this function except rendering routine.

virtual void	postRender (ARenderContext ctx)
	Performs post-draw routines of this AView. Noone should call this function except rendering routine.

void	popStencilIfNeeded (ARenderContext ctx)

const AVector< AString > &	getAssNames () const noexcept

glm::ivec2	getPosition () const noexcept
	Top left corner's position relative to top left corner's position of the parent AView.

glm::ivec2	getCenterPointInWindow () const noexcept
	The center point position of the view relatively to top left corner of the window.

glm::ivec2	getSize () const noexcept
	Size, including content area, border and padding.

glm::ivec2	getMinSize () const noexcept

void	setMinSize (glm::ivec2 minSize) noexcept

virtual void	markMinContentSizeInvalid ()

void	setExtraStylesheet (_< AStylesheet > extraStylesheet)

void	setExtraStylesheet (AStylesheet &&extraStylesheet)

const _< AStylesheet > &	extraStylesheet () const noexcept

AOverflow	getOverflow () const
	Determines whether display graphics that go out of the bounds of this AView or not.

void	setOverflow (AOverflow overflow)

AOverflowMask	getOverflowMask () const
	Controls how does the overflow (stencil) mask is produced.

void	setOverflowMask (AOverflowMask overflow)

float	getBorderRadius () const
	border-radius, specified in ASS.

void	setBorderRadius (float radius)

int	getWidth () const

int	getHeight () const

int	getTotalOccupiedWidth () const

int	getTotalOccupiedHeight () const

glm::ivec2	getMinimumSizePlusMargin ()

const ABoxFields &	getMargin ()
	Returns the margin.

void	setMargin (const ABoxFields &margin)
	Sets the margin.

virtual bool	consumesClick (const glm::ivec2 &pos)
	Determines whether this AView processes this click or passes it thru.

const ABoxFields &	getPadding ()
	Returns the padding.

void	setPadding (const ABoxFields &padding)
	Sets the padding.

virtual AString	debugString () const
	String which helps to identify this object in debug string output (i.e., for logging)

int	getTotalFieldHorizontal () const

int	getTotalFieldVertical () const

glm::ivec2	getTotalFieldSize () const

AViewContainerBase *	getParent () const
	Parent AView.

const AOptional< ACursor > &	getCursor () const
	Determines shape which should pointer take when it's above this AView.

void	setCursor (AOptional< ACursor > cursor)

virtual int	getContentMinimumWidth ()

virtual int	getContentMinimumHeight ()

glm::ivec2	getContentMinimumSize () noexcept

bool	isContentMinimumSizeInvalidated () noexcept

bool	hasFocus () const

virtual int	getMinimumWidth ()

virtual int	getMinimumHeight ()

glm::ivec2	getMinimumSize ()

void	setMaxSize (const glm::ivec2 &maxSize)

const glm::ivec2 &	getMaxSize () const

glm::ivec2	getContentSize () const

int	getContentWidth () const

int	getContentHeight () const

const glm::ivec2 &	getExpanding () const

void	setExpanding (glm::ivec2 expanding)
	Changes the expanding of view.

void	setExpanding (int expanding)
	Changes the expanding of view.

void	setExpanding ()

const _< AAnimator > &	getAnimator () const

void	setAnimator (const _< AAnimator > &animator)

void	getTransform (glm::mat4 &transform) const

int	getExpandingHorizontal () const

int	getExpandingVertical () const

aui::float_within_0_1	getOpacity () const

void	setOpacity (aui::float_within_0_1 opacity)

virtual void	setPosition (glm::ivec2 position)

void	setSizeForced (glm::ivec2 size)

virtual void	setSize (glm::ivec2 size)

virtual void	setGeometry (int x, int y, int width, int height)

void	setGeometry (const glm::ivec2 &position, const glm::ivec2 &size)

bool	isBlockClicksWhenPressed () const noexcept

void	setBlockClicksWhenPressed (bool value) noexcept

const glm::ivec2 &	getFixedSize ()
	Fixed size.

void	setFixedSize (glm::ivec2 size)

bool	isMouseHover () const noexcept

bool	isPressed () const noexcept

bool	isPressed (APointerIndex index) const noexcept

bool	isFocused () const

bool	isMouseEntered () const

Visibility	getVisibility () const

Visibility	getVisibilityRecursive () const

void	setVisibility (Visibility visibility) noexcept

void	setVisible (bool visible) noexcept

MouseCollisionPolicy	getMouseCollisionPolicy () const

void	setMouseCollisionPolicy (MouseCollisionPolicy mouseCollisionPolicy)

void	click ()

void	pack ()
	Sets minimal size.

void	focus (bool needFocusChainUpdate=true)
	Requests focus for this AView.

virtual bool	capturesFocus ()

bool	hasIndirectParent (const _< AView > &v)
	Checks if the specified view is an indirect parent of this view.

glm::ivec2	getPositionInWindow () const

void	addAssName (const AString &assName)
	Adds an ASS class to this AView.

void	removeAssName (const AString &assName)
	Removes an ASS class to this AView.

void	setAssName (const AString &assName, bool value)
	Depending on value, either adds or removes ass name.

AView &	operator<< (const AString &assName)

const _< AAssHelper > &	getAssHelper () const

const ass::PropertyListRecursive &	getCustomAss () const

void	setCustomStyle (ass::PropertyListRecursive rule)

void	ensureAssUpdated ()

_< AView >	sharedPtr ()

_weak< AView >	weakPtr ()

virtual bool	onGesture (const glm::ivec2 &origin, const AGestureEvent &event)

virtual void	onMouseEnter ()

virtual void	onPointerMove (glm::vec2 pos, const APointerMoveEvent &event)
	Handles pointer hover events.

virtual void	onMouseLeave ()

virtual void	onDpiChanged ()

virtual void	onPointerPressed (const APointerPressedEvent &event)
	Called on pointer (mouse) released event.

virtual void	onPointerReleased (const APointerReleasedEvent &event)
	Called on pointer (mouse) released event.

virtual void	onPointerDoubleClicked (const APointerPressedEvent &event)

virtual void	onScroll (const AScrollEvent &event)

virtual void	onKeyDown (AInput::Key key)

virtual void	onKeyRepeat (AInput::Key key)

virtual void	onKeyUp (AInput::Key key)

virtual void	onFocusAcquired ()

virtual void	onFocusLost ()

virtual void	onCharEntered (char16_t c)

virtual bool	handlesNonMouseNavigation ()

virtual void	forceUpdateLayoutRecursively ()

virtual void	setEnabled (bool enabled=true)

void	setDisabled (bool disabled=true)

void	updateEnableState ()

void	enable ()

void	disable ()

void	operator& (ass::PropertyListRecursive rule)
	Helper function for kAUI.h:with_style.

virtual void	onClickPrevented ()
	Called on AWindowBase::preventClickOnPointerRelease.

virtual void	invalidateAllStyles ()
	Invalidates all styles, causing to iterate over all rules in global and parent stylesheets.

void	invalidateStateStyles ()
	Updates state selectors for ASS.

virtual void	invalidateAssHelper ()
	Resets mAssHelper.

virtual bool	wantsTouchscreenKeyboard ()
	Returns true if view is textfield-like view which requires touchscreen keyboard when clicked.

void	setSkipUntilLayoutUpdate (bool skipUntilLayoutUpdate)

void	setFloating (AFloat f) noexcept
	Set floating value for AText.

AFloat	getFloating () const noexcept
	Floating value for AText.

Public Member Functions inherited from AObject
_< AObject >	sharedPtr ()

_weak< AObject >	weakPtr ()

template<typename Connectable, ACompatibleSlotFor< Connectable > Function>
decltype(auto)	connect (const Connectable &connectable, Function &&function)
	Connects signal or property to slot of `"this"` object.

void	setSignalsEnabled (bool enabled)

bool	isSignalsEnabled () const noexcept

template<ASignalInvokable T>
void	operator^ (T &&t) noexcept

_< AAbstractThread >	getThread () const

bool	isSlotsCallsOnlyOnMyThread () const noexcept

void	setSlotsCallsOnlyOnMyThread (bool slotsCallsOnlyOnMyThread)

Public Member Functions inherited from AObjectBase
	AObjectBase (AObjectBase &&rhs) noexcept

	AObjectBase (const AObjectBase &rhs) noexcept

AObjectBase &	operator= (const AObjectBase &rhs) noexcept

AObjectBase &	operator= (AObjectBase &&rhs) noexcept

Public Member Functions inherited from aui::noncopyable
	noncopyable (const noncopyable &)=delete

noncopyable &	operator= (const noncopyable &)=delete

Signals and public fields#
emits	viewGraphSubtreeChanged

emits	redrawn
	View is painted onto the some surface.

emits< bool >	hoveredState

emits	mouseEnter

emits	mouseLeave

emits< bool, APointerIndex >	pressedState

emits< APointerIndex >	pressed

emits< APointerIndex >	released

emits< APointerIndex >	clickedButton
	Some mouse button clicked.

emits	clicked
	Left mouse button clicked.

emits< glm::ivec2, glm::ivec2 >	geometryChanged
	Geometry (position and size) changed.

emits< glm::ivec2 >	scrolled
	Scroll event.

emits< AInput::Key >	keyPressed
	Keyboard key pressed.

emits< AInput::Key >	keyReleased
	Keyboard key released.

emits	clickedRight
	Right mouse button clicked.

emits	clickedRightOrLongPressed
	Right mouse button clicked or long press gesture applied.

emits< APointerIndex >	doubleClicked

emits	customCssPropertyChanged

emits< bool >	focusState
	Focus state changed.

emits	focusAcquired

emits	focusLost

emits< _< AView > >	childFocused

Protected Member Functions#
bool	transformGestureEventsToDesktop (const glm::ivec2 &origin, const AGestureEvent &event)
	Converts touch screen events to desktop.

void	applyAssRule (const ass::PropertyList &propertyList)

void	applyAssRule (const ass::PropertyListRecursive &propertyList)

virtual AMenuModel	composeContextMenu ()
	Produce context (right click) menu.

virtual void	onViewGraphSubtreeChanged ()
	Called when direct or indirect parent has changed.

virtual void	markPixelDataInvalid (ARect< int > invalidArea)
	A view requests to redraw it and passes it's coords relative to this.

virtual void	commitStyle ()

Protected Member Functions inherited from AObject
void	setThread (_< AAbstractThread > thread)
	Set thread of the object.

Protected Member Functions inherited from AObjectBase
void	clearAllIngoingConnections () noexcept

virtual void	handleSlotException (std::exception_ptr exception)
	Called then an exception has thrown during slot processing of the signal emitted by this object.

Protected Attributes#
AViewContainerBase *	mParent = nullptr
	Parent AView.

std::array< ass::prop::IPropertyBase *, int(ass::prop::PropertySlot::COUNT)>	mAss
	Drawing list, or baking drawing commands so that you don't have to parse the ASS every time.

ass::PropertyListRecursive	mCustomStyleRule
	Custom ASS Rules.

AOptional< ACursor >	mCursor = ACursor::DEFAULT
	Determines shape which should pointer take when it's above this AView.

glm::ivec2	mPosition = { 0, 0 }
	Top left corner's position relative to top left corner's position of the parent AView.

emits< glm::ivec2 >	mPositionChanged
	Position changed.

glm::ivec2	mSize = { 20, 20 }
	Size, including content area, border and padding.

emits< glm::ivec2 >	mSizeChanged
	Size changed.

AOptional< glm::ivec2 >	mCachedMinContentSize

bool	mMarkedMinContentSizeInvalid = false

bool	mRedrawRequested = false
	Redraw requested flag for this particular view/.

glm::ivec2	mMinSize = {0, 0}
	Minimal size.

glm::ivec2	mMaxSize = {0x7fffffff, 0x7fffffff}
	Maximal size.

glm::ivec2	mFixedSize = {0, 0}
	Fixed size.

ABoxFields	mMargin
	Margin, which defines the spacing around this AView. Processed by the layout manager.

ABoxFields	mPadding
	Padding, which defines the spacing around content area inside the view. Processed by AView implementation.

AVector< AString >	mAssNames
	ASS class names.

bool	mSkipUntilLayoutUpdate = true
	If set to true, AViewContainer is obligated ignore this view. This value is set to false by AView::setGeometry.

Additional Inherited Members#
Static Public Member Functions inherited from AObject
static void	disconnect ()

template<AAnySignal Signal, aui::derived_from< AObjectBase > Object, ACompatibleSlotFor< Signal > Function>
static decltype(auto)	connect (const Signal &signal, Object *object, Function &&function)
	Connects signal to the slot of the specified object.

template<AAnyProperty Property, aui::derived_from< AObjectBase > Object, typename Function>
static decltype(auto)	connect (const Property &property, Object *object, Function &&function)
	Connects property to the slot of the specified object.

template<APropertyReadable PropertySource, APropertyWritable PropertyDestination> requires requires { { propertySource } -> aui::convertible_to<std::decay_t<decltype(propertyDestination)>>; }
static void	connect (PropertySource &&propertySource, PropertyDestination &&propertyDestination)
	Connects source property to the destination property.

template<APropertyWritable PropertySource, APropertyWritable PropertyDestination> requires requires { { propertySource } -> aui::convertible_to<std::decay_t<decltype(propertyDestination)>>; { propertyDestination } -> aui::convertible_to<std::decay_t<decltype(propertySource)>>; }
static void	biConnect (PropertySource &&propertySource, PropertyDestination &&propertyDestination)
	Connects source property to the destination property and opposite (bidirectionally).

template<AAnySignalOrProperty Connectable, aui::derived_from< AObjectBase > Object, ACompatibleSlotFor< Connectable > Function>
static decltype(auto)	connect (const Connectable &connectable, Object &object, Function &&function)
	Connects signal or property to the slot of the specified object.

template<AAnySignalOrProperty Connectable, aui::derived_from< AObjectBase > Object, ACompatibleSlotFor< Connectable > Function>
static decltype(auto)	connect (const Connectable &connectable, _< Object > object, Function &&function)
	Connects signal or property to the slot of the specified object.

template<AAnySignalOrProperty Connectable, aui::derived_from< AObjectBase > Object, typename Function>
static decltype(auto)	connect (const Connectable &connectable, ASlotDef< Object *, Function > slotDef)
	Connects signal to the slot of the specified object. Slot is packed to single argument.

template<AAnyProperty Property, typename Object, ACompatibleSlotFor< Property > Function> requires (!aui::derived_from<Object, AObject>)
static void	connect (const Property &property, _< Object > object, Function &&function)
	Connects signal or property to the slot of the specified non-AObject type.

static void	moveToThread (aui::no_escape< AObject > object, _< AAbstractThread > thread)

Static Public Attributes inherited from AObject
static constexpr AObjectBase *	GENERIC_OBSERVER = nullptr
	Indicates that a connection should not be explicitly linked to receiver's lifetime.

Static Public Attributes inherited from AObjectBase
static ASpinlockMutex	SIGNAL_SLOT_GLOBAL_SYNC

Detailed Description#

A class that describes the minimum unit that can be placed in a container (including a window) that takes up some space on the screen, responds to changes in size, position, moving the cursor, pressing / releasing keys and buttons, mouse wheel, etc...

Analogue to Qt's QWidget, Android's View.

Examples: /home/runner/work/aui/aui/aui.views/src/AUI/View/AView.h, examples/7guis/circle_drawer/src/main.cpp, examples/7guis/flight_booker/src/main.cpp, examples/app/fractal/src/FractalView.h, examples/app/game_of_life/src/main.cpp, examples/app/minesweeper/src/CellView.h, examples/app/minesweeper/src/Style.cpp, and examples/ui/views/src/DemoGraphView.h.

Member Function Documentation#

◆ addAssName()#

void AView::addAssName ( const AString & assName )

Parameters

assName new ASS name

◆ capturesFocus()#

virtual bool AView::capturesFocus ( )

virtual

Returns: Can this view capture focus.

For containers, capturing focus is redundant.

Reimplemented in ASlider, and AViewContainerBase.

◆ click()#

void AView::click ( )

inline

Simulates click on the view. Useful then you want to call clicked() slots of this view.

◆ composeContextMenu()#

virtual AMenuModel AView::composeContextMenu ( )

protectedvirtual

Returns: menu model

Examples: examples/7guis/circle_drawer/src/main.cpp.

◆ consumesClick()#

virtual bool AView::consumesClick ( const glm::ivec2 & pos )

virtual

Parameters

pos	mouse position

Returns: true if AView processes this click

Used in AViewContainer::getViewAt method subset, thus affecting click event handling.

Reimplemented in A2FingerTransformArea, AAbstractLabel, AButton, ACheckBox, ADividerView, AGridSplitter, ASpacerExpanding, ASpacerFixed, AViewContainerBase, and AWindow.

◆ expanding()#

auto AView::expanding ( ) const

inline

It does affect expanding environment inside the container. See expanding layout managers for more info.

It does not affect parent's size or parent's expanding property. Use AView::setExpanding() on parent, or Expanding variant of declarative container notation (Vertical::Expanding, Horizontal::Expanding, Stacked::Expanding) for such case.

◆ extraStylesheet()#

const _< AStylesheet > & AView::extraStylesheet ( ) const

inlinenodiscardnoexcept

See also: mExtraStylesheet

◆ focus()#

void AView::focus ( bool needFocusChainUpdate = true )

Parameters

needFocusChainUpdate if true, focus chain for new focused view will be updated

Note: if needFocusChainUpdate is false you need to control focus chain targets outside the focus function

◆ getCenterPointInWindow()#

glm::ivec2 AView::getCenterPointInWindow ( ) const

inlinenodiscardnoexcept

Useful in UI tests:

mWindow->onPointerMove(mView->getCenterPointInWindow()); // triggers on pointer move over the view through window

◆ getContentMinimumHeight()#

virtual int AView::getContentMinimumHeight ( )

nodiscardvirtual

Returns: minimal content-area height.

Reimplemented in AAbstractLabel, AScrollArea, ASpacerFixed, ATextBase< WordWrappingEngine >, ATextBase< AWordWrappingEngine<> >, ATreeView, and AViewContainerBase.

Examples: examples/app/game_of_life/src/main.cpp.

◆ getContentMinimumSize()#

glm::ivec2 AView::getContentMinimumSize ( )

inlinenodiscardnoexcept

Returns: minimal content-area size.

◆ getContentMinimumWidth()#

virtual int AView::getContentMinimumWidth ( )

nodiscardvirtual

Returns: minimal content-area width.

Reimplemented in AAbstractLabel, ADropdownList, APageSwitch, AScrollArea, ASpacerFixed, ATextBase< WordWrappingEngine >, ATextBase< AWordWrappingEngine<> >, and AViewContainerBase.

Examples: examples/app/game_of_life/src/main.cpp.

◆ getContentSize()#

glm::ivec2 AView::getContentSize ( ) const

inline

Returns: content size

◆ getFixedSize()#

const glm::ivec2 & AView::getFixedSize ( )

inline

Returns: Fixed size. {0, 0} if unspecified.

◆ getMargin()#

const ABoxFields & AView::getMargin ( )

inlinenodiscard

Returns: margin

See AUI Box Model.

◆ getMaxSize()#

const glm::ivec2 & AView::getMaxSize ( ) const

inlinenodiscard

Returns: maxSize (ignoring fixedSize)

◆ getMinimumSizePlusMargin()#

glm::ivec2 AView::getMinimumSizePlusMargin ( )

inlinenodiscard

Returns: minimum content size plus margin.

This value is bare minimum space required for this view. It includes minimal content size + padding + margin which is exact space the view requires.

◆ getMinSize()#

glm::ivec2 AView::getMinSize ( ) const

inlinenoexcept

Returns: minSize (ignoring fixedSize)

◆ getPadding()#

const ABoxFields & AView::getPadding ( )

inlinenodiscard

Returns: padding

◆ getPositionInWindow()#

glm::ivec2 AView::getPositionInWindow ( ) const

nodiscard

Returns: Coords of this AView relative to window

◆ getTotalFieldHorizontal()#

int AView::getTotalFieldHorizontal ( ) const

inlinenodiscard

Returns: pixel count which this AView's margin and padding acquired by width.

◆ getTotalFieldSize()#

glm::ivec2 AView::getTotalFieldSize ( ) const

inlinenodiscard

Returns: pixel count which this AView's margin and padding acquired.

◆ getTotalFieldVertical()#

int AView::getTotalFieldVertical ( ) const

inlinenodiscard

Returns: pixel count which this AView's margin and padding acquired by height.

◆ getTotalOccupiedHeight()#

int AView::getTotalOccupiedHeight ( ) const

inline

Returns: pixel count which this AView acquired by height including content area, padding, border and margin.

◆ getTotalOccupiedWidth()#

int AView::getTotalOccupiedWidth ( ) const

inline

Returns: pixel count which this AView acquired by width including content area, padding, border and margin.

◆ getWindow()#

AWindowBase * AView::getWindow ( ) const

Returns: window which this AView belongs to. Could be nullptr

◆ handlesNonMouseNavigation()#

virtual bool AView::handlesNonMouseNavigation ( )

virtual

Returns: true if this AView accepts tab focus

◆ invalidateAllStyles()#

virtual void AView::invalidateAllStyles ( )

virtual

Unlike invalidateStateStyles(), completely resets styles for this view, causing it to iterate over all rules in global and parent stylesheets. This operation is much more expensive than invalidateStateStyles because invalidateStateStyles iterates over a small set of rules and performs fewer checks.

Prefer invalidateAllStyles over invalidateStateStyles when:

Added/removed rules to applicable stylesheets
The view is reinflated to other layout
Added/removed/changed ass names of this or parent views

Reimplemented in AAbstractLabel, ATextBase< WordWrappingEngine >, ATextBase< AWordWrappingEngine<> >, and AViewContainerBase.

◆ invalidateAssHelper()#

virtual void AView::invalidateAssHelper ( )

virtual

Reimplemented in AViewContainerBase.

◆ invalidateStateStyles()#

void AView::invalidateStateStyles ( )

inline

Unlike invalidateAllStyles, iterates on an already calculated small set of rules which is much more cheap that invalidateAllStyles.

Prefer invalidateStateStyles over invalidateAllStyles when:

Changed state (hover, active, focus) of this view

◆ markPixelDataInvalid()#

virtual void AView::markPixelDataInvalid ( ARect< int > invalidArea )

protectedvirtual

Parameters

invalidArea area to invalidate. Must be in this view's coordinate space.

Reimplemented in AViewContainerBase, and AWindowBase.

◆ onClickPrevented()#

virtual void AView::onClickPrevented ( )

virtual

Reimplemented in ASplitter, and AViewContainerBase.

◆ onGesture()#

virtual bool AView::onGesture	(	const glm::ivec2 &	origin,
		const AGestureEvent &	event )

virtual

Handles touch screen gesture event.

Parameters

origin	position where the event(s) started to occur from.
event	gesture event.

Note: The standard implementation AView::onGesture emulates desktop events such as right click and scroll.

See also: transformGestureEventsToDesktop

Returns: true, if consumed (handled). True value prevents click.

Reimplemented in AScrollArea, AViewContainerBase, and AWindowBase.

◆ onPointerMove()#

virtual void AView::onPointerMove	(	glm::vec2	pos,
		const APointerMoveEvent &	event )

virtual

Parameters

pos	event position
event	event description

Note: If the view is pressed, it would still received move events. Use AView::isMouseHover to check is the pointer actually over view or not. See AView::onPointerReleased for more info.

Reimplemented in A2FingerTransformArea, ADragNDropView, AGridSplitter, ARulerArea, AScrollbarHandle, ASlider, ASplitter, AViewContainerBase, AWindow, and AWindowBase.

Examples: examples/7guis/circle_drawer/src/main.cpp.

◆ onPointerPressed()#

virtual void AView::onPointerPressed ( const APointerPressedEvent & event )

virtual

Parameters

event event

Reimplemented in A2FingerTransformArea, ACustomWindow, ADragArea::ADraggableHandle, AGridSplitter, AScrollArea, AScrollbar, AScrollbarHandle, ASlider, ASplitter, AViewContainerBase, and AWindowBase.

Examples: examples/app/game_of_life/src/main.cpp.

◆ onPointerReleased()#

virtual void AView::onPointerReleased ( const APointerReleasedEvent & event )

virtual

Parameters

event event

Note: To handle clicks, you should use AView::clicked signal instead. View still receives pointer move and released events even if cursor goes outside the view boundaries, or other exclusive event appeared (i.e. scrollarea scroll). AView::clicked emitted only if release event occurred inside view and no other event has prevented click gesture. See APointerReleasedEvent::triggerClick.

Reimplemented in A2FingerTransformArea, ACustomWindow, ADragArea::ADraggableHandle, ADropdownList, AGridSplitter, ARadioButton, AScrollArea, AScrollbarHandle, ASlider, ASplitter, AViewContainerBase, and AWindowBase.

Examples: examples/7guis/circle_drawer/src/main.cpp.

◆ onScroll()#

virtual void AView::onScroll ( const AScrollEvent & event )

virtual

Handles mouse wheel events.

Parameters

event event info.

Reimplemented in AScrollArea, AScrollbar, ATreeView, AViewContainerBase, and AWindowBase.

Examples: examples/app/fractal/src/FractalView.cpp, and examples/app/fractal/src/FractalView.h.

◆ onViewGraphSubtreeChanged()#

virtual void AView::onViewGraphSubtreeChanged ( )

protectedvirtual

Called when a new direct or indirect parent was assigned or removed.

If a subtree reattached atomically (i.e., there were no dangling state), the method is called once.

The method is mostly intended to invalidate styles in order to respond to stylesheet rules (mExtraStylesheet) of the new (in)direct parent.

Emits viewGraphSubtreeChanged signal.

Reimplemented in AForEachUIBase, and AViewContainerBase.

◆ postRender()#

virtual void AView::postRender ( ARenderContext ctx )

virtual

See also: AView::drawView

◆ removeAssName()#

void AView::removeAssName ( const AString & assName )

Parameters

assName ASS name to remove

◆ render()#

virtual void AView::render ( ARenderContext ctx )

virtual

See also: AView::drawView

AView::render is not guaranteed to be called on per-frame basis. Moreover, this method can be called multiple times if render-to-texture caching decides to do so.

Reimplemented in AAbstractLabel, ACircleProgressBar, ADrawableView, ADropdownList, AProgressBar, ARulerArea, ARulerView, ASpinner, ASpinnerV2, ATextBase< WordWrappingEngine >, ATextBase< AWordWrappingEngine<> >, AViewContainerBase, and AWindowBase.

Examples: examples/7guis/circle_drawer/src/main.cpp, examples/app/fractal/src/FractalView.cpp, examples/app/fractal/src/FractalView.h, examples/app/game_of_life/src/main.cpp, examples/app/minesweeper/src/CellView.cpp, examples/app/minesweeper/src/CellView.h, examples/ui/views/src/DemoGraphView.cpp, and examples/ui/views/src/DemoGraphView.h.

◆ setAssName()#

void AView::setAssName	(	const AString &	assName,
		bool	value )

inline

Parameters

assName	ASS name to add or remove
value	boolean that determines actual operation

Examples: examples/7guis/flight_booker/src/main.cpp.

◆ setExpanding() [1/2]#

void AView::setExpanding ( glm::ivec2 expanding )

inline

See also: Layout Managers; mExpanding; ass::Expanding

◆ setExpanding() [2/2]#

void AView::setExpanding ( int expanding )

inline

See also: Layout Managers; mExpanding; ass::Expanding

◆ setExtraStylesheet() [1/2]#

void AView::setExtraStylesheet ( _< AStylesheet > extraStylesheet )

inline

See also: mExtraStylesheet

Examples: examples/7guis/crud/src/main.cpp, examples/7guis/flight_booker/src/main.cpp, and examples/app/notes/src/main.cpp.

◆ setExtraStylesheet() [2/2]#

void AView::setExtraStylesheet ( AStylesheet && extraStylesheet )

See also: mExtraStylesheet

◆ setMargin()#

void AView::setMargin ( const ABoxFields & margin )

inline

Parameters

margin margin

See AUI Box Model.

◆ setPadding()#

void AView::setPadding ( const ABoxFields & padding )

inline

Parameters

padding padding

See AUI Box Model.

◆ setSizeForced()#

void AView::setSizeForced ( glm::ivec2 size )

inline

Set size ignoring all restrictions (i.e. min size, max size, fixed size, etc...). Used by AAnimator.

Parameters

size

◆ setSkipUntilLayoutUpdate()#

void AView::setSkipUntilLayoutUpdate ( bool skipUntilLayoutUpdate )

inline

See also: AView::mSkipUntilLayoutUpdate

◆ transformGestureEventsToDesktop()#

bool AView::transformGestureEventsToDesktop	(	const glm::ivec2 &	origin,
		const AGestureEvent &	event )

protected

Parameters

origin	position where the event(s) started to occur from.
event	gesture event.

Returns: true if consumed (handled).

AFingerDragEvent: Emulates mouse wheel scroll
ALongPressEvent: Shows context menu (if exists) or AView::clickedRightOrLongPressed

Member Data Documentation#

◆ focusState#

emits<bool> AView::focusState

Parameters

first whether focused or not.

◆ mAssNames#

AVector<AString> AView::mAssNames

protected

Needs keeping order.

◆ mMargin#

ABoxFields AView::mMargin

protected

See AUI Box Model.

◆ mPadding#

ABoxFields AView::mPadding

protected

See AUI Box Model.

◆ mRedrawRequested#

bool AView::mRedrawRequested = false

protected

This flag is set in redraw() method and reset in AView::render(ARenderContext context). redraw() method does not actually requests redraw of window if mRedrawRequested. This approach ignores sequential redraw() calls if the view is not even drawn.

◆ mSkipUntilLayoutUpdate#

bool AView::mSkipUntilLayoutUpdate = true

protected

This flag addresses the issue when some container is filled with views by addView during several frames, causing to draw them in wrong place (then their layout is not processed yet).

◆ redrawn#

emits AView::redrawn

This signal is emitted when view's AView::postRender() is called. This signal can be used to keep track if view is visible; however, AUI performs some optimizations when painting views. For example, a view located somewhere in AScrollArea is not painted until it is outside of AScrollArea's frame or at least barely reaches it.