wx.FileHistory

Inheritance diagram for wx.FileHistory:

Description

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

wx.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.

See also

wx.DocManager

Derived From

• wx.Object

Methods Summary

• __init__
• AddFileToHistory
• AddFilesToMenu
• AddFilesToThisMenu
• GetCount
• GetHistoryFile
• GetMaxFiles
• GetNoHistoryFiles
• Load
• RemoveFileFromHistory
• RemoveMenu
• Save
• UseMenu

Properties Summary

• Count
• HistoryFile
• MaxFiles
• NoHistoryFiles

Class API

Methods

__init__(maxFiles=9, idBase=wx.ID_FILE1)

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

idBase defaults to wx.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 wx.FileHistory in your application

Parameters:

• maxFiles (int)
• idBase (int)

Returns:

wx.FileHistory

---

AddFileToHistory(filename)

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

Parameters:

• filename (string)

---

AddFilesToMenu()

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

---

AddFilesToThisMenu(menu)

Parameters:

• menu (wx.Menu)

---

GetCount()

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

Returns:

long

---

GetHistoryFile(index)

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

Parameters:

• index (long)

Returns:

string

---

GetMaxFiles()

Returns the maximum number of files that can be stored.

Returns:

int

---

GetNoHistoryFiles()

Alias for GetCount.

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

Returns:

long

---

Load(config)

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

Parameters:

• config (wx.ConfigBase)

See also

wx.ConfigBase

---

RemoveFileFromHistory(i)

Removes the specified file from the history.

Parameters:

• i (long)

---

RemoveMenu(menu)

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

Parameters:

• menu (wx.Menu)

---

Save(config)

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

Parameters:

• config (wx.ConfigBase)

See also

wx.ConfigBase

---

UseMenu(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.

Parameters:

• menu (wx.Menu)

See also

AddFilesToMenu

---

Properties

Count

See GetCount

HistoryFile

See GetHistoryFile

MaxFiles

See GetMaxFiles

NoHistoryFiles

See GetNoHistoryFiles