X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d50d561a0546773b0b4771528167572aaebd3838..d5d29b8a2250ee3097f31dfb8593374b89128ce2:/include/wx/html/htmlcell.h diff --git a/include/wx/html/htmlcell.h b/include/wx/html/htmlcell.h index 66ca0c2325..e3b1abce93 100644 --- a/include/wx/html/htmlcell.h +++ b/include/wx/html/htmlcell.h @@ -4,7 +4,7 @@ // as a basic visual element of HTML page // Author: Vaclav Slavik // RCS-ID: $Id$ -// Copyright: (c) 1999 Vaclav Slavik +// Copyright: (c) 1999-2003 Vaclav Slavik // Licence: wxWindows Licence ///////////////////////////////////////////////////////////////////////////// @@ -12,7 +12,7 @@ #ifndef _WX_HTMLCELL_H_ #define _WX_HTMLCELL_H_ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "htmlcell.h" #endif @@ -25,19 +25,142 @@ #include "wx/window.h" -class WXDLLEXPORT wxHtmlLinkInfo; -class WXDLLEXPORT wxHtmlCell; -class WXDLLEXPORT wxHtmlContainerCell; +class WXDLLIMPEXP_HTML wxHtmlLinkInfo; +class WXDLLIMPEXP_HTML wxHtmlCell; +class WXDLLIMPEXP_HTML wxHtmlContainerCell; -//-------------------------------------------------------------------------------- + +// wxHtmlSelection is data holder with information about text selection. +// Selection is defined by two positions (beginning and end of the selection) +// and two leaf(!) cells at these positions. +class WXDLLIMPEXP_HTML wxHtmlSelection +{ +public: + wxHtmlSelection() + : m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition), + m_fromPrivPos(wxDefaultPosition), m_toPrivPos(wxDefaultPosition), + m_fromCell(NULL), m_toCell(NULL) {} + + 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 && + m_toPos == wxDefaultPosition; } + +private: + wxPoint m_fromPos, m_toPos; + wxPoint m_fromPrivPos, m_toPrivPos; + const wxHtmlCell *m_fromCell, *m_toCell; +}; + + + +enum wxHtmlSelectionState +{ + wxHTML_SEL_OUT, // currently rendered cell is outside the selection + wxHTML_SEL_IN, // ... is inside selection + wxHTML_SEL_CHANGING // ... is the cell on which selection state changes +}; + +// Selection state is passed to wxHtmlCell::Draw so that it can render itself +// differently e.g. when inside text selection or outside it. +class WXDLLIMPEXP_HTML wxHtmlRenderingState +{ +public: + wxHtmlRenderingState() : m_selState(wxHTML_SEL_OUT) {} + + 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; } + +private: + wxHtmlSelectionState m_selState; + wxColour m_fgColour, m_bgColour; +}; + + +// HTML rendering customization. This class is used when rendering wxHtmlCells +// as a callback: +class WXDLLIMPEXP_HTML wxHtmlRenderingStyle +{ +public: + virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0; + virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0; +}; + +// Standard style: +class WXDLLIMPEXP_HTML wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle +{ +public: + virtual wxColour GetSelectedTextColour(const wxColour& clr); + virtual wxColour GetSelectedTextBgColour(const wxColour& clr); +}; + + +// Information given to cells when drawing them. Contains rendering state, +// selection information and rendering style object that can be used to +// customize the output. +class WXDLLIMPEXP_HTML wxHtmlRenderingInfo +{ +public: + wxHtmlRenderingInfo() : m_selection(NULL), m_style(NULL) {} + + 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; + wxHtmlRenderingState m_state; +}; + + +// Flags for wxHtmlCell::FindCellByPos +enum +{ + wxHTML_FIND_EXACT = 1, + wxHTML_FIND_NEAREST_BEFORE = 2, + wxHTML_FIND_NEAREST_AFTER = 4 +}; + + + + +// --------------------------------------------------------------------------- // wxHtmlCell -// Internal data structure. It represents fragments of parsed HTML -// page - a word, picture, table, horizontal line and so on. -// It is used by wxHtmlWindow to represent HTML page in memory. -//-------------------------------------------------------------------------------- +// Internal data structure. It represents fragments of parsed +// HTML page - a word, picture, table, horizontal line and so +// on. It is used by wxHtmlWindow to represent HTML page in +// memory. +// --------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlCell : public wxObject +class WXDLLIMPEXP_HTML wxHtmlCell : public wxObject { public: wxHtmlCell(); @@ -52,34 +175,50 @@ public: int GetHeight() const {return m_Height;} int GetDescent() const {return m_Descent;} + // Formatting cells are not visible on the screen, they only alter + // renderer's state. + bool IsFormattingCell() const { return m_Width == 0 && m_Height == 0; } + const wxString& GetId() const { return m_id; } void SetId(const wxString& id) { m_id = id; } - // returns the link associated with this cell. The position is position within - // the cell so it varies from 0 to m_Width, from 0 to m_Height - virtual wxHtmlLinkInfo* GetLink(int WXUNUSED(x) = 0, int WXUNUSED(y) = 0) const + // returns the link associated with this cell. The position is position + // within the cell so it varies from 0 to m_Width, from 0 to m_Height + virtual wxHtmlLinkInfo* GetLink(int WXUNUSED(x) = 0, + int WXUNUSED(y) = 0) const { return m_Link; } - // members access methods + // Returns cursor to be used when mouse is over the cell: + virtual wxCursor GetCursor() const; + + // return next cell among parent's cells wxHtmlCell *GetNext() const {return m_Next;} + // returns first child cell (if there are any, i.e. if this is container): + virtual wxHtmlCell* GetFirstChild() const { return NULL; } // members writing methods virtual void SetPos(int x, int y) {m_PosX = x, m_PosY = y;} void SetLink(const wxHtmlLinkInfo& link); void SetNext(wxHtmlCell *cell) {m_Next = cell;} - // 1. adjust cell's width according to the fact that maximal possible width is w. - // (this has sense when working with horizontal lines, tables etc.) - // 2. prepare layout (=fill-in m_PosX, m_PosY (and sometime m_Height) members) - // = place items to fit window, according to the width w + // 1. adjust cell's width according to the fact that maximal possible width + // is w. (this has sense when working with horizontal lines, tables + // etc.) + // 2. prepare layout (=fill-in m_PosX, m_PosY (and sometime m_Height) + // members) = place items to fit window, according to the width w virtual void Layout(int w); // renders the cell - virtual void Draw(wxDC& WXUNUSED(dc), int WXUNUSED(x), int WXUNUSED(y), int WXUNUSED(view_y1), int WXUNUSED(view_y2)) {} + virtual void Draw(wxDC& WXUNUSED(dc), + int WXUNUSED(x), int WXUNUSED(y), + int WXUNUSED(view_y1), int WXUNUSED(view_y2), + wxHtmlRenderingInfo& WXUNUSED(info)) {} - // proceed drawing actions in case the cell is not visible (scrolled out of screen). - // This is needed to change fonts, colors and so on - virtual void DrawInvisible(wxDC& WXUNUSED(dc), int WXUNUSED(x), int WXUNUSED(y)) {} + // proceed drawing actions in case the cell is not visible (scrolled out of + // screen). This is needed to change fonts, colors and so on. + virtual void DrawInvisible(wxDC& WXUNUSED(dc), + int WXUNUSED(x), int WXUNUSED(y), + wxHtmlRenderingInfo& WXUNUSED(info)) {} // This method returns pointer to the FIRST cell for that // the condition @@ -97,38 +236,64 @@ public: // // Parent is pointer to wxHtmlWindow that generated the event // HINT: if this handling is not enough for you you should use - // wxHtmlBinderCell + // wxHtmlWidgetCell virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event); - // This method used to adjust pagebreak position. The parameter is - // variable that contains y-coordinate of page break (= horizontal line that - // should not be crossed by words, images etc.). If this cell cannot be divided + // This method used to adjust pagebreak position. The parameter is variable + // that contains y-coordinate of page break (= horizontal line that should + // not be crossed by words, images etc.). If this cell cannot be divided // into two pieces (each one on another page) then it moves the pagebreak // few pixels up. // // Returned value : true if pagebreak was modified, false otherwise // Usage : while (container->AdjustPagebreak(&p)) {} - virtual bool AdjustPagebreak(int *pagebreak) const; + virtual bool AdjustPagebreak(int *pagebreak, + int *known_pagebreaks = NULL, + int number_of_pages = 0) const; // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default // is true - the cell can be split on two pages void SetCanLiveOnPagebreak(bool can) { m_CanLiveOnPagebreak = can; } - - // Returns y-coordinates that contraint the cell, i.e. left is highest - // and right lowest coordinate such that the cell lays between then. - // Note: this method does not return meaningful values if you haven't - // called Layout() before! - virtual void GetHorizontalConstraints(int *left, int *right) const; + + // 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; } - // Find the terminal cell inside this cell at the given position (relative - // to this cell) - // - // Returns NULL if not found - virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y) const; + // Find a cell inside this cell positioned at the given coordinates + // (relative to this's positions). Returns NULL if no such cell exists. + // The flag can be used to specify whether to look for terminal or + // nonterminal cells or both. In either case, returned cell is deepest + // cell in cells tree that contains [x,y]. + 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 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 + { return wxConstCast(this, wxHtmlCell); } + 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: wxHtmlCell *m_Next; @@ -146,50 +311,65 @@ protected: // true if this cell can be placed on pagebreak, false otherwise wxString m_id; // unique identifier of the cell, generated from "id" property of tags + + DECLARE_NO_COPY_CLASS(wxHtmlCell) }; -//-------------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- // Inherited cells: -//-------------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- -//-------------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- // wxHtmlWordCell // Single word in input stream. -//-------------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlWordCell : public wxHtmlCell +class WXDLLIMPEXP_HTML wxHtmlWordCell : public wxHtmlCell { public: wxHtmlWordCell(const wxString& word, wxDC& dc); - void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); + void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2, + wxHtmlRenderingInfo& info); + wxCursor GetCursor() const; + 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, + const wxPoint& selFrom, const wxPoint& selTo, + unsigned& pos1, unsigned& pos2) const; + wxString m_Word; -}; + bool m_allowLinebreak; + DECLARE_NO_COPY_CLASS(wxHtmlWordCell) +}; -//-------------------------------------------------------------------------------- -// wxHtmlContainerCell -// Container - it contains other cells. Basic of layout algorithm. -//-------------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell +// Container contains other cells, thus forming tree structure of rendering +// elements. Basic code of layout algorithm is contained in this class. +class WXDLLIMPEXP_HTML wxHtmlContainerCell : public wxHtmlCell { public: wxHtmlContainerCell(wxHtmlContainerCell *parent); ~wxHtmlContainerCell(); virtual void Layout(int w); - virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); - virtual void DrawInvisible(wxDC& dc, int x, int y); - virtual bool AdjustPagebreak(int *pagebreak) const; + 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; // insert cell at the end of m_Cells list void InsertCell(wxHtmlCell *cell); @@ -219,20 +399,39 @@ public: 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;} + // 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;} 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 void GetHorizontalConstraints(int *left, int *right) const; - // returns pointer to the first cell in container or NULL - wxHtmlCell* GetFirstCell() const {return m_Cells;} + virtual wxHtmlCell* GetFirstChild() const { return m_Cells; } +#if WXWIN_COMPATIBILITY_2_4 + wxDEPRECATED( wxHtmlCell* GetFirstCell() const ); +#endif // see comment in wxHtmlCell about this method virtual bool IsTerminalCell() const { return FALSE; } - virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y) const; + 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); +protected: + void UpdateRenderingStatePre(wxHtmlRenderingInfo& info, + 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 @@ -256,27 +455,37 @@ protected: int m_LastLayout; // if != -1 then call to Layout may be no-op // if previous call to Layout has same argument + + DECLARE_NO_COPY_CLASS(wxHtmlContainerCell) }; +#if WXWIN_COMPATIBILITY_2_4 +inline wxHtmlCell* wxHtmlContainerCell::GetFirstCell() const + { return GetFirstChild(); } +#endif -//-------------------------------------------------------------------------------- +// --------------------------------------------------------------------------- // wxHtmlColourCell // Color changer. -//-------------------------------------------------------------------------------- +// --------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlColourCell : public wxHtmlCell +class WXDLLIMPEXP_HTML wxHtmlColourCell : public wxHtmlCell { public: wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND) : wxHtmlCell() {m_Colour = clr; m_Flags = flags;} - virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); - virtual void DrawInvisible(wxDC& dc, int x, int y); + 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); protected: wxColour m_Colour; unsigned m_Flags; + + DECLARE_NO_COPY_CLASS(wxHtmlColourCell) }; @@ -287,15 +496,19 @@ protected: // Sets actual font used for text rendering //-------------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlFontCell : public wxHtmlCell +class WXDLLIMPEXP_HTML wxHtmlFontCell : public wxHtmlCell { public: wxHtmlFontCell(wxFont *font) : wxHtmlCell() { m_Font = (*font); } - virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); - virtual void DrawInvisible(wxDC& dc, int x, int y); + 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); protected: wxFont m_Font; + + DECLARE_NO_COPY_CLASS(wxHtmlFontCell) }; @@ -310,7 +523,7 @@ protected: // (buttons, input boxes etc.) //-------------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlWidgetCell : public wxHtmlCell +class WXDLLIMPEXP_HTML wxHtmlWidgetCell : public wxHtmlCell { public: // !!! wnd must have correct parent! @@ -319,14 +532,18 @@ public: // (w is percent of parent's width) wxHtmlWidgetCell(wxWindow *wnd, int w = 0); ~wxHtmlWidgetCell() { m_Wnd->Destroy(); } - virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); - virtual void DrawInvisible(wxDC& dc, int x, int y); + 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 void Layout(int w); protected: wxWindow* m_Wnd; int m_WidthFloat; // width float is used in adjustWidth (it is in percents) + + DECLARE_NO_COPY_CLASS(wxHtmlWidgetCell) }; @@ -336,7 +553,7 @@ protected: // Internal data structure. It represents hypertext link //-------------------------------------------------------------------------------- -class WXDLLEXPORT wxHtmlLinkInfo : public wxObject +class WXDLLIMPEXP_HTML wxHtmlLinkInfo : public wxObject { public: wxHtmlLinkInfo() : wxObject() @@ -366,6 +583,26 @@ private: +// ---------------------------------------------------------------------------- +// wxHtmlTerminalCellsInterator +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_HTML wxHtmlTerminalCellsInterator +{ +public: + wxHtmlTerminalCellsInterator(const wxHtmlCell *from, const wxHtmlCell *to) + : m_to(to), m_pos(from) {} + + operator bool() const { return m_pos != NULL; } + const wxHtmlCell* operator++(); + const wxHtmlCell* operator->() const { return m_pos; } + const wxHtmlCell* operator*() const { return m_pos; } + +private: + const wxHtmlCell *m_to, *m_pos; +}; + + #endif // wxUSE_HTML