\section{Kate::Document Class Reference}
\label{classKate_1_1Document}\index{Kate::Document@{Kate::Document}}
This interface provides access to the {\bf Kate}{\rm (p.\,\pageref{namespaceKate})} {\bf Document}{\rm (p.\,\pageref{classKate_1_1Document})} class.  


{\tt \#include $<$document.h$>$}

Collaboration diagram for Kate::Document:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=81pt]{classKate_1_1Document__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Config\-Flags} \{ \par
{\bf cf\-Auto\-Indent} =  0x1, 
{\bf cf\-Backspace\-Indents} =  0x2, 
{\bf cf\-Word\-Wrap} =  0x4, 
{\bf cf\-Replace\-Tabs} =  0x8, 
\par
{\bf cf\-Remove\-Spaces} =  0x10, 
{\bf cf\-Wrap\-Cursor} =  0x20, 
{\bf cf\-Auto\-Brackets} =  0x40, 
{\bf cf\-Persistent} =  0x80, 
\par
{\bf cf\-Keep\-Selection} =  0x100, 
{\bf cf\-Del\-On\-Input} =  0x400, 
{\bf cf\-Xor\-Select} =  0x800, 
{\bf cf\-Ovr} =  0x1000, 
\par
{\bf cf\-Mark} =  0x2000, 
{\bf cf\-Keep\-Indent\-Profile} =  0x8000, 
{\bf cf\-Keep\-Extra\-Spaces} =  0x10000, 
{\bf cf\-Tab\-Indents} =  0x80000, 
\par
{\bf cf\-Show\-Tabs} =  0x200000, 
{\bf cf\-Space\-Indent} =  0x400000, 
{\bf cf\-Smart\-Home} =  0x800000
 \}
\end{CompactItemize}
\subsection*{Public Slots}
\begin{CompactItemize}
\item 
virtual void {\bf flush} ()\label{classKate_1_1Document_i0}

\item 
virtual void {\bf reload\-File} ()=0
\item 
virtual void {\bf spellcheck} ()
\item 
virtual void {\bf export\-As} (const {\bf QString} \&)=0\label{classKate_1_1Document_i3}

\item 
virtual void {\bf apply\-Word\-Wrap} ()=0\label{classKate_1_1Document_i4}

\end{CompactItemize}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf modified\-On\-Disc} ({\bf Kate::Document} $\ast$doc, bool is\-Modified, unsigned char reason)
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Document} ({\bf QObject} $\ast$parent, const char $\ast$name)\label{classKate_1_1Document_a1}

\item 
virtual void {\bf is\-Mod\-On\-HD} (bool=false)
\item 
virtual {\bf QString} {\bf doc\-Name} ()
\item 
virtual void {\bf set\-Doc\-Name} ({\bf QString})
\item 
virtual Action\-Menu $\ast$ {\bf hl\-Action\-Menu} (const {\bf QString} \&, {\bf QObject} $\ast$=0, const char $\ast$=0)=0\label{classKate_1_1Document_a6}

\item 
virtual Action\-Menu $\ast$ {\bf export\-Action\-Menu} (const {\bf QString} \&, {\bf QObject} $\ast$=0, const char $\ast$=0)=0\label{classKate_1_1Document_a7}

\item 
virtual void {\bf set\-Word\-Wrap} (bool)=0\label{classKate_1_1Document_a8}

\item 
virtual bool {\bf word\-Wrap} ()=0\label{classKate_1_1Document_a9}

\item 
virtual void {\bf set\-Word\-Wrap\-At} (unsigned int)=0\label{classKate_1_1Document_a10}

\item 
virtual uint {\bf word\-Wrap\-At} ()=0\label{classKate_1_1Document_a11}

\item 
virtual void {\bf set\-Encoding} (const {\bf QString} \&e)=0\label{classKate_1_1Document_a12}

\item 
virtual {\bf QString} {\bf encoding} () const =0\label{classKate_1_1Document_a13}

\item 
virtual Config\-Page $\ast$ {\bf color\-Config\-Page} ({\bf QWidget} $\ast$)=0
\item 
virtual Config\-Page $\ast$ {\bf font\-Config\-Page} ({\bf QWidget} $\ast$)=0
\item 
virtual Config\-Page $\ast$ {\bf indent\-Config\-Page} ({\bf QWidget} $\ast$)=0
\item 
virtual Config\-Page $\ast$ {\bf select\-Config\-Page} ({\bf QWidget} $\ast$)=0
\item 
virtual Config\-Page $\ast$ {\bf edit\-Config\-Page} ({\bf QWidget} $\ast$)=0
\item 
virtual Config\-Page $\ast$ {\bf keys\-Config\-Page} ({\bf QWidget} $\ast$)=0
\item 
virtual Config\-Page $\ast$ {\bf k\-Spell\-Config\-Page} ({\bf QWidget} $\ast$)
\item 
virtual Config\-Page $\ast$ {\bf hl\-Config\-Page} ({\bf QWidget} $\ast$)=0
\item 
virtual uint {\bf config\-Flags} ()=0\label{classKate_1_1Document_a22}

\item 
virtual void {\bf set\-Config\-Flags} (uint flags)=0\label{classKate_1_1Document_a23}

\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static bool {\bf register\-Command} ({\bf Command} $\ast$cmd)
\item 
static bool {\bf unregister\-Command} ({\bf Command} $\ast$cmd)\label{classKate_1_1Document_e1}

\item 
static {\bf Command} $\ast$ {\bf query\-Command} (const {\bf QString} \&cmd)\label{classKate_1_1Document_e2}

\item 
static void {\bf set\-Open\-Error\-Dialogs\-Activated} (bool on)\label{classKate_1_1Document_e3}

\item 
static void {\bf set\-File\-Changed\-Dialogs\-Activated} (bool on)\label{classKate_1_1Document_e4}

\item 
static const {\bf QString} \& {\bf default\-Encoding} ()\label{classKate_1_1Document_e5}

\end{CompactItemize}
\subsection*{Static Protected Attributes}
\begin{CompactItemize}
\item 
static bool {\bf s\_\-open\-Error\-Dialogs\-Activated} = true\label{classKate_1_1Document_t0}

\item 
static bool {\bf s\_\-file\-Changed\-Dialogs\-Activated} = false\label{classKate_1_1Document_t1}

\item 
static {\bf QString} {\bf s\_\-default\-Encoding}\label{classKate_1_1Document_t2}

\end{CompactItemize}


\subsection{Detailed Description}
This interface provides access to the {\bf Kate}{\rm (p.\,\pageref{namespaceKate})} {\bf Document}{\rm (p.\,\pageref{classKate_1_1Document})} class. 



Definition at line 182 of file document.h.

\subsection{Member Function Documentation}
\index{Kate::Document@{Kate::Document}!registerCommand@{registerCommand}}
\index{registerCommand@{registerCommand}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Kate::Document::register\-Command ({\bf Command} $\ast$ {\em cmd})\hspace{0.3cm}{\tt  [static]}}\label{classKate_1_1Document_e0}


Commands handling. 



Definition at line 62 of file interfaces.cpp.\index{Kate::Document@{Kate::Document}!isModOnHD@{isModOnHD}}
\index{isModOnHD@{isModOnHD}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate::Document::is\-Mod\-On\-HD (bool = {\tt false})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKate_1_1Document_a3}


deprecated for {\bf KDE} 4.0, just does reload\-File, which will ask the normal \char`\"{}do you want it really\char`\"{} questions 

\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}


Definition at line 212 of file document.h.\index{Kate::Document@{Kate::Document}!docName@{docName}}
\index{docName@{docName}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} Kate::Document::doc\-Name ()\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKate_1_1Document_a4}


Returns the document name. 



Definition at line 217 of file document.h.\index{Kate::Document@{Kate::Document}!setDocName@{setDocName}}
\index{setDocName@{setDocName}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate::Document::set\-Doc\-Name ({\bf QString})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKate_1_1Document_a5}


Sets the document name. 

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

\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}


Definition at line 225 of file document.h.\index{Kate::Document@{Kate::Document}!reloadFile@{reloadFile}}
\index{reloadFile@{reloadFile}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate::Document::reload\-File ()\hspace{0.3cm}{\tt  [pure virtual, slot]}}\label{classKate_1_1Document_i1}


Reloads the current document from disk if possible. 

\index{Kate::Document@{Kate::Document}!spellcheck@{spellcheck}}
\index{spellcheck@{spellcheck}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Kate::Document::spellcheck ()\hspace{0.3cm}{\tt  [inline, virtual, slot]}}\label{classKate_1_1Document_i2}


Spellchecking. 



Definition at line 242 of file document.h.\index{Kate::Document@{Kate::Document}!colorConfigPage@{colorConfigPage}}
\index{colorConfigPage@{colorConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::color\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKate_1_1Document_a14}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
\index{Kate::Document@{Kate::Document}!fontConfigPage@{fontConfigPage}}
\index{fontConfigPage@{fontConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::font\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKate_1_1Document_a15}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
\index{Kate::Document@{Kate::Document}!indentConfigPage@{indentConfigPage}}
\index{indentConfigPage@{indentConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::indent\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKate_1_1Document_a16}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
\index{Kate::Document@{Kate::Document}!selectConfigPage@{selectConfigPage}}
\index{selectConfigPage@{selectConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::select\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKate_1_1Document_a17}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
\index{Kate::Document@{Kate::Document}!editConfigPage@{editConfigPage}}
\index{editConfigPage@{editConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::edit\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKate_1_1Document_a18}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
\index{Kate::Document@{Kate::Document}!keysConfigPage@{keysConfigPage}}
\index{keysConfigPage@{keysConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::keys\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKate_1_1Document_a19}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
\index{Kate::Document@{Kate::Document}!kSpellConfigPage@{kSpellConfigPage}}
\index{kSpellConfigPage@{kSpellConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::k\-Spell\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKate_1_1Document_a20}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}


Definition at line 276 of file document.h.\index{Kate::Document@{Kate::Document}!hlConfigPage@{hlConfigPage}}
\index{hlConfigPage@{hlConfigPage}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Config\-Page$\ast$ Kate::Document::hl\-Config\-Page ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKate_1_1Document_a21}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
\index{Kate::Document@{Kate::Document}!modifiedOnDisc@{modifiedOnDisc}}
\index{modifiedOnDisc@{modifiedOnDisc}!Kate::Document@{Kate::Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate::Document::modified\-On\-Disc ({\bf Kate::Document} $\ast$ {\em doc}, bool {\em is\-Modified}, unsigned char {\em reason})\hspace{0.3cm}{\tt  [signal]}}\label{classKate_1_1Document_l0}


Indicate this file is modified on disk. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em doc}]the Kate::Document object that represents the file on disk \item[{\em is\-Modified}]indicates the file was modified rather than created or deleted \item[{\em reason}]the reason we are emitting the signal. \begin{itemize}
\item 0 - nothing \item 1 - dirty \item 2 - created \item 3 - deleted \end{itemize}
\end{description}
\end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
document.h\item 
interfaces.cpp\end{CompactItemize}
