lib

KoPageVariable Class Reference

#include <KoVariable.h>

Inheritance diagram for KoPageVariable:

KoVariable KoTextCustomItem List of all members.

Detailed Description

"current page number" and "number of pages" variables This is a base class, it must be inherited by applications, to provide recalc().

Definition at line 660 of file KoVariable.h.


Public Types

enum  {
  VST_PGNUM_CURRENT = 0, VST_PGNUM_TOTAL = 1, VST_CURRENT_SECTION = 2, VST_PGNUM_PREVIOUS = 3,
  VST_PGNUM_NEXT = 4
}

Public Member Functions

 KoPageVariable (KoTextDocument *textdoc, short int subtype, KoVariableFormat *varFormat, KoVariableCollection *_varColl)
virtual VariableType type () const
virtual QString fieldCode ()
virtual QStringList subTypeList ()
virtual void setVariableSubType (short int subtype)
void setPgNum (int pgNum)
void setSectionTitle (const QString &title)
virtual short int subType () const
virtual void recalc ()=0
virtual void saveVariable (QDomElement &parentElem)
virtual void load (QDomElement &elem)
virtual void loadOasis (const QDomElement &elem, KoOasisContext &context)
virtual void saveOasis (KoXmlWriter &writer, KoSavingContext &context) const

Static Public Member Functions

static QStringList actionTexts ()

Protected Attributes

short int m_subtype

Member Function Documentation

QStringList KoPageVariable::subTypeList (  )  [virtual]

List of available subtypes (translated). Use variableSubType() to map index to ID.

Reimplemented from KoVariable.

Definition at line 1952 of file KoVariable.cpp.

void KoPageVariable::setVariableSubType ( short int  subtype  )  [virtual]

Set this variable's subtype.

Reimplemented from KoVariable.

Definition at line 1957 of file KoVariable.cpp.

virtual void KoPageVariable::recalc (  )  [pure virtual]

Reimplemented by KoVariable to recalculate the value.

It exists at the KoTextCustomItem level so that KoTextParag::setCustomItem can call it to set the initial value. This should call always resize().

Reimplemented from KoTextCustomItem.

void KoPageVariable::saveVariable ( QDomElement &  parentElem  )  [virtual]

Variable should reimplement this to implement saving.

Implements KoVariable.

Definition at line 1840 of file KoVariable.cpp.

void KoPageVariable::saveOasis ( KoXmlWriter writer,
KoSavingContext context 
) const [virtual]

Save to Oasis XML.

Reimplemented from KoVariable.

Definition at line 1866 of file KoVariable.cpp.


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