docs/latex/wx/docmanag.tex

   1 \section{\class{wxDocManager}}\label{wxdocmanager}
   2
   3 The wxDocManager class is part of the document/view framework supported by wxWindows,
   4 and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument}\rtfsp
   5 and \helpref{wxDocTemplate}{wxdoctemplate} classes.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxEvtHandler}{wxevthandler}\\
  10 \helpref{wxObject}{wxobject}
  11
  12 \wxheading{See also}
  13
  14 \helpref{wxDocManager overview}{wxdocmanageroverview}, \helpref{wxDocument}{wxdocument},\rtfsp
  15 \helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate}, \helpref{wxFileHistory}{wxfilehistory}
  16
  17 \latexignore{\rtfignore{\wxheading{Members}}}
  18
  19 \membersection{wxDocManager::m\_currentView}
  20
  21 \member{wxView*}{m\_currentView}
  22
  23 The currently active view.
  24
  25 \membersection{wxDocManager::m\_defaultDocumentNameCounter}
  26
  27 \member{int}{m\_defaultDocumentNameCounter}
  28
  29 Stores the integer to be used for the next default document name.
  30
  31 \membersection{wxDocManager::m\_fileHistory}
  32
  33 \member{wxFileHistory*}{m\_fileHistory}
  34
  35 A pointer to an instance of \helpref{wxFileHistory}{wxfilehistory},
  36 which manages the history of recently-visited files on the File menu.
  37
  38 \membersection{wxDocManager::m\_maxDocsOpen}
  39
  40 \member{int}{m\_maxDocsOpen}
  41
  42 Stores the maximum number of documents that can be opened before
  43 existing documents are closed. By default, this is 10,000.
  44
  45 \membersection{wxDocManager::m\_docs}
  46
  47 \member{wxList}{m\_docs}
  48
  49 A list of all documents.
  50
  51 \membersection{wxDocManager::m\_flags}
  52
  53 \member{long}{m\_flags}
  54
  55 Stores the flags passed to the constructor.
  56
  57 \membersection{wxDocManager::m\_templates}
  58
  59 \member{wxList}{mnTemplates}
  60
  61 A list of all document templates.
  62
  63 \membersection{wxDocManager::wxDocManager}
  64
  65 \func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = TRUE}}
  66
  67 Constructor. Create a document manager instance dynamically near the start of your application
  68 before doing any document or view operations.
  69
  70 {\it flags} is currently unused.
  71
  72 If {\it initialize} is TRUE, the \helpref{Initialize}{wxdocmanagerinitialize} function will be called
  73 to create a default history list object. If you derive from wxDocManager, you may wish to call the
  74 base constructor with FALSE, and then call Initialize in your own constructor, to allow
  75 your own Initialize or OnCreateFileHistory functions to be called.
  76
  77 \membersection{wxDocManager::\destruct{wxDocManager}}
  78
  79 \func{void}{\destruct{wxDocManager}}{\void}
  80
  81 Destructor.
  82
  83 \membersection{wxDocManager::ActivateView}
  84
  85 \func{void}{ActivateView}{\param{wxView* }{doc}, \param{bool}{ activate}, \param{bool}{ deleting}}
  86
  87 Sets the current view.
  88
  89 \membersection{wxDocManager::AddDocument}
  90
  91 \func{void}{AddDocument}{\param{wxDocument *}{doc}}
  92
  93 Adds the document to the list of documents.
  94
  95 \membersection{wxDocManager::AddFileToHistory}
  96
  97 \func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
  98
  99 Adds a file to the file history list, if we have a pointer to an appropriate file menu.
 100
 101 \membersection{wxDocManager::AssociateTemplate}
 102
 103 \func{void}{AssociateTemplate}{\param{wxDocTemplate *}{temp}}
 104
 105 Adds the template to the document manager's template list.
 106
 107 \membersection{wxDocManager::CreateDocument}
 108
 109 \func{wxDocument*}{CreateDocument}{\param{const wxString\& }{path}, \param{long}{ flags}}
 110
 111 Creates a new document in a manner determined by the {\it flags} parameter, which can be:
 112
 113 \begin{itemize}\itemsep=0pt
 114 \item wxDOC\_NEW Creates a fresh document.
 115 \item wxDOC\_SILENT Silently loads the given document file.
 116 \end{itemize}
 117
 118 If wxDOC\_NEW is present, a new document will be created and returned, possibly after
 119 asking the user for a template to use if there is more than one document template.
 120 If wxDOC\_SILENT is present, a new document will be created and the given file loaded
 121 into it. If neither of these flags is present, the user will be presented with
 122 a file selector for the file to load, and the template to use will be determined by the
 123 extension (Windows) or by popping up a template choice list (other platforms).
 124
 125 If the maximum number of documents has been reached, this function
 126 will delete the oldest currently loaded document before creating a new one.
 127
 128 \membersection{wxDocManager::CreateView}
 129
 130 \func{wxView*}{CreateView}{\param{wxDocument*}{doc}, \param{long}{ flags}}
 131
 132 Creates a new view for the given document. If more than one view is allowed for the
 133 document (by virtue of multiple templates mentioning the same document type), a choice
 134 of view is presented to the user.
 135
 136 \membersection{wxDocManager::DisassociateTemplate}
 137
 138 \func{void}{DisassociateTemplate}{\param{wxDocTemplate *}{temp}}
 139
 140 Removes the template from the list of templates.
 141
 142 \membersection{wxDocManager::FileHistoryAddFilesToMenu}\label{wxdocmanagerfilehistoryaddfilestomenu}
 143
 144 \func{void}{FileHistoryAddFilesToMenu}{\void}
 145
 146 Appends the files in the history list, to all menus managed by the file history object.
 147
 148 \func{void}{FileHistoryAddFilesToMenu}{\param{wxMenu*}{ menu}}
 149
 150 Appends the files in the history list, to the given menu only.
 151
 152 \membersection{wxDocManager::FileHistoryLoad}\label{wxdocmanagerfilehistoryload}
 153
 154 \func{void}{FileHistoryLoad}{\param{wxConfigBase\& }{config}}
 155
 156 Loads the file history from a config object.
 157
 158 \wxheading{See also}
 159
 160 \helpref{wxConfig}{wxconfigbase}
 161
 162 \membersection{wxDocManager::FileHistoryRemoveMenu}\label{wxdocmanagerfilehistoryremovemenu}
 163
 164 \func{void}{FileHistoryRemoveMenu}{\param{wxMenu*}{ menu}}
 165
 166 Removes the given menu from the list of menus managed by the file history object.
 167
 168 \membersection{wxDocManager::FileHistorySave}\label{wxdocmanagerfilehistorysave}
 169
 170 \func{void}{FileHistorySave}{\param{wxConfigBase\& }{resourceFile}}
 171
 172 Saves the file history into a config object. This must be called
 173 explicitly by the application.
 174
 175 \wxheading{See also}
 176
 177 \helpref{wxConfig}{wxconfigbase}
 178
 179 \membersection{wxDocManager::FileHistoryUseMenu}\label{wxdocmanagerfilehistoryusemenu}
 180
 181 \func{void}{FileHistoryUseMenu}{\param{wxMenu*}{ menu}}
 182
 183 Use this menu for appending recently-visited document filenames, for convenient
 184 access. Calling this function with a valid menu pointer enables the history
 185 list functionality.
 186
 187 Note that you can add multiple menus using this function, to be managed by the
 188 file history object.
 189
 190 \membersection{wxDocManager::FindTemplateForPath}
 191
 192 \func{wxDocTemplate *}{FindTemplateForPath}{\param{const wxString\& }{path}}
 193
 194 Given a path, try to find template that matches the extension. This is only
 195 an approximate method of finding a template for creating a document.
 196
 197 \membersection{wxDocManager::GetCurrentDocument}
 198
 199 \func{wxDocument *}{GetCurrentDocument}{\void}
 200
 201 Returns the document associated with the currently active view (if any).
 202
 203 \membersection{wxDocManager::GetCurrentView}
 204
 205 \func{wxView *}{GetCurrentView}{\void}
 206
 207 Returns the currently active view
 208
 209 \membersection{wxDocManager::GetDocuments}
 210
 211 \func{wxList\&}{GetDocuments}{\void}
 212
 213 Returns a reference to the list of documents.
 214
 215 \membersection{wxDocManager::GetFileHistory}
 216
 217 \func{wxFileHistory *}{GetFileHistory}{\void}
 218
 219 Returns a pointer to file history.
 220
 221 \membersection{wxDocManager::GetMaxDocsOpen}
 222
 223 \func{int}{GetMaxDocsOpen}{\void}
 224
 225 Returns the number of documents that can be open simultaneously.
 226
 227 \membersection{wxDocManager::GetNoHistoryFiles}
 228
 229 \func{int}{GetNoHistoryFiles}{\void}
 230
 231 Returns the number of files currently stored in the file history.
 232
 233 \membersection{wxDocManager::Initialize}\label{wxdocmanagerinitialize}
 234
 235 \func{bool}{Initialize}{\void}
 236
 237 Initializes data; currently just calls OnCreateFileHistory. Some data cannot
 238 always be initialized in the constructor because the programmer must be given
 239 the opportunity to override functionality. If OnCreateFileHistory was called
 240 from the constructor, an overridden virtual OnCreateFileHistory would not be
 241 called due to C++'s `interesting' constructor semantics. In fact Initialize
 242 \rtfsp{\it is} called from the wxDocManager constructor, but this can be
 243 vetoed by passing FALSE to the second argument, allowing the derived class's
 244 constructor to call Initialize, possibly calling a different OnCreateFileHistory
 245 from the default.
 246
 247 The bottom line: if you're not deriving from Initialize, forget it and
 248 construct wxDocManager with no arguments.
 249
 250 \membersection{wxDocManager::MakeDefaultName}
 251
 252 \func{bool}{MakeDefaultName}{\param{const wxString\& }{buf}}
 253
 254 Copies a suitable default name into {\it buf}. This is implemented by
 255 appending an integer counter to the string {\bf unnamed} and incrementing
 256 the counter.
 257
 258 \membersection{wxDocManager::OnCreateFileHistory}
 259
 260 \func{wxFileHistory *}{OnCreateFileHistory}{\void}
 261
 262 A hook to allow a derived class to create a different type of file history. Called
 263 from \helpref{Initialize}{wxdocmanagerinitialize}.
 264
 265 \membersection{wxDocManager::OnFileClose}
 266
 267 \func{void}{OnFileClose}{\void}
 268
 269 Closes and deletes the currently active document.
 270
 271 \membersection{wxDocManager::OnFileNew}
 272
 273 \func{void}{OnFileNew}{\void}
 274
 275 Creates a document from a list of templates (if more than one template).
 276
 277 \membersection{wxDocManager::OnFileOpen}
 278
 279 \func{void}{OnFileOpen}{\void}
 280
 281 Creates a new document and reads in the selected file.
 282
 283 \membersection{wxDocManager::OnFileSave}
 284
 285 \func{void}{OnFileSave}{\void}
 286
 287 Saves the current document by calling wxDocument::Save for the current document.
 288
 289 \membersection{wxDocManager::OnFileSaveAs}
 290
 291 \func{void}{OnFileSaveAs}{\void}
 292
 293 Calls wxDocument::SaveAs for the current document.
 294
 295 \membersection{wxDocManager::OnMenuCommand}
 296
 297 \func{void}{OnMenuCommand}{\param{int}{ cmd}}
 298
 299 Processes menu commands routed from child or parent frames. This deals
 300 with the following predefined menu item identifiers:
 301
 302 \begin{itemize}\itemsep=0pt
 303 \item wxID\_OPEN Creates a new document and opens a file into it.
 304 \item wxID\_CLOSE Closes the current document.
 305 \item wxID\_NEW Creates a new document.
 306 \item wxID\_SAVE Saves the document.
 307 \item wxID\_SAVE\_AS Saves the document into a specified filename.
 308 \end{itemize}
 309
 310 Unrecognized commands are routed to the currently active wxView's OnMenuCommand.
 311
 312 \membersection{wxDocManager::RemoveDocument}
 313
 314 \func{void}{RemoveDocument}{\param{wxDocument *}{doc}}
 315
 316 Removes the document from the list of documents.
 317
 318 \membersection{wxDocManager::SelectDocumentPath}
 319
 320 \func{wxDocTemplate *}{SelectDocumentPath}{\param{wxDocTemplate **}{templates},
 321  \param{int}{ noTemplates}, \param{const wxString\& }{path}, \param{const wxString\& }{bufSize},
 322  \param{long}{ flags}, \param{bool}{ save}}
 323
 324 Under Windows, pops up a file selector with a list of filters corresponding to document templates.
 325 The wxDocTemplate corresponding to the selected file's extension is returned.
 326
 327 On other platforms, if there is more than one document template a choice list is popped up,
 328 followed by a file selector.
 329
 330 This function is used in wxDocManager::CreateDocument.
 331
 332 \membersection{wxDocManager::SelectDocumentType}
 333
 334 \func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates},
 335  \param{int}{ noTemplates}}
 336
 337 Returns a document template by asking the user (if there is more than one template).
 338 This function is used in wxDocManager::CreateDocument.
 339
 340 \membersection{wxDocManager::SelectViewType}
 341
 342 \func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates},
 343  \param{int}{ noTemplates}}
 344
 345 Returns a document template by asking the user (if there is more than one template),
 346 displaying a list of valid views. This function is used in wxDocManager::CreateView.
 347 The dialog normally won't appear because the array of templates only contains
 348 those relevant to the document in question, and often there will only be one such.
 349
 350 \membersection{wxDocManager::SetMaxDocsOpen}
 351
 352 \func{void}{SetMaxDocsOpen}{\param{int}{ n}}
 353
 354 Sets the maximum number of documents that can be open at a time. By default, this
 355 is 10,000. If you set it to 1, existing documents will be saved and deleted
 356 when the user tries to open or create a new one (similar to the behaviour
 357 of Windows Write, for example). Allowing multiple documents gives behaviour
 358 more akin to MS Word and other Multiple Document Interface applications.
 359
 360
 361