projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxFileHistory}}\label{wxfilehistory} |
| 2 | ||
| 3 | The wxFileHistory encapsulates a user interface convenience, the | |
| 4 | list of most recently visited files as shown on a menu (usually the File menu). | |
| 5 | ||
| 7f555861 JS |
6 | wxFileHistory can manage one or more file menus. More than one menu may be required |
| 7 | in an MDI application, where the file history should appear on each MDI child menu | |
| 8 | as well as the MDI parent frame. | |
| 9 | ||
| a660d684 KB |
10 | \wxheading{Derived from} |
| 11 | ||
| 12 | \helpref{wxObject}{wxobject} | |
| 13 | ||
| 14 | \wxheading{See also} | |
| 15 | ||
| 7f555861 | 16 | \helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager} |
| a660d684 KB |
17 | |
| 18 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 19 | ||
| 20 | \membersection{wxFileHistory::m\_fileHistory} | |
| 21 | ||
| 22 | \member{char**}{m\_fileHistory} | |
| 23 | ||
| 24 | A character array of strings corresponding to the most recently opened | |
| 25 | files. | |
| 26 | ||
| 27 | \membersection{wxFileHistory::m\_fileHistoryN} | |
| 28 | ||
| 29 | \member{int}{m\_fileHistoryN} | |
| 30 | ||
| 31 | The number of files stored in the history array. | |
| 32 | ||
| 33 | \membersection{wxFileHistory::m\_fileMaxFiles} | |
| 34 | ||
| 35 | \member{int}{m\_fileMaxFiles} | |
| 36 | ||
| 37 | The maximum number of files to be stored and displayed on the menu. | |
| 38 | ||
| 39 | \membersection{wxFileHistory::m\_fileMenu} | |
| 40 | ||
| 41 | \member{wxMenu*}{m\_fileMenu} | |
| 42 | ||
| 43 | The file menu used to display the file history list (if enabled). | |
| 44 | ||
| 45 | \membersection{wxFileHistory::wxFileHistory} | |
| 46 | ||
| 47 | \func{}{wxFileHistory}{\param{int}{ maxFiles = 9}} | |
| 48 | ||
| 49 | Constructor. Pass the maximum number of files that should be stored and displayed. | |
| 50 | ||
| 51 | \membersection{wxFileHistory::\destruct{wxFileHistory}} | |
| 52 | ||
| 53 | \func{}{\destruct{wxFileHistory}}{\void} | |
| 54 | ||
| 55 | Destructor. | |
| 56 | ||
| 57 | \membersection{wxFileHistory::AddFileToHistory} | |
| 58 | ||
| 59 | \func{void}{AddFileToHistory}{\param{const wxString\& }{filename}} | |
| 60 | ||
| 61 | Adds a file to the file history list, if the object has a pointer to an appropriate file menu. | |
| 62 | ||
| 7f555861 | 63 | \membersection{wxFileHistory::AddFilesToMenu}\label{wxfilehistoryaddfilestomenu} |
| a660d684 | 64 | |
| 7f555861 | 65 | \func{void}{AddFilesToMenu}{\void} |
| a660d684 | 66 | |
| 7f555861 | 67 | Appends the files in the history list, to all menus managed by the file history object. |
| a660d684 | 68 | |
| 7f555861 | 69 | \func{void}{AddFilesToMenu}{\param{wxMenu*}{ menu}} |
| a660d684 | 70 | |
| 7f555861 | 71 | Appends the files in the history list, to the given menu only. |
| a660d684 | 72 | |
| 7f555861 | 73 | \membersection{wxFileHistory::GetHistoryFile}\label{wxfilehistorygethistoryfile} |
| a660d684 | 74 | |
| 7f555861 | 75 | \constfunc{wxString}{GetHistoryFile}{\param{int}{ index}} |
| a660d684 | 76 | |
| 7f555861 | 77 | Returns the file at this index (zero-based). |
| a660d684 KB |
78 | |
| 79 | \membersection{wxFileHistory::GetMaxFiles} | |
| 80 | ||
| 7f555861 | 81 | \constfunc{int}{GetMaxFiles}{\void} |
| a660d684 KB |
82 | |
| 83 | Returns the maximum number of files that can be stored. | |
| 84 | ||
| 85 | \membersection{wxFileHistory::GetNoHistoryFiles} | |
| 86 | ||
| 7f555861 | 87 | \constfunc{int}{GetNoHistoryFiles}{\void} |
| a660d684 KB |
88 | |
| 89 | Returns the number of files currently stored in the file history. | |
| 90 | ||
| 7f555861 JS |
91 | \membersection{wxFileHistory::Load} |
| 92 | ||
| 93 | \func{void}{Load}{\param{wxConfigBase\& }{config}} | |
| 94 | ||
| 95 | Loads the file history from the given config object. This function should be called explicitly by the application. | |
| 96 | ||
| 97 | \wxheading{See also} | |
| 98 | ||
| 99 | \helpref{wxConfig}{wxconfigbase} | |
| 100 | ||
| 101 | \membersection{wxFileHistory::RemoveMenu} | |
| 102 | ||
| 103 | \func{void}{RemoveMenu}{\param{wxMenu* }{menu}} | |
| 104 | ||
| 105 | Removes this menu from the list of those managed by this object. | |
| 106 | ||
| 107 | \membersection{wxFileHistory::Save} | |
| 108 | ||
| 109 | \func{void}{Save}{\param{wxConfigBase\& }{config}} | |
| 110 | ||
| 111 | Saves the file history into the given config object. This must be called | |
| 112 | explicitly by the application. | |
| 113 | ||
| 114 | \wxheading{See also} | |
| 115 | ||
| 116 | \helpref{wxConfig}{wxconfigbase} | |
| 117 | ||
| 118 | \membersection{wxFileHistory::UseMenu} | |
| 119 | ||
| 120 | \func{void}{UseMenu}{\param{wxMenu* }{menu}} | |
| 121 | ||
| 122 | Adds this menu to the list of those managed by this object. | |
| 123 | ||
| a660d684 | 124 |