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

The StringField class. More...

#include <stringfield.h>

Inheritance diagram for StringField:
EffectField

Public Member Functions

 StringField (EffectRow *parent, const QString &id, bool rich_text=true)
 Reimplementation of EffectField::EffectField(). More...
 
QString GetStringAt (double timecode)
 Get the string at the 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...
 
- 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...
 
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 (const QString &b)
 Internal function connected to any QWidget made from CreateWidget() to update the value based on user input. More...
 

Private Attributes

bool rich_text_
 Internal value for whether this field is in rich text or plain text mode. 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 StringField class.

An EffectField derivative that produces arbitrary strings entered by the user and uses a TextEditEx as its visual representation.

Constructor & Destructor Documentation

StringField::StringField ( EffectRow parent,
const QString &  id,
bool  rich_text = true 
)

Reimplementation of EffectField::EffectField().

Provides a setting for whether this StringField - and its attached TextEditEx objects - should operate in rich text or plain text mode, defaulting to rich text mode.

Member Function Documentation

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

Reimplementation of EffectField::CreateWidget()

Creates and connects to a TextEditEx.

Implements EffectField.

QString StringField::GetStringAt ( double  timecode)

Get the string at the given timecode.

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

Parameters
timecodeThe timecode to retrieve the string at
Returns

The string at this timecode

void StringField::UpdateFromWidget ( const QString &  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 (EmbeddedFileChooser in this case). Automatically set when this slot is connected to the EmbeddedFileChooser::changed() signal.
void StringField::UpdateWidgetValue ( QWidget *  widget,
double  timecode 
)
overridevirtual

Reimplementation of EffectField::UpdateWidgetValue()

Reimplemented from EffectField.

Member Data Documentation

bool StringField::rich_text_
private

Internal value for whether this field is in rich text or plain text mode.


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