KateDocumentConfig Class Reference

#include <kateconfig.h>

Inheritance diagram for KateDocumentConfig:

[legend]

List of all members.

Public Types
enum	BackupFlags { LocalFiles = 1, RemoteFiles = 2 }
enum	ConfigFlags {   cfBackspaceIndents = 0x2, cfWordWrap = 0x4, cfRemoveSpaces = 0x10, cfWrapCursor = 0x20,   cfAutoBrackets = 0x40, cfTabIndentsMode = 0x200, cfOvr = 0x1000, cfKeepIndentProfile = 0x8000,   cfKeepExtraSpaces = 0x10000, cfTabIndents = 0x80000, cfShowTabs = 0x200000, cfSpaceIndent = 0x400000,   cfSmartHome = 0x800000, cfTabInsertsTab = 0x1000000, cfReplaceTabsDyn = 0x2000000, cfRemoveTrailingDyn = 0x4000000,   cfDoxygenAutoTyping = 0x8000000, cfMixedIndent = 0x10000000, cfIndentPastedText = 0x20000000 }
enum	Eol { eolUnix = 0, eolDos = 1, eolMac = 2 }
enum	IndentationMode {   imNone = 0, imNormal = 1, imCStyle = 2, imPythonStyle = 3,   imXmlStyle = 4, imCSAndS = 5, imVarIndent = 6, imScriptIndent = 7 }
Public Member Functions
bool	allowEolDetection () const
uint	backupFlags () const
const QString &	backupPrefix () const
const QString &	backupSuffix () const
QTextCodec *	codec ()
uint	configFlags () const
const QString &	encoding () const
int	eol () const
QString	eolString ()
uint	indentationMode () const
int	indentationWidth () const
bool	isGlobal () const
bool	isSetEncoding () const
	KateDocumentConfig (KateDocument *doc)
bool	pageUpDownMovesCursor () const
bool	plugin (uint index) const
void	readConfig (KConfig *config)
int	searchDirConfigDepth () const
void	setAllowEolDetection (bool on)
void	setBackupFlags (uint flags)
void	setBackupPrefix (const QString &prefix)
void	setBackupSuffix (const QString &suffix)
void	setConfigFlags (uint fullFlags)
void	setConfigFlags (KateDocumentConfig::ConfigFlags flag, bool enable)
void	setEncoding (const QString &encoding)
void	setEol (int mode)
void	setIndentationMode (uint identationMode)
void	setIndentationWidth (int indentationWidth)
void	setPageUpDownMovesCursor (bool on)
void	setPlugin (uint index, bool load)
void	setSearchDirConfigDepth (int depth)
void	setTabWidth (int tabWidth)
void	setUndoSteps (uint undoSteps)
void	setWordWrap (bool on)
void	setWordWrapAt (unsigned int col)
int	tabWidth () const
uint	undoSteps () const
bool	wordWrap () const
unsigned int	wordWrapAt () const
void	writeConfig (KConfig *config)
	~KateDocumentConfig ()
Static Public Member Functions
static KateDocumentConfig *	global ()
Protected Member Functions
void	updateConfig ()

---

Detailed Description

Definition at line 89 of file kateconfig.h.

---

Member Enumeration Documentation

enum KateDocumentConfig::BackupFlags

Enumerator:

LocalFiles
RemoteFiles

Definition at line 211 of file kateconfig.h.

enum KateDocumentConfig::ConfigFlags

Enumerator:

cfBackspaceIndents
cfWordWrap
cfRemoveSpaces
cfWrapCursor
cfAutoBrackets
cfTabIndentsMode
cfOvr
cfKeepIndentProfile
cfKeepExtraSpaces
cfTabIndents
cfShowTabs
cfSpaceIndent
cfSmartHome
cfTabInsertsTab
cfReplaceTabsDyn
cfRemoveTrailingDyn
cfDoxygenAutoTyping
cfMixedIndent
cfIndentPastedText

Definition at line 162 of file kateconfig.h.

enum KateDocumentConfig::Eol

Enumerator:

eolUnix
eolDos
eolMac

Definition at line 196 of file kateconfig.h.

enum KateDocumentConfig::IndentationMode

Enumerator:

imNone
imNormal
imCStyle
imPythonStyle
imXmlStyle
imCSAndS
imVarIndent
imScriptIndent

Definition at line 135 of file kateconfig.h.

---

Constructor & Destructor Documentation

KateDocumentConfig::KateDocumentConfig

(

KateDocument *

doc

)

Construct a DocumentConfig.

Definition at line 122 of file kateconfig.cpp.

KateDocumentConfig::~KateDocumentConfig

(

)

Cu DocumentConfig.

Definition at line 148 of file kateconfig.cpp.

---

Member Function Documentation

bool KateDocumentConfig::allowEolDetection

(

)

const

Definition at line 496 of file kateconfig.cpp.

uint KateDocumentConfig::backupFlags

(

)

const

Definition at line 514 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupPrefix

(

)

const

Definition at line 532 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupSuffix

(

)

const

Definition at line 540 of file kateconfig.cpp.

QTextCodec * KateDocumentConfig::codec

(

)

Definition at line 420 of file kateconfig.cpp.

uint KateDocumentConfig::configFlags

(

)

const

Definition at line 380 of file kateconfig.cpp.

const QString & KateDocumentConfig::encoding

(

)

const

Definition at line 412 of file kateconfig.cpp.

int KateDocumentConfig::eol

(

)

const

Definition at line 466 of file kateconfig.cpp.

QString KateDocumentConfig::eolString

(

)

Definition at line 474 of file kateconfig.cpp.

static KateDocumentConfig* KateDocumentConfig::global

(

)

[inline, static]

Definition at line 110 of file kateconfig.h.

uint KateDocumentConfig::indentationMode

(

)

const

Definition at line 287 of file kateconfig.cpp.

int KateDocumentConfig::indentationWidth

(

)

const

Definition at line 266 of file kateconfig.cpp.

bool KateDocumentConfig::isGlobal

(

)

const [inline]

Definition at line 112 of file kateconfig.h.

bool KateDocumentConfig::isSetEncoding

(

)

const

Definition at line 461 of file kateconfig.cpp.

bool KateDocumentConfig::pageUpDownMovesCursor

(

)

const

Definition at line 362 of file kateconfig.cpp.

bool KateDocumentConfig::plugin

(

uint

index

)

const

Definition at line 568 of file kateconfig.cpp.

void KateDocumentConfig::readConfig

(

KConfig *

config

)

Read config from object.

Definition at line 152 of file kateconfig.cpp.

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 592 of file kateconfig.cpp.

void KateDocumentConfig::setAllowEolDetection

(

bool

on

)

Definition at line 504 of file kateconfig.cpp.

void KateDocumentConfig::setBackupFlags

(

uint

flags

)

Definition at line 522 of file kateconfig.cpp.

void KateDocumentConfig::setBackupPrefix

(

const QString &

prefix

)

Definition at line 548 of file kateconfig.cpp.

void KateDocumentConfig::setBackupSuffix

(

const QString &

suffix

)

Definition at line 558 of file kateconfig.cpp.

void KateDocumentConfig::setConfigFlags

(

uint

fullFlags

)

Definition at line 402 of file kateconfig.cpp.

void KateDocumentConfig::setConfigFlags	(	KateDocumentConfig::ConfigFlags	flag,
		bool	enable
	)

Definition at line 388 of file kateconfig.cpp.

void KateDocumentConfig::setEncoding

(

const QString &

encoding

)

Definition at line 435 of file kateconfig.cpp.

void KateDocumentConfig::setEol

(

int

mode

)

Definition at line 486 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationMode

(

uint

identationMode

)

Definition at line 295 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationWidth

(

int

indentationWidth

)

Definition at line 274 of file kateconfig.cpp.

void KateDocumentConfig::setPageUpDownMovesCursor

(

bool

on

)

Definition at line 370 of file kateconfig.cpp.

void KateDocumentConfig::setPlugin	(	uint	index,
		bool	load
	)

Definition at line 579 of file kateconfig.cpp.

void KateDocumentConfig::setSearchDirConfigDepth

(

int

depth

)

Definition at line 600 of file kateconfig.cpp.

void KateDocumentConfig::setTabWidth

(

int

tabWidth

)

Definition at line 253 of file kateconfig.cpp.

void KateDocumentConfig::setUndoSteps

(

uint

undoSteps

)

Definition at line 352 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrap

(

bool

on

)

Definition at line 313 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrapAt

(

unsigned int

col

)

Definition at line 331 of file kateconfig.cpp.

int KateDocumentConfig::tabWidth

(

)

const

Definition at line 245 of file kateconfig.cpp.

uint KateDocumentConfig::undoSteps

(

)

const

Definition at line 344 of file kateconfig.cpp.

void KateDocumentConfig::updateConfig

(

)

[protected, virtual]

do the real update

Implements KateConfig.

Definition at line 228 of file kateconfig.cpp.

bool KateDocumentConfig::wordWrap

(

)

const

Definition at line 305 of file kateconfig.cpp.

unsigned int KateDocumentConfig::wordWrapAt

(

)

const

Definition at line 323 of file kateconfig.cpp.

void KateDocumentConfig::writeConfig

(

KConfig *

config

)

Write config to object.

Definition at line 194 of file kateconfig.cpp.

---

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

• kateconfig.h
• kateconfig.cpp