X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ca16b7a98e70752eb57448571d7223052834550f..2a45803fc3877afd0ae3ce356dfe216505165882:/include/wx/html/htmlcell.h diff --git a/include/wx/html/htmlcell.h b/include/wx/html/htmlcell.h index 312b50634e..328aefce8a 100644 --- a/include/wx/html/htmlcell.h +++ b/include/wx/html/htmlcell.h @@ -1,21 +1,16 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: htmlcell.h +// Name: wx/html/htmlcell.h // Purpose: wxHtmlCell class is used by wxHtmlWindow/wxHtmlWinParser // as a basic visual element of HTML page // Author: Vaclav Slavik // RCS-ID: $Id$ // Copyright: (c) 1999-2003 Vaclav Slavik -// Licence: wxWindows Licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// - #ifndef _WX_HTMLCELL_H_ #define _WX_HTMLCELL_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "htmlcell.h" -#endif - #include "wx/defs.h" #if wxUSE_HTML @@ -25,9 +20,10 @@ #include "wx/window.h" -class WXDLLIMPEXP_HTML wxHtmlLinkInfo; -class WXDLLIMPEXP_HTML wxHtmlCell; -class WXDLLIMPEXP_HTML wxHtmlContainerCell; +class WXDLLIMPEXP_FWD_HTML wxHtmlWindowInterface; +class WXDLLIMPEXP_FWD_HTML wxHtmlLinkInfo; +class WXDLLIMPEXP_FWD_HTML wxHtmlCell; +class WXDLLIMPEXP_FWD_HTML wxHtmlContainerCell; // wxHtmlSelection is data holder with information about text selection. @@ -36,36 +32,39 @@ class WXDLLIMPEXP_HTML wxHtmlContainerCell; class WXDLLIMPEXP_HTML wxHtmlSelection { public: - wxHtmlSelection() + wxHtmlSelection() : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition), - m_fromPrivPos(wxDefaultPosition), m_toPrivPos(wxDefaultPosition), + m_fromCharacterPos(-1), m_toCharacterPos(-1), m_fromCell(NULL), m_toCell(NULL) {} + // this version is used for the user selection defined with the mouse void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell, const wxPoint& toPos, const wxHtmlCell *toCell); void Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell); - + const wxHtmlCell *GetFromCell() const { return m_fromCell; } const wxHtmlCell *GetToCell() const { return m_toCell; } - + // these values are in absolute coordinates: const wxPoint& GetFromPos() const { return m_fromPos; } const wxPoint& GetToPos() const { return m_toPos; } - + // these are From/ToCell's private data - const wxPoint& GetFromPrivPos() const { return m_fromPrivPos; } - const wxPoint& GetToPrivPos() const { return m_toPrivPos; } - void SetFromPrivPos(const wxPoint& pos) { m_fromPrivPos = pos; } - void SetToPrivPos(const wxPoint& pos) { m_toPrivPos = pos; } - void ClearPrivPos() { m_toPrivPos = m_fromPrivPos = wxDefaultPosition; } - - const bool IsEmpty() const - { return m_fromPos == wxDefaultPosition && + void ClearFromToCharacterPos() { m_toCharacterPos = m_fromCharacterPos = -1; } + bool AreFromToCharacterPosSet() const { return m_toCharacterPos != -1 && m_fromCharacterPos != -1; } + + void SetFromCharacterPos (wxCoord pos) { m_fromCharacterPos = pos; } + void SetToCharacterPos (wxCoord pos) { m_toCharacterPos = pos; } + wxCoord GetFromCharacterPos () const { return m_fromCharacterPos; } + wxCoord GetToCharacterPos () const { return m_toCharacterPos; } + + bool IsEmpty() const + { return m_fromPos == wxDefaultPosition && m_toPos == wxDefaultPosition; } private: wxPoint m_fromPos, m_toPos; - wxPoint m_fromPrivPos, m_toPrivPos; + wxCoord m_fromCharacterPos, m_toCharacterPos; const wxHtmlCell *m_fromCell, *m_toCell; }; @@ -85,17 +84,20 @@ class WXDLLIMPEXP_HTML wxHtmlRenderingState public: wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT) {} - void SetSelectionState(wxHtmlSelectionState s) { m_selState = s; } + void SetSelectionState(wxHtmlSelectionState s) { m_selState = s; } wxHtmlSelectionState GetSelectionState() const { return m_selState; } void SetFgColour(const wxColour& c) { m_fgColour = c; } const wxColour& GetFgColour() const { return m_fgColour; } void SetBgColour(const wxColour& c) { m_bgColour = c; } const wxColour& GetBgColour() const { return m_bgColour; } - + void SetBgMode(int m) { m_bgMode = m; } + int GetBgMode() const { return m_bgMode; } + private: wxHtmlSelectionState m_selState; wxColour m_fgColour, m_bgColour; + int m_bgMode; }; @@ -104,6 +106,7 @@ private: class WXDLLIMPEXP_HTML wxHtmlRenderingStyle { public: + virtual ~wxHtmlRenderingStyle() {} virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0; virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0; }; @@ -127,12 +130,12 @@ public: void SetSelection(wxHtmlSelection *s) { m_selection = s; } wxHtmlSelection *GetSelection() const { return m_selection; } - + void SetStyle(wxHtmlRenderingStyle *style) { m_style = style; } wxHtmlRenderingStyle& GetStyle() { return *m_style; } wxHtmlRenderingState& GetState() { return m_state; } - + protected: wxHtmlSelection *m_selection; wxHtmlRenderingStyle *m_style; @@ -149,6 +152,13 @@ enum }; +// Superscript/subscript/normal script mode of a cell +enum wxHtmlScriptMode +{ + wxHTML_SCRIPT_NORMAL, + wxHTML_SCRIPT_SUB, + wxHTML_SCRIPT_SUP +}; // --------------------------------------------------------------------------- @@ -172,7 +182,7 @@ public: int GetPosX() const {return m_PosX;} int GetPosY() const {return m_PosY;} int GetWidth() const {return m_Width;} - + // Returns the maximum possible length of the cell. // Call Layout at least once before using GetMaxTotalWidth() virtual int GetMaxTotalWidth() const { return m_Width; } @@ -180,6 +190,10 @@ public: int GetHeight() const {return m_Height;} int GetDescent() const {return m_Descent;} + void SetScriptMode(wxHtmlScriptMode mode, long previousBase); + wxHtmlScriptMode GetScriptMode() const { return m_ScriptMode; } + long GetScriptBaseline() { return m_ScriptBaseline; } + // Formatting cells are not visible on the screen, they only alter // renderer's state. bool IsFormattingCell() const { return m_Width == 0 && m_Height == 0; } @@ -194,7 +208,12 @@ public: { return m_Link; } // Returns cursor to be used when mouse is over the cell: + virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const; + +#if WXWIN_COMPATIBILITY_2_6 + // this was replaced by GetMouseCursor, don't use in new code! virtual wxCursor GetCursor() const; +#endif // return next cell among parent's cells wxHtmlCell *GetNext() const {return m_Next;} @@ -237,12 +256,23 @@ public: // returns pointer to anchor news virtual const wxHtmlCell* Find(int condition, const void* param) const; + // This function is called when mouse button is clicked over the cell. + // Returns true if a link is clicked, false otherwise. // - // Parent is pointer to wxHtmlWindow that generated the event + // 'window' is pointer to wxHtmlWindowInterface of the window which + // generated the event. // HINT: if this handling is not enough for you you should use // wxHtmlWidgetCell - virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event); + virtual bool ProcessMouseClick(wxHtmlWindowInterface *window, + const wxPoint& pos, + const wxMouseEvent& event); + +#if WXWIN_COMPATIBILITY_2_6 + // this was replaced by ProcessMouseClick, don't use in new code! + virtual void OnMouseClick(wxWindow *window, + int x, int y, const wxMouseEvent& event); +#endif // This method used to adjust pagebreak position. The parameter is variable // that contains y-coordinate of page break (= horizontal line that should @@ -253,20 +283,22 @@ public: // Returned value : true if pagebreak was modified, false otherwise // Usage : while (container->AdjustPagebreak(&p)) {} virtual bool AdjustPagebreak(int *pagebreak, - int *known_pagebreaks = NULL, - int number_of_pages = 0) const; + const wxArrayInt& known_pagebreaks, + int pageHeight) const; // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default // is true - the cell can be split on two pages + // If there is no way to fit a cell in the current page size, the cell + // is always split, ignoring this setting. void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; } - + // Can the line be broken before this cell? virtual bool IsLinebreakAllowed() const { return !IsFormattingCell(); } // Returns true for simple == terminal cells, i.e. not composite ones. // This if for internal usage only and may disappear in future versions! - virtual bool IsTerminalCell() const { return TRUE; } + virtual bool IsTerminalCell() const { return true; } // Find a cell inside this cell positioned at the given coordinates // (relative to this's positions). Returns NULL if no such cell exists. @@ -276,49 +308,60 @@ public: virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y, unsigned flags = wxHTML_FIND_EXACT) const; - // Returns absolute position of the cell on HTML canvas - wxPoint GetAbsPos() const; + // Returns absolute position of the cell on HTML canvas. + // If rootCell is provided, then it's considered to be the root of the + // hierarchy and the returned value is relative to it. + wxPoint GetAbsPos(wxHtmlCell *rootCell = NULL) const; + + // Returns root cell of the hierarchy (i.e. grand-grand-...-parent that + // doesn't have a parent itself) + wxHtmlCell *GetRootCell() const; // Returns first (last) terminal cell inside this cell. It may return NULL, // but it is rare -- only if there are no terminals in the tree. - virtual wxHtmlCell *GetFirstTerminal() const + virtual wxHtmlCell *GetFirstTerminal() const { return wxConstCast(this, wxHtmlCell); } - virtual wxHtmlCell *GetLastTerminal() const + virtual wxHtmlCell *GetLastTerminal() const { return wxConstCast(this, wxHtmlCell); } // Returns cell's depth, i.e. how far under the root cell it is // (if it is the root, depth is 0) unsigned GetDepth() const; - + // Returns true if the cell appears before 'cell' in natural order of // cells (= as they are read). If cell A is (grand)parent of cell B, // then both A.IsBefore(B) and B.IsBefore(A) always return true. bool IsBefore(wxHtmlCell *cell) const; - + // Converts the cell into text representation. If sel != NULL then // only part of the cell inside the selection is converted. virtual wxString ConvertToText(wxHtmlSelection *WXUNUSED(sel)) const { return wxEmptyString; } protected: + // pointer to the next cell wxHtmlCell *m_Next; - // pointer to the next cell + // pointer to parent cell wxHtmlContainerCell *m_Parent; - // pointer to parent cell + + // dimensions of fragment (m_Descent is used to position text & images) long m_Width, m_Height, m_Descent; - // dimensions of fragment - // m_Descent is used to position text&images.. + // position where the fragment is drawn: long m_PosX, m_PosY; - // position where the fragment is drawn + + // superscript/subscript/normal: + wxHtmlScriptMode m_ScriptMode; + long m_ScriptBaseline; + + // destination address if this fragment is hypertext link, NULL otherwise wxHtmlLinkInfo *m_Link; - // destination address if this fragment is hypertext link, NULL otherwise + // true if this cell can be placed on pagebreak, false otherwise bool m_CanLiveOnPagebreak; - // true if this cell can be placed on pagebreak, false otherwise + // unique identifier of the cell, generated from "id" property of tags wxString m_id; - // unique identifier of the cell, generated from "id" property of tags DECLARE_ABSTRACT_CLASS(wxHtmlCell) - DECLARE_NO_COPY_CLASS(wxHtmlCell) + wxDECLARE_NO_COPY_CLASS(wxHtmlCell); }; @@ -337,30 +380,56 @@ protected: class WXDLLIMPEXP_HTML wxHtmlWordCell : public wxHtmlCell { public: - wxHtmlWordCell(const wxString& word, wxDC& dc); + wxHtmlWordCell(const wxString& word, const wxDC& dc); void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2, wxHtmlRenderingInfo& info); - wxCursor GetCursor() const; - wxString ConvertToText(wxHtmlSelection *sel) const; + virtual wxCursor GetMouseCursor(wxHtmlWindowInterface *window) const; + virtual wxString ConvertToText(wxHtmlSelection *sel) const; bool IsLinebreakAllowed() const { return m_allowLinebreak; } void SetPreviousWord(wxHtmlWordCell *cell); protected: - void SetSelectionPrivPos(wxDC& dc, wxHtmlSelection *s) const; - void Split(wxDC& dc, + virtual wxString GetAllAsText() const + { return m_Word; } + virtual wxString GetPartAsText(int begin, int end) const + { return m_Word.Mid(begin, end - begin); } + + void SetSelectionPrivPos(const wxDC& dc, wxHtmlSelection *s) const; + void Split(const wxDC& dc, const wxPoint& selFrom, const wxPoint& selTo, unsigned& pos1, unsigned& pos2) const; - + wxString m_Word; bool m_allowLinebreak; DECLARE_ABSTRACT_CLASS(wxHtmlWordCell) - DECLARE_NO_COPY_CLASS(wxHtmlWordCell) + wxDECLARE_NO_COPY_CLASS(wxHtmlWordCell); }; +// wxHtmlWordCell specialization for storing text fragments with embedded +// '\t's; these differ from normal words in that the displayed text is +// different from the text copied to clipboard +class WXDLLIMPEXP_HTML wxHtmlWordWithTabsCell : public wxHtmlWordCell +{ +public: + wxHtmlWordWithTabsCell(const wxString& word, + const wxString& wordOrig, + size_t linepos, + const wxDC& dc) + : wxHtmlWordCell(word, dc), + m_wordOrig(wordOrig), + m_linepos(linepos) + {} + +protected: + virtual wxString GetAllAsText() const; + virtual wxString GetPartAsText(int begin, int end) const; + wxString m_wordOrig; + size_t m_linepos; +}; // Container contains other cells, thus forming tree structure of rendering @@ -369,14 +438,17 @@ class WXDLLIMPEXP_HTML wxHtmlContainerCell : public wxHtmlCell { public: wxHtmlContainerCell(wxHtmlContainerCell *parent); - ~wxHtmlContainerCell(); + virtual ~wxHtmlContainerCell(); virtual void Layout(int w); virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2, wxHtmlRenderingInfo& info); virtual void DrawInvisible(wxDC& dc, int x, int y, wxHtmlRenderingInfo& info); - virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const; + + virtual bool AdjustPagebreak(int *pagebreak, + const wxArrayInt& known_pagebreaks, + int pageHeight) const; // insert cell at the end of m_Cells list void InsertCell(wxHtmlCell *cell); @@ -405,33 +477,41 @@ public: // sets minimal height of this container. void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP) {m_MinHeight = h; m_MinHeightAlign = align; m_LastLayout = -1;} - void SetBackgroundColour(const wxColour& clr) {m_UseBkColour = TRUE; m_BkColour = clr;} + void SetBackgroundColour(const wxColour& clr) {m_UseBkColour = true; m_BkColour = clr;} // returns background colour (of wxNullColour if none set), so that widgets can // adapt to it: wxColour GetBackgroundColour(); - void SetBorder(const wxColour& clr1, const wxColour& clr2) {m_UseBorder = TRUE; m_BorderColour1 = clr1, m_BorderColour2 = clr2;} + void SetBorder(const wxColour& clr1, const wxColour& clr2, int border = 1) {m_Border = border; m_BorderColour1 = clr1, m_BorderColour2 = clr2;} virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0) const; virtual const wxHtmlCell* Find(int condition, const void* param) const; - virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event); - virtual wxHtmlCell* GetFirstChild() const { return m_Cells; } -#if WXWIN_COMPATIBILITY_2_4 - wxDEPRECATED( wxHtmlCell* GetFirstCell() const ); +#if WXWIN_COMPATIBILITY_2_6 + // this was replaced by ProcessMouseClick, don't use in new code! + virtual void OnMouseClick(wxWindow *window, + int x, int y, const wxMouseEvent& event); #endif + virtual bool ProcessMouseClick(wxHtmlWindowInterface *window, + const wxPoint& pos, + const wxMouseEvent& event); + + virtual wxHtmlCell* GetFirstChild() const { return m_Cells; } + + // returns last child cell: + wxHtmlCell* GetLastChild() const { return m_LastCell; } // see comment in wxHtmlCell about this method - virtual bool IsTerminalCell() const { return FALSE; } + virtual bool IsTerminalCell() const { return false; } virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y, unsigned flags = wxHTML_FIND_EXACT) const; - + virtual wxHtmlCell *GetFirstTerminal() const; virtual wxHtmlCell *GetLastTerminal() const; - - + + // Removes indentation on top or bottom of the container (i.e. above or // below first/last terminal cell). For internal use only. - void RemoveExtraSpacing(bool top, bool bottom); + virtual void RemoveExtraSpacing(bool top, bool bottom); // Returns the maximum possible length of the container. // Call Layout at least once before using GetMaxTotalWidth() @@ -442,7 +522,7 @@ protected: wxHtmlCell *cell) const; void UpdateRenderingStatePost(wxHtmlRenderingInfo& info, wxHtmlCell *cell) const; - + protected: int m_IndentLeft, m_IndentRight, m_IndentTop, m_IndentBottom; // indentation of subcells. There is always m_Indent pixels @@ -460,7 +540,8 @@ protected: bool m_UseBkColour; wxColour m_BkColour; // background color of this container - bool m_UseBorder; + int m_Border; + // border size. Draw only if m_Border > 0 wxColour m_BorderColour1, m_BorderColour2; // borders color of this container int m_LastLayout; @@ -469,17 +550,11 @@ protected: int m_MaxTotalWidth; // Maximum possible length if ignoring line wrap - + DECLARE_ABSTRACT_CLASS(wxHtmlContainerCell) - DECLARE_NO_COPY_CLASS(wxHtmlContainerCell) + wxDECLARE_NO_COPY_CLASS(wxHtmlContainerCell); }; -#if WXWIN_COMPATIBILITY_2_4 -inline wxHtmlCell* wxHtmlContainerCell::GetFirstCell() const - { return GetFirstChild(); } -#endif - - // --------------------------------------------------------------------------- @@ -501,7 +576,7 @@ protected: unsigned m_Flags; DECLARE_ABSTRACT_CLASS(wxHtmlColourCell) - DECLARE_NO_COPY_CLASS(wxHtmlColourCell) + wxDECLARE_NO_COPY_CLASS(wxHtmlColourCell); }; @@ -525,7 +600,7 @@ protected: wxFont m_Font; DECLARE_ABSTRACT_CLASS(wxHtmlFontCell) - DECLARE_NO_COPY_CLASS(wxHtmlFontCell) + wxDECLARE_NO_COPY_CLASS(wxHtmlFontCell); }; @@ -548,7 +623,7 @@ public: // it's width according to parent container's width // (w is percent of parent's width) wxHtmlWidgetCell(wxWindow *wnd, int w = 0); - ~wxHtmlWidgetCell() { m_Wnd->Destroy(); } + virtual ~wxHtmlWidgetCell() { m_Wnd->Destroy(); } virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2, wxHtmlRenderingInfo& info); virtual void DrawInvisible(wxDC& dc, int x, int y, @@ -561,7 +636,7 @@ protected: // width float is used in adjustWidth (it is in percents) DECLARE_ABSTRACT_CLASS(wxHtmlWidgetCell) - DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell) + wxDECLARE_NO_COPY_CLASS(wxHtmlWidgetCell); };