[wxWidgets.git] / docs / latex / wx / filehist.tex

\section{\class{wxFileHistory}}\label{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.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/docview.h>

\wxheading{See also}

\helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxFileHistory::m\_fileHistory}

\member{char**}{m\_fileHistory}

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

\membersection{wxFileHistory::m\_fileHistoryN}

\member{int}{m\_fileHistoryN}

The number of files stored in the history array.

\membersection{wxFileHistory::m\_fileMaxFiles}

\member{int}{m\_fileMaxFiles}

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

\membersection{wxFileHistory::m\_fileMenu}

\member{wxMenu*}{m\_fileMenu}

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

\membersection{wxFileHistory::wxFileHistory}

\func{}{wxFileHistory}{\param{int}{ maxFiles = 9}}

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

\membersection{wxFileHistory::\destruct{wxFileHistory}}

\func{}{\destruct{wxFileHistory}}{\void}

Destructor.

\membersection{wxFileHistory::AddFileToHistory}

\func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}

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

\membersection{wxFileHistory::AddFilesToMenu}\label{wxfilehistoryaddfilestomenu}

\func{void}{AddFilesToMenu}{\void}

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

\func{void}{AddFilesToMenu}{\param{wxMenu*}{ menu}}

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

\membersection{wxFileHistory::GetHistoryFile}\label{wxfilehistorygethistoryfile}

\constfunc{wxString}{GetHistoryFile}{\param{int}{ index}}

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

\membersection{wxFileHistory::GetMaxFiles}

\constfunc{int}{GetMaxFiles}{\void}

Returns the maximum number of files that can be stored.

\membersection{wxFileHistory::GetNoHistoryFiles}

\constfunc{int}{GetNoHistoryFiles}{\void}

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

\membersection{wxFileHistory::Load}

\func{void}{Load}{\param{wxConfigBase\& }{config}}

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

\wxheading{See also}

\helpref{wxConfig}{wxconfigbase}

\membersection{wxFileHistory::RemoveMenu}

\func{void}{RemoveMenu}{\param{wxMenu* }{menu}}

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

\membersection{wxFileHistory::Save}

\func{void}{Save}{\param{wxConfigBase\& }{config}}

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

\wxheading{See also}

\helpref{wxConfig}{wxconfigbase}

\membersection{wxFileHistory::UseMenu}

\func{void}{UseMenu}{\param{wxMenu* }{menu}}

Adds this menu to the list of those managed by this object.
Commit	Line	Data
a660d684 KB	1	\section{\class{wxFileHistory}}\label{wxfilehistory}
	2
	3	The wxFileHistory encapsulates a user interface convenience, the
	4	list of most recently visited files as shown on a menu (usually the File menu).
	5
7f555861 JS	6	wxFileHistory can manage one or more file menus. More than one menu may be required
	7	in an MDI application, where the file history should appear on each MDI child menu
	8	as well as the MDI parent frame.
	9
a660d684 KB	10	\wxheading{Derived from}
	11
	12	\helpref{wxObject}{wxobject}
	13
954b8ae6 JS	14	\wxheading{Include files}
	15
	16	<wx/docview.h>
	17
a660d684 KB	18	\wxheading{See also}
a660d684 KB	19
7f555861	20	\helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}
a660d684 KB	21
	22	\latexignore{\rtfignore{\wxheading{Members}}}
	23
	24	\membersection{wxFileHistory::m\_fileHistory}
	25
	26	\member{char**}{m\_fileHistory}
	27
	28	A character array of strings corresponding to the most recently opened
	29	files.
	30
	31	\membersection{wxFileHistory::m\_fileHistoryN}
	32
	33	\member{int}{m\_fileHistoryN}
	34
	35	The number of files stored in the history array.
	36
	37	\membersection{wxFileHistory::m\_fileMaxFiles}
	38
	39	\member{int}{m\_fileMaxFiles}
	40
	41	The maximum number of files to be stored and displayed on the menu.
	42
	43	\membersection{wxFileHistory::m\_fileMenu}
	44
	45	\member{wxMenu*}{m\_fileMenu}
	46
	47	The file menu used to display the file history list (if enabled).
	48
	49	\membersection{wxFileHistory::wxFileHistory}
	50
	51	\func{}{wxFileHistory}{\param{int}{ maxFiles = 9}}
	52
	53	Constructor. Pass the maximum number of files that should be stored and displayed.
	54
	55	\membersection{wxFileHistory::\destruct{wxFileHistory}}
	56
	57	\func{}{\destruct{wxFileHistory}}{\void}
	58
	59	Destructor.
	60
	61	\membersection{wxFileHistory::AddFileToHistory}
	62
	63	\func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
	64
	65	Adds a file to the file history list, if the object has a pointer to an appropriate file menu.
	66
7f555861	67	\membersection{wxFileHistory::AddFilesToMenu}\label{wxfilehistoryaddfilestomenu}
a660d684	68
7f555861	69	\func{void}{AddFilesToMenu}{\void}
a660d684	70
7f555861	71	Appends the files in the history list, to all menus managed by the file history object.
a660d684	72
7f555861	73	\func{void}{AddFilesToMenu}{\param{wxMenu*}{ menu}}
a660d684	74
7f555861	75	Appends the files in the history list, to the given menu only.
a660d684	76
7f555861	77	\membersection{wxFileHistory::GetHistoryFile}\label{wxfilehistorygethistoryfile}
a660d684	78
7f555861	79	\constfunc{wxString}{GetHistoryFile}{\param{int}{ index}}
a660d684	80
7f555861	81	Returns the file at this index (zero-based).
a660d684 KB	82
	83	\membersection{wxFileHistory::GetMaxFiles}
	84
7f555861	85	\constfunc{int}{GetMaxFiles}{\void}
a660d684 KB	86
	87	Returns the maximum number of files that can be stored.
	88
	89	\membersection{wxFileHistory::GetNoHistoryFiles}
	90
7f555861	91	\constfunc{int}{GetNoHistoryFiles}{\void}
a660d684 KB	92
	93	Returns the number of files currently stored in the file history.
	94
7f555861 JS	95	\membersection{wxFileHistory::Load}
	96
	97	\func{void}{Load}{\param{wxConfigBase\& }{config}}
	98
	99	Loads the file history from the given config object. This function should be called explicitly by the application.
	100
	101	\wxheading{See also}
	102
	103	\helpref{wxConfig}{wxconfigbase}
	104
	105	\membersection{wxFileHistory::RemoveMenu}
	106
	107	\func{void}{RemoveMenu}{\param{wxMenu* }{menu}}
	108
	109	Removes this menu from the list of those managed by this object.
	110
	111	\membersection{wxFileHistory::Save}
	112
	113	\func{void}{Save}{\param{wxConfigBase\& }{config}}
	114
	115	Saves the file history into the given config object. This must be called
	116	explicitly by the application.
	117
	118	\wxheading{See also}
	119
	120	\helpref{wxConfig}{wxconfigbase}
	121
	122	\membersection{wxFileHistory::UseMenu}
	123
	124	\func{void}{UseMenu}{\param{wxMenu* }{menu}}
	125
	126	Adds this menu to the list of those managed by this object.
	127
a660d684	128