Seamly2D
Code documentation
VPE::VShortcutProperty Class Reference

This property can be used to handle key shortcuts. More...

#include <vshortcutproperty.h>

Inheritance diagram for VPE::VShortcutProperty:
Collaboration diagram for VPE::VShortcutProperty:

Public Member Functions

 VShortcutProperty (const QString &name)
 
virtual ~VShortcutProperty () Q_DECL_OVERRIDE
 The destructor. More...
 
virtual QVariant data (int column=DPC_Name, int role=Qt::DisplayRole) const Q_DECL_OVERRIDE
 Get the data how it should be displayed. More...
 
virtual QWidget * createEditor (QWidget *parent, const QStyleOptionViewItem &options, const QAbstractItemDelegate *delegate) Q_DECL_OVERRIDE
 Returns an editor widget, or NULL if it doesn't supply one. More...
 
virtual bool setEditorData (QWidget *editor) Q_DECL_OVERRIDE
 Sets the property's data to the editor (returns false, if the standard delegate should do that) More...
 
virtual QVariant getEditorData (const QWidget *editor) const Q_DECL_OVERRIDE
 Gets the data from the widget. More...
 
virtual QString type () const Q_DECL_OVERRIDE
 Returns a string containing the type of the property. More...
 
virtual Q_REQUIRED_RESULT VPropertyclone (bool include_children=true, VProperty *container=nullptr) const Q_DECL_OVERRIDE
 Clones this property. More...
 
virtual void setValue (const QVariant &value) Q_DECL_OVERRIDE
 Sets the value of the property. More...
 
- Public Member Functions inherited from VPE::VProperty
 VProperty (const QString &name, QVariant::Type type=QVariant::String)
 Standard constructor, takes a name and a parent property as argument. More...
 
virtual ~VProperty () Q_DECL_OVERRIDE
 Destructor. More...
 
virtual bool setData (const QVariant &data, int role=Qt::EditRole)
 This is used by the model to set the data. More...
 
virtual bool paint (QPainter *, const QStyleOptionViewItem &, const QModelIndex &, const QAbstractItemDelegate *) const
 This is called by the delegate when the property value is being drawn. The standard implementation doesn't do anything. If you reimplement this in a sub property, make sure to return true or the delegate will draw the item. More...
 
virtual Qt::ItemFlags flags (int column=DPC_Name) const
 Returns item flags. More...
 
virtual QVariant getValue () const
 Returns the value of the property as a QVariant. More...
 
virtual QString serialize () const
 Serializes the value to a string. More...
 
virtual void deserialize (const QString &value)
 Deserializes the value from a string. More...
 
virtual void setName (const QString &name)
 Sets the name of the property. More...
 
virtual QString getName () const
 Gets the name of the property. More...
 
virtual void setDescription (const QString &desc)
 Sets the name of the property. More...
 
virtual QString getDescription () const
 Gets the name of the property. More...
 
virtual int addChild (VProperty *child)
 Adds a child to this property. More...
 
virtual QList< VProperty * > & getChildren ()
 Returns a reference to the list of children. More...
 
virtual const QList< VProperty * > & getChildren () const
 Returns a reference to the list of children. More...
 
virtual VPropertygetChild (int row) const
 Returns the child at a certain row. More...
 
virtual int getRowCount () const
 Gets the number of children. More...
 
virtual VPropertygetParent () const
 Gets the parent of this property. More...
 
virtual void setParent (VProperty *parent)
 Sets the parent of this property. More...
 
virtual void removeChild (VProperty *child)
 Removes a child from the children list, doesn't delete the child! More...
 
virtual int getChildRow (VProperty *child) const
 Returns the row the child has. More...
 
virtual bool getUpdateParent () const
 Returns whether the views have to update the parent of this property if it changes. More...
 
virtual bool getUpdateChildren () const
 Returns whether the views have to update the children of this property if it changes. More...
 
virtual void setUpdateBehaviour (bool update_parent, bool update_children)
 Sets whether the views should update Parents or children after this property changes. More...
 
virtual void setSettings (const QMap< QString, QVariant > &settings)
 Sets the settings by calling the overloaded setSetting(const QString &key, const QVariant &value) for each item in the map. More...
 
virtual QMap< QString, QVariant > getSettings () const
 Get the settings. More...
 
virtual void setSetting (const QString &key, const QVariant &value)
 Sets the settings. This function has to be implemented in a subclass in order to have an effect. More...
 
virtual QVariant getSetting (const QString &key) const
 Get the settings. This function has to be implemented in a subclass in order to have an effect. More...
 
virtual QStringList getSettingKeys () const
 Returns the list of keys of the property's settings. More...
 
Property propertyType () const
 
void setPropertyType (const Property &type)
 
virtual void updateParent (const QVariant &value)
 

Additional Inherited Members

- Public Types inherited from VPE::VProperty
enum  DPC_DisplayColumn { DPC_Name = 0 , DPC_Data }
 
- Public Slots inherited from VPE::VProperty
virtual void childValueChanged (const QVariant &value, int typeForParent)
 
- Signals inherited from VPE::VProperty
void childChanged (const QVariant &value, int typeForParent)
 
- Protected Member Functions inherited from VPE::VProperty
 VProperty (VPropertyPrivate *d)
 Protected constructor. More...
 
- Protected Attributes inherited from VPE::VProperty
VPropertyPrivated_ptr
 The protected structure holding the member variables (to assure binary compatibility) More...
 

Detailed Description

This property can be used to handle key shortcuts.

Definition at line 39 of file vshortcutproperty.h.

Constructor & Destructor Documentation

◆ VShortcutProperty()

VPE::VShortcutProperty::VShortcutProperty ( const QString &  name)
explicit

Definition at line 31 of file vshortcutproperty.cpp.

◆ ~VShortcutProperty()

VPE::VShortcutProperty::~VShortcutProperty ( )
virtual

The destructor.

Definition at line 37 of file vshortcutproperty.cpp.

Member Function Documentation

◆ clone()

VPE::VProperty * VPE::VShortcutProperty::clone ( bool  include_children = true,
VProperty container = nullptr 
) const
virtual

Clones this property.

Parameters
include_childrenIndicates whether to also clone the children
containerIf a property is being passed here, no new VProperty is being created but instead it is tried to fill all the data into container. This can also be used when subclassing this function.
Returns
Returns the newly created property (or container, if it was not NULL)

Reimplemented from VPE::VProperty.

Definition at line 99 of file vshortcutproperty.cpp.

References VPE::VProperty::clone().

◆ createEditor()

QWidget * VPE::VShortcutProperty::createEditor ( QWidget *  parent,
const QStyleOptionViewItem &  options,
const QAbstractItemDelegate *  delegate 
)
virtual

Returns an editor widget, or NULL if it doesn't supply one.

Parameters
parentThe widget to which the editor will be added as a child \options Render options \delegate A pointer to the QAbstractItemDelegate requesting the editor. This can be used to connect signals and slots.

Reimplemented from VPE::VProperty.

Definition at line 53 of file vshortcutproperty.cpp.

◆ data()

QVariant VPE::VShortcutProperty::data ( int  column = DPC_Name,
int  role = Qt::DisplayRole 
) const
virtual

Get the data how it should be displayed.

Reimplemented from VPE::VProperty.

Definition at line 42 of file vshortcutproperty.cpp.

References VPE::VProperty::data().

◆ getEditorData()

QVariant VPE::VShortcutProperty::getEditorData ( const QWidget *  editor) const
virtual

Gets the data from the widget.

Reimplemented from VPE::VProperty.

Definition at line 82 of file vshortcutproperty.cpp.

References VPE::VShortcutEditWidget::getShortcutAsString().

◆ setEditorData()

bool VPE::VShortcutProperty::setEditorData ( QWidget *  editor)
virtual

Sets the property's data to the editor (returns false, if the standard delegate should do that)

Reimplemented from VPE::VProperty.

Definition at line 68 of file vshortcutproperty.cpp.

References VPE::VShortcutEditWidget::setShortcut().

◆ setValue()

void VPE::VShortcutProperty::setValue ( const QVariant &  value)
virtual

Sets the value of the property.

Reimplemented from VPE::VProperty.

Definition at line 104 of file vshortcutproperty.cpp.

References VPE::VProperty::setValue().

◆ type()

QString VPE::VShortcutProperty::type ( ) const
virtual

Returns a string containing the type of the property.

Reimplemented from VPE::VProperty.

Definition at line 94 of file vshortcutproperty.cpp.


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