kate Library API Documentation

KateDocumentConfig Class Reference

Inheritance diagram for KateDocumentConfig:

KateConfig List of all members.

Public Types

enum  IndentationMode {
  imNone = 0, imNormal = 1, imCStyle = 2, imPythonStyle = 3,
  imXmlStyle = 4, imCSAndS = 5, imVarIndent = 6
}
enum  ConfigFlags {
  cfBackspaceIndents = 0x2, cfWordWrap = 0x4, cfReplaceTabs = 0x8, cfRemoveSpaces = 0x10,
  cfWrapCursor = 0x20, cfAutoBrackets = 0x40, cfPersistent = 0x80, cfKeepSelection = 0x100,
  cfTabIndentsMode = 0x200, cfDelOnInput = 0x400, cfXorSelect = 0x800, cfOvr = 0x1000,
  cfMark = 0x2000, cfKeepIndentProfile = 0x8000, cfKeepExtraSpaces = 0x10000, cfTabIndents = 0x80000,
  cfShowTabs = 0x200000, cfSpaceIndent = 0x400000, cfSmartHome = 0x800000, cfTabInsertsTab = 0x1000000,
  cfReplaceTabsDyn = 0x2000000, cfRemoveTrailingDyn = 0x4000000, cfDoxygenAutoTyping = 0x8000000, cfMixedIndent = 0x10000000
}
enum  Eol { eolUnix = 0, eolDos = 1, eolMac = 2 }
enum  BackupFlags { LocalFiles = 1, RemoteFiles = 2 }

Public Member Functions

 KateDocumentConfig (KateDocument *doc)
 ~KateDocumentConfig ()
bool isGlobal () const
void readConfig (KConfig *config)
void writeConfig (KConfig *config)
int tabWidth () const
void setTabWidth (int tabWidth)
int indentationWidth () const
void setIndentationWidth (int indentationWidth)
uint indentationMode () const
void setIndentationMode (uint identationMode)
bool wordWrap () const
void setWordWrap (bool on)
unsigned int wordWrapAt () const
void setWordWrapAt (unsigned int col)
uint undoSteps () const
void setUndoSteps (uint undoSteps)
bool pageUpDownMovesCursor () const
void setPageUpDownMovesCursor (bool on)
uint configFlags () const
void setConfigFlags (KateDocumentConfig::ConfigFlags flag, bool enable)
void setConfigFlags (uint fullFlags)
const QStringencoding () const
QTextCodeccodec ()
void setEncoding (const QString &encoding)
bool isSetEncoding () const
int eol () const
QString eolString ()
void setEol (int mode)
uint backupFlags () const
void setBackupFlags (uint flags)
const QStringbackupPrefix () const
void setBackupPrefix (const QString &prefix)
const QStringbackupSuffix () const
void setBackupSuffix (const QString &suffix)
bool plugin (uint index) const
void setPlugin (uint index, bool load)
int searchDirConfigDepth () const
void setSearchDirConfigDepth (int depth)

Static Public Member Functions

static KateDocumentConfigglobal ()

Protected Member Functions

void updateConfig ()

Friends

class KateFactory

Detailed Description

Definition at line 89 of file kateconfig.h.


Constructor & Destructor Documentation

KateDocumentConfig::KateDocumentConfig KateDocument doc  ) 
 

Construct a DocumentConfig.

Definition at line 121 of file kateconfig.cpp.

References QBitArray::fill().

KateDocumentConfig::~KateDocumentConfig  ) 
 

Cu DocumentConfig.

Definition at line 146 of file kateconfig.cpp.


Member Function Documentation

void KateDocumentConfig::readConfig KConfig config  ) 
 

Read config from object.

Definition at line 150 of file kateconfig.cpp.

References KateConfig::configEnd(), KateConfig::configStart(), KateFactory::plugins(), KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readNumEntry(), KateFactory::self(), setBackupFlags(), setBackupPrefix(), setBackupSuffix(), setConfigFlags(), setEncoding(), setEol(), setIndentationMode(), setIndentationWidth(), setPageUpDownMovesCursor(), setPlugin(), setSearchDirConfigDepth(), setTabWidth(), setUndoSteps(), setWordWrap(), and setWordWrapAt().

Referenced by KateDocument::readConfig().

void KateDocumentConfig::writeConfig KConfig config  ) 
 

Write config to object.

Definition at line 190 of file kateconfig.cpp.

References backupFlags(), backupPrefix(), backupSuffix(), configFlags(), encoding(), eol(), indentationMode(), indentationWidth(), pageUpDownMovesCursor(), plugin(), searchDirConfigDepth(), KateFactory::self(), tabWidth(), undoSteps(), wordWrap(), wordWrapAt(), and KConfigBase::writeEntry().

Referenced by KateDocument::writeConfig().

void KateDocumentConfig::updateConfig  )  [protected, virtual]
 

do the real update

Implements KateConfig.

Definition at line 223 of file kateconfig.cpp.

References QPtrList::at(), KateFactory::documents(), isGlobal(), KateFactory::self(), and KateDocument::updateConfig().

int KateDocumentConfig::searchDirConfigDepth  )  const
 

Should Kate Part search for dir wide config file and if, how depth?

Returns:
search depth (< 0 no search)

Definition at line 569 of file kateconfig.cpp.

References isGlobal(), and searchDirConfigDepth().

Referenced by searchDirConfigDepth(), and writeConfig().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 8 06:26:26 2006 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003