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, cfKeepExtraSpaces = 0x10000,   cfTabIndents = 0x80000, cfShowTabs = 0x200000, cfShowSpaces = 0x400000, cfSmartHome = 0x800000,   cfTabInsertsTab = 0x1000000, cfReplaceTabsDyn = 0x2000000, cfRemoveTrailingDyn = 0x4000000, cfIndentPastedText = 0x10000000 }
enum	Eol { eolUnix = 0, eolDos = 1, eolMac = 2 }
enum	TabHandling { tabInsertsTab = 0, tabIndents = 1, tabSmart = 2 }
Public Member Functions
	KateDocumentConfig (KateDocument *doc)
	~KateDocumentConfig ()
bool	allowEolDetection () const
bool	allowSimpleMode () const
uint	backupFlags () const
const QString &	backupPrefix () const
const QString &	backupSuffix () const
bool	bom () const
QTextCodec *	codec () const
uint	configFlags () const
const QString &	encoding () const
KEncodingProber::ProberType	encodingProberType () const
int	eol () const
QString	eolString ()
const QString &	indentationMode () const
int	indentationWidth () const
bool	isGlobal () const
bool	isSetEncoding () const
bool	onTheFlySpellCheck () const
bool	pageUpDownMovesCursor () const
void	readConfig (const KConfigGroup &config)
int	searchDirConfigDepth () const
void	setAllowEolDetection (bool on)
void	setAllowSimpleMode (bool on)
void	setBackupFlags (uint flags)
void	setBackupPrefix (const QString &prefix)
void	setBackupSuffix (const QString &suffix)
void	setBom (bool bom)
void	setConfigFlags (uint fullFlags)
void	setConfigFlags (KateDocumentConfig::ConfigFlags flag, bool enable)
bool	setEncoding (const QString &encoding, bool resetDetection=true)
void	setEncodingProberType (KEncodingProber::ProberType)
void	setEol (int mode)
void	setIndentationMode (const QString &identationMode)
void	setIndentationWidth (int indentationWidth)
void	setOnTheFlySpellCheck (bool on)
void	setPageUpDownMovesCursor (bool on)
void	setSearchDirConfigDepth (int depth)
void	setTabHandling (uint tabHandling)
void	setTabWidth (int tabWidth)
void	setWordWrap (bool on)
void	setWordWrapAt (unsigned int col)
uint	tabHandling () const
int	tabWidth () const
bool	wordWrap () const
unsigned int	wordWrapAt () const
void	writeConfig (KConfigGroup &config)
Static Public Member Functions
static KateDocumentConfig *	global ()
Protected Member Functions
void	updateConfig ()

---

Detailed Description

Definition at line 90 of file kateconfig.h.

---

Member Enumeration Documentation

enum KateDocumentConfig::BackupFlags

Enumerator:

LocalFiles
RemoteFiles

Definition at line 210 of file kateconfig.h.

enum KateDocumentConfig::ConfigFlags

Enumerator:

cfBackspaceIndents
cfWordWrap
cfRemoveSpaces
cfWrapCursor
cfAutoBrackets
cfTabIndentsMode
cfOvr
cfKeepExtraSpaces
cfTabIndents
cfShowTabs
cfShowSpaces
cfSmartHome
cfTabInsertsTab
cfReplaceTabsDyn
cfRemoveTrailingDyn
cfIndentPastedText

Definition at line 158 of file kateconfig.h.

enum KateDocumentConfig::Eol

Enumerator:

eolUnix
eolDos
eolMac

Definition at line 189 of file kateconfig.h.

enum KateDocumentConfig::TabHandling

Enumerator:

tabInsertsTab
tabIndents
tabSmart	indents in leading space, otherwise inserts tab

Definition at line 139 of file kateconfig.h.

---

Constructor & Destructor Documentation

KateDocumentConfig::KateDocumentConfig

(

KateDocument *

doc

)

Construct a DocumentConfig.

Definition at line 119 of file kateconfig.cpp.

KateDocumentConfig::~KateDocumentConfig

(

)

Cu DocumentConfig.

Definition at line 144 of file kateconfig.cpp.

---

Member Function Documentation

bool KateDocumentConfig::allowEolDetection

(

)

const

Definition at line 541 of file kateconfig.cpp.

bool KateDocumentConfig::allowSimpleMode

(

)

const

Definition at line 560 of file kateconfig.cpp.

uint KateDocumentConfig::backupFlags

(

)

const

Definition at line 578 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupPrefix

(

)

const

Definition at line 596 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupSuffix

(

)

const

Definition at line 604 of file kateconfig.cpp.

bool KateDocumentConfig::bom

(

)

const

Definition at line 533 of file kateconfig.cpp.

QTextCodec * KateDocumentConfig::codec

(

)

const

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.

KEncodingProber::ProberType KateDocumentConfig::encodingProberType

(

)

const

Definition at line 477 of file kateconfig.cpp.

int KateDocumentConfig::eol

(

)

const

Definition at line 493 of file kateconfig.cpp.

QString KateDocumentConfig::eolString

(

)

Definition at line 501 of file kateconfig.cpp.

static KateDocumentConfig* KateDocumentConfig::global

(

)

[inline, static]

Definition at line 111 of file kateconfig.h.

const QString & KateDocumentConfig::indentationMode

(

)

const

Definition at line 286 of file kateconfig.cpp.

int KateDocumentConfig::indentationWidth

(

)

const

Definition at line 265 of file kateconfig.cpp.

bool KateDocumentConfig::isGlobal

(

)

const [inline]

Definition at line 113 of file kateconfig.h.

bool KateDocumentConfig::isSetEncoding

(

)

const

Definition at line 472 of file kateconfig.cpp.

bool KateDocumentConfig::onTheFlySpellCheck

(

)

const

Definition at line 650 of file kateconfig.cpp.

bool KateDocumentConfig::pageUpDownMovesCursor

(

)

const

Definition at line 362 of file kateconfig.cpp.

void KateDocumentConfig::readConfig

(

const KConfigGroup &

config

)

Read config from object.

Definition at line 148 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 632 of file kateconfig.cpp.

void KateDocumentConfig::setAllowEolDetection

(

bool

on

)

Definition at line 549 of file kateconfig.cpp.

void KateDocumentConfig::setAllowSimpleMode

(

bool

on

)

Definition at line 568 of file kateconfig.cpp.

void KateDocumentConfig::setBackupFlags

(

uint

flags

)

Definition at line 586 of file kateconfig.cpp.

void KateDocumentConfig::setBackupPrefix

(

const QString &

prefix

)

Definition at line 612 of file kateconfig.cpp.

void KateDocumentConfig::setBackupSuffix

(

const QString &

suffix

)

Definition at line 622 of file kateconfig.cpp.

void KateDocumentConfig::setBom

(

bool

bom

)

Definition at line 523 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.

bool KateDocumentConfig::setEncoding	(	const QString &	encoding,
		bool	resetDetection = true
	)

Definition at line 435 of file kateconfig.cpp.

void KateDocumentConfig::setEncodingProberType

(

KEncodingProber::ProberType

proberType

)

Definition at line 482 of file kateconfig.cpp.

void KateDocumentConfig::setEol

(

int

mode

)

Definition at line 513 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationMode

(

const QString &

identationMode

)

Definition at line 294 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationWidth

(

int

indentationWidth

)

Definition at line 273 of file kateconfig.cpp.

void KateDocumentConfig::setOnTheFlySpellCheck

(

bool

on

)

Definition at line 665 of file kateconfig.cpp.

void KateDocumentConfig::setPageUpDownMovesCursor

(

bool

on

)

Definition at line 370 of file kateconfig.cpp.

void KateDocumentConfig::setSearchDirConfigDepth

(

int

depth

)

Definition at line 640 of file kateconfig.cpp.

void KateDocumentConfig::setTabHandling

(

uint

tabHandling

)

Definition at line 314 of file kateconfig.cpp.

void KateDocumentConfig::setTabWidth

(

int

tabWidth

)

Definition at line 252 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrap

(

bool

on

)

Definition at line 331 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrapAt

(

unsigned int

col

)

Definition at line 349 of file kateconfig.cpp.

uint KateDocumentConfig::tabHandling

(

)

const

Definition at line 304 of file kateconfig.cpp.

int KateDocumentConfig::tabWidth

(

)

const

Definition at line 244 of file kateconfig.cpp.

void KateDocumentConfig::updateConfig

(

)

[protected, virtual]

do the real update

Implements KateConfig.

Definition at line 229 of file kateconfig.cpp.

bool KateDocumentConfig::wordWrap

(

)

const

Definition at line 323 of file kateconfig.cpp.

unsigned int KateDocumentConfig::wordWrapAt

(

)

const

Definition at line 341 of file kateconfig.cpp.

void KateDocumentConfig::writeConfig

(

KConfigGroup &

config

)

Write config to object.

Definition at line 192 of file kateconfig.cpp.

---

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

• kateconfig.h
• kateconfig.cpp