X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0f11c2334567bd440bb2676f43d3376badc921f2..9869c26285dc51d13607cddaa04f65ce983653a5:/include/wx/html/htmlwin.h diff --git a/include/wx/html/htmlwin.h b/include/wx/html/htmlwin.h index d2a55a7695..176cc9a46d 100644 --- a/include/wx/html/htmlwin.h +++ b/include/wx/html/htmlwin.h @@ -1,8 +1,7 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: htmlwin.h +// Name: wx/html/htmlwin.h // Purpose: wxHtmlWindow class for parsing & displaying HTML // Author: Vaclav Slavik -// RCS-ID: $Id$ // Copyright: (c) 1999 Vaclav Slavik // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -28,10 +27,10 @@ class wxHtmlProcessor; class wxHtmlWinModule; class wxHtmlHistoryArray; class wxHtmlProcessorList; -class WXDLLIMPEXP_HTML wxHtmlWinAutoScrollTimer; -class WXDLLIMPEXP_HTML wxHtmlCellEvent; -class WXDLLIMPEXP_HTML wxHtmlLinkEvent; - +class WXDLLIMPEXP_FWD_HTML wxHtmlWinAutoScrollTimer; +class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent; +class WXDLLIMPEXP_FWD_HTML wxHtmlLinkEvent; +class WXDLLIMPEXP_FWD_CORE wxStatusBar; // wxHtmlWindow flags: #define wxHW_SCROLLBAR_NEVER 0x0002 @@ -195,7 +194,7 @@ protected: /** Called by HandleMouseClick when the user clicks on a cell. - Default behavior is to call wxHtmlWindowInterface::OnLinkClicked() + Default behaviour is to call wxHtmlWindowInterface::OnLinkClicked() if this cell corresponds to a hypertext link. @param cell the cell the mouse is over @@ -297,7 +296,8 @@ public: #if wxUSE_STATUSBAR // After(!) calling SetRelatedFrame, this sets statusbar slot where messages // will be displayed. Default is -1 = no messages. - void SetRelatedStatusBar(int bar); + void SetRelatedStatusBar(int index); + void SetRelatedStatusBar(wxStatusBar*, int index = 0); #endif // wxUSE_STATUSBAR // Sets fonts to be used when displaying HTML page. @@ -317,12 +317,14 @@ public: // when/if we have CSS support we could add other possibilities...) void SetBackgroundImage(const wxBitmap& bmpBg) { m_bmpBg = bmpBg; } +#if wxUSE_CONFIG // Saves custom settings into cfg config. it will use the path 'path' // if given, otherwise it will save info into currently selected path. // saved values : things set by SetFonts, SetBorders. virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString); // ... virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString); +#endif // wxUSE_CONFIG // Goes to previous/next page (in browsing history) // Returns true if successful, false otherwise @@ -355,7 +357,7 @@ public: // (depending on the information passed to SetRelatedFrame() method) virtual void OnSetTitle(const wxString& title); - // Called when user clicked on hypertext link. Default behavior is to + // Called when user clicked on hypertext link. Default behaviour is to // call LoadPage(loc) virtual void OnLinkClicked(const wxHtmlLinkInfo& link); @@ -399,8 +401,8 @@ protected: // actual size of window. This method also setup scrollbars void CreateLayout(); - void OnEraseBackground(wxEraseEvent& event); void OnPaint(wxPaintEvent& event); + void OnEraseBackground(wxEraseEvent& event); void OnSize(wxSizeEvent& event); void OnMouseMove(wxMouseEvent& event); void OnMouseDown(wxMouseEvent& event); @@ -443,7 +445,7 @@ protected: wxString DoSelectionToText(wxHtmlSelection *sel); -private: +public: // wxHtmlWindowInterface methods: virtual void SetHTMLWindowTitle(const wxString& title); virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link); @@ -467,25 +469,26 @@ protected: // is usually top one = all other cells are sub-cells of this one) wxHtmlContainerCell *m_Cell; // parser which is used to parse HTML input. - // Each wxHtmlWindow has it's own parser because sharing one global + // Each wxHtmlWindow has its own parser because sharing one global // parser would be problematic (because of reentrancy) wxHtmlWinParser *m_Parser; - // contains name of actualy opened page or empty string if no page opened + // contains name of actually opened page or empty string if no page opened wxString m_OpenedPage; // contains name of current anchor within m_OpenedPage wxString m_OpenedAnchor; - // contains title of actualy opened page or empty string if no tag + // contains title of actually opened page or empty string if no <TITLE> tag wxString m_OpenedPageTitle; // class for opening files (file system) wxFileSystem* m_FS; + // frame in which page title should be displayed & number of its statusbar + // reserved for usage with this html window 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; + int m_RelatedStatusBarIndex; + wxStatusBar* m_RelatedStatusBar; #endif // wxUSE_STATUSBAR + wxString m_TitleFormat; // borders (free space between text and window borders) // defaults to 10 pixels. @@ -508,8 +511,13 @@ protected: #endif // wxUSE_CLIPBOARD private: - // window content for double buffered rendering: - wxBitmap *m_backBuffer; + // erase the window background using m_bmpBg or just solid colour if we + // don't have any background image + void DoEraseBackground(wxDC& dc); + + // window content for double buffered rendering, may be invalid until it is + // really initialized in OnPaint() + wxBitmap m_backBuffer; // background image, may be invalid wxBitmap m_bmpBg; @@ -537,29 +545,23 @@ private: // if this FLAG is false, items are not added to history bool m_HistoryOn; - // a flag set if we need to erase background in OnPaint() (otherwise this - // is supposed to have been done in OnEraseBackground()) - bool m_eraseBgInOnPaint; + // Flag used to communicate between OnPaint() and OnEraseBackground(), see + // the comments near its use. + bool m_isBgReallyErased; // standard mouse cursors static wxCursor *ms_cursorLink; static wxCursor *ms_cursorText; DECLARE_EVENT_TABLE() - DECLARE_NO_COPY_CLASS(wxHtmlWindow) + wxDECLARE_NO_COPY_CLASS(wxHtmlWindow); }; +class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent; - - -BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_HTML, - wxEVT_COMMAND_HTML_CELL_CLICKED, 1000) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_HTML, - wxEVT_COMMAND_HTML_CELL_HOVER, 1001) - DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_HTML, - wxEVT_COMMAND_HTML_LINK_CLICKED, 1002) -END_DECLARE_EVENT_TYPES() +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_HTML_CELL_CLICKED, wxHtmlCellEvent ); +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_HTML_CELL_HOVER, wxHtmlCellEvent ); +wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_HTML_LINK_CLICKED, wxHtmlLinkEvent ); /*! @@ -612,7 +614,7 @@ class WXDLLIMPEXP_HTML wxHtmlLinkEvent : public wxCommandEvent public: wxHtmlLinkEvent() {} wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo) - : wxCommandEvent(wxEVT_COMMAND_HTML_LINK_CLICKED, id) + : wxCommandEvent(wxEVT_HTML_LINK_CLICKED, id) { m_linkInfo = linkinfo; } @@ -633,17 +635,22 @@ typedef void (wxEvtHandler::*wxHtmlCellEventFunction)(wxHtmlCellEvent&); typedef void (wxEvtHandler::*wxHtmlLinkEventFunction)(wxHtmlLinkEvent&); #define wxHtmlCellEventHandler(func) \ - (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHtmlCellEventFunction, &func) + wxEVENT_HANDLER_CAST(wxHtmlCellEventFunction, func) #define wxHtmlLinkEventHandler(func) \ - (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHtmlLinkEventFunction, &func) + wxEVENT_HANDLER_CAST(wxHtmlLinkEventFunction, func) #define EVT_HTML_CELL_CLICKED(id, fn) \ - wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn)) + wx__DECLARE_EVT1(wxEVT_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn)) #define EVT_HTML_CELL_HOVER(id, fn) \ - wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_HOVER, id, wxHtmlCellEventHandler(fn)) + wx__DECLARE_EVT1(wxEVT_HTML_CELL_HOVER, id, wxHtmlCellEventHandler(fn)) #define EVT_HTML_LINK_CLICKED(id, fn) \ - wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_LINK_CLICKED, id, wxHtmlLinkEventHandler(fn)) + wx__DECLARE_EVT1(wxEVT_HTML_LINK_CLICKED, id, wxHtmlLinkEventHandler(fn)) + +// old wxEVT_COMMAND_* constants +#define wxEVT_COMMAND_HTML_CELL_CLICKED wxEVT_HTML_CELL_CLICKED +#define wxEVT_COMMAND_HTML_CELL_HOVER wxEVT_HTML_CELL_HOVER +#define wxEVT_COMMAND_HTML_LINK_CLICKED wxEVT_HTML_LINK_CLICKED #endif // wxUSE_HTML