KateDocumentConfig Class Reference

#include <kateconfig.h>

Inheritance diagram for KateDocumentConfig:

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	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
int	lineLengthLimit () const
bool	newLineAtEof () const
bool	onTheFlySpellCheck () const
bool	ovr () const
bool	pageUpDownMovesCursor () const
void	readConfig (const KConfigGroup &config)
int	removeSpaces () const
bool	replaceTabsDyn () const
int	searchDirConfigDepth () const
void	setAllowEolDetection (bool on)
void	setAllowSimpleMode (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	setLineLengthLimit (int limit)
void	setNewLineAtEof (bool on)
void	setOnTheFlySpellCheck (bool on)
void	setOvr (bool on)
void	setPageUpDownMovesCursor (bool on)
void	setRemoveSpaces (int triState)
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 (int col)
bool	showSpaces () const
bool	showTabs () const
bool	smartHome () const
bool	swapFileNoSync () const
uint	tabHandling () const
bool	tabIndentsEnabled () const
int	tabWidth () const
bool	wordWrap () const
int	wordWrapAt () const
void	writeConfig (KConfigGroup &config)
Public Member Functions inherited from KateConfig
	KateConfig ()
virtual	~KateConfig ()
void	configEnd ()
void	configStart ()

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

KateDocumentConfig::KateDocumentConfig

(

KateDocument *

doc

)

Construct a DocumentConfig.

Definition at line 251 of file kateconfig.cpp.

KateDocumentConfig::~KateDocumentConfig

(

)

Cu DocumentConfig.

Definition at line 287 of file kateconfig.cpp.

Member Function Documentation

bool KateDocumentConfig::allowEolDetection

(

)

const

Definition at line 937 of file kateconfig.cpp.

bool KateDocumentConfig::allowSimpleMode

(

)

const

Definition at line 958 of file kateconfig.cpp.

bool KateDocumentConfig::backspaceIndents

(

)

const

Definition at line 653 of file kateconfig.cpp.

uint KateDocumentConfig::backupFlags

(

)

const

Definition at line 979 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupPrefix

(

)

const

Definition at line 1000 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupSuffix

(

)

const

Definition at line 1008 of file kateconfig.cpp.

bool KateDocumentConfig::bom

(

)

const

Definition at line 929 of file kateconfig.cpp.

QTextCodec * KateDocumentConfig::codec

(

)

const

Definition at line 837 of file kateconfig.cpp.

const QString & KateDocumentConfig::encoding

(

)

const

Definition at line 829 of file kateconfig.cpp.

int KateDocumentConfig::eol

(

)

const

Definition at line 883 of file kateconfig.cpp.

QString KateDocumentConfig::eolString

(

)

Definition at line 891 of file kateconfig.cpp.

static KateDocumentConfig* KateDocumentConfig::global ( )

inlinestatic

Definition at line 165 of file kateconfig.h.

const QString & KateDocumentConfig::indentationMode

(

)

const

Definition at line 492 of file kateconfig.cpp.

int KateDocumentConfig::indentationWidth

(

)

const

Definition at line 468 of file kateconfig.cpp.

bool KateDocumentConfig::indentPastedText

(

)

const

Definition at line 632 of file kateconfig.cpp.

bool KateDocumentConfig::isGlobal ( ) const

inline

Definition at line 167 of file kateconfig.h.

bool KateDocumentConfig::isSetEncoding

(

)

const

Definition at line 878 of file kateconfig.cpp.

bool KateDocumentConfig::keepExtraSpaces

(

)

const

Definition at line 611 of file kateconfig.cpp.

int KateDocumentConfig::lineLengthLimit

(

)

const

Definition at line 1113 of file kateconfig.cpp.

bool KateDocumentConfig::newLineAtEof

(

)

const

Definition at line 779 of file kateconfig.cpp.

bool KateDocumentConfig::onTheFlySpellCheck

(

)

const

Definition at line 1084 of file kateconfig.cpp.

bool KateDocumentConfig::ovr

(

)

const

Definition at line 800 of file kateconfig.cpp.

bool KateDocumentConfig::pageUpDownMovesCursor

(

)

const

Definition at line 577 of file kateconfig.cpp.

void KateDocumentConfig::readConfig

(

const KConfigGroup &

config

)

Read config from object.

Definition at line 325 of file kateconfig.cpp.

int KateDocumentConfig::removeSpaces

(

)

const

Definition at line 758 of file kateconfig.cpp.

bool KateDocumentConfig::replaceTabsDyn

(

)

const

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

void KateDocumentConfig::setAllowEolDetection

(

bool

on

)

Definition at line 945 of file kateconfig.cpp.

void KateDocumentConfig::setAllowSimpleMode

(

bool

on

)

Definition at line 966 of file kateconfig.cpp.

void KateDocumentConfig::setBackspaceIndents

(

bool

on

)

Definition at line 640 of file kateconfig.cpp.

void KateDocumentConfig::setBackupFlags

(

uint

flags

)

Definition at line 987 of file kateconfig.cpp.

void KateDocumentConfig::setBackupPrefix

(

const QString &

prefix

)

Definition at line 1016 of file kateconfig.cpp.

void KateDocumentConfig::setBackupSuffix

(

const QString &

suffix

)

Definition at line 1029 of file kateconfig.cpp.

void KateDocumentConfig::setBom

(

bool

bom

)

Definition at line 916 of file kateconfig.cpp.

bool KateDocumentConfig::setEncoding

(

const QString &

encoding

)

Definition at line 852 of file kateconfig.cpp.

void KateDocumentConfig::setEol

(

int

mode

)

Definition at line 903 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationMode

(

const QString &

identationMode

)

Definition at line 500 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationWidth

(

int

indentationWidth

)

Definition at line 476 of file kateconfig.cpp.

void KateDocumentConfig::setIndentPastedText

(

bool

on

)

Definition at line 619 of file kateconfig.cpp.

void KateDocumentConfig::setKeepExtraSpaces

(

bool

on

)

Definition at line 598 of file kateconfig.cpp.

void KateDocumentConfig::setLineLengthLimit

(

int

limit

)

Definition at line 1121 of file kateconfig.cpp.

void KateDocumentConfig::setNewLineAtEof

(

bool

on

)

Definition at line 766 of file kateconfig.cpp.

void KateDocumentConfig::setOnTheFlySpellCheck

(

bool

on

)

Definition at line 1099 of file kateconfig.cpp.

void KateDocumentConfig::setOvr

(

bool

on

)

Definition at line 787 of file kateconfig.cpp.

void KateDocumentConfig::setPageUpDownMovesCursor

(

bool

on

)

Definition at line 585 of file kateconfig.cpp.

void KateDocumentConfig::setRemoveSpaces

(

int

triState

)

Remove trailing spaces on save.

triState = 0: never remove trailing spaces triState = 1: remove trailing spaces of modified lines (line modification system) triState = 2: remove trailing spaces in entire document

Definition at line 745 of file kateconfig.cpp.

void KateDocumentConfig::setReplaceTabsDyn

(

bool

on

)

Definition at line 724 of file kateconfig.cpp.

void KateDocumentConfig::setSearchDirConfigDepth

(

int

depth

)

Definition at line 1071 of file kateconfig.cpp.

void KateDocumentConfig::setShowSpaces

(

bool

on

)

Definition at line 703 of file kateconfig.cpp.

void KateDocumentConfig::setShowTabs

(

bool

on

)

Definition at line 682 of file kateconfig.cpp.

void KateDocumentConfig::setSmartHome

(

bool

on

)

Definition at line 661 of file kateconfig.cpp.

void KateDocumentConfig::setSwapFileNoSync

(

bool

on

)

Definition at line 1050 of file kateconfig.cpp.

void KateDocumentConfig::setTabHandling

(

uint

tabHandling

)

Definition at line 523 of file kateconfig.cpp.

void KateDocumentConfig::setTabIndents

(

bool

on

)

Definition at line 808 of file kateconfig.cpp.

void KateDocumentConfig::setTabWidth

(

int

tabWidth

)

Definition at line 452 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrap

(

bool

on

)

Definition at line 540 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrapAt

(

int

col

)

Definition at line 561 of file kateconfig.cpp.

bool KateDocumentConfig::showSpaces

(

)

const

Definition at line 716 of file kateconfig.cpp.

bool KateDocumentConfig::showTabs

(

)

const

Definition at line 695 of file kateconfig.cpp.

bool KateDocumentConfig::smartHome

(

)

const

Definition at line 674 of file kateconfig.cpp.

bool KateDocumentConfig::swapFileNoSync

(

)

const

Definition at line 1042 of file kateconfig.cpp.

uint KateDocumentConfig::tabHandling

(

)

const

Definition at line 513 of file kateconfig.cpp.

bool KateDocumentConfig::tabIndentsEnabled

(

)

const

Definition at line 821 of file kateconfig.cpp.

int KateDocumentConfig::tabWidth

(

)

const

Definition at line 444 of file kateconfig.cpp.

void KateDocumentConfig::updateConfig ( )

protectedvirtual

do the real update

Implements KateConfig.

Definition at line 429 of file kateconfig.cpp.

bool KateDocumentConfig::wordWrap

(

)

const

Definition at line 532 of file kateconfig.cpp.

int KateDocumentConfig::wordWrapAt

(

)

const

Definition at line 553 of file kateconfig.cpp.

void KateDocumentConfig::writeConfig

(

KConfigGroup &

config

)

Write config to object.

Definition at line 379 of file kateconfig.cpp.

---

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

• kateconfig.h
• kateconfig.cpp