.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxFileHistory 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxFileHistory \- 
.SH DESCRIPTION

  


   The wxFileHistory encapsulates a user interface convenience, the list of most
   recently visited files as shown on a menu (usually the File menu).
  
  


   wxFileHistory can manage one or more file menus. More than one menu may be
   required in an MDI application, where the file history should appear on each
   MDI child menu as well as the MDI parent frame.
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/docview.h
.SH MEMBERS

  
   
  
   
  
   
  
   
  
.SS  wxFileHistory (size_t maxFiles = 9wxWindowID idBase = wxID_FILE1)

     


      Constructor. Pass the maximum number of files that should be stored and
      displayed.
     
     


      
       idBase
      
      defaults to wxID_FILE1 and represents the id given to the first history
      menu item. Since menu items can't share the same ID you should change
      idBase (To one of your own defined IDs) when using more than one
      wxFileHistory in your application.
     
    
   
  
.SS  ~wxFileHistory ()

     


      Destructor.
     
    
   
  
.SS void AddFileToHistory (const wxString& filename)

     


      Adds a file to the file history list, if the object has a pointer to an
      appropriate file menu.
     
    
   
  
.SS void AddFilesToMenu ()

     


      
     
     


      Appends the files in the history list, to all menus managed by the file
      history object.
     
    
.SS void AddFilesToMenu (wxMenu* menu)

     


      Appends the files in the history list, to the given menu only.
     
    
   
  
.SS wxString GetHistoryFile (size_t index)

     


      Returns the file at this index (zero-based).
     
    
   
  
.SS size_t GetMaxFiles ()

     


      Returns the maximum number of files that can be stored.
     
    
   
  
.SS size_t GetCount ()

     


      Returns the number of files currently stored in the file history.
     
    
   
  
.SS void Load (wxConfigBase& config)

     


      Loads the file history from the given config object. This function should
      be called explicitly by the application.
     
    
   
  
.SS void RemoveFileFromHistory (size_t i)

     


      Removes the specified file from the history.
     
    
   
  
.SS void RemoveMenu (wxMenu* menu)

     


      Removes this menu from the list of those managed by this object.
     
    
   
  
.SS void Save (wxConfigBase& config)

     


      Saves the file history into the given config object. This must be called
      explicitly by the application.
     
    
   
  
.SS void UseMenu (wxMenu* menu)

     


      Adds this menu to the list of those menus that are managed by this file
      history object. Also see
      AddFilesToMenu()
      for initializing the menu with filenames that are already in the history
      when this function is called, as this is not done automatically.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxFileHistory overview
  wxDocManager
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.