Simple wxBatteryPower API for the support in wxWinCE, wxPalmOS and any other mobile...

[wxWidgets.git] / include / wx / html / htmlwin.h

diff --git a/include/wx/html/htmlwin.h b/include/wx/html/htmlwin.h
index d05a6389c31e495952d0a2cd70035838bb7e7bf3..fd0ea89b1a489994238ca5768fce5a7e0d6518b2 100644 (file)
--- a/include/wx/html/htmlwin.h
+++ b/include/wx/html/htmlwin.h
@@ -4,7 +4,7 @@
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -68,7 +68,7 @@ class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow
 
 public:
     wxHtmlWindow() { Init(); }
-    wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
+    wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = wxHW_DEFAULT_STYLE,
@@ -79,7 +79,7 @@ public:
     }
     ~wxHtmlWindow();
 
-    bool Create(wxWindow *parent, wxWindowID id = -1,
+    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxHW_SCROLLBAR_AUTO,
@@ -88,7 +88,7 @@ public:
     // Set HTML page and display it. !! source is HTML document itself,
     // it is NOT address/filename of HTML document. If you want to
     // specify document location, use LoadPage() istead
-    // Return value : FALSE if an error occured, TRUE otherwise
+    // Return value : false if an error occured, true otherwise
     bool SetPage(const wxString& source);
 
     // Append to current page
@@ -120,14 +120,22 @@ public:
     void SetRelatedFrame(wxFrame* frame, const wxString& format);
     wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
 
+#if wxUSE_STATUSBAR
     // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
     // will be displayed. Default is -1 = no messages.
     void SetRelatedStatusBar(int bar);
+#endif // wxUSE_STATUSBAR
 
     // Sets fonts to be used when displaying HTML page.
     void SetFonts(wxString normal_face, wxString fixed_face,
                   const int *sizes = NULL);
 
+    // Sets font sizes to be relative to the given size or the system
+    // default size; use either specified or default font
+    void SetStandardFonts(int size = -1,
+                          const wxString& normal_face = wxEmptyString,
+                          const wxString& fixed_face = wxEmptyString);
+
     // Sets space between text and window borders.
     void SetBorders(int b) {m_Borders = b;}
 
@@ -139,7 +147,7 @@ public:
     virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 
     // Goes to previous/next page (in browsing history)
-    // Returns TRUE if successful, FALSE otherwise
+    // Returns true if successful, false otherwise
     bool HistoryBack();
     bool HistoryForward();
     bool HistoryCanBack();
@@ -184,30 +192,36 @@ public:
 
     // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
     // loading a page or loading an image). The data are downloaded if and only if
-    // OnOpeningURL returns TRUE. If OnOpeningURL returns wxHTML_REDIRECT,
+    // OnOpeningURL returns true. If OnOpeningURL returns wxHTML_REDIRECT,
     // it must set *redirect to the new URL
     virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
                                              const wxString& WXUNUSED(url),
                                              wxString *WXUNUSED(redirect)) const
         { return wxHTML_OPEN; }
-   
+
 #if wxUSE_CLIPBOARD
     // Helper functions to select parts of page:
     void SelectWord(const wxPoint& pos);
     void SelectLine(const wxPoint& pos);
     void SelectAll();
+
+    // Convert selection to text:
+    wxString SelectionToText() { return DoSelectionToText(m_selection); }
+
+    // Converts current page to text:
+    wxString ToText();
 #endif
 
     virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))
         { /* do nothing */ }
-    
+
 protected:
     void Init();
 
     // Scrolls to anchor of this name. (Anchor is #news
     // or #features etc. it is part of address sometimes:
     // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
-    // Return value : TRUE if anchor exists, FALSE otherwise
+    // Return value : true if anchor exists, false otherwise
     bool ScrollToAnchor(const wxString& anchor);
 
     // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
@@ -252,14 +266,13 @@ protected:
     bool CopySelection(ClipboardType t = Secondary);
 
 #if wxUSE_CLIPBOARD
-    // Convert selection to text:
-    wxString SelectionToText();
-
     // Automatic scrolling during selection:
     void StopAutoScrolling();
 #endif // wxUSE_CLIPBOARD
 
 protected:
+    wxString DoSelectionToText(wxHtmlSelection *sel);
+
     // This is pointer to the first cell in parsed data.  (Note: the first cell
     // is usually top one = all other cells are sub-cells of this one)
     wxHtmlContainerCell *m_Cell;
@@ -278,9 +291,11 @@ protected:
 
     wxFrame *m_RelatedFrame;
     wxString m_TitleFormat;
+#if wxUSE_STATUSBAR
     // frame in which page title should be displayed & number of it's statusbar
     // reserved for usage with this html window
     int m_RelatedStatusBar;
+#endif // wxUSE_STATUSBAR
 
     // borders (free space between text and window borders)
     // defaults to 10 pixels.
@@ -313,7 +328,7 @@ private:
     wxHtmlCell *m_tmpSelFromCell;
 
     // a flag indicated if mouse moved
-    // (if TRUE we will try to change cursor in last call to OnIdle)
+    // (if true we will try to change cursor in last call to OnIdle)
     bool m_tmpMouseMoved;
     // contains last link name
     wxHtmlLinkInfo *m_tmpLastLink;