Catalog Class Reference

#include <catalog.h>

Inheritance diagram for Catalog:

Public Slots
QString	activePhase () const
ProjectLocal::PersonRole	activePhaseRole () const
QList< Phase >	allPhases () const
QMap< QString, Tool >	allTools () const
QVector< AltTrans >	altTrans (const DocPosition &pos) const
int	binUnitsCount () const
CatalogString	catalogString (const DocPosition &pos) const
QByteArray	contents ()
QStringList	context (const DocPosition &pos) const
QVector< Note >	developerNotes (const DocPosition &pos) const
QString	id (const DocPosition &pos) const
bool	isApproved (uint index) const
bool	isApproved (const DocPosition &pos) const
bool	isBookmarked (uint index) const
bool	isEmpty (uint index) const
bool	isEmpty (const DocPosition &) const
bool	isEquivTrans (const DocPosition &) const
bool	isModified (DocPos entry) const
bool	isModified (int entry) const
bool	isObsolete (int entry) const
bool	isPlural (uint index) const
bool	isPlural (const DocPosition &pos) const
int	loadFromUrl (const KUrl &url, const KUrl &saidUrl=KUrl(), int *fileSize=0)
QString	mimetype ()
QStringList	noteAuthors () const
QVector< Note >	notes (const DocPosition &pos) const
int	numberOfEntries () const
int	numberOfNonApproved () const
int	numberOfPluralForms () const
int	numberOfUntranslated () const
QString	phase (const DocPosition &pos) const
Phase	phase (const QString &name) const
QVector< Note >	phaseNotes (const QString &phase) const
bool	save ()
bool	saveToUrl (KUrl url)
void	setActivePhase (const QString &phase, ProjectLocal::PersonRole role=ProjectLocal::Approver)
void	setBookmark (uint, bool)
Note	setNote (const DocPosition &pos, const Note &note)
QString	setPhase (const DocPosition &pos, const QString &phase)
QVector< Note >	setPhaseNotes (const QString &phase, QVector< Note >)
QString	source (const DocPosition &pos) const
QStringList	sourceFiles (const DocPosition &pos) const
QString	sourceLangCode () const
CatalogString	sourceWithTags (const DocPosition &pos) const
TargetState	state (const DocPosition &pos) const
QString	target (const DocPosition &pos) const
QString	targetLangCode () const
CatalogString	targetWithTags (const DocPosition &pos) const
int	unitById (const QString &id) const
const KUrl &	url () const

Signals
void	activePhaseChanged ()
void	signalEntryModified (const DocPosition &)
void	signalFileAutoSaveFailed (const QString &)
Q_SCRIPTABLE void	signalFileLoaded ()
void	signalFileLoaded (const KUrl &)
Q_SCRIPTABLE void	signalFileSaved ()
void	signalFileSaved (const KUrl &)
void	signalNumberOfEmptyChanged ()
void	signalNumberOfFuzziesChanged ()

Public Member Functions
	Catalog (QObject *parent)
virtual	~Catalog ()
void	attachAltTrans (int entry, const AltTrans &trans)
void	attachAltTransCatalog (Catalog *)
bool	autoSaveRecovered ()
int	capabilities () const
void	clear ()
int	firstBookmarkIndex () const
int	firstFuzzyIndex () const
int	firstUntranslatedIndex () const
bool	isEmpty ()
bool	isReadOnly ()
int	lastBookmarkIndex () const
int	lastFuzzyIndex () const
int	lastUntranslatedIndex () const
QString	msgid (const DocPosition &) const
virtual QString	msgstr (const DocPosition &) const
int	nextBookmarkIndex (uint index) const
int	nextFuzzyIndex (uint index) const
int	nextUntranslatedIndex (uint index) const
int	prevBookmarkIndex (uint index) const
int	prevFuzzyIndex (uint index) const
int	prevUntranslatedIndex (uint index) const
void	push (QUndoCommand *cmd)
virtual const DocPosition &	redo ()
void	setTarget (DocPosition pos, const CatalogString &s)
void	setUrl (const KUrl &u)
virtual const DocPosition &	undo ()

Static Public Member Functions
static bool	extIsSupported (const QString &path)
static const char *const *	states ()
static QStringList	supportedExtensions ()

Static Public Attributes
static QString	supportedMimeFilters

Protected Slots
void	doAutoSave ()
void	flushUpdateDBBuffer ()
void	projectConfigChanged ()
void	setAutoSaveDirty ()

Protected Member Functions
virtual KAutoSaveFile *	checkAutoSave (const KUrl &url)
void	setApproved (const DocPosition &pos, bool approved)
void	setEquivTrans (const DocPosition &, bool equivTrans)
void	setLastModifiedPos (const DocPosition &)
bool	setModified (DocPos entry, bool modif)
TargetState	setState (const DocPosition &pos, TargetState state)
void	targetDelete (const DocPosition &pos, int count)
InlineTag	targetDeleteTag (const DocPosition &pos)
void	targetInsert (const DocPosition &pos, const QString &arg)
void	targetInsertTag (const DocPosition &pos, const InlineTag &tag)
void	updateApprovedEmptyIndexCache ()
Phase	updatePhase (const Phase &phase)

Protected Attributes
CatalogPrivate *	d
CatalogStorage *	m_storage

Detailed Description

This class represents a catalog It uses CatalogStorage interface to work with catalogs in different formats Also it defines all necessary functions to set and get the entries.

Wrapper class that represents a translation catalog

Author

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

Definition at line 74 of file catalog.h.

Constructor & Destructor Documentation

Catalog::Catalog

(

QObject *

parent

)

Definition at line 102 of file catalog.cpp.

Catalog::~Catalog ( )

virtual

Definition at line 122 of file catalog.cpp.

Member Function Documentation

QString Catalog::activePhase ( ) const

inlineslot

Definition at line 119 of file catalog.h.

void Catalog::activePhaseChanged ( )

signal

ProjectLocal::PersonRole Catalog::activePhaseRole ( ) const

inlineslot

Definition at line 120 of file catalog.h.

QList< Phase > Catalog::allPhases ( ) const

slot

Definition at line 385 of file catalog.cpp.

QMap< QString, Tool > Catalog::allTools ( ) const

slot

Definition at line 400 of file catalog.cpp.

QVector< AltTrans > Catalog::altTrans ( const DocPosition &  pos ) const

slot

Definition at line 272 of file catalog.cpp.

void Catalog::attachAltTrans	(	int	entry,
		const AltTrans &	trans
	)

Definition at line 267 of file catalog.cpp.

void Catalog::attachAltTransCatalog

(

Catalog *

altCat

)

Definition at line 260 of file catalog.cpp.

bool Catalog::autoSaveRecovered ( )

inline

Definition at line 171 of file catalog.h.

int Catalog::binUnitsCount ( ) const

slot

so DocPosition::entry may actually be < size()+binUnitsCount()

Definition at line 448 of file catalog.cpp.

int Catalog::capabilities

(

)

const

Definition at line 164 of file catalog.cpp.

CatalogString Catalog::catalogString ( const DocPosition &  pos ) const

slot

Definition at line 219 of file catalog.cpp.

KAutoSaveFile * Catalog::checkAutoSave ( const KUrl &  url )

protectedvirtual

Definition at line 489 of file catalog.cpp.

void Catalog::clear

(

)

Definition at line 130 of file catalog.cpp.

QByteArray Catalog::contents ( )

slot

Definition at line 700 of file catalog.cpp.

QStringList Catalog::context ( const DocPosition &  pos ) const

slot

Definition at line 322 of file catalog.cpp.

QVector< Note > Catalog::developerNotes ( const DocPosition &  pos ) const

slot

Definition at line 236 of file catalog.cpp.

void Catalog::doAutoSave ( )

protectedslot

Definition at line 678 of file catalog.cpp.

bool Catalog::extIsSupported ( const QString &  path )

static

Definition at line 93 of file catalog.cpp.

int Catalog::firstBookmarkIndex ( ) const

inline

Definition at line 166 of file catalog.h.

int Catalog::firstFuzzyIndex ( ) const

inline

Definition at line 157 of file catalog.h.

int Catalog::firstUntranslatedIndex ( ) const

inline

Definition at line 161 of file catalog.h.

void Catalog::flushUpdateDBBuffer ( )

protectedslot

updates DB for _posBuffer and accompanying _originalForLastModified

Definition at line 749 of file catalog.cpp.

QString Catalog::id ( const DocPosition &  pos ) const

slot

Definition at line 314 of file catalog.cpp.

bool Catalog::isApproved ( uint  index ) const

slot

Definition at line 410 of file catalog.cpp.

bool Catalog::isApproved ( const DocPosition &  pos ) const

inlineslot

Definition at line 132 of file catalog.h.

bool Catalog::isBookmarked ( uint  index ) const

inlineslot

Definition at line 147 of file catalog.h.

bool Catalog::isEmpty ( uint  index ) const

slot

Returns

true if at least one form is untranslated

Definition at line 432 of file catalog.cpp.

bool Catalog::isEmpty ( const DocPosition &  pos ) const

slot

Definition at line 437 of file catalog.cpp.

bool Catalog::isEmpty ( )

inline

Definition at line 174 of file catalog.h.

bool Catalog::isEquivTrans ( const DocPosition &  pos ) const

slot

Definition at line 443 of file catalog.cpp.

bool Catalog::isModified ( DocPos  entry ) const

slot

Definition at line 925 of file catalog.cpp.

bool Catalog::isModified ( int  entry ) const

slot

Definition at line 930 of file catalog.cpp.

bool Catalog::isObsolete ( int  entry ) const

slot

Definition at line 1012 of file catalog.cpp.

bool Catalog::isPlural ( uint  index ) const

slot

Definition at line 405 of file catalog.cpp.

bool Catalog::isPlural ( const DocPosition &  pos ) const

inlineslot

Definition at line 130 of file catalog.h.

bool Catalog::isReadOnly ( )

inline

Definition at line 175 of file catalog.h.

int Catalog::lastBookmarkIndex ( ) const

inline

Definition at line 167 of file catalog.h.

int Catalog::lastFuzzyIndex ( ) const

inline

Definition at line 158 of file catalog.h.

int Catalog::lastUntranslatedIndex ( ) const

inline

Definition at line 162 of file catalog.h.

int Catalog::loadFromUrl ( const KUrl &  url, const KUrl &  saidUrl = KUrl(), int *  fileSize = 0  )

slot

Returns

0 if success, >0 erroneous line (parsing error)

Definition at line 508 of file catalog.cpp.

QString Catalog::mimetype ( )

slot

Definition at line 458 of file catalog.cpp.

QString Catalog::msgid

(

const DocPosition &

pos

)

const

Definition at line 187 of file catalog.cpp.

QString Catalog::msgstr ( const DocPosition &  pos ) const

virtual

Reimplemented in MergeCatalog.

Definition at line 195 of file catalog.cpp.

int Catalog::nextBookmarkIndex ( uint  index ) const

inline

Definition at line 168 of file catalog.h.

int Catalog::nextFuzzyIndex ( uint  index ) const

inline

Definition at line 159 of file catalog.h.

int Catalog::nextUntranslatedIndex ( uint  index ) const

inline

Definition at line 163 of file catalog.h.

QStringList Catalog::noteAuthors ( ) const

slot

Definition at line 252 of file catalog.cpp.

QVector< Note > Catalog::notes ( const DocPosition &  pos ) const

slot

Definition at line 228 of file catalog.cpp.

int Catalog::numberOfEntries ( ) const

slot

Definition at line 171 of file catalog.cpp.

int Catalog::numberOfNonApproved ( ) const

inlineslot

Definition at line 152 of file catalog.h.

int Catalog::numberOfPluralForms ( ) const

inlineslot

Definition at line 150 of file catalog.h.

int Catalog::numberOfUntranslated ( ) const

inlineslot

Definition at line 153 of file catalog.h.

QString Catalog::phase ( const DocPosition &  pos ) const

slot

Definition at line 372 of file catalog.cpp.

Phase Catalog::phase ( const QString &  name ) const

slot

Definition at line 380 of file catalog.cpp.

QVector< Note > Catalog::phaseNotes ( const QString &  phase ) const

slot

Definition at line 390 of file catalog.cpp.

int Catalog::prevBookmarkIndex ( uint  index ) const

inline

Definition at line 169 of file catalog.h.

int Catalog::prevFuzzyIndex ( uint  index ) const

inline

Definition at line 160 of file catalog.h.

int Catalog::prevUntranslatedIndex ( uint  index ) const

inline

Definition at line 164 of file catalog.h.

void Catalog::projectConfigChanged ( )

protectedslot

Definition at line 695 of file catalog.cpp.

void Catalog::push

(

QUndoCommand *

cmd

)

Definition at line 155 of file catalog.cpp.

const DocPosition & Catalog::redo ( )

virtual

Definition at line 743 of file catalog.cpp.

bool Catalog::save ( )

slot

Definition at line 606 of file catalog.cpp.

bool Catalog::saveToUrl ( KUrl  url )

slot

Definition at line 612 of file catalog.cpp.

void Catalog::setActivePhase ( const QString &  phase, ProjectLocal::PersonRole  role = ProjectLocal::Approver  )

slot

Definition at line 339 of file catalog.cpp.

void Catalog::setApproved ( const DocPosition &  pos, bool  approved  )

protected

(EDITING) accessed from undo/redo code accessed from mergeCatalog) it does check if action should be taken

void Catalog::setAutoSaveDirty ( )

inlineprotectedslot

Definition at line 209 of file catalog.h.

void Catalog::setBookmark ( uint  idx, bool  set  )

slot

Definition at line 981 of file catalog.cpp.

void Catalog::setEquivTrans ( const DocPosition &  pos, bool  equivTrans  )

protected

Definition at line 907 of file catalog.cpp.

void Catalog::setLastModifiedPos ( const DocPosition &  pos )

protected

(EDITING) accessed from undo/redo code called BEFORE modification

Definition at line 780 of file catalog.cpp.

bool Catalog::setModified ( DocPos  entry, bool  modif  )

protected

Returns

true if entry wasn't modified before

Definition at line 912 of file catalog.cpp.

Note Catalog::setNote ( const DocPosition &  pos, const Note &  note  )

slot

pos.form is note number

Returns

previous note contents, if any

Definition at line 244 of file catalog.cpp.

QString Catalog::setPhase ( const DocPosition &  pos, const QString &  phase  )

slot

Returns

previous phase-name

Definition at line 330 of file catalog.cpp.

QVector< Note > Catalog::setPhaseNotes ( const QString &  phase, QVector< Note >  notes  )

slot

• pos.entry - number of phase,
• pos.form - number of note

Definition at line 395 of file catalog.cpp.

TargetState Catalog::setState ( const DocPosition &  pos, TargetState  state  )

protected

Definition at line 869 of file catalog.cpp.

void Catalog::setTarget	(	DocPosition	pos,
		const CatalogString &	s
	)

Definition at line 863 of file catalog.cpp.

void Catalog::setUrl ( const KUrl &  u )

inline

Definition at line 187 of file catalog.h.

void Catalog::signalEntryModified ( const DocPosition &  )

signal

void Catalog::signalFileAutoSaveFailed ( const QString &  )

signal

Q_SCRIPTABLE void Catalog::signalFileLoaded ( )

signal

void Catalog::signalFileLoaded ( const KUrl &  )

signal

Q_SCRIPTABLE void Catalog::signalFileSaved ( )

signal

void Catalog::signalFileSaved ( const KUrl &  )

signal

void Catalog::signalNumberOfEmptyChanged ( )

signal

void Catalog::signalNumberOfFuzziesChanged ( )

signal

QString Catalog::source ( const DocPosition &  pos ) const

inlineslot

Definition at line 95 of file catalog.h.

QStringList Catalog::sourceFiles ( const DocPosition &  pos ) const

slot

Definition at line 306 of file catalog.cpp.

QString Catalog::sourceLangCode ( ) const

slot

Definition at line 466 of file catalog.cpp.

CatalogString Catalog::sourceWithTags ( const DocPosition &  pos ) const

slot

Definition at line 203 of file catalog.cpp.

TargetState Catalog::state ( const DocPosition &  pos ) const

slot

Definition at line 421 of file catalog.cpp.

const char *const * Catalog::states ( )

static

Definition at line 79 of file catalog.cpp.

QStringList Catalog::supportedExtensions ( )

static

Definition at line 84 of file catalog.cpp.

QString Catalog::target ( const DocPosition &  pos ) const

inlineslot

Definition at line 96 of file catalog.h.

void Catalog::targetDelete ( const DocPosition &  pos, int  count  )

protected

Definition at line 802 of file catalog.cpp.

InlineTag Catalog::targetDeleteTag ( const DocPosition &  pos )

protected

Definition at line 849 of file catalog.cpp.

void Catalog::targetInsert ( const DocPosition &  pos, const QString &  arg  )

protected

Definition at line 825 of file catalog.cpp.

void Catalog::targetInsertTag ( const DocPosition &  pos, const InlineTag &  tag  )

protected

Definition at line 837 of file catalog.cpp.

QString Catalog::targetLangCode ( ) const

slot

Definition at line 474 of file catalog.cpp.

CatalogString Catalog::targetWithTags ( const DocPosition &  pos ) const

slot

Definition at line 211 of file catalog.cpp.

const DocPosition & Catalog::undo ( )

virtual

Definition at line 737 of file catalog.cpp.

int Catalog::unitById ( const QString &  id ) const

slot

Definition at line 453 of file catalog.cpp.

void Catalog::updateApprovedEmptyIndexCache ( )

protected

Definition at line 347 of file catalog.cpp.

Phase Catalog::updatePhase ( const Phase &  phase )

protected

Definition at line 902 of file catalog.cpp.

const KUrl& Catalog::url ( ) const

inlineslot

Definition at line 189 of file catalog.h.

Member Data Documentation

CatalogPrivate* Catalog::d

protected

Definition at line 242 of file catalog.h.

CatalogStorage* Catalog::m_storage

protected

Definition at line 243 of file catalog.h.

QString Catalog::supportedMimeFilters

static

Definition at line 259 of file catalog.h.

---

The documentation for this class was generated from the following files:

• catalog.h
• catalog.cpp