include/wx/html/htmlwin.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmlwin.h
   3 // Purpose:     wxHtmlWindow class for parsing & displaying HTML
   4 // Author:      Vaclav Slavik
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1999 Vaclav Slavik
   7 // Licence:     wxWindows Licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifndef _WX_HTMLWIN_H_
  12 #define _WX_HTMLWIN_H_
  13
  14 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  15 #pragma interface "htmlwin.h"
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #if wxUSE_HTML
  20
  21 #include "wx/window.h"
  22 #include "wx/scrolwin.h"
  23 #include "wx/config.h"
  24 #include "wx/html/winpars.h"
  25 #include "wx/html/htmlcell.h"
  26 #include "wx/filesys.h"
  27 #include "wx/html/htmlfilt.h"
  28 #include "wx/filename.h"
  29
  30 class wxHtmlProcessor;
  31 class wxHtmlWinModule;
  32 class wxHtmlHistoryArray;
  33 class wxHtmlProcessorList;
  34 class WXDLLIMPEXP_HTML wxHtmlWinAutoScrollTimer;
  35
  36
  37 // wxHtmlWindow flags:
  38 #define wxHW_SCROLLBAR_NEVER    0x0002
  39 #define wxHW_SCROLLBAR_AUTO     0x0004
  40 #define wxHW_NO_SELECTION       0x0008
  41
  42 #define wxHW_DEFAULT_STYLE      wxHW_SCROLLBAR_AUTO
  43
  44
  45 // enums for wxHtmlWindow::OnOpeningURL
  46 enum wxHtmlOpeningStatus
  47 {
  48     wxHTML_OPEN,
  49     wxHTML_BLOCK,
  50     wxHTML_REDIRECT
  51 };
  52
  53 // ----------------------------------------------------------------------------
  54 // wxHtmlWindow
  55 //                  (This is probably the only class you will directly use.)
  56 //                  Purpose of this class is to display HTML page (either local
  57 //                  file or downloaded via HTTP protocol) in a window. Width of
  58 //                  window is constant - given in constructor - virtual height
  59 //                  is changed dynamicly depending on page size.  Once the
  60 //                  window is created you can set it's content by calling
  61 //                  SetPage(text) or LoadPage(filename).
  62 // ----------------------------------------------------------------------------
  63
  64 class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow
  65 {
  66     DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
  67     friend class wxHtmlWinModule;
  68
  69 public:
  70     wxHtmlWindow() { Init(); }
  71     wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
  72                  const wxPoint& pos = wxDefaultPosition,
  73                  const wxSize& size = wxDefaultSize,
  74                  long style = wxHW_DEFAULT_STYLE,
  75                  const wxString& name = wxT("htmlWindow"))
  76     {
  77         Init();
  78         Create(parent, id, pos, size, style, name);
  79     }
  80     ~wxHtmlWindow();
  81
  82     bool Create(wxWindow *parent, wxWindowID id = -1,
  83                 const wxPoint& pos = wxDefaultPosition,
  84                 const wxSize& size = wxDefaultSize,
  85                 long style = wxHW_SCROLLBAR_AUTO,
  86                 const wxString& name = wxT("htmlWindow"));
  87
  88     // Set HTML page and display it. !! source is HTML document itself,
  89     // it is NOT address/filename of HTML document. If you want to
  90     // specify document location, use LoadPage() istead
  91     // Return value : FALSE if an error occured, TRUE otherwise
  92     bool SetPage(const wxString& source);
  93
  94     // Append to current page
  95     bool AppendToPage(const wxString& source);
  96
  97     // Load HTML page from given location. Location can be either
  98     // a) /usr/wxGTK2/docs/html/wx.htm
  99     // b) http://www.somewhere.uk/document.htm
 100     // c) ftp://ftp.somesite.cz/pub/something.htm
 101     // In case there is no prefix (http:,ftp:), the method
 102     // will try to find it itself (1. local file, then http or ftp)
 103     // After the page is loaded, the method calls SetPage() to display it.
 104     // Note : you can also use path relative to previously loaded page
 105     // Return value : same as SetPage
 106     virtual bool LoadPage(const wxString& location);
 107
 108     // Loads HTML page from file
 109     bool LoadFile(const wxFileName& filename);
 110
 111     // Returns full location of opened page
 112     wxString GetOpenedPage() const {return m_OpenedPage;}
 113     // Returns anchor within opened page
 114     wxString GetOpenedAnchor() const {return m_OpenedAnchor;}
 115     // Returns <TITLE> of opened page or empty string otherwise
 116     wxString GetOpenedPageTitle() const {return m_OpenedPageTitle;}
 117
 118     // Sets frame in which page title will  be displayed. Format is format of
 119     // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
 120     void SetRelatedFrame(wxFrame* frame, const wxString& format);
 121     wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
 122
 123     // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
 124     // will be displayed. Default is -1 = no messages.
 125     void SetRelatedStatusBar(int bar);
 126
 127     // Sets fonts to be used when displaying HTML page.
 128     void SetFonts(wxString normal_face, wxString fixed_face,
 129                   const int *sizes = NULL);
 130
 131     // Sets space between text and window borders.
 132     void SetBorders(int b) {m_Borders = b;}
 133
 134     // Saves custom settings into cfg config. it will use the path 'path'
 135     // if given, otherwise it will save info into currently selected path.
 136     // saved values : things set by SetFonts, SetBorders.
 137     virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 138     // ...
 139     virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 140
 141     // Goes to previous/next page (in browsing history)
 142     // Returns TRUE if successful, FALSE otherwise
 143     bool HistoryBack();
 144     bool HistoryForward();
 145     bool HistoryCanBack();
 146     bool HistoryCanForward();
 147     // Resets history
 148     void HistoryClear();
 149
 150     // Returns pointer to conteiners/cells structure.
 151     // It should be used ONLY when printing
 152     wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;}
 153
 154     // Adds input filter
 155     static void AddFilter(wxHtmlFilter *filter);
 156
 157     // Returns a pointer to the parser.
 158     wxHtmlWinParser *GetParser() const { return m_Parser; }
 159
 160     // Adds HTML processor to this instance of wxHtmlWindow:
 161     void AddProcessor(wxHtmlProcessor *processor);
 162     // Adds HTML processor to wxHtmlWindow class as whole:
 163     static void AddGlobalProcessor(wxHtmlProcessor *processor);
 164
 165     // -- Callbacks --
 166
 167     // Sets the title of the window
 168     // (depending on the information passed to SetRelatedFrame() method)
 169     virtual void OnSetTitle(const wxString& title);
 170
 171     // Called when the mouse hovers over a cell: (x, y) are logical coords
 172     // Default behaviour is to do nothing at all
 173     virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
 174
 175     // Called when user clicks on a cell. Default behavior is to call
 176     // OnLinkClicked() if this cell corresponds to a hypertext link
 177     virtual void OnCellClicked(wxHtmlCell *cell,
 178                                wxCoord x, wxCoord y,
 179                                const wxMouseEvent& event);
 180
 181     // Called when user clicked on hypertext link. Default behavior is to
 182     // call LoadPage(loc)
 183     virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
 184
 185     // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
 186     // loading a page or loading an image). The data are downloaded if and only if
 187     // OnOpeningURL returns TRUE. If OnOpeningURL returns wxHTML_REDIRECT,
 188     // it must set *redirect to the new URL
 189     virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
 190                                              const wxString& WXUNUSED(url),
 191                                              wxString *WXUNUSED(redirect)) const
 192         { return wxHTML_OPEN; }
 193
 194 protected:
 195     void Init();
 196
 197     // Scrolls to anchor of this name. (Anchor is #news
 198     // or #features etc. it is part of address sometimes:
 199     // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
 200     // Return value : TRUE if anchor exists, FALSE otherwise
 201     bool ScrollToAnchor(const wxString& anchor);
 202
 203     // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
 204     // actual size of window. This method also setup scrollbars
 205     void CreateLayout();
 206
 207     void OnEraseBackground(wxEraseEvent& event);
 208     void OnPaint(wxPaintEvent& event);
 209     void OnSize(wxSizeEvent& event);
 210     void OnMouseMove(wxMouseEvent& event);
 211     void OnMouseDown(wxMouseEvent& event);
 212     void OnMouseUp(wxMouseEvent& event);
 213 #if wxUSE_CLIPBOARD
 214     void OnKeyUp(wxKeyEvent& event);
 215     void OnDoubleClick(wxMouseEvent& event);
 216     void OnCopy(wxCommandEvent& event);
 217     void OnMouseEnter(wxMouseEvent& event);
 218     void OnMouseLeave(wxMouseEvent& event);
 219 #endif // wxUSE_CLIPBOARD
 220
 221     virtual void OnInternalIdle();
 222
 223     // Returns new filter (will be stored into m_DefaultFilter variable)
 224     virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
 225
 226     // cleans static variables
 227     static void CleanUpStatics();
 228
 229     // Returns true if text selection is enabled (wxClipboard must be available
 230     // and wxHW_NO_SELECTION not used)
 231     bool IsSelectionEnabled() const;
 232
 233     enum ClipboardType
 234     {
 235         Primary,
 236         Secondary
 237     };
 238
 239     // Copies selection to clipboard if the clipboard support is available
 240     //
 241     // returns true if anything was copied to clipboard, false otherwise
 242     bool CopySelection(ClipboardType t = Secondary);
 243
 244 #if wxUSE_CLIPBOARD
 245     // Convert selection to text:
 246     wxString SelectionToText();
 247
 248     // Helper functions to select parts of page:
 249     void SelectWord(const wxPoint& pos);
 250     void SelectLine(const wxPoint& pos);
 251
 252     // Automatic scrolling during selection:
 253     void StopAutoScrolling();
 254 #endif // wxUSE_CLIPBOARD
 255
 256 protected:
 257     // This is pointer to the first cell in parsed data.  (Note: the first cell
 258     // is usually top one = all other cells are sub-cells of this one)
 259     wxHtmlContainerCell *m_Cell;
 260     // parser which is used to parse HTML input.
 261     // Each wxHtmlWindow has it's own parser because sharing one global
 262     // parser would be problematic (because of reentrancy)
 263     wxHtmlWinParser *m_Parser;
 264     // contains name of actualy opened page or empty string if no page opened
 265     wxString m_OpenedPage;
 266     // contains name of current anchor within m_OpenedPage
 267     wxString m_OpenedAnchor;
 268     // contains title of actualy opened page or empty string if no <TITLE> tag
 269     wxString m_OpenedPageTitle;
 270     // class for opening files (file system)
 271     wxFileSystem* m_FS;
 272
 273     wxFrame *m_RelatedFrame;
 274     wxString m_TitleFormat;
 275     // frame in which page title should be displayed & number of it's statusbar
 276     // reserved for usage with this html window
 277     int m_RelatedStatusBar;
 278
 279     // borders (free space between text and window borders)
 280     // defaults to 10 pixels.
 281     int m_Borders;
 282
 283     int m_Style;
 284
 285     // current text selection or NULL
 286     wxHtmlSelection *m_selection;
 287
 288     // true if the user is dragging mouse to select text
 289     bool m_makingSelection;
 290
 291 #if wxUSE_CLIPBOARD
 292     // time of the last doubleclick event, used to detect tripleclicks
 293     // (tripleclicks are used to select whole line):
 294     wxLongLong m_lastDoubleClick;
 295
 296     // helper class to automatically scroll the window if the user is selecting
 297     // text and the mouse leaves wxHtmlWindow:
 298     wxHtmlWinAutoScrollTimer *m_timerAutoScroll;
 299 #endif // wxUSE_CLIPBOARD
 300
 301 private:
 302     // window content for double buffered rendering:
 303     wxBitmap *m_backBuffer;
 304
 305     // variables used when user is selecting text
 306     wxPoint     m_tmpSelFromPos;
 307     wxHtmlCell *m_tmpSelFromCell;
 308
 309     // a flag indicated if mouse moved
 310     // (if TRUE we will try to change cursor in last call to OnIdle)
 311     bool m_tmpMouseMoved;
 312     // contains last link name
 313     wxHtmlLinkInfo *m_tmpLastLink;
 314     // contains the last (terminal) cell which contained the mouse
 315     wxHtmlCell *m_tmpLastCell;
 316     // if >0 contents of the window is not redrawn
 317     // (in order to avoid ugly blinking)
 318     int m_tmpCanDrawLocks;
 319
 320     // list of HTML filters
 321     static wxList m_Filters;
 322     // this filter is used when no filter is able to read some file
 323     static wxHtmlFilter *m_DefaultFilter;
 324
 325     wxHtmlHistoryArray *m_History;
 326     // browser history
 327     int m_HistoryPos;
 328     // if this FLAG is false, items are not added to history
 329     bool m_HistoryOn;
 330
 331     // html processors array:
 332     wxHtmlProcessorList *m_Processors;
 333     static wxHtmlProcessorList *m_GlobalProcessors;
 334
 335     DECLARE_EVENT_TABLE()
 336     DECLARE_NO_COPY_CLASS(wxHtmlWindow)
 337 };
 338
 339
 340 #endif // wxUSE_HTML
 341
 342 #endif // _WX_HTMLWIN_H_
 343