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

The FontField class. More...

#include <fontfield.h>

Inheritance diagram for FontField:
EffectField

Public Member Functions

 FontField (EffectRow *parent, const QString &id)
 Reimplementation of EffectField::EffectField(). More...
 
QString GetFontAt (double timecode)
 Get the font family name 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 &index)
 Internal function connected to any QWidget made from CreateWidget() to update the value based on user input. More...
 

Private Attributes

QStringList font_list
 Internal list of fonts to add to a QComboBox when creating one in CreateWidget(). 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 FontField class.

An EffectField derivative the produces font family names in string and uses a QComboBox as its visual representation.

TODO Upgrade to QFontComboBox.

Constructor & Destructor Documentation

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

Reimplementation of EffectField::EffectField().

Member Function Documentation

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

Reimplementation of EffectField::CreateWidget()

Creates and connects to a QComboBox.

Implements EffectField.

QString FontField::GetFontAt ( double  timecode)

Get the font family name at the given timecode.

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

Parameters
timecodeThe timecode to retrieve the font family name at
Returns

The font family name at this timecode

void FontField::UpdateFromWidget ( const QString &  index)
privateslot

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

Parameters
bThe current font name specified by the QWidget (QComboBox in this case). Automatically set when this slot is connected to the QComboBox::currentTextChanged() signal.
void FontField::UpdateWidgetValue ( QWidget *  widget,
double  timecode 
)
overridevirtual

Reimplementation of EffectField::UpdateWidgetValue()

Reimplemented from EffectField.

Member Data Documentation

QStringList FontField::font_list
private

Internal list of fonts to add to a QComboBox when creating one in CreateWidget().

NOTE: Deprecated. Once QComboBox is replaced by QFontComboBox this will be completely unnecessary.


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