stage::widget Namespace Reference

Description

Lumiera custom widgets.

Namespaces
namespace	anonymous_namespace{element-box-widget.cpp}
namespace	anonymous_namespace{error-log-display.hpp}
namespace	anonymous_namespace{menu-button.cpp}
namespace	anonymous_namespace{timecode-widget.cpp}
namespace	anonymous_namespace{video-display-widget.cpp}

Typedefs
using	SizeGetter = std::function< int()>
using	MiniButton = MiniWrapper< Gtk::Button >
	A ToolButton-like widget.
using	MiniToggleButton = MiniWrapper< Gtk::ToggleButton >
	A ToggleToolButton-like widget.

Enumerations
enum	Kind {   MARK ,   SPAN ,   ITEM ,   CONTENT }
	the presentation intent for the ElementBoxWidget More...
enum	Type {   VIDEO ,   AUDIO ,   TEXT ,   AUTO ,   EVENT ,   EFFECT ,   LABEL ,   RULER ,   GROUP ,   META }
	the type of content object to derive suitable styling (background colour, icon) More...

Classes
class	BinWidget
class	ButtonBar
	A modified toolbar widget for use in dialogs. More...
class	ElementBoxWidget
	A basic building block of the Lumiera UI. More...
class	ErrorLogDisplay
	Widget to display log and error messages. More...
class	IDLabel
	Widget arrangement to represent an entity for manipulation. More...
class	MenuButton
	A button that displays a menu when clicked on. More...
class	MiniWrapper
	A wrapper for ToolButton-like Button widgets. More...
class	MixerWidget
class	PanelBar
	A container widget for widgets to be displayed on GDL panels grips. More...
class	PlayerWidget
class	SwitchboardWidget
class	TimeCode
	Widget for timecode input and display. More...
class	TimelineZoomScale
class	VideoDisplayWidget

Functions
ElementBoxWidget::Config::Qualifier	kind (Kind kind)
	qualify the basic use case for the new ElementBoxWidget
ElementBoxWidget::Config::Qualifier	name (string id)
	define the name-ID displayed in the caption
ElementBoxWidget::Config::Qualifier	expander (model::Expander &expander)
	provide an expand/collapse button, wired with the given Expander
ElementBoxWidget::Config::Qualifier	constrained (SizeGetter widthConstraint)
	switch in to size-constrained layout mode.
ElementBoxWidget::Config::Qualifier	constrained (SizeGetter widthConstraint, SizeGetter heightConstraint)
	activate size-constrained layout mode, similar as constrained(SizeGetter).

Variables
const float	framerate = 25

Typedef Documentation

SizeGetter

using SizeGetter = std::function<int()>

Definition at line 85 of file element-box-widget.hpp.

MiniButton

using MiniButton = MiniWrapper<Gtk::Button>

A ToolButton-like widget.

Definition at line 75 of file mini-button.hpp.

MiniToggleButton

using MiniToggleButton = MiniWrapper<Gtk::ToggleButton>

A ToggleToolButton-like widget.

Definition at line 78 of file mini-button.hpp.

Enumeration Type Documentation

Kind

enum Kind

the presentation intent for the ElementBoxWidget

Enumerator
MARK	Widget is a pin or marks a position.
SPAN	Widget spans a time range.
ITEM	Widget represents an entity within a collection (Bin)
CONTENT	Widget serves to represent a piece of content (Clip)

Definition at line 66 of file element-box-widget.hpp.

Type

enum Type

the type of content object to derive suitable styling (background colour, icon)

Enumerator
VIDEO	represents moving (or still) image data
AUDIO	represents sound data
TEXT	represents text content
AUTO	represents automation
EVENT	represents event streams or live connections
EFFECT	represents a processor or transformer
LABEL	represents a label or descriptor
RULER	represents an overview ruler or TOC
GROUP	represents a container to group other entities
META	represents some meta entity

Definition at line 73 of file element-box-widget.hpp.

Function Documentation

kind()

ElementBoxWidget::Config::Qualifier kind ( Kind  kind )

inline

qualify the basic use case for the new ElementBoxWidget

Definition at line 223 of file element-box-widget.hpp.

name()

ElementBoxWidget::Config::Qualifier name ( string  id )

inline

define the name-ID displayed in the caption

Definition at line 234 of file element-box-widget.hpp.

expander()

ElementBoxWidget::Config::Qualifier expander ( model::Expander &  expander )

inline

provide an expand/collapse button, wired with the given Expander

Definition at line 245 of file element-box-widget.hpp.

constrained() [1/2]

ElementBoxWidget::Config::Qualifier constrained ( SizeGetter  widthConstraint )

inline

switch in to size-constrained layout mode.

The base size allocation (without borders and margin) will span exactly the horizontal extension as retrieved from invoking the SizeGetter.

Definition at line 260 of file element-box-widget.hpp.

constrained() [2/2]

ElementBoxWidget::Config::Qualifier constrained ( SizeGetter  widthConstraint, SizeGetter  heightConstraint  )

inline

activate size-constrained layout mode, similar as constrained(SizeGetter).

Additionally, also the vertical extension is controlled in this variant.

Definition at line 274 of file element-box-widget.hpp.

Variable Documentation

framerate

const float framerate = 25

Definition at line 56 of file timecode-widget.cpp.

Referenced by TimeCode::smpte_sanitize_display().