wxRuby Documentation Home

# Wx::FileHistory

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

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.

## Derived from

Object

## See also

FileHistory overview, DocManager

## Methods

- FileHistory#m__file_history
- FileHistory#m__file_history_n
- FileHistory#m__file_max_files
- FileHistory#m__file_menu
- FileHistory.new
- FileHistory#add_file_to_history
- FileHistory#add_files_to_menu
- FileHistory#get_history_file
- FileHistory#get_max_files
- FileHistory#get_count
- FileHistory#load
- FileHistory#remove_file_from_history
- FileHistory#remove_menu
- FileHistory#save
- FileHistory#use_menu

### FileHistory#m__file_history

char**m_fileHistory

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

### FileHistory#m__file_history_n

Integerm_fileHistoryN

The number of files stored in the history array.

### FileHistory#m__file_max_files

Integerm_fileMaxFiles

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

### FileHistory#m__file_menu

Menu*m_fileMenu

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

### FileHistory.new

FileHistory.new(%(arg-type)Integer% maxFiles = 9, Integer idBase = ID_FILE1)

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

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

destructor()

Destructor.

### FileHistory#add_file_to_history

add_file_to_history(%(arg-type)String% filename)

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

### FileHistory#add_files_to_menu

add_files_to_menu()

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

add_files_to_menu(%(arg-type)Menu% menu)

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

### FileHistory#get_history_file

String get_history_file(%(arg-type)Integer% index)

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

### FileHistory#get_max_files

Integer get_max_files()

Returns the maximum number of files that can be stored.

### FileHistory#get_count

Integer get_count()

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

### FileHistory#load

load(%(arg-type)ConfigBase% config)

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

#### See also

Config

### FileHistory#remove_file_from_history

remove_file_from_history(%(arg-type)Integer% i)

Removes the specified file from the history.

### FileHistory#remove_menu

remove_menu(%(arg-type)Menu% menu)

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

### FileHistory#save

save(%(arg-type)ConfigBase% config)

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

#### See also

Config

### FileHistory#use_menu

use_menu(%(arg-type)Menu% menu)

Adds this menu to the list of those menus that are managed by this file history object.
Also see add_files_to_menu for
initializing the menu with filenames that are already in the history when this
function is called, as this is not done automatically.

[This page automatically generated from the Textile source at 2023-06-09 00:45:30 +0000]