Documented help API extension and fixed gsocket compilation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3144 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index 1e1b5dea8764191d9d4e68dc563b82f7689396a8..8d8bdff00d71ccec43f0f20a3f68c378c9897b16 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -23,6 +23,7 @@ There are currently the following help controller classes defined:
 \item wxWinHelpController, for controlling Windows Help.
 \item wxExtHelpController, for controlling external browsers under Unix.
 The default browser is Netscape Navigator.
+\item wxHelpControllerHtml, using wxHTML to display help
 \item wxXLPHelpController, for controlling wxHelp (from wxWindows 1).
 \end{itemize}
 
@@ -37,6 +38,7 @@ wxHelpControllerBase\\
 <wx/helpbase.h> (wxHelpControllerBase class)\\
 <wx/helpwin.h> (Windows Help controller)\\
 <wx/generic/helpext.h> (external HTML browser controller)
+<wx/generic/helpwxht.h> (wxHTML based help controller)
 <wx/generic/helpxlp.h> (wxHelp controller)
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -95,7 +97,7 @@ If the help viewer is not running, runs it and displays the given section.
 
 {\it WinHelp:} {\it sectionNo} is a context id.
 
-{\it External HTML help:} wxExtHelpController implements {\it sectionNo} as an id in a map file, which is of the form:
+{\it External HTML help/wxHTML based help:} wxExtHelpController and wxHelpControllerHtml implement {\it sectionNo} as an id in a map file, which is of the form:
 
 \begin{verbatim}
 0  wx.html             ; Index
@@ -136,6 +138,31 @@ has opened another file.
 
 Sets detailed viewer information. So far this is only relevant to wxExtHelpController.
 
+\membersection{wxHelpController::SetFrameParameters}\label{wxhelpcontrollersetframeparameters}
+\func{virtual void}{SetFrameParameters}
+{\param{const wxString \& }{title},
+ \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
+ \param{bool }{newFrameEachTime = FALSE}}
+
+For the wxHelpControllerHtml, this allows the application to set the
+default frame title, size and position for the frame. If the title
+contains \%s, this will be replaced with the page title. If the
+parammeter newFrameEachTime is set, the controller will open a new
+help frame each time it is called. For all other help controllers this 
+function has no effect.
+
+\membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
+\func{virtual wxFrame *}{GetFrameParameters}
+{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
+ \param{bool *}{newFrameEachTime = NULL}}
+This reads the current settings for the help frame in the case of the
+wxHelpControllerHtml, setting the frame size, position and
+the newFrameEachTime parameters to the last values used. It also
+returns the pointer to the last opened help frame. This can be used
+for example, to automatically close the help frame on program
+shutdown. For all other help controllers, this function does nothing
+and just returns NULL.
+
 \wxheading{Parameters}
 
 \docparam{viewer}{This defaults to "netscape" for wxExtHelpController.}

diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h
index 0230cfb1c32f3aef124b6bfb5b0559f8430ff98a..d6a9b0d989d5462922ae1af678cd79eda7411414 100644 (file)
--- a/include/wx/helpbase.h
+++ b/include/wx/helpbase.h
@@ -50,6 +50,22 @@ class WXDLLEXPORT wxHelpControllerBase: public wxObject
   virtual bool DisplaySection(int sectionNo) = 0;
   virtual bool DisplayBlock(long blockNo) = 0;
   virtual bool KeywordSearch(const wxString& k) = 0;
+  /// Allows one to override the default settings for the help frame.
+  virtual void SetFrameParameters(const wxString &title,
+                                   const wxSize &size,
+                                   const wxPoint &pos = wxDefaultPosition,
+                                   bool newFrameEachTime = FALSE)
+      {
+         // does nothing by default
+      }
+   /// Obtains the latest settings used by the help frame and the help 
+   /// frame.
+   virtual wxFrame *GetFrameParameters(wxSize *size = NULL,
+                                   wxPoint *pos = NULL,
+                                   bool *newFrameEachTime = NULL)
+      {
+         return (wxFrame*) NULL;// does nothing by default
+      }
 
   virtual bool Quit(void) = 0;
   virtual void OnQuit(void) {};

diff --git a/src/generic/helpwxht.cpp b/src/generic/helpwxht.cpp
index 1c25e77bc3673ac36f2fa57f64ae76a137391fc5..336273ba87a41b305903f88daf91842e3ca1028b 100644 (file)
--- a/src/generic/helpwxht.cpp
+++ b/src/generic/helpwxht.cpp
@@ -27,6 +27,7 @@
 #   include "wx/list.h"
 #   include "wx/intl.h"
 #   include "wx/layout.h"
+#   include "wx/combobox.h"
 #endif
 
 #include "wx/helpbase.h"

diff --git a/src/unix/gsocket.c b/src/unix/gsocket.c
index 1aba194f6fffca083a522392070549dcbc3bb6b3..fa01cea28059a67d7e711f534934c3f5cbab634f 100644 (file)
--- a/src/unix/gsocket.c
+++ b/src/unix/gsocket.c
@@ -34,7 +34,7 @@
 #endif
 
 #include <signal.h>
-#include <features.h>
+//#include <features.h>
 
 #include <wx/setup.h>
 #include <wx/gsocket.h>