X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fe604ccddcf5696a751892ad70dbc822be239c95..4a82116e2ee3060ecdb8a451403280f54be93372:/docs/latex/wx/tdocview.tex diff --git a/docs/latex/wx/tdocview.tex b/docs/latex/wx/tdocview.tex index 8b147fa176..35a2f3357b 100644 --- a/docs/latex/wx/tdocview.tex +++ b/docs/latex/wx/tdocview.tex @@ -2,6 +2,7 @@ Classes: \helpref{wxDocument}{wxdocument}, \helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate},\rtfsp \helpref{wxDocManager}{wxdocmanager}, \helpref{wxDocParentFrame}{wxdocparentframe}, \helpref{wxDocChildFrame}{wxdocchildframe}, +\rtfsp\helpref{wxDocMDIParentFrame}{wxdocmdiparentframe}, \helpref{wxDocMDIChildFrame}{wxdocmdichildframe}, \rtfsp\helpref{wxCommand}{wxcommand}, \helpref{wxCommandProcessor}{wxcommandprocessor} The document/view framework is found in most application frameworks, because it @@ -59,7 +60,16 @@ class, to provide multi-page document facilities. \end{itemize} 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 wxWidgets \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} @@ -68,7 +78,7 @@ the wxWindows \helpref{predefined command identifiers}{predefinedids} in your me Class: \helpref{wxDocument}{wxdocument} The wxDocument class can be used to model an application's file-based -data. It is part of the document/view framework supported by wxWindows, +data. It is part of the document/view framework supported by wxWidgets, and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate}\rtfsp and \helpref{wxDocManager}{wxdocmanager} classes. @@ -97,7 +107,7 @@ a \helpref{wxDocTemplate}{wxdoctemplate} object on application initialization, y should pass CLASSINFO(YourDocumentClass) to the wxDocTemplate constructor so that it knows how to create an instance of this class. -If you do not wish to use the wxWindows method of creating document +If you do not wish to use the wxWidgets method of creating document objects dynamically, you must override wxDocTemplate::CreateDocument to return an instance of the appropriate class. @@ -108,14 +118,14 @@ to return an instance of the appropriate class. Class: \helpref{wxView}{wxview} The wxView class can be used to model the viewing and editing component of -an application's file-based data. It is part of the document/view framework supported by wxWindows, +an application's file-based data. It is part of the document/view framework supported by wxWidgets, and cooperates with the \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate} and \helpref{wxDocManager}{wxdocmanager} classes. See the example application in {\tt samples/docview}. To use the abstract wxView class, you need to derive a new class and override -at least the member functions OnCreate, OnDraw, OnUpdate and OnClose. You'll probably +at least the member functions OnCreate, OnDraw, OnUpdate and OnClose. You will probably want to override OnMenuCommand to respond to menu commands from the frame containing the view. @@ -125,7 +135,7 @@ a \helpref{wxDocTemplate}{wxdoctemplate} object on application initialization, y should pass CLASSINFO(YourViewClass) to the wxDocTemplate constructor so that it knows how to create an instance of this class. -If you do not wish to use the wxWindows method of creating view +If you do not wish to use the wxWidgets method of creating view objects dynamically, you must override wxDocTemplate::CreateView to return an instance of the appropriate class. @@ -162,8 +172,8 @@ For the case where an application has one document type and one view type, a single document template is constructed, and dialogs will be appropriately simplified. -wxDocTemplate is part of the document/view framework supported by wxWindows, -and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument} +wxDocTemplate is part of the document/view framework supported by wxWidgets, +and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument} and \helpref{wxDocManager}{wxdocmanager} classes. See the example application in {\tt samples/docview}. @@ -171,12 +181,12 @@ See the example application in {\tt samples/docview}. To use the wxDocTemplate class, you do not need to derive a new class. Just pass relevant information to the constructor including CLASSINFO(YourDocumentClass) and CLASSINFO(YourViewClass) to allow dynamic instance creation. -If you do not wish to use the wxWindows method of creating document +If you do not wish to use the wxWidgets method of creating document objects dynamically, you must override wxDocTemplate::CreateDocument and wxDocTemplate::CreateView to return instances of the appropriate class. {\it NOTE}: the document template has nothing to do with the C++ template construct. C++ -templates are not used anywhere in wxWindows. +templates are not used anywhere in wxWidgets. \subsection{wxDocManager overview}\label{wxdocmanageroverview} @@ -184,11 +194,11 @@ templates are not used anywhere in wxWindows. Class: \helpref{wxDocManager}{wxdocmanager} -The wxDocManager class is part of the document/view framework supported by wxWindows, +The wxDocManager class is part of the document/view framework supported by wxWidgets, and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument}\rtfsp and \helpref{wxDocTemplate}{wxdoctemplate} classes. -A wxDocManager instance coordinates documents, views and document templates. It keeps a list of document and +A wxDocManager instance coordinates documents, views and document templates. It keeps a list of document and template instances, and much functionality is routed through this object, such as providing selection and file dialogs. The application can use this class `as is' or derive a class and override some members to extend or change the functionality. @@ -218,7 +228,7 @@ When a user interface event occurs, the application {\it submits} a command to a \helpref{wxCommandProcessor}{wxcommandprocessoroverview} object to execute and store. -The wxWindows document/view framework handles Undo and Redo by use of +The wxWidgets document/view framework handles Undo and Redo by use of wxCommand and wxCommandProcessor objects. You might find further uses for wxCommand, such as implementing a macro facility that stores, loads and replays commands. @@ -254,44 +264,30 @@ the file history, that will be used for appending the filenames. They are appended using menu identifiers in the range wxID\_FILE1 to wxID\_FILE9. In order to respond to a file load command from one of these identifiers, -you need to handle them in your wxFrame::OnMenuCommand. Below is the -code used by the default document/view parent frame. +you need to handle them using an event handler, for example: +{\small \begin{verbatim} -void wxDocParentFrame::OnMenuCommand(int id) +BEGIN_EVENT_TABLE(wxDocParentFrame, wxFrame) + EVT_MENU(wxID_EXIT, wxDocParentFrame::OnExit) + EVT_MENU_RANGE(wxID_FILE1, wxID_FILE9, wxDocParentFrame::OnMRUFile) +END_EVENT_TABLE() + +void wxDocParentFrame::OnExit(wxCommandEvent& WXUNUSED(event)) { - switch (id) - { - case wxID_EXIT: - { - if (GetEventHandler()->OnClose()) - delete this; - break; - } - case wxID_FILE1: - case wxID_FILE2: - case wxID_FILE3: - case wxID_FILE4: - case wxID_FILE5: - case wxID_FILE6: - case wxID_FILE7: - case wxID_FILE8: - case wxID_FILE9: - { - char *f = docManager->GetHistoryFile(id-wxID_FILE1); - if (f) - (void)docManager->CreateDocument(f, wxDOC_SILENT); - break; - } - default: - { - docManager->OnMenuCommand(id); - } - } + Close(); +} + +void wxDocParentFrame::OnMRUFile(wxCommandEvent& event) +{ + wxString f(m_docManager->GetHistoryFile(event.GetId() - wxID_FILE1)); + if (f != "") + (void)m_docManager->CreateDocument(f, wxDOC_SILENT); } \end{verbatim} +} -\subsection{wxWindows predefined command identifiers}\label{predefinedids} +\subsection{wxWidgets predefined command identifiers}\label{predefinedids} To allow communication between the application's menus and the document/view framework, several command identifiers are predefined for you