Doc corrections; added HelpGen project files

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@8498 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2000-10-09 13:53:33 +00:00
parent 7cb74906e1
commit 4e28924cdb
10 changed files with 415 additions and 12 deletions

View File

@@ -12,7 +12,7 @@ No base class
\wxheading{See also}
\helpref{wxHelpContext}{wxhelpcontext}, \helpref{wxHelpContextButton}{wxhelpcontextbutton},
\helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxContextHelpButton}{wxcontexthelpbutton},
\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}, \helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider},
\helpref{wxWindow::SetHelpText}{wxwindowsethelptext}, \helpref{wxWindow::GetHelpText}{wxwindowgethelptext}
@@ -64,8 +64,6 @@ Associates the text with the given window or id. Although all help
providers have these functions to allow making \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}
work, not all of them implement the functions.
\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
\func{void}{AddHelp}{\param{wxWindowID }{id}, \param{const wxString\& }{text}}
This version associates the given text with all windows with this id.

View File

@@ -16,7 +16,7 @@ id to a string for passing to \helpref{wxWindow::SetHelpText}{wxwindowsethelptex
\wxheading{See also}
\helpref{wxHelpProvider}{wxhelpprovider}, \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider},
\helpref{wxHelpContext}{wxhelpcontext}, \helpref{wxWindow::SetHelpText}{wxwindowsethelptext},
\helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxWindow::SetHelpText}{wxwindowsethelptext},
\helpref{wxWindow::GetHelpText}{wxwindowgethelptext}
\latexignore{\rtfignore{\wxheading{Members}}}

View File

@@ -11,6 +11,6 @@ control (if any) in a tooltip.
\wxheading{See also}
\helpref{wxHelpProvider}{wxhelpprovider}, \helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider},
\helpref{wxHelpContext}{wxhelpcontext}, \helpref{wxWindow::SetHelpText}{wxwindowsethelptext},
\helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxWindow::SetHelpText}{wxwindowsethelptext},
\helpref{wxWindow::GetHelpText}{wxwindowgethelptext}

View File

@@ -600,7 +600,7 @@ be used at all.
Returns the grandparent of a window, or NULL if there isn't one.
\membersection{wxWindow::GetHandle}
\membersection{wxWindow::GetHandle}\label{wxwindowgethandle}
\constfunc{void*}{GetHandle}{\void}
@@ -609,6 +609,19 @@ handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget
\pythonnote{This method will return an integer in wxPython.}
\membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext}
\constfunc{virtual wxString}{GetHelpText}{\void}
Gets the help text to be used as context-sensitive help for this window.
Note that the text is actually stored by the current \helpref{wxHelpProvider}{wxhelpprovider} implementation,
and not in the window object itself.
\wxheading{See also}
\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
\membersection{wxWindow::GetId}\label{wxwindowgetid}
\constfunc{int}{GetId}{\void}
@@ -1412,8 +1425,6 @@ Sent to the event handler when the window must be refreshed.
\wxheading{Remarks}
Use the EVT\_PAINT macro in an event table definition to intercept paint events.
Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
@@ -1992,6 +2003,19 @@ their parent windows.
\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
\membersection{wxWindow::SetHelpText}\label{wxwindowsethelptext}
\func{virtual void}{SetHelpText}{\param{const wxString\& }{helpText}}
Sets the help text to be used as context-sensitive help for this window.
Note that the text is actually stored by the current \helpref{wxHelpProvider}{wxhelpprovider} implementation,
and not in the window object itself.
\wxheading{See also}
\helpref{GetHelpText}{wxwindowgethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
\membersection{wxWindow::SetId}\label{wxwindowsetid}
\func{void}{SetId}{\param{int}{ id}}

View File

@@ -1,5 +1,5 @@
[OPTIONS]
BMROOT=. ; Assume that bitmaps are where the source is
BMROOT=d:\wx2dev\wxWind~1\docs/latex/wx ; Assume that bitmaps are where the source is
TITLE=wxWindows Manual
CONTENTS=Contents
COMPRESS=HIGH

View File

@@ -1,4 +1,4 @@
\chapter{wxHTML Notes}\label{wxHTML}
\chapter{wxHTML Notes}\label{wxhtml}
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%