#include <document.h>

Inherits KTextEditor::Document, KTextEditor::EditInterface, KTextEditor::UndoInterface, KTextEditor::CursorInterface, KTextEditor::SelectionInterface, KTextEditor::SearchInterface, KTextEditor::HighlightingInterface, KTextEditor::BlockSelectionInterface, KTextEditor::ConfigInterface, KTextEditor::MarkInterface, KTextEditor::PrintInterface, KTextEditor::WordWrapInterface, KTextEditor::MarkInterfaceExtension, and KTextEditor::SelectionInterfaceExt.

Inherited by KateDocument.

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	flush ()

Signals
void	modifiedOnDisc (Kate::Document *doc, bool isModified, unsigned char reason)

Public Member Functions
	Document (TQObject parent, const char name)

virtual void	isModOnHD (bool=false)

virtual TQString	docName ()

virtual void	setDocName (TQString)

virtual ActionMenu *	hlActionMenu (const TQString &, TQObject =0, const char =0)=0

virtual ActionMenu *	exportActionMenu (const TQString &, TQObject =0, const char =0)=0

virtual void	reloadFile ()=0

virtual void	spellcheck ()

virtual void	exportAs (const TQString &)=0

virtual void	applyWordWrap ()=0

virtual void	setWordWrap (bool)=0

virtual bool	wordWrap ()=0

virtual void	setWordWrapAt (unsigned int)=0

virtual uint	wordWrapAt ()=0

virtual void	setEncoding (const TQString &e)=0

virtual TQString	encoding () const =0

virtual ConfigPage *	colorConfigPage (TQWidget *)=0

virtual ConfigPage *	fontConfigPage (TQWidget *)=0

virtual ConfigPage *	indentConfigPage (TQWidget *)=0

virtual ConfigPage *	selectConfigPage (TQWidget *)=0

virtual ConfigPage *	editConfigPage (TQWidget *)=0

virtual ConfigPage *	keysConfigPage (TQWidget *)=0

virtual ConfigPage *	kSpellConfigPage (TQWidget *)

virtual ConfigPage *	hlConfigPage (TQWidget *)=0

virtual uint	configFlags ()=0

virtual void	setConfigFlags (uint flags)=0

Static Public Member Functions
static bool	registerCommand (Command *cmd)

static bool	unregisterCommand (Command *cmd)

static Command *	queryCommand (const TQString &cmd)

static void	setOpenErrorDialogsActivated (bool on)

static void	setFileChangedDialogsActivated (bool on)

static const TQString &	defaultEncoding ()

Static Protected Attributes
static bool	s_openErrorDialogsActivated = true

static bool	s_fileChangedDialogsActivated = false

static TQString	s_defaultEncoding

Detailed Description

This interface provides access to the Kate Document class.

Definition at line 182 of file document.h.

Member Enumeration Documentation

◆ ConfigFlags

enum Kate::Document::ConfigFlags

Definition at line 285 of file document.h.

Constructor & Destructor Documentation

◆ Document() [1/2]

Kate::Document::Document ( )

Definition at line 39 of file interfaces.cpp.

◆ Document() [2/2]

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

Definition at line 34 of file interfaces.cpp.

◆ ~Document()

Kate::Document::~Document ( )

virtual

Definition at line 43 of file interfaces.cpp.

Member Function Documentation

◆ colorConfigPage()

virtual ConfigPage * Kate::Document::colorConfigPage ( TQWidget * )

pure virtual

Deprecated:

Deprecated:

◆ defaultEncoding()

const TQString & Kate::Document::defaultEncoding ( )

static

Definition at line 57 of file interfaces.cpp.

◆ docName()

virtual TQString Kate::Document::docName ( )

inlinevirtual

Returns the document name.

Definition at line 217 of file document.h.

◆ editConfigPage()

virtual ConfigPage * Kate::Document::editConfigPage ( TQWidget * )

pure virtual

Deprecated:

◆ flush

virtual void Kate::Document::flush ( )

inlinevirtualslot

Definition at line 232 of file document.h.

◆ fontConfigPage()

virtual ConfigPage * Kate::Document::fontConfigPage ( TQWidget * )

pure virtual

Deprecated:

◆ hlConfigPage()

virtual ConfigPage * Kate::Document::hlConfigPage ( TQWidget * )

pure virtual

Deprecated:

◆ indentConfigPage()

virtual ConfigPage * Kate::Document::indentConfigPage ( TQWidget * )

pure virtual

Deprecated:

◆ isModOnHD()

virtual void Kate::Document::isModOnHD ( bool = false )

inlinevirtual

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

Deprecated:

Definition at line 212 of file document.h.

◆ keysConfigPage()

virtual ConfigPage * Kate::Document::keysConfigPage ( TQWidget * )

pure virtual

Deprecated:

◆ kSpellConfigPage()

virtual ConfigPage * Kate::Document::kSpellConfigPage ( TQWidget * )

inlinevirtual

Deprecated:

Definition at line 276 of file document.h.

◆ modifiedOnDisc

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

◆ queryCommand()

Command * Kate::Document::queryCommand ( const TQString & cmd )

static

Definition at line 72 of file interfaces.cpp.

◆ registerCommand()

bool Kate::Document::registerCommand ( Command * cmd )

static

Commands handling.

Definition at line 62 of file interfaces.cpp.

◆ reloadFile()

virtual void Kate::Document::reloadFile ( )

pure virtual

Reloads the current document from disk if possible.

◆ selectConfigPage()

virtual ConfigPage * Kate::Document::selectConfigPage ( TQWidget * )

pure virtual

Deprecated:

◆ setDocName()

virtual void Kate::Document::setDocName ( TQString )

inlinevirtual

Sets the document name.

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

Deprecated:

Definition at line 225 of file document.h.

◆ setFileChangedDialogsActivated()

void Kate::Document::setFileChangedDialogsActivated ( bool on )

static

Definition at line 52 of file interfaces.cpp.

◆ setOpenErrorDialogsActivated()

void Kate::Document::setOpenErrorDialogsActivated ( bool on )

static

Definition at line 47 of file interfaces.cpp.

◆ spellcheck()

virtual void Kate::Document::spellcheck ( )

inlinevirtual

Spellchecking.

Definition at line 242 of file document.h.

◆ unregisterCommand()

bool Kate::Document::unregisterCommand ( Command * cmd )

static

Definition at line 67 of file interfaces.cpp.

Member Data Documentation

◆ s_defaultEncoding

TQString Kate::Document::s_defaultEncoding

staticprotected

Definition at line 340 of file document.h.

◆ s_fileChangedDialogsActivated

bool Kate::Document::s_fileChangedDialogsActivated = false

staticprotected

Definition at line 338 of file document.h.

◆ s_openErrorDialogsActivated

bool Kate::Document::s_openErrorDialogsActivated = true

staticprotected

Definition at line 337 of file document.h.

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

kate

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ConfigFlags

Constructor & Destructor Documentation

◆ Document() [1/2]

◆ Document() [2/2]

◆ ~Document()

Member Function Documentation

◆ colorConfigPage()

◆ defaultEncoding()

◆ docName()

◆ editConfigPage()

◆ flush

◆ fontConfigPage()

◆ hlConfigPage()

◆ indentConfigPage()

◆ isModOnHD()

◆ keysConfigPage()

◆ kSpellConfigPage()

◆ modifiedOnDisc

◆ queryCommand()

◆ registerCommand()

◆ reloadFile()

◆ selectConfigPage()

◆ setDocName()

◆ setFileChangedDialogsActivated()

◆ setOpenErrorDialogsActivated()

◆ spellcheck()

◆ unregisterCommand()

Member Data Documentation

◆ s_defaultEncoding

◆ s_fileChangedDialogsActivated

◆ s_openErrorDialogsActivated

kate

kate