Olive
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Private Attributes | List of all members
LabelField Class Reference

The LabelField class. More...

#include <labelfield.h>

Inheritance diagram for LabelField:
EffectField

Public Member Functions

 LabelField (EffectRow *parent, const QString &string)
 Reimplementation of EffectField::EffectField(). More...
 
virtual QWidget * CreateWidget (QWidget *existing=nullptr) override
 Reimplementation of EffectField::CreateWidget() More...
 
- Public Member Functions inherited from EffectField
 EffectField (EffectRow *parent, const QString &i, EffectFieldType t)
 EffectField Constructor. More...
 
EffectRowGetParentRow ()
 Get the EffectRow that this field is a member of. More...
 
const EffectFieldTypetype ()
 Get the type of data to expect from this field. More...
 
const QString & id ()
 Get the unique identifier of this field set in the constructor. More...
 
QVariant GetValueAt (double timecode)
 Get the value of this field at a given timecode. More...
 
void SetValueAt (double time, const QVariant &value)
 Set the value of this field at a given timecode. More...
 
double Now ()
 Get the current clip/media time. More...
 
void PrepareDataForKeyframing (bool enabled, ComboAction *ca)
 Set up keyframing on this field. More...
 
int GetColumnSpan ()
 Get field's column span. More...
 
void SetColumnSpan (int i)
 Set field's column span. More...
 
virtual QString ConvertValueToString (const QVariant &v)
 Convert a value from this field to a string. More...
 
virtual QVariant ConvertStringToValue (const QString &s)
 Convert a string to a value appropriate for this field. More...
 
virtual void UpdateWidgetValue (QWidget *widget, double timecode)
 Update a widget created by CreateWidget() using the value at a given time. More...
 
double GetValidKeyframeHandlePosition (int key, bool post)
 Get the correct X position/time value of a bezier keyframe's handles. More...
 
bool IsEnabled ()
 Return whether this field is enabled or not. More...
 
void SetEnabled (bool e)
 Set the enabled state of this field. More...
 

Private Attributes

QString label_text_
 Internal text string. More...
 

Additional Inherited Members

- Public Types inherited from EffectField
enum  EffectFieldType {
  EFFECT_FIELD_DOUBLE, EFFECT_FIELD_COLOR, EFFECT_FIELD_STRING, EFFECT_FIELD_BOOL,
  EFFECT_FIELD_COMBO, EFFECT_FIELD_FONT, EFFECT_FIELD_FILE, EFFECT_FIELD_UI
}
 The EffectFieldType enum. More...
 
- Signals inherited from EffectField
void Changed ()
 Changed signal. More...
 
void Clicked ()
 Clicked signal. More...
 
void EnabledChanged (bool)
 Enable change state signal. More...
 
- Public Attributes inherited from EffectField
QVariant persistent_data_
 Persistent data object. More...
 
QVector< EffectKeyframekeyframes
 Keyframe array. More...
 

Detailed Description

The LabelField class.

A UI-type EffectField. This field is largely an EffectField wrapper around a QLabel and provides no data that's usable in the Effect. It's primarily useful for showing UI information. This field is not exposed to the external shader API as it requires raw C++ code to connect it to other elements.

Constructor & Destructor Documentation

LabelField::LabelField ( EffectRow parent,
const QString &  string 
)

Reimplementation of EffectField::EffectField().

Member Function Documentation

QWidget * LabelField::CreateWidget ( QWidget *  existing = nullptr)
overridevirtual

Reimplementation of EffectField::CreateWidget()

Creates and connects to a QLabel.

Implements EffectField.

Member Data Documentation

QString LabelField::label_text_
private

Internal text string.


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