wxFileHistory

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.

Derived from

wxObject

Include files

<wx/docview.h>

See also

wxFileHistory overview, wxDocManager

Members

wxFileHistory::m_fileHistory
wxFileHistory::m_fileHistoryN
wxFileHistory::m_fileMaxFiles
wxFileHistory::m_fileMenu
wxFileHistory::wxFileHistory
wxFileHistory::~wxFileHistory
wxFileHistory::AddFileToHistory
wxFileHistory::AddFilesToMenu
wxFileHistory::GetBaseId
wxFileHistory::GetCount
wxFileHistory::GetHistoryFile
wxFileHistory::GetMaxFiles
wxFileHistory::GetMenus
wxFileHistory::Load
wxFileHistory::RemoveFileFromHistory
wxFileHistory::RemoveMenu
wxFileHistory::Save
wxFileHistory::SetBaseId
wxFileHistory::UseMenu

wxFileHistory::m_fileHistory

char** m_fileHistory

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

wxFileHistory::m_fileHistoryN

size_t m_fileHistoryN

The number of files stored in the history array.

wxFileHistory::m_fileMaxFiles

size_t m_fileMaxFiles

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

wxFileHistory::m_fileMenu

wxMenu* m_fileMenu

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

wxFileHistory::wxFileHistory

wxFileHistory(size_t maxFiles = 9, wxWindowID 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.

wxFileHistory::~wxFileHistory

~wxFileHistory()

Destructor.

wxFileHistory::AddFileToHistory

void AddFileToHistory(const wxString& filename)

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

wxFileHistory::AddFilesToMenu

void AddFilesToMenu()

Appends the files in the history list, to all menus managed by the file history object.

void AddFilesToMenu(wxMenu* menu)

Appends the files in the history list, to the given menu only.

wxFileHistory::GetBaseId

wxWindowID GetBaseId() const

Returns the base identifier for the range used for appending items.

wxFileHistory::GetCount

size_t GetCount() const

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

wxFileHistory::GetHistoryFile

wxString GetHistoryFile(size_t index) const

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

wxFileHistory::GetMaxFiles

int GetMaxFiles() const

Returns the maximum number of files that can be stored.

wxFileHistory::GetMenus

const wxList& GetMenus() const

Returns the list of menus that are managed by this file history object.

See also

wxFileHistory::UseMenu

wxFileHistory::Load

void Load(wxConfigBase& config)

Loads the file history from the given config object. This function should be called explicitly by the application.

See also

wxConfig

wxFileHistory::RemoveFileFromHistory

void RemoveFileFromHistory(size_t i)

Removes the specified file from the history.

wxFileHistory::RemoveMenu

void RemoveMenu(wxMenu* menu)

Removes this menu from the list of those managed by this object.

wxFileHistory::Save

void Save(wxConfigBase& config)

Saves the file history into the given config object. This must be called explicitly by the application.

See also

wxConfig

wxFileHistory::SetBaseId

void SetBaseId(wxWindowID baseId)

Sets the base identifier for the range used for appending items.

wxFileHistory::UseMenu

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.