/////////////////////////////////////////////////////////////////////////////
// Name: docview.h
-// Purpose: documentation for wxDocTemplate class
+// Purpose: interface of wxDocTemplate
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{dvf}
- @seealso
- @ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument, wxView
+ @see @ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument,
+ wxView
*/
class wxDocTemplate : public wxObject
{
wxTEMPLATE_VISIBLE The template may be displayed to the user in dialogs.
wxTEMPLATE_INVISIBLE The template may not be displayed to the user in dialogs.
wxDEFAULT_TEMPLATE_FLAGS Defined as wxTEMPLATE_VISIBLE.
-
-
+
+
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName, docClassInfo, viewClassInfo, flags
)
-
+
will construct document and view objects from the class information
-
+
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName, docClassName, viewClassName, flags
)
-
+
will construct document and view objects from perl packages
-
+
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName )
-
+
@c Wx::DocTemplate::CreateDocument() and
@c Wx::DocTemplate::CreateView() must be overridden
*/
};
+
/**
@class wxDocManager
@wxheader{docview.h}
@library{wxcore}
@category{dvf}
- @seealso
- @ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument, wxView,
- wxDocTemplate, wxFileHistory
+ @see @ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument,
+ wxView, wxDocTemplate, wxFileHistory
*/
class wxDocManager : public wxEvtHandler
{
/**
Loads the file history from a config object.
-
- @see wxConfig
+
+ @see wxConfig()
*/
void FileHistoryLoad(wxConfigBase& config);
/**
Saves the file history into a config object. This must be called
explicitly by the application.
-
- @see wxConfig
+
+ @see wxConfig()
*/
void FileHistorySave(wxConfigBase& resourceFile);
Returns a document template by asking the user (if there is more than one
template).
This function is used in CreateDocument().
-
+
@param templates
Pointer to an array of templates from which to choose a desired template.
@param noTemplates
If more than one template is passed in in templates,
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.
-
+
Default is @false.
*/
wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
The dialog normally will not appear because the array of templates only contains
those relevant to the document in question, and often there will only be one
such.
-
+
@param templates
Pointer to an array of templates from which to choose a desired template.
@param noTemplates
If more than one template is passed in in templates,
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.
-
+
Default is @false.
*/
wxDocTemplate* SelectViewType(wxDocTemplate** templates,
};
+
/**
@class wxView
@wxheader{docview.h}
@library{wxcore}
@category{dvf}
- @seealso
- @ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate,
+ @see @ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate,
wxDocManager
*/
class wxView : public wxEvtHandler
};
+
/**
@class wxDocChildFrame
@wxheader{docview.h}
@library{wxcore}
@category{dvf}
- @seealso
- @ref overview_docviewoverview, wxFrame
+ @see @ref overview_docviewoverview, wxFrame
*/
class wxDocChildFrame : public wxFrame
{
};
+
/**
@class wxDocParentFrame
@wxheader{docview.h}
SDI (not MDI) parent frames.
It cooperates with the wxView, wxDocument,
- wxDocManager and wxDocTemplates classes.
+ wxDocManager and wxDocTemplates() classes.
See the example application in @c samples/docview.
@library{wxcore}
@category{dvf}
- @seealso
- @ref overview_docviewoverview, wxFrame
+ @see @ref overview_docviewoverview, wxFrame
*/
class wxDocParentFrame : public wxFrame
{
};
+
/**
@class wxDocument
@wxheader{docview.h}
@library{wxcore}
@category{dvf}
- @seealso
- @ref overview_wxdocumentoverview "wxDocument overview", wxView, wxDocTemplate,
- wxDocManager
+ @see @ref overview_wxdocumentoverview "wxDocument overview", wxView,
+ wxDocTemplate, wxDocManager
*/
class wxDocument : public wxEvtHandler
{
/**
Gets the document type name for this document. See the comment for
- documentTypeName.
+ documentTypeName().
*/
wxString GetDocumentName() const;
/**
Sets the document type name for this document. See the comment for
- documentTypeName.
+ documentTypeName().
*/
void SetDocumentName(const wxString& name);
*/
void UpdateAllViews(wxView* sender = NULL, wxObject* hint = NULL);
+protected:
+ /**
+ This method is called by OnSaveDocument() to really save the document
+ contents to the specified file.
+
+ Base class version creates a file-based stream and calls SaveObject().
+ Override this if you need to do something else or prefer not to use
+ SaveObject() at all.
+ */
+ virtual bool DoSaveDocument(const wxString& file);
+
+ /**
+ This method is called by OnOpenDocument() to really load the document
+ contents from the specified file.
+
+ Base class version creates a file-based stream and calls LoadObject().
+ Override this if you need to do something else or prefer not to use
+ LoadObject() at all.
+ */
+ virtual bool DoOpenDocument(const wxString& file);
+
+
/**
wxCommandProcessor* m_commandProcessor
A pointer to the command processor associated with this document.
};
+
/**
@class wxFileHistory
@wxheader{docview.h}
@library{wxcore}
@category{FIXME}
- @seealso
- @ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager
+ @see @ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager
*/
class wxFileHistory : public wxObject
{
/**
Returns the list of menus that are managed by this file history object.
-
+
@see UseMenu()
*/
const wxList GetMenus() const;
/**
Loads the file history from the given config object. This function should be
called explicitly by the application.
-
- @see wxConfig
+
+ @see wxConfig()
*/
void Load(wxConfigBase& config);
/**
Saves the file history into the given config object. This must be called
explicitly by the application.
-
- @see wxConfig
+
+ @see wxConfig()
*/
void Save(wxConfigBase& config);
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
+/** @ingroup group_funcmacro_file */
+//@{
+
/**
- Copies the given file to @e stream. Useful when converting an old application to
- use streams (within the document/view framework, for example).
+ Copies the given file to @a stream. Useful when converting an old
+ application to use streams (within the document/view framework, for
+ example).
+
+ @header{wx/docview.h}
*/
bool wxTransferFileToStream(const wxString& filename,
ostream& stream);
+/**
+ Copies the given stream to the file @a filename. Useful when converting an
+ old application to use streams (within the document/view framework, for
+ example).
+
+ @header{wx/docview.h}
+*/
+bool wxTransferStreamToFile(istream& stream,
+ const wxString& filename);
+
+//@}
+
projects / wxWidgets.git / blobdiff