wxPerl notes for DocView.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18432 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Mattia Barbon
2002-12-27 18:30:48 +00:00
parent 5f133dc1bb
commit 762e199741
5 changed files with 39 additions and 2 deletions

View File

@@ -358,6 +358,12 @@ followed by a file selector.
This function is used in wxDocManager::CreateDocument. This function is used in wxDocManager::CreateDocument.
\perlnote{In wxPerl {\tt templates} is a reference to a list of templates.
If you override this method in your document manager it must return
two values, eg:\par
(doctemplate, path) = My::DocManager->SelectDocumentPath( ... );
}
\membersection{wxDocManager::SelectDocumentType} \membersection{wxDocManager::SelectDocumentType}
\func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates}, \func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates},
@@ -375,6 +381,8 @@ then this parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box dialog. will have to choose from is sorted or not when shown the choice box dialog.
Default is FALSE.} Default is FALSE.}
\perlnote{In wxPerl {\tt templates} is a reference to a list of templates.}
\membersection{wxDocManager::SelectViewType} \membersection{wxDocManager::SelectViewType}
\func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates}, \func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates},
@@ -394,6 +402,8 @@ then this parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box dialog. will have to choose from is sorted or not when shown the choice box dialog.
Default is FALSE.} Default is FALSE.}
\perlnote{In wxPerl {\tt templates} is a reference to a list of templates.}
\membersection{wxDocManager::SetLastDirectory}\label{wxdocmanagersetlastdirectory} \membersection{wxDocManager::SetLastDirectory}\label{wxdocmanagersetlastdirectory}
\func{void}{SetLastDirectory}{\param{const wxString\&}{ dir}} \func{void}{SetLastDirectory}{\param{const wxString\&}{ dir}}

View File

@@ -121,6 +121,24 @@ member to return a new view instance on demand.
\item wxDEFAULT\_TEMPLATE\_FLAGS Defined as wxTEMPLATE\_VISIBLE. \item wxDEFAULT\_TEMPLATE\_FLAGS Defined as wxTEMPLATE\_VISIBLE.
\end{itemize} \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}} \membersection{wxDocTemplate::\destruct{wxDocTemplate}}
\func{void}{\destruct{wxDocTemplate}}{\void} \func{void}{\destruct{wxDocTemplate}}{\void}

View File

@@ -1,4 +1,4 @@
\section{wxScopedArray}\label{wxscopedarray} \section{\class{wxScopedArray}}\label{wxscopedarray}
This is a simple scoped smart pointer array implementation that is similar to This is a simple scoped smart pointer array implementation that is similar to
the \urlref{Boost}{http://www.boost.org} smart pointers but rewritten to the \urlref{Boost}{http://www.boost.org} smart pointers but rewritten to

View File

@@ -1,4 +1,4 @@
\section{wxScopedPtr}\label{wxscopedptr} \section{\class{wxScopedPtr}}\label{wxscopedptr}
This is a simple scoped smart pointer implementation that is similar to This is a simple scoped smart pointer implementation that is similar to
the \urlref{Boost}{http://www.boost.org} smart pointers but rewritten to the \urlref{Boost}{http://www.boost.org} smart pointers but rewritten to

View File

@@ -62,6 +62,15 @@ class, to provide multi-page document facilities.
Note that to activate framework functionality, you need to use some or all of Note that to activate framework functionality, you need to use some or all of
the wxWindows \helpref{predefined command identifiers}{predefinedids} in your menus. the wxWindows \helpref{predefined command identifiers}{predefinedids} in your menus.
\perlnote{The document/view framework is available in wxPerl. To use it,
you will need the following statements in your application code:\par
{\small
\begin{verbatim}
use Wx::DocView;
use Wx ':docview'; # import constants (optional)
\end{verbatim}
}}
\subsection{wxDocument overview}\label{wxdocumentoverview} \subsection{wxDocument overview}\label{wxdocumentoverview}
\overview{Document/view framework overview}{docviewoverview} \overview{Document/view framework overview}{docviewoverview}