X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6aa358aebb951956f0e0ab645788e00a4b904886..329eeca9c404b5e670af89cf7d2b1e517aa71853:/docs/latex/wx/doctempl.tex diff --git a/docs/latex/wx/doctempl.tex b/docs/latex/wx/doctempl.tex index a7287f5f26..afaaea357e 100644 --- a/docs/latex/wx/doctempl.tex +++ b/docs/latex/wx/doctempl.tex @@ -57,7 +57,7 @@ A pointer to the document manager for which this template was created. \member{wxString}{m\_fileFilter} -The file filter (such as \tt{*.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} @@ -92,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 \tt{*.txt}. +{\it filter} is an appropriate file filter such as {\tt *.txt}. {\it dir} is the default directory to use for file selectors. @@ -121,6 +121,25 @@ 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}): + +\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} @@ -135,6 +154,9 @@ Creates a new instance of the associated document class. If you have not supplie a wxClassInfo parameter to the template constructor, you will need to override this function to return an appropriate document instance. +This function calls wxDocTemplate::InitDocument which in turns +calls wxDocument::OnCreate. + \membersection{wxDocTemplate::CreateView} \func{wxView *}{CreateView}{\param{wxDocument *}{doc}, \param{long}{ flags = 0}} @@ -191,11 +213,18 @@ Returns the flags, as passed to the document template constructor. Returns the view type name, as passed to the document template constructor. +\membersection{wxDocTemplate::InitDocument} + +\func{bool}{InitDocument}{\param{wxDocument* }{doc}, \param{const wxString\& }{path}, \param{long}{ flags = 0}} + +Initialises the document, calling wxDocument::OnCreate. This is called from +wxDocTemplate::CreateDocument. + \membersection{wxDocTemplate::IsVisible} \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}