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

KateDocumentConfig::KateDocumentConfig

(

KateDocument *

doc

)

Construct a DocumentConfig.

Definition at line 244 of file kateconfig.cpp.

KateDocumentConfig::~KateDocumentConfig

(

)

Cu DocumentConfig.

Definition at line 280 of file kateconfig.cpp.

Member Function Documentation

bool KateDocumentConfig::allowEolDetection

(

)

const

Definition at line 896 of file kateconfig.cpp.

bool KateDocumentConfig::allowSimpleMode

(

)

const

Definition at line 917 of file kateconfig.cpp.

bool KateDocumentConfig::backspaceIndents

(

)

const

Definition at line 612 of file kateconfig.cpp.

uint KateDocumentConfig::backupFlags

(

)

const

Definition at line 938 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupPrefix

(

)

const

Definition at line 959 of file kateconfig.cpp.

const QString & KateDocumentConfig::backupSuffix

(

)

const

Definition at line 967 of file kateconfig.cpp.

bool KateDocumentConfig::bom

(

)

const

Definition at line 888 of file kateconfig.cpp.

QTextCodec * KateDocumentConfig::codec

(

)

const

Definition at line 796 of file kateconfig.cpp.

const QString & KateDocumentConfig::encoding

(

)

const

Definition at line 788 of file kateconfig.cpp.

int KateDocumentConfig::eol

(

)

const

Definition at line 842 of file kateconfig.cpp.

QString KateDocumentConfig::eolString

(

)

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

int KateDocumentConfig::indentationWidth

(

)

const

Definition at line 427 of file kateconfig.cpp.

bool KateDocumentConfig::indentPastedText

(

)

const

Definition at line 591 of file kateconfig.cpp.

bool KateDocumentConfig::isGlobal ( ) const

inline

Definition at line 167 of file kateconfig.h.

bool KateDocumentConfig::isSetEncoding

(

)

const

Definition at line 837 of file kateconfig.cpp.

bool KateDocumentConfig::keepExtraSpaces

(

)

const

Definition at line 570 of file kateconfig.cpp.

int KateDocumentConfig::lineLengthLimit

(

)

const

Definition at line 1072 of file kateconfig.cpp.

bool KateDocumentConfig::newLineAtEof

(

)

const

Definition at line 738 of file kateconfig.cpp.

bool KateDocumentConfig::onTheFlySpellCheck

(

)

const

Definition at line 1043 of file kateconfig.cpp.

bool KateDocumentConfig::ovr

(

)

const

Definition at line 759 of file kateconfig.cpp.

bool KateDocumentConfig::pageUpDownMovesCursor

(

)

const

Definition at line 536 of file kateconfig.cpp.

void KateDocumentConfig::readConfig

(

const KConfigGroup &

config

)

Read config from object.

Definition at line 284 of file kateconfig.cpp.

int KateDocumentConfig::removeSpaces

(

)

const

Definition at line 717 of file kateconfig.cpp.

bool KateDocumentConfig::replaceTabsDyn

(

)

const

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

void KateDocumentConfig::setAllowEolDetection

(

bool

on

)

Definition at line 904 of file kateconfig.cpp.

void KateDocumentConfig::setAllowSimpleMode

(

bool

on

)

Definition at line 925 of file kateconfig.cpp.

void KateDocumentConfig::setBackspaceIndents

(

bool

on

)

Definition at line 599 of file kateconfig.cpp.

void KateDocumentConfig::setBackupFlags

(

uint

flags

)

Definition at line 946 of file kateconfig.cpp.

void KateDocumentConfig::setBackupPrefix

(

const QString &

prefix

)

Definition at line 975 of file kateconfig.cpp.

void KateDocumentConfig::setBackupSuffix

(

const QString &

suffix

)

Definition at line 988 of file kateconfig.cpp.

void KateDocumentConfig::setBom

(

bool

bom

)

Definition at line 875 of file kateconfig.cpp.

bool KateDocumentConfig::setEncoding

(

const QString &

encoding

)

Definition at line 811 of file kateconfig.cpp.

void KateDocumentConfig::setEol

(

int

mode

)

Definition at line 862 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationMode

(

const QString &

identationMode

)

Definition at line 459 of file kateconfig.cpp.

void KateDocumentConfig::setIndentationWidth

(

int

indentationWidth

)

Definition at line 435 of file kateconfig.cpp.

void KateDocumentConfig::setIndentPastedText

(

bool

on

)

Definition at line 578 of file kateconfig.cpp.

void KateDocumentConfig::setKeepExtraSpaces

(

bool

on

)

Definition at line 557 of file kateconfig.cpp.

void KateDocumentConfig::setLineLengthLimit

(

int

limit

)

Definition at line 1080 of file kateconfig.cpp.

void KateDocumentConfig::setNewLineAtEof

(

bool

on

)

Definition at line 725 of file kateconfig.cpp.

void KateDocumentConfig::setOnTheFlySpellCheck

(

bool

on

)

Definition at line 1058 of file kateconfig.cpp.

void KateDocumentConfig::setOvr

(

bool

on

)

Definition at line 746 of file kateconfig.cpp.

void KateDocumentConfig::setPageUpDownMovesCursor

(

bool

on

)

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

void KateDocumentConfig::setReplaceTabsDyn

(

bool

on

)

Definition at line 683 of file kateconfig.cpp.

void KateDocumentConfig::setSearchDirConfigDepth

(

int

depth

)

Definition at line 1030 of file kateconfig.cpp.

void KateDocumentConfig::setShowSpaces

(

bool

on

)

Definition at line 662 of file kateconfig.cpp.

void KateDocumentConfig::setShowTabs

(

bool

on

)

Definition at line 641 of file kateconfig.cpp.

void KateDocumentConfig::setSmartHome

(

bool

on

)

Definition at line 620 of file kateconfig.cpp.

void KateDocumentConfig::setSwapFileNoSync

(

bool

on

)

Definition at line 1009 of file kateconfig.cpp.

void KateDocumentConfig::setTabHandling

(

uint

tabHandling

)

Definition at line 482 of file kateconfig.cpp.

void KateDocumentConfig::setTabIndents

(

bool

on

)

Definition at line 767 of file kateconfig.cpp.

void KateDocumentConfig::setTabWidth

(

int

tabWidth

)

Definition at line 411 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrap

(

bool

on

)

Definition at line 499 of file kateconfig.cpp.

void KateDocumentConfig::setWordWrapAt

(

int

col

)

Definition at line 520 of file kateconfig.cpp.

bool KateDocumentConfig::showSpaces

(

)

const

Definition at line 675 of file kateconfig.cpp.

bool KateDocumentConfig::showTabs

(

)

const

Definition at line 654 of file kateconfig.cpp.

bool KateDocumentConfig::smartHome

(

)

const

Definition at line 633 of file kateconfig.cpp.

bool KateDocumentConfig::swapFileNoSync

(

)

const

Definition at line 1001 of file kateconfig.cpp.

uint KateDocumentConfig::tabHandling

(

)

const

Definition at line 472 of file kateconfig.cpp.

bool KateDocumentConfig::tabIndentsEnabled

(

)

const

Definition at line 780 of file kateconfig.cpp.

int KateDocumentConfig::tabWidth

(

)

const

Definition at line 403 of file kateconfig.cpp.

void KateDocumentConfig::updateConfig ( )

protectedvirtual

do the real update

Implements KateConfig.

Definition at line 388 of file kateconfig.cpp.

bool KateDocumentConfig::wordWrap

(

)

const

Definition at line 491 of file kateconfig.cpp.

int KateDocumentConfig::wordWrapAt

(

)

const

Definition at line 512 of file kateconfig.cpp.

void KateDocumentConfig::writeConfig

(

KConfigGroup &

config

)

Write config to object.

Definition at line 338 of file kateconfig.cpp.

---

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

• kateconfig.h
• kateconfig.cpp