KateDocumentConfig Class Reference

#include <kateconfig.h>

Inheritance diagram for KateDocumentConfig:

List of all members.

Public Types
enum	BackupFlags { LocalFiles = 1, RemoteFiles = 2 }
enum	Eol { eolUnix = 0, eolDos = 1, eolMac = 2 }
enum	TabHandling { tabInsertsTab = 0, tabIndents = 1, tabSmart = 2 }
Public Member Functions
	KateDocumentConfig (const KConfigGroup &cg)
	KateDocumentConfig (KateDocument *doc)
	~KateDocumentConfig ()
bool	allowEolDetection () const
bool	allowSimpleMode () const
bool	autoBrackets () const
bool	backspaceIndents () const
uint	backupFlags () const
const QString &	backupPrefix () const
const QString &	backupSuffix () const
bool	bom () const
QTextCodec *	codec () const
const QString &	encoding () const
int	eol () const
QString	eolString ()
const QString &	indentationMode () const
int	indentationWidth () const
bool	indentPastedText () const
bool	isGlobal () const
bool	isSetEncoding () const
bool	keepExtraSpaces () const
bool	onTheFlySpellCheck () const
bool	ovr () const
bool	pageUpDownMovesCursor () const
void	readConfig (const KConfigGroup &config)
bool	removeSpaces () const
bool	removeTrailingDyn () const
bool	replaceTabsDyn () const
int	searchDirConfigDepth () const
void	setAllowEolDetection (bool on)
void	setAllowSimpleMode (bool on)
void	setAutoBrackets (bool on)
void	setBackspaceIndents (bool on)
void	setBackupFlags (uint flags)
void	setBackupPrefix (const QString &prefix)
void	setBackupSuffix (const QString &suffix)
void	setBom (bool bom)
bool	setEncoding (const QString &encoding)
void	setEol (int mode)
void	setIndentationMode (const QString &identationMode)
void	setIndentationWidth (int indentationWidth)
void	setIndentPastedText (bool on)
void	setKeepExtraSpaces (bool on)
void	setOnTheFlySpellCheck (bool on)
void	setOvr (bool on)
void	setPageUpDownMovesCursor (bool on)
void	setRemoveSpaces (bool on)
void	setRemoveTrailingDyn (bool on)
void	setReplaceTabsDyn (bool on)
void	setSearchDirConfigDepth (int depth)
void	setShowSpaces (bool on)
void	setShowTabs (bool on)
void	setSmartHome (bool on)
void	setSwapFileNoSync (bool on)
void	setTabHandling (uint tabHandling)
void	setTabIndents (bool on)
void	setTabWidth (int tabWidth)
void	setWordWrap (bool on)
void	setWordWrapAt (unsigned int col)
void	setWrapCursor (bool on)
bool	showSpaces () const
bool	showTabs () const
bool	smartHome () const
bool	swapFileNoSync () const
uint	tabHandling () const
bool	tabIndentsEnabled () const
int	tabWidth () const
bool	wordWrap () const
unsigned int	wordWrapAt () const
bool	wrapCursor () const
void	writeConfig (KConfigGroup &config)
Static Public Member Functions
static KateDocumentConfig *	global ()
Protected Member Functions
void	updateConfig ()

---

Detailed Description

Definition at line 145 of file kateconfig.h.

---

Member Enumeration Documentation

enum KateDocumentConfig::BackupFlags

Enumerator:

LocalFiles
RemoteFiles

Definition at line 277 of file kateconfig.h.

enum KateDocumentConfig::Eol

Enumerator:

eolUnix
eolDos
eolMac

Definition at line 256 of file kateconfig.h.

enum KateDocumentConfig::TabHandling

Enumerator:

tabInsertsTab
tabIndents
tabSmart	indents in leading space, otherwise inserts tab

Definition at line 193 of file kateconfig.h.

---

Constructor & Destructor Documentation

KateDocumentConfig::KateDocumentConfig

(

const KConfigGroup &

cg

)

Definition at line 203 of file kateconfig.cpp.

KateDocumentConfig::KateDocumentConfig

(

KateDocument *

doc

)

Construct a DocumentConfig.

Definition at line 245 of file kateconfig.cpp.

KateDocumentConfig::~KateDocumentConfig

(

)

Cu DocumentConfig.

Definition at line 282 of file kateconfig.cpp.

---

Member Function Documentation

bool KateDocumentConfig::allowEolDetection

(

)

const

Definition at line 877 of file kateconfig.cpp.

bool KateDocumentConfig::allowSimpleMode

(

)

const

Definition at line 896 of file kateconfig.cpp.

bool KateDocumentConfig::autoBrackets

(

)

const

Definition at line 641 of file kateconfig.cpp.

bool KateDocumentConfig::backspaceIndents

(

)

const

Definition at line 587 of file kateconfig.cpp.

uint KateDocumentConfig::backupFlags

(

)

const

Definition at line 914 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupPrefix

(

)

const

Definition at line 932 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupSuffix

(

)

const

Definition at line 940 of file kateconfig.cpp.

bool KateDocumentConfig::bom

(

)

const

Definition at line 869 of file kateconfig.cpp.

QTextCodec * KateDocumentConfig::codec

(

)

const

Definition at line 783 of file kateconfig.cpp.

const QString & KateDocumentConfig::encoding

(

)

const

Definition at line 775 of file kateconfig.cpp.

int KateDocumentConfig::eol

(

)

const

Definition at line 829 of file kateconfig.cpp.

QString KateDocumentConfig::eolString

(

)

Definition at line 837 of file kateconfig.cpp.

static KateDocumentConfig* KateDocumentConfig::global

(

)

[inline, static]

Definition at line 165 of file kateconfig.h.

const QString & KateDocumentConfig::indentationMode

(

)

const

Definition at line 447 of file kateconfig.cpp.

int KateDocumentConfig::indentationWidth

(

)

const

Definition at line 426 of file kateconfig.cpp.

bool KateDocumentConfig::indentPastedText

(

)

const

Definition at line 569 of file kateconfig.cpp.

bool KateDocumentConfig::isGlobal

(

)

const [inline]

Definition at line 167 of file kateconfig.h.

bool KateDocumentConfig::isSetEncoding

(

)

const

Definition at line 824 of file kateconfig.cpp.

bool KateDocumentConfig::keepExtraSpaces

(

)

const

Definition at line 551 of file kateconfig.cpp.

bool KateDocumentConfig::onTheFlySpellCheck

(

)

const

Definition at line 1004 of file kateconfig.cpp.

bool KateDocumentConfig::ovr

(

)

const

Definition at line 749 of file kateconfig.cpp.

bool KateDocumentConfig::pageUpDownMovesCursor

(

)

const

Definition at line 523 of file kateconfig.cpp.

void KateDocumentConfig::readConfig

(

const KConfigGroup &

config

)

Read config from object.

Definition at line 286 of file kateconfig.cpp.

bool KateDocumentConfig::removeSpaces

(

)

const

Definition at line 731 of file kateconfig.cpp.

bool KateDocumentConfig::removeTrailingDyn

(

)

const

Definition at line 713 of file kateconfig.cpp.

bool KateDocumentConfig::replaceTabsDyn

(

)

const

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

void KateDocumentConfig::setAllowEolDetection

(

bool

on

)

Definition at line 885 of file kateconfig.cpp.

void KateDocumentConfig::setAllowSimpleMode

(

bool

on

)

Definition at line 904 of file kateconfig.cpp.

void KateDocumentConfig::setAutoBrackets

(

bool

on

)

Definition at line 631 of file kateconfig.cpp.

void KateDocumentConfig::setBackspaceIndents

(

bool

on

)

Definition at line 577 of file kateconfig.cpp.

void KateDocumentConfig::setBackupFlags

(

uint

flags

)

Definition at line 922 of file kateconfig.cpp.

void KateDocumentConfig::setBackupPrefix

(

const QString &

prefix

)

Definition at line 948 of file kateconfig.cpp.

void KateDocumentConfig::setBackupSuffix

(

const QString &

suffix

)

Definition at line 958 of file kateconfig.cpp.

void KateDocumentConfig::setBom

(

bool

bom

)

Definition at line 859 of file kateconfig.cpp.

bool KateDocumentConfig::setEncoding

(

const QString &

encoding

)

Definition at line 798 of file kateconfig.cpp.

void KateDocumentConfig::setEol

(

int

mode

)

Definition at line 849 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationMode

(

const QString &

identationMode

)

Definition at line 455 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationWidth

(

int

indentationWidth

)

Definition at line 434 of file kateconfig.cpp.

void KateDocumentConfig::setIndentPastedText

(

bool

on

)

Definition at line 559 of file kateconfig.cpp.

void KateDocumentConfig::setKeepExtraSpaces

(

bool

on

)

Definition at line 541 of file kateconfig.cpp.

void KateDocumentConfig::setOnTheFlySpellCheck

(

bool

on

)

Definition at line 1019 of file kateconfig.cpp.

void KateDocumentConfig::setOvr

(

bool

on

)

Definition at line 739 of file kateconfig.cpp.

void KateDocumentConfig::setPageUpDownMovesCursor

(

bool

on

)

Definition at line 531 of file kateconfig.cpp.

void KateDocumentConfig::setRemoveSpaces

(

bool

on

)

Definition at line 721 of file kateconfig.cpp.

void KateDocumentConfig::setRemoveTrailingDyn

(

bool

on

)

Definition at line 703 of file kateconfig.cpp.

void KateDocumentConfig::setReplaceTabsDyn

(

bool

on

)

Definition at line 685 of file kateconfig.cpp.

void KateDocumentConfig::setSearchDirConfigDepth

(

int

depth

)

Definition at line 994 of file kateconfig.cpp.

void KateDocumentConfig::setShowSpaces

(

bool

on

)

Definition at line 667 of file kateconfig.cpp.

void KateDocumentConfig::setShowTabs

(

bool

on

)

Definition at line 649 of file kateconfig.cpp.

void KateDocumentConfig::setSmartHome

(

bool

on

)

Definition at line 595 of file kateconfig.cpp.

void KateDocumentConfig::setSwapFileNoSync

(

bool

on

)

Definition at line 976 of file kateconfig.cpp.

void KateDocumentConfig::setTabHandling

(

uint

tabHandling

)

Definition at line 475 of file kateconfig.cpp.

void KateDocumentConfig::setTabIndents

(

bool

on

)

Definition at line 757 of file kateconfig.cpp.

void KateDocumentConfig::setTabWidth

(

int

tabWidth

)

Definition at line 413 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrap

(

bool

on

)

Definition at line 492 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrapAt

(

unsigned int

col

)

Definition at line 510 of file kateconfig.cpp.

void KateDocumentConfig::setWrapCursor

(

bool

on

)

Definition at line 613 of file kateconfig.cpp.

bool KateDocumentConfig::showSpaces

(

)

const

Definition at line 677 of file kateconfig.cpp.

bool KateDocumentConfig::showTabs

(

)

const

Definition at line 659 of file kateconfig.cpp.

bool KateDocumentConfig::smartHome

(

)

const

Definition at line 605 of file kateconfig.cpp.

bool KateDocumentConfig::swapFileNoSync

(

)

const

Definition at line 968 of file kateconfig.cpp.

uint KateDocumentConfig::tabHandling

(

)

const

Definition at line 465 of file kateconfig.cpp.

bool KateDocumentConfig::tabIndentsEnabled

(

)

const

Definition at line 767 of file kateconfig.cpp.

int KateDocumentConfig::tabWidth

(

)

const

Definition at line 405 of file kateconfig.cpp.

void KateDocumentConfig::updateConfig

(

)

[protected, virtual]

do the real update

Implements KateConfig.

Definition at line 390 of file kateconfig.cpp.

bool KateDocumentConfig::wordWrap

(

)

const

Definition at line 484 of file kateconfig.cpp.

unsigned int KateDocumentConfig::wordWrapAt

(

)

const

Definition at line 502 of file kateconfig.cpp.

bool KateDocumentConfig::wrapCursor

(

)

const

Definition at line 623 of file kateconfig.cpp.

void KateDocumentConfig::writeConfig

(

KConfigGroup &

config

)

Write config to object.

Definition at line 340 of file kateconfig.cpp.

---

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

• kateconfig.h
• kateconfig.cpp