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 \wxheading{Derived from}
   7
   8 \helpref{wxObject}{wxobject}
   9
  10 \wxheading{See also}
  11
  12 \overview{wxFileHistory overview}{wxfilehistoryoverview}
  13
  14 \latexignore{\rtfignore{\wxheading{Members}}}
  15
  16 \membersection{wxFileHistory::m\_fileHistory}
  17
  18 \member{char**}{m\_fileHistory}
  19
  20 A character array of strings corresponding to the most recently opened
  21 files.
  22
  23 \membersection{wxFileHistory::m\_fileHistoryN}
  24
  25 \member{int}{m\_fileHistoryN}
  26
  27 The number of files stored in the history array.
  28
  29 \membersection{wxFileHistory::m\_fileMaxFiles}
  30
  31 \member{int}{m\_fileMaxFiles}
  32
  33 The maximum number of files to be stored and displayed on the menu.
  34
  35 \membersection{wxFileHistory::m\_fileMenu}
  36
  37 \member{wxMenu*}{m\_fileMenu}
  38
  39 The file menu used to display the file history list (if enabled).
  40
  41 \membersection{wxFileHistory::wxFileHistory}
  42
  43 \func{}{wxFileHistory}{\param{int}{ maxFiles = 9}}
  44
  45 Constructor. Pass the maximum number of files that should be stored and displayed.
  46
  47 \membersection{wxFileHistory::\destruct{wxFileHistory}}
  48
  49 \func{}{\destruct{wxFileHistory}}{\void}
  50
  51 Destructor.
  52
  53 \membersection{wxFileHistory::AddFileToHistory}
  54
  55 \func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
  56
  57 Adds a file to the file history list, if the object has a pointer to an appropriate file menu.
  58
  59 \membersection{wxFileHistory::FileHistoryLoad}
  60
  61 \func{void}{FileHistoryLoad}{\param{const wxString\& }{resourceFile}, \param{const wxString\& }{sectionName}}
  62
  63 Loads the file history from a resource file, using the given section. This must be called
  64 explicitly by the application.
  65
  66 \membersection{wxFileHistory::FileHistorySave}
  67
  68 \func{void}{FileHistorySave}{\param{const wxString\& }{resourceFile}, \param{const wxString\& }{sectionName}}
  69
  70 Saves the file history into a resource file, using the given section. This must be called
  71 explicitly by the application.
  72
  73 \membersection{wxFileHistory::FileHistoryUseMenu}
  74
  75 \func{void}{FileHistoryUseMenu}{\param{wxMenu* }{menu}}
  76
  77 Use this menu for appending recently-visited document filenames, for convenient
  78 access. Calling this function with a valid menu pointer enables the history
  79 list functionality.
  80
  81 \membersection{wxFileHistory::GetMaxFiles}
  82
  83 \func{int}{GetMaxFiles}{\void}
  84
  85 Returns the maximum number of files that can be stored.
  86
  87 \membersection{wxFileHistory::GetNoHistoryFiles}
  88
  89 \func{int}{GetNoHistoryFiles}{\void}
  90
  91 Returns the number of files currently stored in the file history.
  92
  93