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{See also}
  19
  20 \helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24 \membersection{wxFileHistory::m\_fileHistory}\label{wxfilehistorymfilehistory}
  25
  26 \member{char**}{m\_fileHistory}
  27
  28 A character array of strings corresponding to the most recently opened
  29 files.
  30
  31 \membersection{wxFileHistory::m\_fileHistoryN}\label{wxfilehistorymfilehistoryn}
  32
  33 \member{size\_t}{m\_fileHistoryN}
  34
  35 The number of files stored in the history array.
  36
  37 \membersection{wxFileHistory::m\_fileMaxFiles}\label{wxfilehistorymfilemaxfiles}
  38
  39 \member{size\_t}{m\_fileMaxFiles}
  40
  41 The maximum number of files to be stored and displayed on the menu.
  42
  43 \membersection{wxFileHistory::m\_fileMenu}\label{wxfilehistorymfilemenu}
  44
  45 \member{wxMenu*}{m\_fileMenu}
  46
  47 The file menu used to display the file history list (if enabled).
  48
  49 \membersection{wxFileHistory::wxFileHistory}\label{wxfilehistoryctor}
  50
  51 \func{}{wxFileHistory}{\param{size\_t}{ maxFiles = 9}, \param{wxWindowID}{ idBase = wxID\_FILE1}}
  52
  53 Constructor. Pass the maximum number of files that should be stored and
  54 displayed.
  55
  56 {\it idBase} defaults to wxID\_FILE1 and represents the id given to the first
  57 history menu item.  Since menu items can't share the same ID you should change
  58 idBase (To one of your own defined IDs) when using more than one wxFileHistory
  59 in your application.
  60
  61 \membersection{wxFileHistory::\destruct{wxFileHistory}}\label{wxfilehistorydtor}
  62
  63 \func{}{\destruct{wxFileHistory}}{\void}
  64
  65 Destructor.
  66
  67 \membersection{wxFileHistory::AddFileToHistory}\label{wxfilehistoryaddfiletohistory}
  68
  69 \func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
  70
  71 Adds a file to the file history list, if the object has a pointer to an appropriate file menu.
  72
  73 \membersection{wxFileHistory::AddFilesToMenu}\label{wxfilehistoryaddfilestomenu}
  74
  75 \func{void}{AddFilesToMenu}{\void}
  76
  77 Appends the files in the history list, to all menus managed by the file history object.
  78
  79 \func{void}{AddFilesToMenu}{\param{wxMenu*}{ menu}}
  80
  81 Appends the files in the history list, to the given menu only.
  82
  83 \membersection{wxFileHistory::GetHistoryFile}\label{wxfilehistorygethistoryfile}
  84
  85 \constfunc{wxString}{GetHistoryFile}{\param{size\_t}{ index}}
  86
  87 Returns the file at this index (zero-based).
  88
  89 \membersection{wxFileHistory::GetMaxFiles}\label{wxfilehistorygetmaxfiles}
  90
  91 \constfunc{size\_t}{GetMaxFiles}{\void}
  92
  93 Returns the maximum number of files that can be stored.
  94
  95 \membersection{wxFileHistory::GetNoHistoryFiles}\label{wxfilehistorygetnohistoryfiles}
  96
  97 \constfunc{size\_t}{GetNoHistoryFiles}{\void}
  98
  99 Returns the number of files currently stored in the file history.
 100
 101 \membersection{wxFileHistory::Load}\label{wxfilehistoryload}
 102
 103 \func{void}{Load}{\param{wxConfigBase\& }{config}}
 104
 105 Loads the file history from the given config object. This function should be called explicitly by the application.
 106
 107 \wxheading{See also}
 108
 109 \helpref{wxConfig}{wxconfigbase}
 110
 111 \membersection{wxFileHistory::RemoveMenu}\label{wxfilehistoryremovemenu}
 112
 113 \func{void}{RemoveMenu}{\param{wxMenu* }{menu}}
 114
 115 Removes this menu from the list of those managed by this object.
 116
 117 \membersection{wxFileHistory::Save}\label{wxfilehistorysave}
 118
 119 \func{void}{Save}{\param{wxConfigBase\& }{config}}
 120
 121 Saves the file history into the given config object. This must be called
 122 explicitly by the application.
 123
 124 \wxheading{See also}
 125
 126 \helpref{wxConfig}{wxconfigbase}
 127
 128 \membersection{wxFileHistory::UseMenu}\label{wxfilehistoryusemenu}
 129
 130 \func{void}{UseMenu}{\param{wxMenu* }{menu}}
 131
 132 Adds this menu to the list of those managed by this object.
 133
 134