• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

lokalize

Public Member Functions | Protected Attributes | List of all members
CatalogStorage Class Referenceabstract

#include <catalogstorage.h>

Inheritance diagram for CatalogStorage:
Inheritance graph
[legend]

Public Member Functions

 CatalogStorage ()
 
virtual ~CatalogStorage ()
 
virtual QList< Phase > allPhases () const
 
virtual QMap< QString, Tool > allTools () const
 
virtual QVector< AltTrans > altTrans (const DocPosition &pos) const =0
 
virtual int binUnitsCount () const
 
virtual int capabilities () const =0
 
virtual CatalogString catalogString (const DocPosition &pos) const =0
 
virtual QStringList context (const DocPosition &) const =0
 
virtual QVector< Note > developerNotes (const DocPosition &pos) const =0
 
virtual QString id (const DocPosition &) const =0
 
virtual bool isApproved (const DocPosition &) const
 
virtual bool isEmpty (const DocPosition &) const =0
 
virtual bool isEquivTrans (const DocPosition &) const
 
virtual bool isObsolete (int entry) const
 
virtual bool isPlural (const DocPosition &) const =0
 
virtual int load (QIODevice *device)=0
 
virtual QStringList matchData (const DocPosition &) const =0
 
virtual QString mimetype () const =0
 
virtual QStringList noteAuthors () const
 
virtual QVector< Note > notes (const DocPosition &pos) const =0
 
int numberOfEntries () const
 
int numberOfPluralForms () const
 
virtual QString phase (const DocPosition &pos) const
 
virtual Phase phase (const QString &name) const
 
virtual QVector< Note > phaseNotes (const QString &phase) const
 
virtual bool save (QIODevice *device, bool belongsToProject=false)=0
 
virtual void setApproved (const DocPosition &, bool approved)
 
virtual void setEquivTrans (const DocPosition &, bool equivTrans)
 
virtual Note setNote (DocPosition pos, const Note &note)=0
 
virtual QString setPhase (const DocPosition &pos, const QString &phase)
 
virtual QVector< Note > setPhaseNotes (const QString &phase, QVector< Note > notes)
 
virtual TargetState setState (const DocPosition &, TargetState)
 
virtual void setTarget (const DocPosition &pos, const QString &arg)=0
 
void setUrl (const KUrl &u)
 
virtual int size () const =0
 
virtual QString source (const DocPosition &pos) const =0
 
virtual QStringList sourceAllForms (const DocPosition &pos, bool stripNewLines=false) const =0
 
virtual QStringList sourceFiles (const DocPosition &pos) const =0
 
QString sourceLangCode () const
 
virtual CatalogString sourceWithTags (DocPosition pos) const =0
 
virtual TargetState state (const DocPosition &) const
 
virtual QString target (const DocPosition &pos) const =0
 
virtual QStringList targetAllForms (const DocPosition &pos, bool stripNewLines=false) const =0
 
virtual void targetDelete (const DocPosition &pos, int count)=0
 
virtual InlineTag targetDeleteTag (const DocPosition &)
 
virtual void targetInsert (const DocPosition &pos, const QString &arg)=0
 
virtual void targetInsertTag (const DocPosition &, const InlineTag &)
 
QString targetLangCode () const
 
virtual CatalogString targetWithTags (DocPosition pos) const =0
 
virtual int unitById (const QString &id) const
 
virtual Phase updatePhase (const Phase &)
 
const KUrl & url () const
 

Protected Attributes

int m_numberOfPluralForms
 
QString m_sourceLangCode
 
QString m_targetLangCode
 
KUrl m_url
 

Detailed Description

Abstract interface for storage of translation file.

format-specific elements like " for gettext PO should be eliminated

Abstract interface for storage of translation file

Author
Nick Shaforostoff shaff.nosp@m.f@uk.nosp@m.r.net

Definition at line 45 of file catalogstorage.h.

Constructor & Destructor Documentation

CatalogStorage::CatalogStorage ( )
inline

Definition at line 159 of file catalogstorage.h.

CatalogStorage::~CatalogStorage ( )
inlinevirtual

Definition at line 165 of file catalogstorage.h.

Member Function Documentation

virtual QList<Phase> CatalogStorage::allPhases ( ) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 79 of file catalogstorage.h.

virtual QMap<QString,Tool> CatalogStorage::allTools ( ) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 80 of file catalogstorage.h.

virtual QVector<AltTrans> CatalogStorage::altTrans ( const DocPosition &  pos) const
pure virtual

Implemented in GettextCatalog::GettextStorage, XliffStorage, and TsStorage.

virtual int CatalogStorage::binUnitsCount ( ) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 140 of file catalogstorage.h.

virtual int CatalogStorage::capabilities ( ) const
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual CatalogString CatalogStorage::catalogString ( const DocPosition &  pos) const
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual QStringList CatalogStorage::context ( const DocPosition &  ) const
pure virtual

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual QVector<Note> CatalogStorage::developerNotes ( const DocPosition &  pos) const
pure virtual

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual QString CatalogStorage::id ( const DocPosition &  ) const
pure virtual

entry id unique for this file

pos.form doesn't matter

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual bool CatalogStorage::isApproved ( const DocPosition &  ) const
inlinevirtual

Reimplemented in GettextCatalog::GettextStorage, and TsStorage.

Definition at line 133 of file catalogstorage.h.

virtual bool CatalogStorage::isEmpty ( const DocPosition &  ) const
pure virtual

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual bool CatalogStorage::isEquivTrans ( const DocPosition &  ) const
inlinevirtual

Reimplemented in XliffStorage, and TsStorage.

Definition at line 130 of file catalogstorage.h.

virtual bool CatalogStorage::isObsolete ( int  entry) const
inlinevirtual

Reimplemented in TsStorage.

Definition at line 138 of file catalogstorage.h.

virtual bool CatalogStorage::isPlural ( const DocPosition &  ) const
pure virtual

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual int CatalogStorage::load ( QIODevice *  device)
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual QStringList CatalogStorage::matchData ( const DocPosition &  ) const
pure virtual

user-invisible data for matching, e.g.

during TM database lookup it is comprised of several strings

database stores them and thus it is possible to fuzzy-match 'matchData' later

it is responsibility of CatalogStorage implementations to separate/assemble the list properly according to the format specifics

pos.form doesn't matter

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual QString CatalogStorage::mimetype ( ) const
pure virtual

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual QStringList CatalogStorage::noteAuthors ( ) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 89 of file catalogstorage.h.

virtual QVector<Note> CatalogStorage::notes ( const DocPosition &  pos) const
pure virtual

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

int CatalogStorage::numberOfEntries ( ) const
inline

Definition at line 56 of file catalogstorage.h.

int CatalogStorage::numberOfPluralForms ( ) const
inline

Definition at line 57 of file catalogstorage.h.

virtual QString CatalogStorage::phase ( const DocPosition &  pos) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 94 of file catalogstorage.h.

virtual Phase CatalogStorage::phase ( const QString &  name) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 95 of file catalogstorage.h.

virtual QVector<Note> CatalogStorage::phaseNotes ( const QString &  phase) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 96 of file catalogstorage.h.

virtual bool CatalogStorage::save ( QIODevice *  device,
bool  belongsToProject = false 
)
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual void CatalogStorage::setApproved ( const DocPosition &  ,
bool  approved 
)
inlinevirtual

Reimplemented in GettextCatalog::GettextStorage, and TsStorage.

Definition at line 134 of file catalogstorage.h.

virtual void CatalogStorage::setEquivTrans ( const DocPosition &  ,
bool  equivTrans 
)
inlinevirtual

Reimplemented in XliffStorage, and TsStorage.

Definition at line 131 of file catalogstorage.h.

virtual Note CatalogStorage::setNote ( DocPosition  pos,
const Note &  note 
)
pure virtual

Implemented in XliffStorage, GettextCatalog::GettextStorage, and TsStorage.

virtual QString CatalogStorage::setPhase ( const DocPosition &  pos,
const QString &  phase 
)
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 93 of file catalogstorage.h.

virtual QVector<Note> CatalogStorage::setPhaseNotes ( const QString &  phase,
QVector< Note >  notes 
)
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 97 of file catalogstorage.h.

virtual TargetState CatalogStorage::setState ( const DocPosition &  ,
TargetState   
)
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 136 of file catalogstorage.h.

virtual void CatalogStorage::setTarget ( const DocPosition &  pos,
const QString &  arg 
)
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

void CatalogStorage::setUrl ( const KUrl &  u)
inline

Definition at line 144 of file catalogstorage.h.

virtual int CatalogStorage::size ( ) const
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual QString CatalogStorage::source ( const DocPosition &  pos) const
pure virtual

flat-model interface (ignores XLIFF grouping)

format-specific texts like " for gettext PO should be eliminated

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual QStringList CatalogStorage::sourceAllForms ( const DocPosition &  pos,
bool  stripNewLines = false 
) const
pure virtual

all plural forms. pos.form doesn't matter

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual QStringList CatalogStorage::sourceFiles ( const DocPosition &  pos) const
pure virtual

Implemented in GettextCatalog::GettextStorage, XliffStorage, and TsStorage.

QString CatalogStorage::sourceLangCode ( ) const
inline

Definition at line 148 of file catalogstorage.h.

virtual CatalogString CatalogStorage::sourceWithTags ( DocPosition  pos) const
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual TargetState CatalogStorage::state ( const DocPosition &  ) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 135 of file catalogstorage.h.

virtual QString CatalogStorage::target ( const DocPosition &  pos) const
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual QStringList CatalogStorage::targetAllForms ( const DocPosition &  pos,
bool  stripNewLines = false 
) const
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual void CatalogStorage::targetDelete ( const DocPosition &  pos,
int  count 
)
pure virtual

edit operations used by undo/redo system and sync-mode

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual InlineTag CatalogStorage::targetDeleteTag ( const DocPosition &  )
inlinevirtual

Reimplemented in GettextCatalog::GettextStorage, and XliffStorage.

Definition at line 77 of file catalogstorage.h.

virtual void CatalogStorage::targetInsert ( const DocPosition &  pos,
const QString &  arg 
)
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual void CatalogStorage::targetInsertTag ( const DocPosition &  ,
const InlineTag &   
)
inlinevirtual

Reimplemented in GettextCatalog::GettextStorage, and XliffStorage.

Definition at line 76 of file catalogstorage.h.

QString CatalogStorage::targetLangCode ( ) const
inline

Definition at line 149 of file catalogstorage.h.

virtual CatalogString CatalogStorage::targetWithTags ( DocPosition  pos) const
pure virtual

Implemented in GettextCatalog::GettextStorage, TsStorage, and XliffStorage.

virtual int CatalogStorage::unitById ( const QString &  id) const
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 141 of file catalogstorage.h.

virtual Phase CatalogStorage::updatePhase ( const Phase &  )
inlinevirtual

Reimplemented in XliffStorage.

Definition at line 78 of file catalogstorage.h.

const KUrl& CatalogStorage::url ( ) const
inline

Definition at line 143 of file catalogstorage.h.

Member Data Documentation

int CatalogStorage::m_numberOfPluralForms
protected

Definition at line 156 of file catalogstorage.h.

QString CatalogStorage::m_sourceLangCode
protected

Definition at line 153 of file catalogstorage.h.

QString CatalogStorage::m_targetLangCode
protected

Definition at line 154 of file catalogstorage.h.

KUrl CatalogStorage::m_url
protected

Definition at line 152 of file catalogstorage.h.


The documentation for this class was generated from the following file:
  • catalogstorage.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:03:45 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

lokalize

Skip menu "lokalize"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal