phoenix_title wx.FileHistory

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

Document/View Framework, DocManager


class_hierarchy Class Hierarchy

Inheritance diagram for class FileHistory:

method_summary Methods Summary

__init__

Constructor.

AddFileToHistory

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

AddFilesToMenu

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

GetBaseId

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

GetCount

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

GetHistoryFile

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

GetMaxFiles

Returns the maximum number of files that can be stored.

GetMenuPathStyle

Get the current style of the menu item labels.

GetMenus

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

Load

Loads the file history from the given config object.

RemoveFileFromHistory

Removes the specified file from the history.

RemoveMenu

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

Save

Saves the file history into the given config object.

SetBaseId

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

SetMenuPathStyle

Set the style of the menu item labels.

UseMenu

Adds this menu to the list of those menus that are managed by this file history object.


property_summary Properties Summary

BaseId

See GetBaseId and SetBaseId

Count

See GetCount

MaxFiles

See GetMaxFiles

MenuPathStyle

See GetMenuPathStyle and SetMenuPathStyle

Menus

See GetMenus


api Class API

class wx.FileHistory(Object)

Possible constructors:

FileHistory(maxFiles=9, idBase=ID_FILE1)

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


Methods

__init__(self, maxFiles=9, idBase=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 (wx.WindowID) –



AddFileToHistory(self, filename)

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

Parameters:

filename (string) –



AddFilesToMenu(self, *args, **kw)

overload Overloaded Implementations:



AddFilesToMenu (self)

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



AddFilesToMenu (self, menu)

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

Parameters:

menu (wx.Menu) –





GetBaseId(self)

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

Return type:

wx.WindowID



GetCount(self)

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

Return type:

int



GetHistoryFile(self, index)

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

Parameters:

index (int) –

Return type:

string



GetMaxFiles(self)

Returns the maximum number of files that can be stored.

Return type:

int



GetMenuPathStyle(self)

Get the current style of the menu item labels.

Initially returns FH_PATH_SHOW_IF_DIFFERENT.

Return type:

wx.FileHistoryMenuPathStyle

New in version 4.1/wxWidgets-3.1.5.

See also

SetMenuPathStyle



GetMenus(self)

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

Return type:

FileHistoryMenuList

See also

UseMenu



Load(self, 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(self, i)

Removes the specified file from the history.

Parameters:

i (int) –



RemoveMenu(self, menu)

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

Parameters:

menu (wx.Menu) –



Save(self, 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



SetBaseId(self, baseId)

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

Parameters:

baseId (wx.WindowID) –



SetMenuPathStyle(self, style)

Set the style of the menu item labels.

By default, the menu item label style is FH_PATH_SHOW_IF_DIFFERENT.

Parameters:

style (FileHistoryMenuPathStyle) –

New in version 4.1/wxWidgets-3.1.5.



UseMenu(self, 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) –


Properties

BaseId

See GetBaseId and SetBaseId



Count

See GetCount



MaxFiles

See GetMaxFiles



MenuPathStyle

See GetMenuPathStyle and SetMenuPathStyle



Menus

See GetMenus