Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QContentPropertiesEngine Class Reference
[QtBaseModule]

The QContentPropertiesEngine class provides an abstraction for accessing content properties. More...

    #include <QContentPropertiesEngine>

This class is under development and is subject to change.

• List of all members, including inherited members

Public Functions

• virtual ~QContentPropertiesEngine ()
• virtual bool contains ( const QString & key ) const = 0
• virtual bool isReadOnly () const = 0
• virtual QStringList keys () const = 0
• virtual bool remove ( const QString & key ) = 0
• virtual bool setValue ( const QString & key, const QVariant & value ) = 0
• virtual QStringList supportedKeys () const = 0
• virtual QVariant value ( const QString & key, const QVariant & defaultValue ) const = 0

Detailed Description

The QContentPropertiesEngine class provides an abstraction for accessing content properties.

The QContentProperties class uses QContentPropertiesEngine internally to implement meta-data access for different content types.

Engines are created by instances of QContentPropertiesPlugin which are automatically loaded by QContentProperties.

See also QContentProperties and QContentPropertiesPlugin.

Member Function Documentation

QContentPropertiesEngine::~QContentPropertiesEngine ()   [virtual]

Destroys a QContentPropertiesEngine.

bool QContentPropertiesEngine::contains ( const QString & key ) const   [pure virtual]

Returns true if the content contains a property for the given key, and false otherwise.

bool QContentPropertiesEngine::isReadOnly () const   [pure virtual]

Returns true if the content properties are read-only. Properties may be read-only because the underlying file is read-only or the plug-in doesn't support writing properties.

QStringList QContentPropertiesEngine::keys () const   [pure virtual]

Returns a list of all the keys the content has properties for.

bool QContentPropertiesEngine::remove ( const QString & key )   [pure virtual]

Removes the property with the given key from the content. Returns true if the property was removed and false otherwise.

bool QContentPropertiesEngine::setValue ( const QString & key, const QVariant & value )   [pure virtual]

Sets the value of the content property identified by key to value. Returns true if the value was assigned and false otherwise.

See also value().

QStringList QContentPropertiesEngine::supportedKeys () const   [pure virtual]

Returns a list of all property keys explicitly supported for the content's type. If arbitrary strings keys are supported this will return an empty list.

QVariant QContentPropertiesEngine::value ( const QString & key, const QVariant & defaultValue ) const   [pure virtual]

Returns the value of the content property identified by key. If the content doesn't contain the property defaultValue is returned instead.

See also setValue().