docs/latex/wx/filehist.tex

   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
   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
  10 \wxheading{Derived from}
  11
  12 \helpref{wxObject}{wxobject}
  13
  14 \wxheading{Include files}
  15
  16 <wx/docview.h>
  17
  18 \wxheading{Library}
  19
  20 \helpref{wxCore}{librarieslist}
  21
  22 \wxheading{See also}
  23
  24 \helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}
  25
  26 \latexignore{\rtfignore{\wxheading{Members}}}
  27
  28
  29 \membersection{wxFileHistory::m\_fileHistory}\label{wxfilehistorymfilehistory}
  30
  31 \member{char**}{m\_fileHistory}
  32
  33 A character array of strings corresponding to the most recently opened
  34 files.
  35
  36
  37 \membersection{wxFileHistory::m\_fileHistoryN}\label{wxfilehistorymfilehistoryn}
  38
  39 \member{size\_t}{m\_fileHistoryN}
  40
  41 The number of files stored in the history array.
  42
  43
  44 \membersection{wxFileHistory::m\_fileMaxFiles}\label{wxfilehistorymfilemaxfiles}
  45
  46 \member{size\_t}{m\_fileMaxFiles}
  47
  48 The maximum number of files to be stored and displayed on the menu.
  49
  50
  51 \membersection{wxFileHistory::m\_fileMenu}\label{wxfilehistorymfilemenu}
  52
  53 \member{wxMenu*}{m\_fileMenu}
  54
  55 The file menu used to display the file history list (if enabled).
  56
  57
  58 \membersection{wxFileHistory::wxFileHistory}\label{wxfilehistoryctor}
  59
  60 \func{}{wxFileHistory}{\param{size\_t}{ maxFiles = 9}, \param{wxWindowID}{ idBase = wxID\_FILE1}}
  61
  62 Constructor. Pass the maximum number of files that should be stored and
  63 displayed.
  64
  65 {\it idBase} defaults to wxID\_FILE1 and represents the id given to the first
  66 history menu item.  Since menu items can't share the same ID you should change
  67 idBase (To one of your own defined IDs) when using more than one wxFileHistory
  68 in your application.
  69
  70
  71 \membersection{wxFileHistory::\destruct{wxFileHistory}}\label{wxfilehistorydtor}
  72
  73 \func{}{\destruct{wxFileHistory}}{\void}
  74
  75 Destructor.
  76
  77
  78 \membersection{wxFileHistory::AddFileToHistory}\label{wxfilehistoryaddfiletohistory}
  79
  80 \func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
  81
  82 Adds a file to the file history list, if the object has a pointer to an appropriate file menu.
  83
  84
  85 \membersection{wxFileHistory::AddFilesToMenu}\label{wxfilehistoryaddfilestomenu}
  86
  87 \func{void}{AddFilesToMenu}{\void}\label{wxfilehistoryaddfilestomenu}
  88
  89 Appends the files in the history list, to all menus managed by the file history object.
  90
  91 \func{void}{AddFilesToMenu}{\param{wxMenu*}{ menu}}
  92
  93 Appends the files in the history list, to the given menu only.
  94
  95
  96 \membersection{wxFileHistory::GetBaseId}\label{wxfilehistorygetbaseid}
  97
  98 \constfunc{wxWindowID}{GetBaseId}{\void}
  99
 100 Returns the base identifier for the range used for appending items.
 101
 102
 103 \membersection{wxFileHistory::GetCount}\label{wxfilehistorygetcount}
 104
 105 \constfunc{size\_t}{GetCount}{\void}
 106
 107 Returns the number of files currently stored in the file history.
 108
 109
 110 \membersection{wxFileHistory::GetHistoryFile}\label{wxfilehistorygethistoryfile}
 111
 112 \constfunc{wxString}{GetHistoryFile}{\param{size\_t}{ index}}
 113
 114 Returns the file at this index (zero-based).
 115
 116
 117 \membersection{wxFileHistory::GetMaxFiles}\label{wxfilehistorygetmaxfiles}
 118
 119 \constfunc{int}{GetMaxFiles}{\void}
 120
 121 Returns the maximum number of files that can be stored.
 122
 123
 124 \membersection{wxFileHistory::GetMenus}\label{wxfilehistorygetmenus}
 125
 126 \constfunc{const wxList\&}{GetMenus}{\void}
 127
 128 Returns the list of menus that are managed by this file history object.
 129
 130 \wxheading{See also}
 131
 132 \helpref{wxFileHistory::UseMenu}{wxfilehistoryusemenu}
 133
 134
 135 \membersection{wxFileHistory::Load}\label{wxfilehistoryload}
 136
 137 \func{void}{Load}{\param{wxConfigBase\& }{config}}
 138
 139 Loads the file history from the given config object. This function should be called explicitly by the application.
 140
 141 \wxheading{See also}
 142
 143 \helpref{wxConfig}{wxconfigbase}
 144
 145
 146 \membersection{wxFileHistory::RemoveFileFromHistory}\label{wxfilehistoryfromfilefromhistory}
 147
 148 \func{void}{RemoveFileFromHistory}{\param{size\_t }{i}}
 149
 150 Removes the specified file from the history.
 151
 152 \membersection{wxFileHistory::RemoveMenu}\label{wxfilehistoryremovemenu}
 153
 154 \func{void}{RemoveMenu}{\param{wxMenu* }{menu}}
 155
 156 Removes this menu from the list of those managed by this object.
 157
 158
 159 \membersection{wxFileHistory::Save}\label{wxfilehistorysave}
 160
 161 \func{void}{Save}{\param{wxConfigBase\& }{config}}
 162
 163 Saves the file history into the given config object. This must be called
 164 explicitly by the application.
 165
 166 \wxheading{See also}
 167
 168 \helpref{wxConfig}{wxconfigbase}
 169
 170
 171 \membersection{wxFileHistory::SetBaseId}\label{wxfilehistorysetbaseid}
 172
 173 \func{void}{SetBaseId}{\param{wxWindowID}{ baseId}}
 174
 175 Sets the base identifier for the range used for appending items.
 176
 177
 178 \membersection{wxFileHistory::UseMenu}\label{wxfilehistoryusemenu}
 179
 180 \func{void}{UseMenu}{\param{wxMenu* }{menu}}
 181
 182 Adds this menu to the list of those menus that are managed by this file history object.
 183 Also see \helpref{AddFilesToMenu()}{wxfilehistoryaddfilestomenu} for
 184 initializing the menu with filenames that are already in the history when this
 185 function is called, as this is not done automatically.
 186