Référence de la classe KoFieldVariable

#include <KoVariable.h>

Graphe d'héritage de KoFieldVariable:

[légende]
Graphe de collaboration de KoFieldVariable:
[légende]
Liste de tous les membres

Types publics

enum  FieldSubType {
  VST_NONE = -1, VST_FILENAME = 0, VST_DIRECTORYNAME = 1, VST_AUTHORNAME = 2,
  VST_EMAIL = 3, VST_COMPANYNAME = 4, VST_PATHFILENAME = 5, VST_FILENAMEWITHOUTEXTENSION = 6,
  VST_TELEPHONE_WORK = 7, VST_FAX = 8, VST_COUNTRY = 9, VST_TITLE = 10,
  VST_ABSTRACT = 11, VST_POSTAL_CODE = 12, VST_CITY = 13, VST_STREET = 14,
  VST_AUTHORTITLE = 15, VST_INITIAL = 16, VST_TELEPHONE_HOME = 17, VST_SUBJECT = 18,
  VST_KEYWORDS = 19, VST_AUTHORPOSITION = 20
}

Fonctions membres publiques

 KoFieldVariable (KoTextDocument *textdoc, short int subtype, KoVariableFormat *varFormat, KoVariableCollection *_varColl, KoDocument *_doc)
virtual VariableType type () const
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
virtual QString fieldCode ()
virtual void recalc ()
virtual QString text (bool realValue=false)
QString value () const
virtual short int variableSubType (short int menuNumber)
virtual QStringList subTypeList ()
 List of available subtypes (translated). Use variableSubType() to map index to ID.
virtual void setVariableSubType (short int subtype)
 Set this variable's subtype.
virtual short int subType () const

Fonctions membres publiques statiques

static QStringList actionTexts ()
static FieldSubType fieldSubType (short int menuNumber)

Attributs protégés

short int m_subtype
KoDocument * m_doc

Description détaillée

Any variable that is a string, and whose value is automatically determined - as opposed to custom variables whose value is entered by the user

Définition à la ligne 585 du fichier KoVariable.h.

Documentation des énumérations membres

enum KoFieldVariable::FieldSubType

Valeurs énumérées:
VST_NONE 
VST_FILENAME 
VST_DIRECTORYNAME 
VST_AUTHORNAME 
VST_EMAIL 
VST_COMPANYNAME 
VST_PATHFILENAME 
VST_FILENAMEWITHOUTEXTENSION 
VST_TELEPHONE_WORK 
VST_FAX 
VST_COUNTRY 
VST_TITLE 
VST_ABSTRACT 
VST_POSTAL_CODE 
VST_CITY 
VST_STREET 
VST_AUTHORTITLE 
VST_INITIAL 
VST_TELEPHONE_HOME 
VST_SUBJECT 
VST_KEYWORDS 
VST_AUTHORPOSITION 

Définition à la ligne 591 du fichier KoVariable.h.

Documentation des contructeurs et destructeur

KoFieldVariable::KoFieldVariable ( KoTextDocument *  textdoc,
short int  subtype,
KoVariableFormat *  varFormat,
KoVariableCollection *  _varColl,
KoDocument *  _doc 
)

Définition à la ligne 1987 du fichier KoVariable.cpp.

Documentation des fonctions membres

virtual VariableType KoFieldVariable::type (  )  const [inline, virtual]

Implémente KoVariable.

Définition à la ligne 600 du fichier KoVariable.h.

Références VT_FIELD.

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

Variable should reimplement this to implement saving.

Implémente KoVariable.

Définition à la ligne 2068 du fichier KoVariable.cpp.

Références m_subtype, et KoVariable::m_varValue.

void KoFieldVariable::load ( QDomElement &  elem  )  [virtual]

Réimplémentée à partir de KoVariable.

Définition à la ligne 2077 du fichier KoVariable.cpp.

Références KoVariable::load(), m_subtype, KoVariable::m_varValue, et VST_NONE.

Voici le graphe d'appel pour cette fonction :

void KoFieldVariable::loadOasis ( const QDomElement &  elem,
KoOasisContext &  context 
) [virtual]

Réimplémentée à partir de KoVariable.

Définition à la ligne 2091 du fichier KoVariable.cpp.

Références localName, m_subtype, KoVariable::m_varValue, KoXmlNS::text, VST_ABSTRACT, VST_AUTHORNAME, VST_AUTHORPOSITION, VST_AUTHORTITLE, VST_CITY, VST_COMPANYNAME, VST_COUNTRY, VST_DIRECTORYNAME, VST_EMAIL, VST_FAX, VST_FILENAME, VST_FILENAMEWITHOUTEXTENSION, VST_INITIAL, VST_KEYWORDS, VST_PATHFILENAME, VST_POSTAL_CODE, VST_STREET, VST_SUBJECT, VST_TELEPHONE_HOME, VST_TELEPHONE_WORK, et VST_TITLE.

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

Save to Oasis XML

Réimplémentée à partir de KoVariable.

Définition à la ligne 2150 du fichier KoVariable.cpp.

Références KoXmlWriter::addAttribute(), KoXmlWriter::addTextNode(), KoXmlWriter::endElement(), m_subtype, KoVariable::m_varValue, KoXmlWriter::startElement(), VST_ABSTRACT, VST_AUTHORNAME, VST_AUTHORPOSITION, VST_AUTHORTITLE, VST_CITY, VST_COMPANYNAME, VST_COUNTRY, VST_DIRECTORYNAME, VST_EMAIL, VST_FAX, VST_FILENAME, VST_FILENAMEWITHOUTEXTENSION, VST_INITIAL, VST_KEYWORDS, VST_NONE, VST_PATHFILENAME, VST_POSTAL_CODE, VST_STREET, VST_SUBJECT, VST_TELEPHONE_HOME, VST_TELEPHONE_WORK, et VST_TITLE.

Voici le graphe d'appel pour cette fonction :

QString KoFieldVariable::fieldCode (  )  [virtual]

Réimplémentée à partir de KoVariable.

Définition à la ligne 1992 du fichier KoVariable.cpp.

Références m_subtype, VST_ABSTRACT, VST_AUTHORNAME, VST_AUTHORTITLE, VST_CITY, VST_COMPANYNAME, VST_COUNTRY, VST_DIRECTORYNAME, VST_EMAIL, VST_FAX, VST_FILENAME, VST_FILENAMEWITHOUTEXTENSION, VST_INITIAL, VST_KEYWORDS, VST_PATHFILENAME, VST_POSTAL_CODE, VST_STREET, VST_SUBJECT, VST_TELEPHONE_HOME, VST_TELEPHONE_WORK, et VST_TITLE.

Référencé par text().

Voici le graphe d'appel pour cette fonction :

void KoFieldVariable::recalc (  )  [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().

Réimplémentée à partir de KoTextCustomItem.

Définition à la ligne 2228 du fichier KoVariable.cpp.

Références KoDocumentInfo::aboutInfo(), KoDocumentInfo::authorInfo(), KoDocument::documentInfo(), m_doc, m_subtype, KoVariable::m_varValue, gensymbolfontmap::pos, KoVariable::resize(), value(), VST_ABSTRACT, VST_AUTHORNAME, VST_AUTHORPOSITION, VST_AUTHORTITLE, VST_CITY, VST_COMPANYNAME, VST_COUNTRY, VST_DIRECTORYNAME, VST_EMAIL, VST_FAX, VST_FILENAME, VST_FILENAMEWITHOUTEXTENSION, VST_INITIAL, VST_KEYWORDS, VST_NONE, VST_PATHFILENAME, VST_POSTAL_CODE, VST_STREET, VST_SUBJECT, VST_TELEPHONE_HOME, VST_TELEPHONE_WORK, et VST_TITLE.

Voici le graphe d'appel pour cette fonction :

QString KoFieldVariable::text ( bool  realValue = false  )  [virtual]

Returns the text to be displayed for this variable It doesn't need to be cached, convert() is fast, and it's the actual value (date, time etc.) that is cached in the variable already.

Réimplémentée à partir de KoVariable.

Définition à la ligne 2059 du fichier KoVariable.cpp.

Références KoVariableSettings::displayFieldCode(), fieldCode(), KoVariable::m_varColl, value(), et KoVariableCollection::variableSetting().

Voici le graphe d'appel pour cette fonction :

QString KoFieldVariable::value ( void   )  const [inline]

Définition à la ligne 612 du fichier KoVariable.h.

Référencé par recalc(), et text().

Voici le graphe d'appel pour cette fonction :

QStringList KoFieldVariable::actionTexts (  )  [static]

Définition à la ligne 2337 du fichier KoVariable.cpp.

Référencé par subTypeList().

Voici le graphe d'appel pour cette fonction :

short int KoFieldVariable::variableSubType ( short int  menuNumber  )  [virtual]

Converts menuNumber to field variable subtype number

Réimplémentée à partir de KoVariable.

Définition à la ligne 2368 du fichier KoVariable.cpp.

Références fieldSubType().

Voici le graphe d'appel pour cette fonction :

KoFieldVariable::FieldSubType KoFieldVariable::fieldSubType ( short int  menuNumber  )  [static]

Converts menuNumber to field variable subtype number

Définition à la ligne 2373 du fichier KoVariable.cpp.

Références VST_ABSTRACT, VST_AUTHORNAME, VST_AUTHORPOSITION, VST_AUTHORTITLE, VST_CITY, VST_COMPANYNAME, VST_COUNTRY, VST_DIRECTORYNAME, VST_EMAIL, VST_FAX, VST_FILENAME, VST_FILENAMEWITHOUTEXTENSION, VST_INITIAL, VST_KEYWORDS, VST_NONE, VST_PATHFILENAME, VST_POSTAL_CODE, VST_STREET, VST_SUBJECT, VST_TELEPHONE_HOME, VST_TELEPHONE_WORK, et VST_TITLE.

Référencé par variableSubType().

Voici le graphe d'appel pour cette fonction :

QStringList KoFieldVariable::subTypeList (  )  [virtual]

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

Réimplémentée à partir de KoVariable.

Définition à la ligne 2428 du fichier KoVariable.cpp.

Références actionTexts().

Voici le graphe d'appel pour cette fonction :

virtual void KoFieldVariable::setVariableSubType ( short int  subtype  )  [inline, virtual]

Set this variable's subtype.

Réimplémentée à partir de KoVariable.

Définition à la ligne 625 du fichier KoVariable.h.

virtual short int KoFieldVariable::subType (  )  const [inline, virtual]

Réimplémentée à partir de KoVariable.

Définition à la ligne 627 du fichier KoVariable.h.

Documentation des données membres

short int KoFieldVariable::m_subtype [protected]

Définition à la ligne 630 du fichier KoVariable.h.

Référencé par fieldCode(), load(), loadOasis(), recalc(), saveOasis(), et saveVariable().

KoDocument* KoFieldVariable::m_doc [protected]

Définition à la ligne 631 du fichier KoVariable.h.

Référencé par recalc().

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