AlgAudio::UIVisibilityBase Class Reference

#include <UIVisibilityBase.hpp>

Inheritance diagram for AlgAudio::UIVisibilityBase:

Public Types
enum	DisplayMode { DisplayMode::Visible, DisplayMode::EmptySpace, DisplayMode::Invisible }

Public Member Functions
bool	IsDrawn () const
bool	IsInvisible () const
void	SetDisplayMode (DisplayMode m)

Public Attributes
Signal	on_display_mode_changed

Protected Member Functions
	UIVisibilityBase ()

Protected Attributes
DisplayMode	display_mode = DisplayMode::Visible

Member Enumeration Documentation

enum AlgAudio::UIVisibilityBase::DisplayMode

strong

Enumerator
Visible	A Visible widget is drawn just normally.
EmptySpace	An EmptySpace widget is not drawn, but it takes as much space as it would normally take.
Invisible	An Invisible widget is not drawn, and it takes zero area.

Constructor & Destructor Documentation

AlgAudio::UIVisibilityBase::UIVisibilityBase ( )

inlineprotected

Member Function Documentation

bool AlgAudio::UIVisibilityBase::IsDrawn ( ) const

inline

Returns true if the contents of the widget are supposed to be drawn, i.e. whether display mode is 'visible'. When implementing a custom widget, do do not need to test for being drawn in CustomDraw, if a widget is not supposed to be drawn, CustomDraw will never be called.

bool AlgAudio::UIVisibilityBase::IsInvisible ( ) const

inline

Returns true if this widget is marked as invisible.

void AlgAudio::UIVisibilityBase::SetDisplayMode ( DisplayMode  m )

inline

Sets widget display mode.

See also

DisplayModes

Member Data Documentation

DisplayMode AlgAudio::UIVisibilityBase::display_mode = DisplayMode::Visible

protected

Signal AlgAudio::UIVisibilityBase::on_display_mode_changed

Triggered when visibility changes.

---

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

• E:/rc/algaudio/libalgaudio/include/UI/UIVisibilityBase.hpp