The FileHistory encapsulates a user interface convenience, the list of most recently visited files as shown on a menu (usually the File menu).
FileHistory 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.
FileHistory overview, DocManager
char*m_fileHistory
A character array of strings corresponding to the most recently opened files.
Integerm_fileHistoryN
The number of files stored in the history array.
Integerm_fileMaxFiles
The maximum number of files to be stored and displayed on the menu.
Menum_fileMenu
The file menu used to display the file history list (if enabled).
FileHistory.new(Integer maxFiles = 9, Integer idBase = ID_FILE1)Constructor. Pass the maximum number of files that should be stored and displayed.
idBase defaults to ID_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 FileHistory in your application.
destructor()Destructor.
add_file_to_history(String filename)Adds a file to the file history list, if the object has a pointer to an appropriate file menu.
add_files_to_menu()Appends the files in the history list, to all menus managed by the file history object.
add_files_to_menu(Menu menu)Appends the files in the history list, to the given menu only.
String get_history_file(Integer index)Returns the file at this index (zero-based).
Integer get_max_files()Returns the maximum number of files that can be stored.
Integer get_count()Returns the number of files currently stored in the file history.
load(ConfigBase config)Loads the file history from the given config object. This function should be called explicitly by the application.
remove_file_from_history(Integer i)Removes the specified file from the history.
remove_menu(Menu menu)Removes this menu from the list of those managed by this object.
save(ConfigBase config)Saves the file history into the given config object. This must be called explicitly by the application.
use_menu(Menu menu)Adds this menu to the list of those menus that are managed by this file history object. Also see add_files_to_menu()() for initializing the menu with filenames that are already in the history when this function is called, as this is not done automatically.
[This page automatically generated from the Textile source at Fri Oct 31 16:06:41 +0000 2008]