Référence de la classe KoListStyle

#include <KoListStyle.h>

Graphe de collaboration de KoListStyle:

[légende]
Liste de tous les membres

Types publics

enum  Style {
  SquareItem = QTextListFormat::ListSquare, DiscItem = QTextListFormat::ListDisc, CircleItem = QTextListFormat::ListCircle, DecimalItem = QTextListFormat::ListDecimal,
  AlphaLowerItem = QTextListFormat::ListLowerAlpha, UpperAlphaItem = QTextListFormat::ListUpperAlpha, NoItem = 1, RomanLowerItem,
  UpperRomanItem, BoxItem, CustomCharItem
}
 This list is used to specify what kind of list-style to use. Plus de détails...
enum  Property {
  ListItemPrefix = QTextFormat::UserProperty+1000, ListItemSuffix, ConsecutiveNumbering, StartValue,
  Level, DisplayLevel, CharacterStyleId, BulletCharacter,
  BulletSize, ListHeader, NoListItem, ExplicitListValue
}
 further properties Plus de détails...

Fonctions membres publiques

 KoListStyle ()
 constructor
 KoListStyle (const KoListStyle &orig)
 copy constructor
void setStyle (Style style)
 set the style to be used for this list.
Style style () const
 return the used style
void setListItemPrefix (const QString &prefix)
QString listItemPrefix () const
void setListItemSuffix (const QString &suffix)
QString listItemSuffix () const
void setConsecutiveNumbering (bool on)
bool consecutiveNumbering () const
void setStartValue (int value)
int startValue () const
void setLevel (int level)
int level () const
void setDisplayLevel (int level)
int displayLevel () const
void setCharacterStyleId (int id)
int characterStyleId () const
void setBulletCharacter (QChar character)
QChar bulletCharacter () const
void setRelativeBulletSize (int percent)
int relativeBulletSize () const
const QString & name () const
 return the name of the style.
void setName (const QString &name)
 set a user-visible name on the style.
void applyStyle (const QTextBlock &block)

Fonctions membres protégées

void addUser ()
void removeUser ()
int userCount () const
void apply (const KoListStyle &other)

Fonctions membres privées

void setProperty (int key, const QVariant &value)
int propertyInt (int key) const
bool propertyBoolean (int key) const
QString propertyString (int key) const

Attributs privés

QString m_name
StylePrivate * m_stylesPrivate
QMap< const QTextDocument *,
QPointer< QTextList > > 		m_textLists
int m_refCount

Amis

class KoParagraphStyle

Description détaillée

This class groups all styling-options for lists. See KoParagraphStyle::setListStyle() This class represents one list-level which can span several paragraphs, but typically just one pargraph-style since that style can be reused on various paragraphs.

Définition à la ligne 36 du fichier KoListStyle.h.

Documentation des énumérations membres

enum KoListStyle::Style

This list is used to specify what kind of list-style to use.

Valeurs énumérées:
SquareItem  Draw a square.
DiscItem  Draw a disc (filled circle).
CircleItem  Draw a disc (non-filled disk).
DecimalItem  use arabic numbering (1, 2, 3, ...)
AlphaLowerItem  use alpha numbering (a, b, c, ... aa, ab, ...)
UpperAlphaItem  use alpha numbering (A, B, C, ... AA, AB, ...)
NoItem  don't draw a list item, just the prefix/suffix
RomanLowerItem  use lower roman counting. (i, ii, iii, iv, ...)
UpperRomanItem  use lower roman counting. (I, II, III, IV, ...)
BoxItem  draw a box
CustomCharItem  use an unicode char for the numbering

Définition à la ligne 39 du fichier KoListStyle.h.

enum KoListStyle::Property

further properties

Valeurs énumérées:
ListItemPrefix  The text to be printed before the listItem.
ListItemSuffix  The text to be printed after the listItem.
ConsecutiveNumbering  when true don't let non-numbering parags restart numbering
StartValue  First value to use.
Level  list nesting level, is 1 or higher, or zero when implied
DisplayLevel  show this many levels. Is always lower than the (implied) level.
CharacterStyleId  CharacterStyle used for markup of the counter.
BulletCharacter  an int with the unicode value of the character
BulletSize  size in percent relative to the height of the text
ListHeader  TextBlock level flag to mark a block to be a listHeader.
NoListItem  TextBlock level flag to mark a block to not have a listItem.
ExplicitListValue  TextBlock level int with the value that that parag will have.

Définition à la ligne 67 du fichier KoListStyle.h.

Documentation des contructeurs et destructeur

KoListStyle::KoListStyle (  ) 

constructor

Définition à la ligne 26 du fichier KoListStyle.cpp.

Références DiscItem, m_refCount, m_stylesPrivate, setStartValue(), et setStyle().

Voici le graphe d'appel pour cette fonction :

KoListStyle::KoListStyle ( const KoListStyle &  orig  ) 

copy constructor

Définition à la ligne 33 du fichier KoListStyle.cpp.

Références StylePrivate::copyMissing(), m_name, m_refCount, m_stylesPrivate, et name().

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

void KoListStyle::setStyle ( Style  style  )  [inline]

set the style to be used for this list.

Définition à la ligne 88 du fichier KoListStyle.h.

Références setProperty().

Référencé par KoListStyle().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Style KoListStyle::style (  )  const [inline]

return the used style

Définition à la ligne 90 du fichier KoListStyle.h.

Références propertyInt().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setListItemPrefix ( const QString &  prefix  )  [inline]

Définition à la ligne 91 du fichier KoListStyle.h.

Références ListItemPrefix, et setProperty().

Voici le graphe d'appel pour cette fonction :

QString KoListStyle::listItemPrefix (  )  const [inline]

Définition à la ligne 92 du fichier KoListStyle.h.

Références ListItemPrefix, et propertyString().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setListItemSuffix ( const QString &  suffix  )  [inline]

Définition à la ligne 93 du fichier KoListStyle.h.

Références ListItemSuffix, et setProperty().

Voici le graphe d'appel pour cette fonction :

QString KoListStyle::listItemSuffix (  )  const [inline]

Définition à la ligne 94 du fichier KoListStyle.h.

Références ListItemSuffix, et propertyString().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setConsecutiveNumbering ( bool  on  )  [inline]

If true keep numbering even if there was a lower list in between listitems. This attribute specifies whether or not the list style uses consecutive numbering for all list levels or whether each list level restarts the numbering.

Définition à la ligne 100 du fichier KoListStyle.h.

Références ConsecutiveNumbering, et setProperty().

Voici le graphe d'appel pour cette fonction :

bool KoListStyle::consecutiveNumbering (  )  const [inline]

If true keep numbering even if there was a lower list in between listitems. This attribute specifies whether or not the list style uses consecutive numbering for all list levels or whether each list level restarts the numbering.

Définition à la ligne 106 du fichier KoListStyle.h.

Références ConsecutiveNumbering, et propertyBoolean().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setStartValue ( int  value  )  [inline]

Définition à la ligne 107 du fichier KoListStyle.h.

Références setProperty(), et StartValue.

Référencé par KoListStyle().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

int KoListStyle::startValue (  )  const [inline]

Définition à la ligne 108 du fichier KoListStyle.h.

Références propertyInt(), et StartValue.

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setLevel ( int  level  )  [inline]

Définition à la ligne 109 du fichier KoListStyle.h.

Références Level, et setProperty().

Voici le graphe d'appel pour cette fonction :

int KoListStyle::level (  )  const [inline]

Définition à la ligne 110 du fichier KoListStyle.h.

Références Level, et propertyInt().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setDisplayLevel ( int  level  )  [inline]

Définition à la ligne 111 du fichier KoListStyle.h.

Références DisplayLevel, et setProperty().

Voici le graphe d'appel pour cette fonction :

int KoListStyle::displayLevel (  )  const [inline]

Définition à la ligne 112 du fichier KoListStyle.h.

Références DisplayLevel, et propertyInt().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setCharacterStyleId ( int  id  )  [inline]

Définition à la ligne 113 du fichier KoListStyle.h.

Références CharacterStyleId, et setProperty().

Voici le graphe d'appel pour cette fonction :

int KoListStyle::characterStyleId (  )  const [inline]

Définition à la ligne 114 du fichier KoListStyle.h.

Références CharacterStyleId, et propertyInt().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setBulletCharacter ( QChar  character  )  [inline]

Définition à la ligne 115 du fichier KoListStyle.h.

Références BulletCharacter, et setProperty().

Voici le graphe d'appel pour cette fonction :

QChar KoListStyle::bulletCharacter (  )  const [inline]

Définition à la ligne 116 du fichier KoListStyle.h.

Références BulletCharacter, et propertyInt().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setRelativeBulletSize ( int  percent  )  [inline]

Définition à la ligne 117 du fichier KoListStyle.h.

Références BulletSize, et setProperty().

Voici le graphe d'appel pour cette fonction :

int KoListStyle::relativeBulletSize (  )  const [inline]

Définition à la ligne 118 du fichier KoListStyle.h.

Références BulletSize, et propertyInt().

Voici le graphe d'appel pour cette fonction :

const QString& KoListStyle::name (  )  const [inline]

return the name of the style.

Définition à la ligne 121 du fichier KoListStyle.h.

Références m_name.

Référencé par apply(), et KoListStyle().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setName ( const QString &  name  )  [inline]

set a user-visible name on the style.

Définition à la ligne 124 du fichier KoListStyle.h.

Références m_name.

void KoListStyle::applyStyle ( const QTextBlock &  block  ) 

Apply this style to a blockFormat by copying all properties from this style to the target block format.

Définition à la ligne 65 du fichier KoListStyle.cpp.

Références BulletCharacter, BulletSize, CharacterStyleId, ConsecutiveNumbering, DisplayLevel, StylePrivate::get(), Level, ListItemPrefix, ListItemSuffix, m_stylesPrivate, m_textLists, et StartValue.

Référencé par KoParagraphStyle::applyStyle().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoListStyle::addUser (  )  [inline, protected]

Définition à la ligne 134 du fichier KoListStyle.h.

Références m_refCount.

Référencé par KoParagraphStyle::KoParagraphStyle(), et KoParagraphStyle::setListStyle().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::removeUser (  )  [inline, protected]

Définition à la ligne 135 du fichier KoListStyle.h.

Références m_refCount.

Référencé par KoParagraphStyle::~KoParagraphStyle().

Voici le graphe d'appel pour cette fonction :

int KoListStyle::userCount (  )  const [inline, protected]

Définition à la ligne 136 du fichier KoListStyle.h.

Références m_refCount.

Référencé par KoParagraphStyle::~KoParagraphStyle().

Voici le graphe d'appel pour cette fonction :

void KoListStyle::apply ( const KoListStyle &  other  )  [protected]

Définition à la ligne 118 du fichier KoListStyle.cpp.

Références StylePrivate::clearAll(), StylePrivate::copyMissing(), m_name, m_stylesPrivate, et name().

Référencé par KoParagraphStyle::setListStyle().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoListStyle::setProperty ( int  key,
const QVariant &  value 
) [private]

Définition à la ligne 40 du fichier KoListStyle.cpp.

Références StylePrivate::add(), et m_stylesPrivate.

Référencé par setBulletCharacter(), setCharacterStyleId(), setConsecutiveNumbering(), setDisplayLevel(), setLevel(), setListItemPrefix(), setListItemSuffix(), setRelativeBulletSize(), setStartValue(), et setStyle().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

int KoListStyle::propertyInt ( int  key  )  const [private]

Définition à la ligne 44 du fichier KoListStyle.cpp.

Références StylePrivate::get(), et m_stylesPrivate.

Référencé par bulletCharacter(), characterStyleId(), displayLevel(), level(), relativeBulletSize(), startValue(), et style().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoListStyle::propertyBoolean ( int  key  )  const [private]

Définition à la ligne 51 du fichier KoListStyle.cpp.

Références StylePrivate::get(), et m_stylesPrivate.

Référencé par consecutiveNumbering().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

QString KoListStyle::propertyString ( int  key  )  const [private]

Définition à la ligne 58 du fichier KoListStyle.cpp.

Références StylePrivate::get(), et m_stylesPrivate.

Référencé par listItemPrefix(), et listItemSuffix().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions amies et associées

friend class KoParagraphStyle [friend]

Définition à la ligne 133 du fichier KoListStyle.h.

Documentation des données membres

QString KoListStyle::m_name [private]

Définition à la ligne 147 du fichier KoListStyle.h.

Référencé par apply(), KoListStyle(), name(), et setName().

StylePrivate* KoListStyle::m_stylesPrivate [private]

Définition à la ligne 148 du fichier KoListStyle.h.

Référencé par apply(), applyStyle(), KoListStyle(), propertyBoolean(), propertyInt(), propertyString(), et setProperty().

QMap<const QTextDocument*, QPointer<QTextList> > KoListStyle::m_textLists [private]

Définition à la ligne 149 du fichier KoListStyle.h.

Référencé par applyStyle().

int KoListStyle::m_refCount [private]

Définition à la ligne 150 du fichier KoListStyle.h.

Référencé par addUser(), KoListStyle(), removeUser(), et userCount().

La documentation de cette classe a été générée à partir des fichiers suivants :
Généré le Wed Nov 22 23:46:34 2006 pour KPlato par  doxygen 1.5.1-p1