/////////////////////////////////////////////////////////////////////////////
-// Name: htmlwin.h
+// Name: wx/html/htmlwin.h
// Purpose: wxHtmlWindow class for parsing & displaying HTML
// Author: Vaclav Slavik
// RCS-ID: $Id$
class wxHtmlWinModule;
class wxHtmlHistoryArray;
class wxHtmlProcessorList;
-class WXDLLIMPEXP_HTML wxHtmlWinAutoScrollTimer;
-
+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
*/
class WXDLLIMPEXP_HTML wxHtmlWindowMouseHelper
{
-public:
+protected:
/**
Ctor.
*/
wxHtmlWindowMouseHelper(wxHtmlWindowInterface *iface);
+ /**
+ Virtual dtor.
+
+ It is not really needed in this case but at leats it prevents gcc from
+ complaining about its absence.
+ */
+ virtual ~wxHtmlWindowMouseHelper() { }
+
/// Returns true if the mouse moved since the last call to HandleIdle
bool DidMouseMove() const { return m_tmpMouseMoved; }
/**
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
class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow,
public wxHtmlWindowInterface,
- private wxHtmlWindowMouseHelper
+ public wxHtmlWindowMouseHelper
{
DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
friend class wxHtmlWinModule;
Init();
Create(parent, id, pos, size, style, name);
}
- ~wxHtmlWindow();
+ virtual ~wxHtmlWindow();
bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
#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.
// 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
// (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);
// actual size of window. This method also setup scrollbars
void CreateLayout();
- void OnEraseBackground(wxEraseEvent& event);
void OnPaint(wxPaintEvent& event);
void OnSize(wxSizeEvent& event);
void OnMouseMove(wxMouseEvent& event);
void OnKeyUp(wxKeyEvent& event);
void OnDoubleClick(wxMouseEvent& event);
void OnCopy(wxCommandEvent& event);
+ void OnClipboardEvent(wxClipboardTextEvent& event);
void OnMouseEnter(wxMouseEvent& event);
void OnMouseLeave(wxMouseEvent& event);
+ void OnMouseCaptureLost(wxMouseCaptureLostEvent& event);
#endif // wxUSE_CLIPBOARD
// Returns new filter (will be stored into m_DefaultFilter variable)
wxString DoSelectionToText(wxHtmlSelection *sel);
-private:
+public:
// wxHtmlWindowInterface methods:
virtual void SetHTMLWindowTitle(const wxString& title);
virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link);
// 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 <TITLE> 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.
int m_Borders;
- int m_Style;
-
// current text selection or NULL
wxHtmlSelection *m_selection;
#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;
// 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;
-
// 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;
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_CLICKED, wxHtmlCellEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_HOVER, wxHtmlCellEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_LINK_CLICKED, wxHtmlLinkEvent );
+
+
+/*!
+ * Html cell window event
+ */
+
+class WXDLLIMPEXP_HTML wxHtmlCellEvent : public wxCommandEvent
+{
+public:
+ wxHtmlCellEvent() {}
+ wxHtmlCellEvent(wxEventType commandType, int id,
+ wxHtmlCell *cell, const wxPoint &pt,
+ const wxMouseEvent &ev)
+ : wxCommandEvent(commandType, id)
+ {
+ m_cell = cell;
+ m_pt = pt;
+ m_mouseEvent = ev;
+ m_bLinkWasClicked = false;
+ }
+
+ wxHtmlCell* GetCell() const { return m_cell; }
+ wxPoint GetPoint() const { return m_pt; }
+ wxMouseEvent GetMouseEvent() const { return m_mouseEvent; }
+
+ void SetLinkClicked(bool linkclicked) { m_bLinkWasClicked=linkclicked; }
+ bool GetLinkClicked() const { return m_bLinkWasClicked; }
+
+ // default copy ctor, assignment operator and dtor are ok
+ virtual wxEvent *Clone() const { return new wxHtmlCellEvent(*this); }
+
+private:
+ wxHtmlCell *m_cell;
+ wxMouseEvent m_mouseEvent;
+ wxPoint m_pt;
+
+ bool m_bLinkWasClicked;
+
+ DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlCellEvent)
+};
+
+
+
+/*!
+ * Html link event
+ */
+
+class WXDLLIMPEXP_HTML wxHtmlLinkEvent : public wxCommandEvent
+{
+public:
+ wxHtmlLinkEvent() {}
+ wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo)
+ : wxCommandEvent(wxEVT_COMMAND_HTML_LINK_CLICKED, id)
+ {
+ m_linkInfo = linkinfo;
+ }
+
+ const wxHtmlLinkInfo &GetLinkInfo() const { return m_linkInfo; }
+
+ // default copy ctor, assignment operator and dtor are ok
+ virtual wxEvent *Clone() const { return new wxHtmlLinkEvent(*this); }
+
+private:
+ wxHtmlLinkInfo m_linkInfo;
+
+ DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlLinkEvent)
+};
+
+
+typedef void (wxEvtHandler::*wxHtmlCellEventFunction)(wxHtmlCellEvent&);
+typedef void (wxEvtHandler::*wxHtmlLinkEventFunction)(wxHtmlLinkEvent&);
+
+#define wxHtmlCellEventHandler(func) \
+ wxEVENT_HANDLER_CAST(wxHtmlCellEventFunction, func)
+#define wxHtmlLinkEventHandler(func) \
+ wxEVENT_HANDLER_CAST(wxHtmlLinkEventFunction, func)
+
+#define EVT_HTML_CELL_CLICKED(id, fn) \
+ wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn))
+#define EVT_HTML_CELL_HOVER(id, fn) \
+ wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_HOVER, id, wxHtmlCellEventHandler(fn))
+#define EVT_HTML_LINK_CLICKED(id, fn) \
+ wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_LINK_CLICKED, id, wxHtmlLinkEventHandler(fn))
+
#endif // wxUSE_HTML
projects / wxWidgets.git / blobdiff