From 0460407f86c7107ff3548afbd846aa8dfd44cc20 Mon Sep 17 00:00:00 2001
From: Julian Smart <julian@anthemion.co.uk>
Date: Fri, 8 Sep 2000 14:51:08 +0000
Subject: [PATCH] Added manual files

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@8301 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/cshelp.tex  | 58 ++++++++++++++++++++++++++++++++++
 docs/latex/wx/helpevt.tex | 65 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 123 insertions(+)
 create mode 100644 docs/latex/wx/cshelp.tex
 create mode 100644 docs/latex/wx/helpevt.tex

diff --git a/docs/latex/wx/cshelp.tex b/docs/latex/wx/cshelp.tex
new file mode 100644
index 0000000000..fc7b632f19
--- /dev/null
+++ b/docs/latex/wx/cshelp.tex
@@ -0,0 +1,58 @@
+\section{\class{wxContextHelp}}\label{wxcontexthelp}
+
+This class changes the cursor to a query and puts the application into a 'context-sensitive help mode'.
+When the user left-clicks on a window within the specified window, a wxEVT\_HELP event is
+sent to that control, and the application may respond to it by popping up some help.
+
+For example:
+
+\begin{verbatim}
+  wxContextHelp contextHelp(myWindow);
+\end{verbatim}
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/cshelp.h>
+
+\wxheading{See also}
+
+\helpref{wxHelpEvent}{wxhelpevent},\rtfsp
+\helpref{wxHelpController}{wxhelpcontroller}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxContextHelp::wxContextHelp}
+
+\func{}{wxContextHelp}{\param{wxWindow*}{ window = NULL}, \param{bool}{ doNow = TRUE}}
+
+Constructs a context help object, calling \helpref{BeginContextHelp}{wxcontexthelpbegincontexthelp} if\rtfsp
+{\it doNow} is TRUE (the default).
+
+If {\it window} is NULL, the top window is used.
+
+\membersection{wxContextHelp::\destruct{wxContextHelp}}
+
+\func{}{\destruct{wxContextHelp}}{\void}
+
+Destroys the context help object.
+
+\membersection{wxContextHelp::BeginContextHelp}\label{wxcontexthelpbegincontexthelp}
+
+\func{bool}{BeginContextHelp}{\param{wxWindow*}{ window = NULL}}
+
+Puts the application into context-sensitive help mode. {\it window} is the window
+which will be used to catch events; if NULL, the top window will be used.
+
+Returns TRUE if the application was successfully put into context-sensitive help mode.
+This function only returns when the event loop has finished.
+
+\membersection{wxContextHelp::EndContextHelp}\label{wxcontexthelpendcontexthelp}
+
+\func{bool}{EndContextHelp}{\void}
+
+Ends context-sensitive help mode. Not normally called by the application.
+
diff --git a/docs/latex/wx/helpevt.tex b/docs/latex/wx/helpevt.tex
new file mode 100644
index 0000000000..ed8f7836ed
--- /dev/null
+++ b/docs/latex/wx/helpevt.tex
@@ -0,0 +1,65 @@
+\section{\class{wxHelpEvent}}\label{wxhelpevent}
+
+A help event is sent when the user has requested context-sensitive help.
+This can either be caused by the application requesting
+context-sensitive help mode via \helpref{wxContextHelp}{wxcontexthelp}, or
+(on MS Windows) by the system generating a WM\_HELP message when the user pressed F1 or clicked
+on the query button in a dialog caption.
+
+A help event is sent to the window that the user clicked on, and is propagated up the
+window hierarchy until the event is processed or there are no more event handlers.
+The application should call wxEvent::GetId to check the identity of the clicked-on window,
+and then either show some suitable help or call wxEvent::Skip if the identifier is unrecognised.
+Calling Skip is important because it allows wxWindows to generate further events for ancestors
+of the clicked-on window. Otherwise it would be impossible to show help for container windows,
+since processing would stop after the first window found.
+
+\wxheading{Derived from}
+
+\helpref{wxCommandEvent}{wxcommandevent}\\
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/event.h>
+
+\wxheading{Event table macros}
+
+To process an activate event, use these event handler macros to direct input to a member
+function that takes a wxHelpEvent argument.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_HELP(id, func)}}{Process a wxEVT\_HELP event.}
+\twocolitem{{\bf EVT\_HELP\_RANGE(id1, id2, func)}}{Process a wxEVT\_HELP event for a range of ids.}
+\end{twocollist}%
+
+\wxheading{See also}
+
+\helpref{wxContextHelp}{wxcontexthelp},\rtfsp
+\helpref{wxDialog}{wxdialog},\rtfsp
+\helpref{Event handling overview}{eventhandlingoverview}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxHelpEvent::wxHelpEvent}
+
+\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = TRUE}, \param{wxWindowID }{id = 0},
+ \param{const wxPoint\& }{point}}
+
+Constructor.
+
+\membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition}
+
+\constfunc{const wxPoint\&}{GetPosition}{\void}
+
+Returns the left-click position of the mouse, in screen coordinates. This allows
+the application to position the help appropriately.
+
+\membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition}
+
+\func{void}{SetPosition}{\param{const wxPoint\&}{ pt}}
+
+Sets the left-click position of the mouse, in screen coordinates.
+
-- 
2.50.0

