Logo Search packages:      
Sourcecode: palapeli version File versions  Download package

Palapeli::HexagonalPatternConfiguration Class Reference

#include <pattern-hexagon.h>

Inheritance diagram for Palapeli::HexagonalPatternConfiguration:


List of all members.

Detailed Description

For internal use only.

Definition at line 50 of file pattern-hexagon.h.

Public Types

enum  DataType { Variant = 0, String, Integer, Boolean }
 Defines acceptable data types for properties. Note that this does not affect the internal handling of values, these are always passed as QVariant (but it is ensured that they have a specific meta type). The data type defined through this enumeration mainly specifies which configuration widget is used to let the user manipulate this property. More...

Public Slots

void setProperty (const QByteArray &key, const QVariant &value)
 Sets a property to the given value.


void propertyChanged (const QByteArray &key, const QVariant &value)
 This signal is emitted whenever a defined property's value changed.

Public Member Functions

virtual PatterncreatePattern () const
 Creates a Pattern instance. You will have to implement this function in your subclass to create your own Palapeli::Pattern instance. This is also the point to pass any property values to your pattern.
 HexagonalPatternConfiguration (const QString &pluginName, const QString &displayName, const QString &iconName)
void populateWidget (QWidget *widget)
QVariant property (const QByteArray &key) const
 Reads a property.
void readArguments (KConfigGroup *config)
 Loads parameters from a configuration. This function reads all defined properties from the passed config.
void writeArguments (KConfigGroup *config) const
 Saves parameters to a configuration. This function writes the values of all defined properties to the passed config.

Protected Member Functions

void addProperty (const QByteArray &key, DataType type, const QString &caption)
 Define a new property.
void addPropertyParameters (const QByteArray &key, const QVariantList &parameters)
 Add parameters to this property. It depends on the DataType of the property what these parameters do. For String properties, the parameters are understood as valid values; the input is then restricted to these options (by using a KComboBox instead of a KLineEdit in configuration dialogs). For Int properties, the first parameter is the minimum value (default is 0), and the second parameter is the maximum value (default is 100); any further parameters are discarded. For all other data types, all parameters are discarded.
virtual void readCustomArguments (KConfigGroup *config)
virtual void writeCustomArguments (KConfigGroup *config) const

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

Generated by  Doxygen 1.6.0   Back to index