.TH "Kate::Document" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Kate::Document \- This interface provides access to the \fBKate\fP \fBDocument\fP class.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <document.h>\fP
.PP
Inherits Document, EditInterface, UndoInterface, CursorInterface, SelectionInterface, SearchInterface, HighlightingInterface, BlockSelectionInterface, ConfigInterface, MarkInterface, PrintInterface, WordWrapInterface, MarkInterfaceExtension, and SelectionInterfaceExt.
.PP
Inherited by KateDocument.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBConfigFlags\fP { \fBcfAutoIndent\fP =  0x1, \fBcfBackspaceIndents\fP =  0x2, \fBcfWordWrap\fP =  0x4, \fBcfReplaceTabs\fP =  0x8, \fBcfRemoveSpaces\fP =  0x10, \fBcfWrapCursor\fP =  0x20, \fBcfAutoBrackets\fP =  0x40, \fBcfPersistent\fP =  0x80, \fBcfKeepSelection\fP =  0x100, \fBcfDelOnInput\fP =  0x400, \fBcfXorSelect\fP =  0x800, \fBcfOvr\fP =  0x1000, \fBcfMark\fP =  0x2000, \fBcfKeepIndentProfile\fP =  0x8000, \fBcfKeepExtraSpaces\fP =  0x10000, \fBcfTabIndents\fP =  0x80000, \fBcfShowTabs\fP =  0x200000, \fBcfSpaceIndent\fP =  0x400000, \fBcfSmartHome\fP =  0x800000 }"
.br
.in -1c
.SS "Public Slots"

.in +1c
.ti -1c
.RI "virtual void \fBflush\fP ()"
.br
.ti -1c
.RI "virtual void \fBreloadFile\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBspellcheck\fP ()"
.br
.ti -1c
.RI "virtual void \fBexportAs\fP (const \fBQString\fP &)=0"
.br
.ti -1c
.RI "virtual void \fBapplyWordWrap\fP ()=0"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBmodifiedOnDisc\fP (\fBKate::Document\fP *doc, bool isModified, unsigned char reason)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDocument\fP (\fBQObject\fP *parent, const char *name)"
.br
.ti -1c
.RI "virtual void \fBisModOnHD\fP (bool=false)"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBdocName\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetDocName\fP (\fBQString\fP)"
.br
.ti -1c
.RI "virtual ActionMenu * \fBhlActionMenu\fP (const \fBQString\fP &, \fBQObject\fP *=0, const char *=0)=0"
.br
.ti -1c
.RI "virtual ActionMenu * \fBexportActionMenu\fP (const \fBQString\fP &, \fBQObject\fP *=0, const char *=0)=0"
.br
.ti -1c
.RI "virtual void \fBsetWordWrap\fP (bool)=0"
.br
.ti -1c
.RI "virtual bool \fBwordWrap\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBsetWordWrapAt\fP (unsigned int)=0"
.br
.ti -1c
.RI "virtual uint \fBwordWrapAt\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBsetEncoding\fP (const \fBQString\fP &e)=0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBencoding\fP () const =0"
.br
.ti -1c
.RI "virtual ConfigPage * \fBcolorConfigPage\fP (\fBQWidget\fP *)=0"
.br
.ti -1c
.RI "virtual ConfigPage * \fBfontConfigPage\fP (\fBQWidget\fP *)=0"
.br
.ti -1c
.RI "virtual ConfigPage * \fBindentConfigPage\fP (\fBQWidget\fP *)=0"
.br
.ti -1c
.RI "virtual ConfigPage * \fBselectConfigPage\fP (\fBQWidget\fP *)=0"
.br
.ti -1c
.RI "virtual ConfigPage * \fBeditConfigPage\fP (\fBQWidget\fP *)=0"
.br
.ti -1c
.RI "virtual ConfigPage * \fBkeysConfigPage\fP (\fBQWidget\fP *)=0"
.br
.ti -1c
.RI "virtual ConfigPage * \fBkSpellConfigPage\fP (\fBQWidget\fP *)"
.br
.ti -1c
.RI "virtual ConfigPage * \fBhlConfigPage\fP (\fBQWidget\fP *)=0"
.br
.ti -1c
.RI "virtual uint \fBconfigFlags\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBsetConfigFlags\fP (uint flags)=0"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static bool \fBregisterCommand\fP (\fBCommand\fP *cmd)"
.br
.ti -1c
.RI "static bool \fBunregisterCommand\fP (\fBCommand\fP *cmd)"
.br
.ti -1c
.RI "static \fBCommand\fP * \fBqueryCommand\fP (const \fBQString\fP &cmd)"
.br
.ti -1c
.RI "static void \fBsetOpenErrorDialogsActivated\fP (bool on)"
.br
.ti -1c
.RI "static void \fBsetFileChangedDialogsActivated\fP (bool on)"
.br
.ti -1c
.RI "static const \fBQString\fP & \fBdefaultEncoding\fP ()"
.br
.in -1c
.SS "Static Protected Attributes"

.in +1c
.ti -1c
.RI "static bool \fBs_openErrorDialogsActivated\fP = true"
.br
.ti -1c
.RI "static bool \fBs_fileChangedDialogsActivated\fP = false"
.br
.ti -1c
.RI "static \fBQString\fP \fBs_defaultEncoding\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This interface provides access to the \fBKate\fP \fBDocument\fP class. 
.PP
Definition at line 182 of file document.h.
.SH "Member Function Documentation"
.PP 
.SS "bool Kate::Document::registerCommand (\fBCommand\fP * cmd)\fC [static]\fP"
.PP
Commands handling. 
.PP
Definition at line 62 of file interfaces.cpp.
.SS "virtual void Kate::Document::isModOnHD (bool = \fCfalse\fP)\fC [inline, virtual]\fP"
.PP
deprecated for \fBKDE\fP 4.0, just does reloadFile, which will ask the normal 'do you want it really' questions 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 212 of file document.h.
.SS "virtual \fBQString\fP Kate::Document::docName ()\fC [inline, virtual]\fP"
.PP
Returns the document name. 
.PP
Definition at line 217 of file document.h.
.SS "virtual void Kate::Document::setDocName (\fBQString\fP)\fC [inline, virtual]\fP"
.PP
Sets the document name. 
.PP
deprecated for \fBKDE\fP 4.0, is done internally, calling it won't hurt but changes nothing beside triggers signal 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 225 of file document.h.
.SS "virtual void Kate::Document::reloadFile ()\fC [pure virtual, slot]\fP"
.PP
Reloads the current document from disk if possible. 
.PP
.SS "virtual void Kate::Document::spellcheck ()\fC [inline, virtual, slot]\fP"
.PP
Spellchecking. 
.PP
Definition at line 242 of file document.h.
.SS "virtual ConfigPage* Kate::Document::colorConfigPage (\fBQWidget\fP *)\fC [pure virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "virtual ConfigPage* Kate::Document::fontConfigPage (\fBQWidget\fP *)\fC [pure virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "virtual ConfigPage* Kate::Document::indentConfigPage (\fBQWidget\fP *)\fC [pure virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "virtual ConfigPage* Kate::Document::selectConfigPage (\fBQWidget\fP *)\fC [pure virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "virtual ConfigPage* Kate::Document::editConfigPage (\fBQWidget\fP *)\fC [pure virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "virtual ConfigPage* Kate::Document::keysConfigPage (\fBQWidget\fP *)\fC [pure virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "virtual ConfigPage* Kate::Document::kSpellConfigPage (\fBQWidget\fP *)\fC [inline, virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 276 of file document.h.
.SS "virtual ConfigPage* Kate::Document::hlConfigPage (\fBQWidget\fP *)\fC [pure virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.SS "void Kate::Document::modifiedOnDisc (\fBKate::Document\fP * doc, bool isModified, unsigned char reason)\fC [signal]\fP"
.PP
Indicate this file is modified on disk. 
.PP
\fBParameters:\fP
.RS 4
\fIdoc\fP the Kate::Document object that represents the file on disk 
.br
\fIisModified\fP indicates the file was modified rather than created or deleted 
.br
\fIreason\fP the reason we are emitting the signal. 
.PD 0

.IP "\(bu" 2
0 - nothing 
.IP "\(bu" 2
1 - dirty 
.IP "\(bu" 2
2 - created 
.IP "\(bu" 2
3 - deleted 
.PP
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kate Library from the source code.
