wxDocManager::GetTemplates was missing (#1149847)
[wxWidgets.git] / docs / latex / wx / docmanag.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: docmanag.tex
3 %% Purpose: wxDocManager documentation
4 %% Author: wxWidgets Team
5 %% Modified by:
6 %% Created:
7 %% RCS-ID: $Id$
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \section{\class{wxDocManager}}\label{wxdocmanager}
13
14 The wxDocManager class is part of the document/view framework supported by wxWidgets,
15 and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument}\rtfsp
16 and \helpref{wxDocTemplate}{wxdoctemplate} classes.
17
18 \wxheading{Derived from}
19
20 \helpref{wxEvtHandler}{wxevthandler}\\
21 \helpref{wxObject}{wxobject}
22
23 \wxheading{Include files}
24
25 <wx/docview.h>
26
27 \wxheading{See also}
28
29 \helpref{wxDocManager overview}{wxdocmanageroverview}, \helpref{wxDocument}{wxdocument},\rtfsp
30 \helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate}, \helpref{wxFileHistory}{wxfilehistory}
31
32 \latexignore{\rtfignore{\wxheading{Members}}}
33
34
35 \membersection{wxDocManager::m\_currentView}\label{wxdocmanagermcreateview}
36
37 \member{wxView*}{m\_currentView}
38
39 The currently active view.
40
41
42 \membersection{wxDocManager::m\_defaultDocumentNameCounter}\label{wxdocmanagermdefaultdocumentnamecounter}
43
44 \member{int}{m\_defaultDocumentNameCounter}
45
46 Stores the integer to be used for the next default document name.
47
48
49 \membersection{wxDocManager::m\_fileHistory}\label{wxdocmanagermfilehistory}
50
51 \member{wxFileHistory*}{m\_fileHistory}
52
53 A pointer to an instance of \helpref{wxFileHistory}{wxfilehistory},
54 which manages the history of recently-visited files on the File menu.
55
56
57 \membersection{wxDocManager::m\_maxDocsOpen}\label{wxdocmanagermmaxdocsopen}
58
59 \member{int}{m\_maxDocsOpen}
60
61 Stores the maximum number of documents that can be opened before
62 existing documents are closed. By default, this is 10,000.
63
64
65 \membersection{wxDocManager::m\_docs}\label{wxdocmanagermdocs}
66
67 \member{wxList}{m\_docs}
68
69 A list of all documents.
70
71
72 \membersection{wxDocManager::m\_flags}\label{wxdocmanagermflags}
73
74 \member{long}{m\_flags}
75
76 Stores the flags passed to the constructor.
77
78
79 \membersection{wxDocManager::m\_lastDirectory}\label{wxdocmanagermlastdirectory}
80
81 The directory last selected by the user when opening a file.
82
83 \member{wxFileHistory*}{m\_fileHistory}
84
85
86 \membersection{wxDocManager::m\_templates}\label{wxdocmanagermtemplates}
87
88 \member{wxList}{mnTemplates}
89
90 A list of all document templates.
91
92
93 \membersection{wxDocManager::wxDocManager}\label{wxdocmanagerctor}
94
95 \func{}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}}
96
97 Constructor. Create a document manager instance dynamically near the start of your application
98 before doing any document or view operations.
99
100 {\it flags} is currently unused.
101
102 If {\it initialize} is true, the \helpref{Initialize}{wxdocmanagerinitialize} function will be called
103 to create a default history list object. If you derive from wxDocManager, you may wish to call the
104 base constructor with false, and then call Initialize in your own constructor, to allow
105 your own Initialize or OnCreateFileHistory functions to be called.
106
107
108 \membersection{wxDocManager::\destruct{wxDocManager}}\label{wxdocmanagerdtor}
109
110 \func{void}{\destruct{wxDocManager}}{\void}
111
112 Destructor.
113
114
115 \membersection{wxDocManager::ActivateView}\label{wxdocmanageractivateview}
116
117 \func{void}{ActivateView}{\param{wxView* }{doc}, \param{bool}{ activate = true}}
118
119 Sets the current view.
120
121
122 \membersection{wxDocManager::AddDocument}\label{wxdocmanageradddocument}
123
124 \func{void}{AddDocument}{\param{wxDocument *}{doc}}
125
126 Adds the document to the list of documents.
127
128
129 \membersection{wxDocManager::AddFileToHistory}\label{wxdocmanageraddfiletohistory}
130
131 \func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
132
133 Adds a file to the file history list, if we have a pointer to an appropriate file menu.
134
135
136 \membersection{wxDocManager::AssociateTemplate}\label{wxdocmanagerassociatetemplate}
137
138 \func{void}{AssociateTemplate}{\param{wxDocTemplate *}{temp}}
139
140 Adds the template to the document manager's template list.
141
142
143 \membersection{wxDocManager::CloseDocuments}\label{wxdocmanagerclosedocuments}
144
145 \func{bool}{CloseDocuments}{\param{bool }{force = true}}
146
147 Closes all currently opened documents.
148
149
150 \membersection{wxDocManager::CreateDocument}\label{wxdocmanagercreatedocument}
151
152 \func{wxDocument*}{CreateDocument}{\param{const wxString\& }{path}, \param{long}{ flags}}
153
154 Creates a new document in a manner determined by the {\it flags} parameter, which can be:
155
156 \begin{itemize}\itemsep=0pt
157 \item wxDOC\_NEW Creates a fresh document.
158 \item wxDOC\_SILENT Silently loads the given document file.
159 \end{itemize}
160
161 If wxDOC\_NEW is present, a new document will be created and returned, possibly after
162 asking the user for a template to use if there is more than one document template.
163 If wxDOC\_SILENT is present, a new document will be created and the given file loaded
164 into it. If neither of these flags is present, the user will be presented with
165 a file selector for the file to load, and the template to use will be determined by the
166 extension (Windows) or by popping up a template choice list (other platforms).
167
168 If the maximum number of documents has been reached, this function
169 will delete the oldest currently loaded document before creating a new one.
170
171
172 \membersection{wxDocManager::CreateView}\label{wxdocmanagercreateview}
173
174 \func{wxView*}{CreateView}{\param{wxDocument*}{doc}, \param{long}{ flags}}
175
176 Creates a new view for the given document. If more than one view is allowed for the
177 document (by virtue of multiple templates mentioning the same document type), a choice
178 of view is presented to the user.
179
180
181 \membersection{wxDocManager::DisassociateTemplate}\label{wxdocmanagerdisassociatetemplate}
182
183 \func{void}{DisassociateTemplate}{\param{wxDocTemplate *}{temp}}
184
185 Removes the template from the list of templates.
186
187
188 \membersection{wxDocManager::FileHistoryAddFilesToMenu}\label{wxdocmanagerfilehistoryaddfilestomenu}
189
190 \func{void}{FileHistoryAddFilesToMenu}{\void}
191
192 Appends the files in the history list, to all menus managed by the file history object.
193
194 \func{void}{FileHistoryAddFilesToMenu}{\param{wxMenu*}{ menu}}
195
196 Appends the files in the history list, to the given menu only.
197
198
199 \membersection{wxDocManager::FileHistoryLoad}\label{wxdocmanagerfilehistoryload}
200
201 \func{void}{FileHistoryLoad}{\param{wxConfigBase\& }{config}}
202
203 Loads the file history from a config object.
204
205 \wxheading{See also}
206
207 \helpref{wxConfig}{wxconfigbase}
208
209
210 \membersection{wxDocManager::FileHistoryRemoveMenu}\label{wxdocmanagerfilehistoryremovemenu}
211
212 \func{void}{FileHistoryRemoveMenu}{\param{wxMenu*}{ menu}}
213
214 Removes the given menu from the list of menus managed by the file history object.
215
216
217 \membersection{wxDocManager::FileHistorySave}\label{wxdocmanagerfilehistorysave}
218
219 \func{void}{FileHistorySave}{\param{wxConfigBase\& }{resourceFile}}
220
221 Saves the file history into a config object. This must be called
222 explicitly by the application.
223
224 \wxheading{See also}
225
226 \helpref{wxConfig}{wxconfigbase}
227
228
229 \membersection{wxDocManager::FileHistoryUseMenu}\label{wxdocmanagerfilehistoryusemenu}
230
231 \func{void}{FileHistoryUseMenu}{\param{wxMenu*}{ menu}}
232
233 Use this menu for appending recently-visited document filenames, for convenient
234 access. Calling this function with a valid menu pointer enables the history
235 list functionality.
236
237 Note that you can add multiple menus using this function, to be managed by the
238 file history object.
239
240
241 \membersection{wxDocManager::FindTemplateForPath}\label{wxdocmanagerfindtemplateforpath}
242
243 \func{wxDocTemplate *}{FindTemplateForPath}{\param{const wxString\& }{path}}
244
245 Given a path, try to find template that matches the extension. This is only
246 an approximate method of finding a template for creating a document.
247
248
249 \membersection{wxDocManager::GetCurrentDocument}\label{wxdocmanagergetcurrentdocument}
250
251 \func{wxDocument *}{GetCurrentDocument}{\void}
252
253 Returns the document associated with the currently active view (if any).
254
255
256 \membersection{wxDocManager::GetCurrentView}\label{wxdocmanagergetcurrentview}
257
258 \func{wxView *}{GetCurrentView}{\void}
259
260 Returns the currently active view
261
262
263 \membersection{wxDocManager::GetDocuments}\label{wxdocmanagergetdocuments}
264
265 \func{wxList\&}{GetDocuments}{\void}
266
267 Returns a reference to the list of documents.
268
269
270 \membersection{wxDocManager::GetFileHistory}\label{wxdocmanagergetfilehistory}
271
272 \func{wxFileHistory *}{GetFileHistory}{\void}
273
274 Returns a pointer to file history.
275
276
277 \membersection{wxDocManager::GetLastDirectory}\label{wxdocmanagergetlastdirectory}
278
279 \constfunc{wxString}{GetLastDirectory}{\void}
280
281 Returns the directory last selected by the user when opening a file. Initially empty.
282
283
284 \membersection{wxDocManager::GetMaxDocsOpen}\label{wxdocmanagergetmaxdocsopen}
285
286 \func{int}{GetMaxDocsOpen}{\void}
287
288 Returns the number of documents that can be open simultaneously.
289
290
291 \membersection{wxDocManager::GetHistoryFilesCount}\label{wxdocmanagergethistoryfilescount}
292
293 \func{size\_t}{GetHistoryFilesCount}{\void}
294
295 Returns the number of files currently stored in the file history.
296
297
298 \membersection{wxDocManager::GetTemplates}\label{wxdocmanagergettemplates}
299
300 \func{wxList\&}{GetTemplates}{\void}
301
302 Returns a reference to the list of associated templates.
303
304
305 \membersection{wxDocManager::Initialize}\label{wxdocmanagerinitialize}
306
307 \func{bool}{Initialize}{\void}
308
309 Initializes data; currently just calls OnCreateFileHistory. Some data cannot
310 always be initialized in the constructor because the programmer must be given
311 the opportunity to override functionality. If OnCreateFileHistory was called
312 from the constructor, an overridden virtual OnCreateFileHistory would not be
313 called due to C++'s `interesting' constructor semantics. In fact Initialize
314 \rtfsp{\it is} called from the wxDocManager constructor, but this can be
315 vetoed by passing false to the second argument, allowing the derived class's
316 constructor to call Initialize, possibly calling a different OnCreateFileHistory
317 from the default.
318
319 The bottom line: if you're not deriving from Initialize, forget it and
320 construct wxDocManager with no arguments.
321
322
323 \membersection{wxDocManager::MakeDefaultName}\label{wxdocmanagermakedefaultname}
324
325 \func{bool}{MakeDefaultName}{\param{const wxString\& }{buf}}
326
327 Copies a suitable default name into {\it buf}. This is implemented by
328 appending an integer counter to the string {\bf unnamed} and incrementing
329 the counter.
330
331 \perlnote{In wxPerl this function must return the modified name rather
332 than just modifying the argument.}
333
334
335 \membersection{wxDocManager::OnCreateFileHistory}\label{wxdocmanageroncreatefilehistory}
336
337 \func{wxFileHistory *}{OnCreateFileHistory}{\void}
338
339 A hook to allow a derived class to create a different type of file history. Called
340 from \helpref{Initialize}{wxdocmanagerinitialize}.
341
342
343 \membersection{wxDocManager::OnFileClose}\label{wxdocmanageronfileclose}
344
345 \func{void}{OnFileClose}{\param{wxCommandEvent\& }{event}}
346
347 Closes and deletes the currently active document.
348
349
350 \membersection{wxDocManager::OnFileCloseAll}\label{wxdocmanageronfilecloseall}
351
352 \func{void}{OnFileCloseAll}{\param{wxCommandEvent\& }{event}}
353
354 Closes and deletes all the currently opened documents.
355
356
357 \membersection{wxDocManager::OnFileNew}\label{wxdocmanageronfilenew}
358
359 \func{void}{OnFileNew}{\param{wxCommandEvent\& }{event}}
360
361 Creates a document from a list of templates (if more than one template).
362
363
364 \membersection{wxDocManager::OnFileOpen}\label{wxdocmanageronfileopen}
365
366 \func{void}{OnFileOpen}{\param{wxCommandEvent\& }{event}}
367
368 Creates a new document and reads in the selected file.
369
370
371 \membersection{wxDocManager::OnFileRevert}\label{wxdocmanageronfilerevert}
372
373 \func{void}{OnFileRevert}{\param{wxCommandEvent\& }{event}}
374
375 Reverts the current document by calling wxDocument::Revert for the current document.
376
377
378 \membersection{wxDocManager::OnFileSave}\label{wxdocmanageronfilesave}
379
380 \func{void}{OnFileSave}{\param{wxCommandEvent\& }{event}}
381
382 Saves the current document by calling wxDocument::Save for the current document.
383
384
385 \membersection{wxDocManager::OnFileSaveAs}\label{wxdocmanageronfilesaveas}
386
387 \func{void}{OnFileSaveAs}{\param{wxCommandEvent\& }{event}}
388
389 Calls wxDocument::SaveAs for the current document.
390
391
392 \membersection{wxDocManager::RemoveDocument}\label{wxdocmanagerremovedocument}
393
394 \func{void}{RemoveDocument}{\param{wxDocument *}{doc}}
395
396 Removes the document from the list of documents.
397
398
399 \membersection{wxDocManager::SelectDocumentPath}\label{wxdocmanagerselectdocumentpath}
400
401 \func{wxDocTemplate *}{SelectDocumentPath}{\param{wxDocTemplate **}{templates},
402 \param{int}{ noTemplates}, \param{wxString\& }{path},
403 \param{long}{ flags}, \param{bool}{ save}}
404
405 Under Windows, pops up a file selector with a list of filters corresponding to document templates.
406 The wxDocTemplate corresponding to the selected file's extension is returned.
407
408 On other platforms, if there is more than one document template a choice list is popped up,
409 followed by a file selector.
410
411 This function is used in wxDocManager::CreateDocument.
412
413 \perlnote{In wxPerl {\tt templates} is a reference to a list of templates.
414 If you override this method in your document manager it must return
415 two values, eg:\par
416 (doctemplate, path) = My::DocManager->SelectDocumentPath( ... );
417 }
418
419
420 \membersection{wxDocManager::SelectDocumentType}\label{wxdocmanagerselectdocumenttype}
421
422 \func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates},
423 \param{int}{ noTemplates}, \param{bool}{ sort=false}}
424
425 Returns a document template by asking the user (if there is more than one template).
426 This function is used in wxDocManager::CreateDocument.
427
428 \wxheading{Parameters}
429
430 \docparam{templates}{Pointer to an array of templates from which to choose a desired template.}
431 \docparam{noTemplates}{Number of templates being pointed to by the {\it templates} pointer.}
432 \docparam{sort}{If more than one template is passed in in {\it templates},
433 then this parameter indicates whether the list of templates that the user
434 will have to choose from is sorted or not when shown the choice box dialog.
435 Default is false.}
436
437 \perlnote{In wxPerl {\tt templates} is a reference to a list of templates.}
438
439
440 \membersection{wxDocManager::SelectViewType}\label{wxdocmanagerselectviewtype}
441
442 \func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates},
443 \param{int}{ noTemplates}, \param{bool}{ sort=false}}
444
445 Returns a document template by asking the user (if there is more than one template),
446 displaying a list of valid views. This function is used in wxDocManager::CreateView.
447 The dialog normally will not appear because the array of templates only contains
448 those relevant to the document in question, and often there will only be one such.
449
450 \wxheading{Parameters}
451
452 \docparam{templates}{Pointer to an array of templates from which to choose a desired template.}
453 \docparam{noTemplates}{Number of templates being pointed to by the {\it templates} pointer.}
454 \docparam{sort}{If more than one template is passed in in {\it templates},
455 then this parameter indicates whether the list of templates that the user
456 will have to choose from is sorted or not when shown the choice box dialog.
457 Default is false.}
458
459 \perlnote{In wxPerl {\tt templates} is a reference to a list of templates.}
460
461
462 \membersection{wxDocManager::SetLastDirectory}\label{wxdocmanagersetlastdirectory}
463
464 \func{void}{SetLastDirectory}{\param{const wxString\&}{ dir}}
465
466 Sets the directory to be displayed to the user when opening a file. Initially this is empty.
467
468
469 \membersection{wxDocManager::SetMaxDocsOpen}\label{wxdocmanagersetmaxdocsopen}
470
471 \func{void}{SetMaxDocsOpen}{\param{int}{ n}}
472
473 Sets the maximum number of documents that can be open at a time. By default, this
474 is 10,000. If you set it to 1, existing documents will be saved and deleted
475 when the user tries to open or create a new one (similar to the behaviour
476 of Windows Write, for example). Allowing multiple documents gives behaviour
477 more akin to MS Word and other Multiple Document Interface applications.
478