Kate::Document Class Reference

This interface provides access to the Kate Document class. More...

#include <document.h>

Inheritance diagram for Kate::Document:

[legend]

List of all members.

Public Types
enum	ConfigFlags {   cfAutoIndent = 0x1, cfBackspaceIndents = 0x2, cfWordWrap = 0x4, cfReplaceTabs = 0x8,   cfRemoveSpaces = 0x10, cfWrapCursor = 0x20, cfAutoBrackets = 0x40, cfPersistent = 0x80,   cfKeepSelection = 0x100, cfDelOnInput = 0x400, cfXorSelect = 0x800, cfOvr = 0x1000,   cfMark = 0x2000, cfKeepIndentProfile = 0x8000, cfKeepExtraSpaces = 0x10000, cfTabIndents = 0x80000,   cfShowTabs = 0x200000, cfSpaceIndent = 0x400000, cfSmartHome = 0x800000 }
Public Slots
virtual void	applyWordWrap ()=0
virtual void	exportAs (const QString &)=0
virtual void	flush ()
virtual void	reloadFile ()=0
virtual void	spellcheck ()
Signals
void	modifiedOnDisc (Kate::Document *doc, bool isModified, unsigned char reason)
Public Member Functions
virtual ConfigPage *	colorConfigPage (QWidget *)=0
virtual uint	configFlags ()=0
virtual QString	docName ()
	Document (QObject *parent, const char *name)
	Document ()
virtual ConfigPage *	editConfigPage (QWidget *)=0
virtual QString	encoding () const =0
virtual ActionMenu *	exportActionMenu (const QString &, QObject *=0, const char *=0)=0
virtual ConfigPage *	fontConfigPage (QWidget *)=0
virtual ActionMenu *	hlActionMenu (const QString &, QObject *=0, const char *=0)=0
virtual ConfigPage *	hlConfigPage (QWidget *)=0
virtual ConfigPage *	indentConfigPage (QWidget *)=0
virtual void	isModOnHD (bool=false)
virtual ConfigPage *	keysConfigPage (QWidget *)=0
virtual ConfigPage *	kSpellConfigPage (QWidget *)
virtual ConfigPage *	selectConfigPage (QWidget *)=0
virtual void	setConfigFlags (uint flags)=0
virtual void	setDocName (QString)
virtual void	setEncoding (const QString &e)=0
virtual void	setWordWrap (bool)=0
virtual void	setWordWrapAt (unsigned int)=0
virtual bool	wordWrap ()=0
virtual uint	wordWrapAt ()=0
virtual	~Document ()
Static Public Member Functions
static const QString &	defaultEncoding ()
static Command *	queryCommand (const QString &cmd)
static bool	registerCommand (Command *cmd)
static void	setFileChangedDialogsActivated (bool on)
static void	setOpenErrorDialogsActivated (bool on)
static bool	unregisterCommand (Command *cmd)
Static Protected Attributes
static QString	s_defaultEncoding
static bool	s_fileChangedDialogsActivated = false
static bool	s_openErrorDialogsActivated = true

---

Detailed Description

This interface provides access to the Kate Document class.

Definition at line 182 of file document.h.

---

Member Enumeration Documentation

enum Kate::Document::ConfigFlags

Enumerator:

cfAutoIndent
cfBackspaceIndents
cfWordWrap
cfReplaceTabs
cfRemoveSpaces
cfWrapCursor
cfAutoBrackets
cfPersistent
cfKeepSelection
cfDelOnInput
cfXorSelect
cfOvr
cfMark
cfKeepIndentProfile
cfKeepExtraSpaces
cfTabIndents
cfShowTabs
cfSpaceIndent
cfSmartHome

Definition at line 285 of file document.h.

---

Constructor & Destructor Documentation

Kate::Document::Document

(

)

Definition at line 39 of file interfaces.cpp.

Kate::Document::Document	(	QObject *	parent,
		const char *	name
	)

Definition at line 34 of file interfaces.cpp.

Kate::Document::~Document

(

)

[virtual]

Definition at line 43 of file interfaces.cpp.

---

Member Function Documentation

virtual void Kate::Document::applyWordWrap

(

)

[pure virtual, slot]

Implemented in KateDocument.

virtual ConfigPage* Kate::Document::colorConfigPage

(

QWidget *

)

[pure virtual]

Deprecated:

Deprecated:

Implemented in KateDocument.

virtual uint Kate::Document::configFlags

(

)

[pure virtual]

Implemented in KateDocument.

const QString & Kate::Document::defaultEncoding

(

)

[static]

Definition at line 57 of file interfaces.cpp.

virtual QString Kate::Document::docName

(

)

[inline, virtual]

Returns the document name.

Reimplemented in KateDocument.

Definition at line 217 of file document.h.

virtual ConfigPage* Kate::Document::editConfigPage

(

QWidget *

)

[pure virtual]

Deprecated:

Implemented in KateDocument.

virtual QString Kate::Document::encoding

(

)

const [pure virtual]

Implemented in KateDocument.

virtual ActionMenu* Kate::Document::exportActionMenu	(	const QString &	,
		QObject *	= 0,
		const char *	= 0
	)			[pure virtual]

Implemented in KateDocument.

virtual void Kate::Document::exportAs

(

const QString &

)

[pure virtual, slot]

Implemented in KateDocument.

virtual void Kate::Document::flush

(

)

[inline, virtual, slot]

Reimplemented in KateDocument.

Definition at line 232 of file document.h.

virtual ConfigPage* Kate::Document::fontConfigPage

(

QWidget *

)

[pure virtual]

Deprecated:

Implemented in KateDocument.

virtual ActionMenu* Kate::Document::hlActionMenu	(	const QString &	,
		QObject *	= 0,
		const char *	= 0
	)			[pure virtual]

Implemented in KateDocument.

virtual ConfigPage* Kate::Document::hlConfigPage

(

QWidget *

)

[pure virtual]

Deprecated:

Implemented in KateDocument.

virtual ConfigPage* Kate::Document::indentConfigPage

(

QWidget *

)

[pure virtual]

Deprecated:

Implemented in KateDocument.

virtual void Kate::Document::isModOnHD

(

bool

= false

)

[inline, virtual]

deprecated for KDE 4.0, just does reloadFile, which will ask the normal "do you want it really" questions

Deprecated:

Reimplemented in KateDocument.

Definition at line 212 of file document.h.

virtual ConfigPage* Kate::Document::keysConfigPage

(

QWidget *

)

[pure virtual]

Deprecated:

Implemented in KateDocument.

virtual ConfigPage* Kate::Document::kSpellConfigPage

(

QWidget *

)

[inline, virtual]

Deprecated:

Definition at line 276 of file document.h.

void Kate::Document::modifiedOnDisc	(	Kate::Document *	doc,
		bool	isModified,
		unsigned char	reason
	)			[signal]

Indicate this file is modified on disk.

Parameters:

	doc	the Kate::Document object that represents the file on disk
	isModified	indicates the file was modified rather than created or deleted
	reason	the reason we are emitting the signal. 0 - nothing 1 - dirty 2 - created 3 - deleted

Command * Kate::Document::queryCommand

(

const QString &

cmd

)

[static]

Definition at line 72 of file interfaces.cpp.

bool Kate::Document::registerCommand

(

Command *

cmd

)

[static]

Commands handling.

Definition at line 62 of file interfaces.cpp.

virtual void Kate::Document::reloadFile

(

)

[pure virtual, slot]

Reloads the current document from disk if possible.

Implemented in KateDocument.

virtual ConfigPage* Kate::Document::selectConfigPage

(

QWidget *

)

[pure virtual]

Deprecated:

Implemented in KateDocument.

virtual void Kate::Document::setConfigFlags

(

uint

flags

)

[pure virtual]

Implemented in KateDocument.

virtual void Kate::Document::setDocName

(

QString

)

[inline, virtual]

Sets the document name.

deprecated for KDE 4.0, is done internally, calling it won't hurt but changes nothing beside triggers signal

Deprecated:

Reimplemented in KateDocument.

Definition at line 225 of file document.h.

virtual void Kate::Document::setEncoding

(

const QString &

e

)

[pure virtual]

Implemented in KateDocument.

void Kate::Document::setFileChangedDialogsActivated

(

bool

on

)

[static]

Definition at line 52 of file interfaces.cpp.

void Kate::Document::setOpenErrorDialogsActivated

(

bool

on

)

[static]

Definition at line 47 of file interfaces.cpp.

virtual void Kate::Document::setWordWrap

(

bool

)

[pure virtual]

Implemented in KateDocument.

virtual void Kate::Document::setWordWrapAt

(

unsigned

int

)

[pure virtual]

virtual void Kate::Document::spellcheck

(

)

[inline, virtual, slot]

Spellchecking.

Definition at line 242 of file document.h.

bool Kate::Document::unregisterCommand

(

Command *

cmd

)

[static]

Definition at line 67 of file interfaces.cpp.

virtual bool Kate::Document::wordWrap

(

)

[pure virtual]

Implemented in KateDocument.

virtual uint Kate::Document::wordWrapAt

(

)

[pure virtual]

Implemented in KateDocument.

---

Member Data Documentation

QString Kate::Document::s_defaultEncoding [static, protected]

Definition at line 340 of file document.h.

bool Kate::Document::s_fileChangedDialogsActivated = false [static, protected]

Definition at line 338 of file document.h.

bool Kate::Document::s_openErrorDialogsActivated = true [static, protected]

Definition at line 337 of file document.h.

---

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

• document.h
• interfaces.cpp