add some apidocs

This commit is contained in:
Giorgos Tsiapaliokas 2013-08-30 12:01:13 +03:00 committed by Marco Martin
parent 39d2575ce2
commit 426d34e6e2

View File

@ -48,10 +48,24 @@ public:
ConfigCategory(QObject *parent = 0); ConfigCategory(QObject *parent = 0);
~ConfigCategory(); ~ConfigCategory();
/**
* @return the name of the category
**/
QString name() const; QString name() const;
/**
* @param name the name of the category
**/
void setName(const QString &name); void setName(const QString &name);
/**
* @return the icon of the category
**/
QString icon() const; QString icon() const;
/**
* @param icon the icon of the category
**/
void setIcon(const QString &icon); void setIcon(const QString &icon);
QString source() const; QString source() const;
@ -61,9 +75,24 @@ public:
void setPluginName(const QString &pluginName); void setPluginName(const QString &pluginName);
Q_SIGNALS: Q_SIGNALS:
/**
* emitted when the name id changed
**/
void nameChanged(); void nameChanged();
/**
* emitted when the icon is changed
**/
void iconChanged(); void iconChanged();
/**
* emitted when the source is changed
**/
void sourceChanged(); void sourceChanged();
/**
* emitted when the plugin is changed
**/
void pluginNameChanged(); void pluginNameChanged();
private: private:
@ -89,7 +118,15 @@ public:
ConfigModel(QObject *parent = 0); ConfigModel(QObject *parent = 0);
~ConfigModel(); ~ConfigModel();
/**
* add a new category in the model
* @param ConfigCategory the new category
**/
void appendCategory(ConfigCategory *c); void appendCategory(ConfigCategory *c);
/**
* clears the model
**/
void clear(); void clear();
void setApplet(Plasma::Applet *interface); void setApplet(Plasma::Applet *interface);
@ -98,6 +135,11 @@ public:
int count() {return rowCount();} int count() {return rowCount();}
virtual int rowCount(const QModelIndex &index = QModelIndex()) const; virtual int rowCount(const QModelIndex &index = QModelIndex()) const;
virtual QVariant data(const QModelIndex&, int) const; virtual QVariant data(const QModelIndex&, int) const;
/**
* @param row the row for which the data will be returned
* @raturn the data of the specified row
**/
Q_INVOKABLE QVariant get(int row) const; Q_INVOKABLE QVariant get(int row) const;
QQmlListProperty<ConfigCategory> categories(); QQmlListProperty<ConfigCategory> categories();
@ -108,6 +150,9 @@ public:
static void categories_clear(QQmlListProperty<ConfigCategory> *prop); static void categories_clear(QQmlListProperty<ConfigCategory> *prop);
Q_SIGNALS: Q_SIGNALS:
/**
* emitted when the count is changed
**/
void countChanged(); void countChanged();
private: private: