lib

KoUserStyle Class Reference

#include <KoUserStyle.h>

Inheritance diagram for KoUserStyle:

KoCharStyle KoParagStyle List of all members.

Detailed Description

Base class for any kind of style that the user can create/modify/delete/display.

Use in conjunction with KoUserStyleCollection.

For every style provided by the application itself and named "Foo", ensure that i18n("Style name", "Foo") is available in a .cpp file, and create KoUserStyle("Foo"). The display name of the style will be set automatically to the translation of "Foo".

Definition at line 33 of file KoUserStyle.h.


Public Member Functions

 KoUserStyle (const QString &name)
QString name () const
void setName (const QString &name)
QString displayName () const
void setDisplayName (const QString &name)

Protected Attributes

QString m_name
QString m_displayName

Member Function Documentation

QString KoUserStyle::displayName  )  const
 

The user-visible name (e.g. translated, or set by the user).

Definition at line 27 of file KoUserStyle.cpp.

QString KoUserStyle::name  )  const [inline]
 

The internal name (used for loading/saving, but not shown to the user) Should be unique in a given style collection.

Definition at line 40 of file KoUserStyle.h.

void KoUserStyle::setDisplayName const QString &  name  ) 
 

Set the user-visible name.

Definition at line 32 of file KoUserStyle.cpp.

void KoUserStyle::setName const QString &  name  )  [inline]
 

Set the internal name - see generateUniqueName() if needed Should be unique in a given style collection.

Definition at line 43 of file KoUserStyle.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys