add events API to wxHtmlWindow (patch #1504493 by Francesco Montorsi)

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

diff --git a/docs/latex/wx/filehist.tex b/docs/latex/wx/filehist.tex
index 2804384dc2f5562c03fda1db60bccfaf74163d5b..6a20ace6942db1ffc41492a0b08ed0a5788b7d77 100644 (file)
--- a/docs/latex/wx/filehist.tex
+++ b/docs/latex/wx/filehist.tex
@@ -21,52 +21,66 @@ as well as the MDI parent frame.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxFileHistory::m\_fileHistory}
+
+\membersection{wxFileHistory::m\_fileHistory}\label{wxfilehistorymfilehistory}

 
 \member{char**}{m\_fileHistory}
 
 A character array of strings corresponding to the most recently opened
 files.
 
 
 \member{char**}{m\_fileHistory}
 
 A character array of strings corresponding to the most recently opened
 files.
 

-\membersection{wxFileHistory::m\_fileHistoryN}

 
 

-\member{int}{m\_fileHistoryN}
+\membersection{wxFileHistory::m\_fileHistoryN}\label{wxfilehistorymfilehistoryn}
+
+\member{size\_t}{m\_fileHistoryN}

 
 The number of files stored in the history array.
 
 
 The number of files stored in the history array.
 

-\membersection{wxFileHistory::m\_fileMaxFiles}

 
 

-\member{int}{m\_fileMaxFiles}
+\membersection{wxFileHistory::m\_fileMaxFiles}\label{wxfilehistorymfilemaxfiles}
+
+\member{size\_t}{m\_fileMaxFiles}

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

-\membersection{wxFileHistory::m\_fileMenu}
+
+\membersection{wxFileHistory::m\_fileMenu}\label{wxfilehistorymfilemenu}

 
 \member{wxMenu*}{m\_fileMenu}
 
 The file menu used to display the file history list (if enabled).
 
 
 \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}}
+\membersection{wxFileHistory::wxFileHistory}\label{wxfilehistoryctor}

 
 

-Constructor. Pass the maximum number of files that should be stored and displayed.
+\func{}{wxFileHistory}{\param{size\_t}{ maxFiles = 9}, \param{wxWindowID}{ idBase = wxID\_FILE1}}

 
 

-\membersection{wxFileHistory::\destruct{wxFileHistory}}
+Constructor. Pass the maximum number of files that should be stored and
+displayed.
+
+{\it idBase} defaults to wxID\_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 wxFileHistory
+in your application.
+
+
+\membersection{wxFileHistory::\destruct{wxFileHistory}}\label{wxfilehistorydtor}

 
 \func{}{\destruct{wxFileHistory}}{\void}
 
 Destructor.
 
 
 \func{}{\destruct{wxFileHistory}}{\void}
 
 Destructor.
 

-\membersection{wxFileHistory::AddFileToHistory}
+
+\membersection{wxFileHistory::AddFileToHistory}\label{wxfilehistoryaddfiletohistory}

 
 \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.
 
 
 \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}
 
 \membersection{wxFileHistory::AddFilesToMenu}\label{wxfilehistoryaddfilestomenu}
 

-\func{void}{AddFilesToMenu}{\void}
+\func{void}{AddFilesToMenu}{\void}\label{wxfilehistoryaddfilestomenu}

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


@@ -74,25 +88,40 @@ Appends the files in the history list, to all menus managed by the file history
 
 Appends the files in the history list, to the given menu only.
 
 
 Appends the files in the history list, to the given menu only.
 

+
+\membersection{wxFileHistory::GetCount}\label{wxfilehistorygetcount}
+
+\constfunc{size\_t}{GetCount}{\void}
+
+Returns the number of files currently stored in the file history.
+
+

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

-\constfunc{wxString}{GetHistoryFile}{\param{int}{ index}}
+\constfunc{wxString}{GetHistoryFile}{\param{size\_t}{ index}}

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

-\membersection{wxFileHistory::GetMaxFiles}
+
+\membersection{wxFileHistory::GetMaxFiles}\label{wxfilehistorygetmaxfiles}

 
 \constfunc{int}{GetMaxFiles}{\void}
 
 Returns the maximum number of files that can be stored.
 
 
 \constfunc{int}{GetMaxFiles}{\void}
 
 Returns the maximum number of files that can be stored.
 

-\membersection{wxFileHistory::GetNoHistoryFiles}

 
 

-\constfunc{int}{GetNoHistoryFiles}{\void}
+\membersection{wxFileHistory::GetMenus}\label{wxfilehistorygetmenus}
+
+\constfunc{const wxList\&}{GetMenus}{\void}
+
+Returns the list of menus that are managed by this file history object.
+
+\wxheading{See also}
+
+\helpref{wxFileHistory::UseMenu}{wxfilehistoryusemenu}

 
 

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

 
 

-\membersection{wxFileHistory::Load}
+\membersection{wxFileHistory::Load}\label{wxfilehistoryload}

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


@@ -102,13 +131,21 @@ Loads the file history from the given config object. This function should be cal
 
 \helpref{wxConfig}{wxconfigbase}
 
 
 \helpref{wxConfig}{wxconfigbase}
 

-\membersection{wxFileHistory::RemoveMenu}
+
+\membersection{wxFileHistory::RemoveFileFromHistory}\label{wxfilehistoryfromfilefromhistory}
+
+\func{void}{RemoveFileFromHistory}{\param{size\_t }{i}}
+
+Removes the specified file from the history.
+
+\membersection{wxFileHistory::RemoveMenu}\label{wxfilehistoryremovemenu}

 
 \func{void}{RemoveMenu}{\param{wxMenu* }{menu}}
 
 Removes this menu from the list of those managed by this object.
 
 
 \func{void}{RemoveMenu}{\param{wxMenu* }{menu}}
 
 Removes this menu from the list of those managed by this object.
 

-\membersection{wxFileHistory::Save}
+
+\membersection{wxFileHistory::Save}\label{wxfilehistorysave}

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


@@ -119,10 +156,13 @@ explicitly by the application.
 
 \helpref{wxConfig}{wxconfigbase}
 
 
 \helpref{wxConfig}{wxconfigbase}
 

-\membersection{wxFileHistory::UseMenu}

 
 

-\func{void}{UseMenu}{\param{wxMenu* }{menu}}
+\membersection{wxFileHistory::UseMenu}\label{wxfilehistoryusemenu}

 
 

-Adds this menu to the list of those managed by this object.
+\func{void}{UseMenu}{\param{wxMenu* }{menu}}

 
 

+Adds this menu to the list of those menus that are managed by this file history object.
+Also see \helpref{AddFilesToMenu()}{wxfilehistoryaddfilestomenu} for
+initializing the menu with filenames that are already in the history when this
+function is called, as this is not done automatically.