preparing wxHtmlWindow for text selection (highlighting works, mouse input and clipboard does not)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@20786 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2003-05-31 21:42:13 +00:00
parent 13005f1d1e
commit f65a786ffd
2 changed files with 154 additions and 46 deletions

View File

@@ -29,12 +29,89 @@ class WXDLLEXPORT wxHtmlLinkInfo;
class WXDLLEXPORT wxHtmlCell; class WXDLLEXPORT wxHtmlCell;
class WXDLLEXPORT wxHtmlContainerCell; class WXDLLEXPORT 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 WXDLLEXPORT wxHtmlSelection
{
public:
wxHtmlSelection()
: m_fromPos(wxDefaultPosition), m_toPos(wxDefaultPosition),
m_fromCell(NULL), m_toCell(NULL) {}
void Set(const wxPoint& fromPos, wxHtmlCell *fromCell,
const wxPoint& toPos, wxHtmlCell *toCell)
{
m_fromCell = fromCell;
m_toCell = toCell;
m_fromPos = fromPos;
m_toPos = toPos;
}
wxHtmlCell *GetFromCell() const { return m_fromCell; }
wxHtmlCell *GetToCell() const { return m_toCell; }
// these values are *relative* to From/To cell's origin:
const wxPoint& GetFromPos() const { return m_fromPos; }
const wxPoint& GetToPos() const { return m_toPos; }
const bool IsEmpty() const
{ return m_fromPos == wxDefaultPosition &&
m_toPos == wxDefaultPosition; }
private:
wxPoint m_fromPos, m_toPos;
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 WXDLLEXPORT wxHtmlRenderingState
{
public:
wxHtmlRenderingState(wxHtmlSelection *s)
: m_selection(s), m_selState(wxHTML_SEL_OUT) {}
wxHtmlSelection *GetSelection() const { return m_selection; }
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:
wxHtmlSelection *m_selection;
wxHtmlSelectionState m_selState;
wxColour m_fgColour, m_bgColour;
};
// Flags for wxHtmlCell::FindCellByPos
enum
{
wxHTML_FIND_TERMINAL = 0x0001,
wxHTML_FIND_NONTERMINAL = 0x0002
};
// ---------------------------------------------------------------------------
// wxHtmlCell // wxHtmlCell
// Internal data structure. It represents fragments of parsed HTML // Internal data structure. It represents fragments of parsed
// page - a word, picture, table, horizontal line and so on. // HTML page - a word, picture, table, horizontal line and so
// It is used by wxHtmlWindow to represent HTML page in memory. // on. It is used by wxHtmlWindow to represent HTML page in
//-------------------------------------------------------------------------------- // memory.
// ---------------------------------------------------------------------------
class WXDLLEXPORT wxHtmlCell : public wxObject class WXDLLEXPORT wxHtmlCell : public wxObject
@@ -55,8 +132,8 @@ public:
const wxString& GetId() const { return m_id; } const wxString& GetId() const { return m_id; }
void SetId(const wxString& id) { m_id = id; } void SetId(const wxString& id) { m_id = id; }
// returns the link associated with this cell. The position is position within // returns the link associated with this cell. The position is position
// the cell so it varies from 0 to m_Width, from 0 to m_Height // 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 virtual wxHtmlLinkInfo* GetLink(int WXUNUSED(x) = 0, int WXUNUSED(y) = 0) const
{ return m_Link; } { return m_Link; }
@@ -68,18 +145,24 @@ public:
void SetLink(const wxHtmlLinkInfo& link); void SetLink(const wxHtmlLinkInfo& link);
void SetNext(wxHtmlCell *cell) {m_Next = cell;} void SetNext(wxHtmlCell *cell) {m_Next = cell;}
// 1. adjust cell's width according to the fact that maximal possible width is w. // 1. adjust cell's width according to the fact that maximal possible width
// (this has sense when working with horizontal lines, tables etc.) // is w. (this has sense when working with horizontal lines, tables
// 2. prepare layout (=fill-in m_PosX, m_PosY (and sometime m_Height) members) // etc.)
// = place items to fit window, according to the width w // 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); virtual void Layout(int w);
// renders the cell // 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),
wxHtmlRenderingState& WXUNUSED(state)) {}
// proceed drawing actions in case the cell is not visible (scrolled out of screen). // proceed drawing actions in case the cell is not visible (scrolled out of
// This is needed to change fonts, colors and so on // screen). This is needed to change fonts, colors and so on.
virtual void DrawInvisible(wxDC& WXUNUSED(dc), int WXUNUSED(x), int WXUNUSED(y)) {} virtual void DrawInvisible(wxDC& WXUNUSED(dc),
int WXUNUSED(x), int WXUNUSED(y),
wxHtmlRenderingState& WXUNUSED(state)) {}
// This method returns pointer to the FIRST cell for that // This method returns pointer to the FIRST cell for that
// the condition // the condition
@@ -100,15 +183,17 @@ public:
// wxHtmlWidgetCell // wxHtmlWidgetCell
virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event); virtual void OnMouseClick(wxWindow *parent, int x, int y, const wxMouseEvent& event);
// This method used to adjust pagebreak position. The parameter is // This method used to adjust pagebreak position. The parameter is variable
// variable that contains y-coordinate of page break (= horizontal line that // that contains y-coordinate of page break (= horizontal line that should
// should not be crossed by words, images etc.). If this cell cannot be divided // 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 // into two pieces (each one on another page) then it moves the pagebreak
// few pixels up. // few pixels up.
// //
// Returned value : true if pagebreak was modified, false otherwise // Returned value : true if pagebreak was modified, false otherwise
// Usage : while (container->AdjustPagebreak(&p)) {} // Usage : while (container->AdjustPagebreak(&p)) {}
virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) 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 // Sets cell's behaviour on pagebreaks (see AdjustPagebreak). Default
// is true - the cell can be split on two pages // is true - the cell can be split on two pages
@@ -124,11 +209,13 @@ public:
// This if for internal usage only and may disappear in future versions! // 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 the terminal cell inside this cell at the given position (relative // Find a cell inside this cell positioned at the given coordinates
// to this cell) // (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
// Returns NULL if not found // nonterminal cells or both. In either case, returned cell is deepest
virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y) const; // cell in cells tree that contains [x,y].
virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
unsigned flags = wxHTML_FIND_TERMINAL) const;
protected: protected:
wxHtmlCell *m_Next; wxHtmlCell *m_Next;
@@ -167,7 +254,8 @@ class WXDLLEXPORT wxHtmlWordCell : public wxHtmlCell
{ {
public: public:
wxHtmlWordCell(const wxString& word, wxDC& dc); 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,
wxHtmlRenderingState& state);
protected: protected:
wxString m_Word; wxString m_Word;
@@ -177,11 +265,8 @@ protected:
//-------------------------------------------------------------------------------- // Container contains other cells, thus forming tree structure of rendering
// wxHtmlContainerCell // elements. Basic code of layout algorithm is contained in this class.
// Container - it contains other cells. Basic of layout algorithm.
//--------------------------------------------------------------------------------
class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell class WXDLLEXPORT wxHtmlContainerCell : public wxHtmlCell
{ {
public: public:
@@ -189,8 +274,10 @@ public:
~wxHtmlContainerCell(); ~wxHtmlContainerCell();
virtual void Layout(int w); virtual void Layout(int w);
virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
virtual void DrawInvisible(wxDC& dc, int x, int y); wxHtmlRenderingState& state);
virtual void DrawInvisible(wxDC& dc, int x, int y,
wxHtmlRenderingState& state);
virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const; virtual bool AdjustPagebreak(int *pagebreak, int *known_pagebreaks = NULL, int number_of_pages = 0) const;
// insert cell at the end of m_Cells list // insert cell at the end of m_Cells list
@@ -236,8 +323,15 @@ public:
// see comment in wxHtmlCell about this method // 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) const; virtual wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
unsigned flags = wxHTML_FIND_TERMINAL) const;
protected:
void UpdateRenderingStatePre(wxHtmlRenderingState& state,
wxHtmlCell *cell) const;
void UpdateRenderingStatePost(wxHtmlRenderingState& state,
wxHtmlCell *cell) const;
protected: protected:
int m_IndentLeft, m_IndentRight, m_IndentTop, m_IndentBottom; int m_IndentLeft, m_IndentRight, m_IndentTop, m_IndentBottom;
// indentation of subcells. There is always m_Indent pixels // indentation of subcells. There is always m_Indent pixels
@@ -278,8 +372,10 @@ class WXDLLEXPORT wxHtmlColourCell : public wxHtmlCell
{ {
public: public:
wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND) : wxHtmlCell() {m_Colour = clr; m_Flags = flags;} 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 Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
virtual void DrawInvisible(wxDC& dc, int x, int y); wxHtmlRenderingState& state);
virtual void DrawInvisible(wxDC& dc, int x, int y,
wxHtmlRenderingState& state);
protected: protected:
wxColour m_Colour; wxColour m_Colour;
@@ -298,8 +394,10 @@ class WXDLLEXPORT wxHtmlFontCell : public wxHtmlCell
{ {
public: public:
wxHtmlFontCell(wxFont *font) : wxHtmlCell() { m_Font = (*font); } wxHtmlFontCell(wxFont *font) : wxHtmlCell() { m_Font = (*font); }
virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
virtual void DrawInvisible(wxDC& dc, int x, int y); wxHtmlRenderingState& state);
virtual void DrawInvisible(wxDC& dc, int x, int y,
wxHtmlRenderingState& state);
protected: protected:
wxFont m_Font; wxFont m_Font;
@@ -326,8 +424,10 @@ public:
// (w is percent of parent's width) // (w is percent of parent's width)
wxHtmlWidgetCell(wxWindow *wnd, int w = 0); wxHtmlWidgetCell(wxWindow *wnd, int w = 0);
~wxHtmlWidgetCell() { m_Wnd->Destroy(); } ~wxHtmlWidgetCell() { m_Wnd->Destroy(); }
virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2); virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
virtual void DrawInvisible(wxDC& dc, int x, int y); wxHtmlRenderingState& state);
virtual void DrawInvisible(wxDC& dc, int x, int y,
wxHtmlRenderingState& state);
virtual void Layout(int w); virtual void Layout(int w);
protected: protected:

View File

@@ -37,6 +37,10 @@ class wxHtmlProcessorList;
// wxHtmlWindow flags: // wxHtmlWindow flags:
#define wxHW_SCROLLBAR_NEVER 0x0002 #define wxHW_SCROLLBAR_NEVER 0x0002
#define wxHW_SCROLLBAR_AUTO 0x0004 #define wxHW_SCROLLBAR_AUTO 0x0004
#define wxHW_NO_SELECTION 0x0008
#define wxHW_DEFAULT_STYLE wxHW_SCROLLBAR_AUTO
// enums for wxHtmlWindow::OnOpeningURL // enums for wxHtmlWindow::OnOpeningURL
enum wxHtmlOpeningStatus enum wxHtmlOpeningStatus
@@ -46,16 +50,16 @@ enum wxHtmlOpeningStatus
wxHTML_REDIRECT wxHTML_REDIRECT
}; };
//-------------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// wxHtmlWindow // wxHtmlWindow
// (This is probably the only class you will directly use.) // (This is probably the only class you will directly use.)
// Purpose of this class is to display HTML page (either local // Purpose of this class is to display HTML page (either local
// file or downloaded via HTTP protocol) in a window. Width // file or downloaded via HTTP protocol) in a window. Width of
// of window is constant - given in constructor - virtual height // window is constant - given in constructor - virtual height
// is changed dynamicly depending on page size. // is changed dynamicly depending on page size. Once the
// Once the window is created you can set it's content by calling // window is created you can set it's content by calling
// SetPage(text) or LoadPage(filename). // SetPage(text) or LoadPage(filename).
//-------------------------------------------------------------------------------- // ----------------------------------------------------------------------------
class WXDLLEXPORT wxHtmlWindow : public wxScrolledWindow class WXDLLEXPORT wxHtmlWindow : public wxScrolledWindow
{ {
@@ -67,7 +71,7 @@ public:
wxHtmlWindow(wxWindow *parent, wxWindowID id = -1, wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxHW_SCROLLBAR_AUTO, long style = wxHW_DEFAULT_STYLE,
const wxString& name = wxT("htmlWindow")) const wxString& name = wxT("htmlWindow"))
{ {
Init(); Init();
@@ -214,6 +218,10 @@ protected:
// cleans static variables // cleans static variables
static void CleanUpStatics(); static void CleanUpStatics();
// Returns true if text selection is enabled (wxClipboard must be available
// and wxHW_NO_SELECTION not used)
bool IsSelectionEnabled() const;
protected: protected:
// This is pointer to the first cell in parsed data. // This is pointer to the first cell in parsed data.
// (Note: the first cell is usually top one = all other cells are sub-cells of this one) // (Note: the first cell is usually top one = all other cells are sub-cells of this one)