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

The BoolField class. More...

#include <boolfield.h>

Inheritance diagram for BoolField:
EffectField

Signals

void Toggled (bool)
 Emitted whenever the UI widget's boolean value has changed. More...
 
- Signals inherited from EffectField
void Changed ()
 Changed signal. More...
 
void Clicked ()
 Clicked signal. More...
 
void EnabledChanged (bool)
 Enable change state signal. More...
 

Public Member Functions

 BoolField (EffectRow *parent, const QString &id)
 Reimplementation of EffectField::EffectField(). More...
 
bool GetBoolAt (double timecode)
 Get the boolean value at a given timecode. More...
 
virtual QWidget * CreateWidget (QWidget *existing=nullptr) override
 Reimplementation of EffectField::CreateWidget() More...
 
virtual void UpdateWidgetValue (QWidget *widget, double timecode) override
 Reimplementation of EffectField::UpdateWidgetValue() More...
 
virtual QVariant ConvertStringToValue (const QString &s) override
 Reimplementation of EffectField::ConvertStringToValue() More...
 
virtual QString ConvertValueToString (const QVariant &v) override
 Reimplementation of EffectField::ConvertValueToString() 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...
 
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 Slots

void UpdateFromWidget (bool b)
 Internal function connected to any QWidget made from CreateWidget() to update the value based on user input. 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...
 
- Public Attributes inherited from EffectField
QVariant persistent_data_
 Persistent data object. More...
 
QVector< EffectKeyframekeyframes
 Keyframe array. More...
 

Detailed Description

The BoolField class.

An EffectField derivative the produces boolean values (true or false) and uses a checkbox as its visual representation.

Constructor & Destructor Documentation

BoolField::BoolField ( EffectRow parent,
const QString &  id 
)

Reimplementation of EffectField::EffectField().

Member Function Documentation

QVariant BoolField::ConvertStringToValue ( const QString &  s)
overridevirtual

Reimplementation of EffectField::ConvertStringToValue()

Reimplemented from EffectField.

QString BoolField::ConvertValueToString ( const QVariant &  v)
overridevirtual

Reimplementation of EffectField::ConvertValueToString()

Reimplemented from EffectField.

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

Reimplementation of EffectField::CreateWidget()

Creates and connects to a QCheckBox.

Implements EffectField.

bool BoolField::GetBoolAt ( double  timecode)

Get the boolean value at a given timecode.

A convenience function, equivalent to GetValueAt(timecode).toBool()

Parameters
timecodeThe timecode to retrieve the value at
Returns

The boolean value at this timecode

void BoolField::Toggled ( bool  )
signal

Emitted whenever the UI widget's boolean value has changed.

For any QCheckBox created through this field's CreateWidget() function, this signal is emitted any time the checkbox value changes (either through user intervention or keyframing). It is mostly useful for enabling/disabling/changing other UI elements based on the checked state of this field's value (e.g. enabling other fields if this field is checked).

It is NOT a reliable signal that the value has changed at all, as it is only emitted if a widget (created from CreateWidget() ) is currently active.

void BoolField::UpdateFromWidget ( bool  b)
privateslot

Internal function connected to any QWidget made from CreateWidget() to update the value based on user input.

Parameters
bThe current checked state of the QWidget (QCheckBox in this case). Automatically set when this slot is connected to the QCheckBox::toggled() signal.
void BoolField::UpdateWidgetValue ( QWidget *  widget,
double  timecode 
)
overridevirtual

Reimplementation of EffectField::UpdateWidgetValue()

Reimplemented from EffectField.


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