Contents Up Previous Next

wxFileHistory: wxObject

Overview

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

wxFileHistory::fileHistory
wxFileHistory::fileHistoryN
wxFileHistory::fileMaxFiles
wxFileHistory::fileMenu
wxFileHistory::wxFileHistory
wxFileHistory::~wxFileHistory
wxFileHistory::AddFileToHistory
wxFileHistory::FileHistoryLoad
wxFileHistory::FileHistorySave
wxFileHistory::FileHistoryUseMenu
wxFileHistory::GetMaxFiles
wxFileHistory::GetNoHistoryFiles


wxFileHistory::fileHistory

char ** fileHistory

A character array of strings corresponding to the most recently opened files.


wxFileHistory::fileHistoryN

int fileHistoryN

The number of files stored in the history array.


wxFileHistory::fileMaxFiles

int fileMaxFiles

The maximum number of files to be stored and displayed on the menu.


wxFileHistory::fileMenu

wxMenu * fileMenu

The file menu used to display the file history list (if enabled).


wxFileHistory::wxFileHistory

void wxFileHistory(int maxFiles = 9)

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


wxFileHistory::~wxFileHistory

void ~wxFileHistory(void)

Destructor.


wxFileHistory::AddFileToHistory

void AddFileToHistory(char *filename)

Adds a file to the file history list, if the object has a pointer to an appropriate file menu.


wxFileHistory::FileHistoryLoad

void FileHistoryLoad(char *resourceFile, char *sectionName)

Loads the file history from a resource file, using the given section. This must be called explicitly by the application.


wxFileHistory::FileHistorySave

void FileHistorySave(char *resourceFile, char *sectionName)

Saves the file history into a resource file, using the given section. This must be called explicitly by the application.


wxFileHistory::FileHistoryUseMenu

void FileHistoryUseMenu(wxMenu *menu)

Use this menu for appending recently-visited document filenames, for convenient access. Calling this function with a valid menu pointer enables the history list functionality.


wxFileHistory::GetMaxFiles

int GetMaxFiles(void)

Returns the maximum number of files that can be stored.


wxFileHistory::GetNoHistoryFiles

int GetNoHistoryFiles(void)

Returns the number of files currently stored in the file history.