added install

[wxWidgets.git] / docs / latex / wx / doctempl.tex

diff --git a/docs/latex/wx/doctempl.tex b/docs/latex/wx/doctempl.tex
index daae6ace6188d19a970bf4fc3e510c3ed96fd743..8ce5e943a82045bc0ac24d4e8be80e5388070ace 100644 (file)
--- a/docs/latex/wx/doctempl.tex
+++ b/docs/latex/wx/doctempl.tex
@@ -7,6 +7,10 @@ document class and a view class.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/docview.h>
+
 \wxheading{See also}
 
 \helpref{wxDocTemplate overview}{wxdoctemplateoverview}, \helpref{wxDocument}{wxdocument}, \helpref{wxView}{wxview}
@@ -53,7 +57,7 @@ A pointer to the document manager for which this template was created.
 
 \member{wxString}{m\_fileFilter}
 
-The file filter (such as \verb$*.txt$) to be used in file selector dialogs.
+The file filter (such as {\tt *.txt}) to be used in file selector dialogs.
 
 \membersection{wxDocTemplate::m\_flags}
 
@@ -88,7 +92,7 @@ a wxDocManager instance, and before doing any document or view operations.
 {\it descr} is a short description of what the template is for. This string will be displayed in the
 file filter list of Windows file selectors.
 
-{\it filter} is an appropriate file filter such as \verb$*.txt$.
+{\it filter} is an appropriate file filter such as {\tt *.txt}.
 
 {\it dir} is the default directory to use for file selectors.
 
@@ -117,6 +121,24 @@ member to return a new view instance on demand.
 \item wxDEFAULT\_TEMPLATE\_FLAGS Defined as wxTEMPLATE\_VISIBLE.
 \end{itemize}
 
+\perlnote{In wxPerl {\tt docClassInfo} and {\tt viewClassInfo} can be
+either {\tt Wx::ClassInfo} objects or strings which contain the name
+of the perl packages which are to be used as {\tt Wx::Document} and
+{\tt Wx::View} classes (they must have a constructor named {\tt
+new}):\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf Wx::DocTemplate->new( docmgr, descr, filter, dir,
+ext, docTypeName, viewTypeName, docClassInfo, viewClassInfo, flags
+)}}{ will construct document and view objects from the class information}
+\twocolitem{{\bf Wx::DocTemplate->new( docmgr, descr, filter, dir,
+ext, docTypeName, viewTypeName, docClassName, viewClassName, flags
+)}}{ will construct document and view objects from perl packages}
+\twocolitem{{\bf Wx::DocTemplate->new( docmgr, descr, filter, dir,
+ext, docTypeName, viewTypeName )}}{
+{\tt Wx::DocTemplate::CreateDocument()} and
+{\tt Wx::DocTemplate::CreateView()} must be overridden}
+\end{twocollist}}}
+
 \membersection{wxDocTemplate::\destruct{wxDocTemplate}}
 
 \func{void}{\destruct{wxDocTemplate}}{\void}
@@ -191,7 +213,7 @@ Returns the view type name, as passed to the document template constructor.
 
 \func{bool}{IsVisible}{\void}
 
-Returns TRUE if the document template can be shown in user dialogs, FALSE otherwise.
+Returns true if the document template can be shown in user dialogs, false otherwise.
 
 \membersection{wxDocTemplate::SetDefaultExtension}
 
@@ -230,4 +252,3 @@ Sets the file filter.
 
 Sets the internal document template flags (see the constructor description for more details).
 
-