**************
wx.FileHistory
**************

Inheritance diagram for `wx.FileHistory`:

|

.. inheritance-diagram:: 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.


.. seealso:: `wx.DocManager <../docview/wx.DocManager.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `AddFileToHistory <#AddFileToHistory>`_ 
* `AddFilesToMenu <#AddFilesToMenu>`_ 
* `AddFilesToThisMenu <#AddFilesToThisMenu>`_ 
* `GetCount <#GetCount>`_ 
* `GetHistoryFile <#GetHistoryFile>`_ 
* `GetMaxFiles <#GetMaxFiles>`_ 
* `GetNoHistoryFiles <#GetNoHistoryFiles>`_
* `Load <#Load>`_ 
* `RemoveFileFromHistory <#RemoveFileFromHistory>`_ 
* `RemoveMenu <#RemoveMenu>`_ 
* `Save <#Save>`_ 
* `UseMenu <#UseMenu>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Count <#Count>`_ 
* `HistoryFile <#HistoryFile>`_ 
* `MaxFiles <#MaxFiles>`_ 
* `NoHistoryFiles <#NoHistoryFiles>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __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 <wx.FileHistory.html>`_
 

--------

.. method:: AddFileToHistory(filename)

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

   **Parameters:**

   * `filename` (string) 

--------

.. method:: AddFilesToMenu()

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

--------

.. method:: AddFilesToThisMenu(menu)

   |
   
   **Parameters:**

   * `menu` (`wx.Menu <wx.Menu.html>`_)


--------

.. method:: GetCount()

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

   |  

   **Returns:**

   `long` 

--------

.. method:: GetHistoryFile(index)

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

   **Parameters:**

   * `index` (long) 

   |  

   **Returns:**

   `string` 

--------

.. method:: GetMaxFiles()

   Returns the maximum number of files that can be stored.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetNoHistoryFiles()

   Alias for `GetCount <#GetCount>`_.
   
   Returns the number of files currently stored in the file history.

   |  

   **Returns:**

   `long` 

--------

.. method:: Load(config)

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

   **Parameters:**

   * `config` (`wx.ConfigBase <wx.ConfigBase.html>`_) 


.. seealso:: `wx.ConfigBase <wx.ConfigBase.html>`_
  

--------

.. method:: RemoveFileFromHistory(i)

   Removes the specified file from the history.

   **Parameters:**

   * `i` (long) 

--------

.. method:: RemoveMenu(menu)

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

   **Parameters:**

   * `menu` (`wx.Menu <wx.Menu.html>`_) 

--------

.. method:: Save(config)

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

   **Parameters:**

   * `config` (`wx.ConfigBase <wx.ConfigBase.html>`_) 

.. seealso:: `wx.ConfigBase <wx.ConfigBase.html>`_
  

--------

.. method:: UseMenu(menu)

   Adds this menu to the list of those menus that are managed by this file history object. Also see `AddFilesToMenu <#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 <wx.Menu.html>`_) 

.. seealso:: `AddFilesToMenu <#AddFilesToMenu>`_


--------

Properties
^^^^^^^^^^


.. attribute:: Count

   See `GetCount <#GetCount>`_

.. attribute:: HistoryFile

   See `GetHistoryFile <#GetHistoryFile>`_

.. attribute:: MaxFiles

   See `GetMaxFiles <#GetMaxFiles>`_

.. attribute:: NoHistoryFiles

   See `GetNoHistoryFiles <#GetNoHistoryFiles>`_