Added periods

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

diff --git a/docs/latex/wx/filehist.tex b/docs/latex/wx/filehist.tex
index 1d9001be31ca0e7c410e778710987c6b0860bfe1..af48e1b4e71949b32d185322c7ecae8fa4c8a575 100644 (file)
--- a/docs/latex/wx/filehist.tex
+++ b/docs/latex/wx/filehist.tex
@@ -11,58 +11,80 @@ as well as the MDI parent frame.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/docview.h>
+
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}
 
 \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}
+
+\func{}{wxFileHistory}{\param{size\_t}{ maxFiles = 9}, \param{wxWindowID}{ idBase = wxID\_FILE1}}
+
+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.

 
 

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

 
 

-\membersection{wxFileHistory::\destruct{wxFileHistory}}
+\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.
 


@@ -70,25 +92,47 @@ 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::GetBaseId}\label{wxfilehistorygetbaseid}
+
+\constfunc{wxWindowID}{GetBaseId}{\void}
+
+Returns the base identifier for the range used for appending items.
+
+
+\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}

 
 

-Returns the number of files currently stored in the file history.
+\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}

 
 

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

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


@@ -98,13 +142,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}}
 


@@ -115,10 +167,20 @@ explicitly by the application.
 
 \helpref{wxConfig}{wxconfigbase}
 
 
 \helpref{wxConfig}{wxconfigbase}
 

-\membersection{wxFileHistory::UseMenu}

 
 

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

 
 

-Adds this menu to the list of those managed by this object.
+\func{void}{SetBaseId}{\param{wxWindowID}{ baseId}}
+
+Sets the base identifier for the range used for appending items.
+
+
+\membersection{wxFileHistory::UseMenu}\label{wxfilehistoryusemenu}
+
+\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.