// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-
#ifndef _WX_HTMLWIN_H_
#define _WX_HTMLWIN_H_
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "htmlwin.h"
-#endif
-
#include "wx/defs.h"
#if wxUSE_HTML
#include "wx/window.h"
#include "wx/scrolwin.h"
#include "wx/config.h"
+#include "wx/stopwatch.h"
#include "wx/html/winpars.h"
#include "wx/html/htmlcell.h"
#include "wx/filesys.h"
#include "wx/html/htmlfilt.h"
#include "wx/filename.h"
+#include "wx/bitmap.h"
class wxHtmlProcessor;
class wxHtmlWinModule;
public:
wxHtmlWindow() { Init(); }
- wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
+ wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHW_DEFAULT_STYLE,
}
~wxHtmlWindow();
- bool Create(wxWindow *parent, wxWindowID id = -1,
+ bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHW_SCROLLBAR_AUTO,
// Set HTML page and display it. !! source is HTML document itself,
// it is NOT address/filename of HTML document. If you want to
// specify document location, use LoadPage() istead
- // Return value : FALSE if an error occured, TRUE otherwise
- bool SetPage(const wxString& source);
+ // Return value : false if an error occurred, true otherwise
+ virtual bool SetPage(const wxString& source);
// Append to current page
bool AppendToPage(const wxString& source);
void SetRelatedFrame(wxFrame* frame, const wxString& format);
wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
+#if wxUSE_STATUSBAR
// After(!) calling SetRelatedFrame, this sets statusbar slot where messages
// will be displayed. Default is -1 = no messages.
void SetRelatedStatusBar(int bar);
+#endif // wxUSE_STATUSBAR
// Sets fonts to be used when displaying HTML page.
- void SetFonts(wxString normal_face, wxString fixed_face,
+ void SetFonts(const wxString& normal_face, const wxString& fixed_face,
const int *sizes = NULL);
+ // Sets font sizes to be relative to the given size or the system
+ // default size; use either specified or default font
+ void SetStandardFonts(int size = -1,
+ const wxString& normal_face = wxEmptyString,
+ const wxString& fixed_face = wxEmptyString);
+
// Sets space between text and window borders.
void SetBorders(int b) {m_Borders = b;}
+ // Sets the bitmap to use for background (currnetly it will be tiled,
+ // when/if we have CSS support we could add other possibilities...)
+ void SetBackgroundImage(const wxBitmap& bmpBg) { m_bmpBg = bmpBg; }
+
// 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 WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
// Goes to previous/next page (in browsing history)
- // Returns TRUE if successful, FALSE otherwise
+ // Returns true if successful, false otherwise
bool HistoryBack();
bool HistoryForward();
bool HistoryCanBack();
// Adds HTML processor to wxHtmlWindow class as whole:
static void AddGlobalProcessor(wxHtmlProcessor *processor);
+
// -- Callbacks --
// Sets the title of the window
// Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
// loading a page or loading an image). The data are downloaded if and only if
- // OnOpeningURL returns TRUE. If OnOpeningURL returns wxHTML_REDIRECT,
+ // OnOpeningURL returns true. If OnOpeningURL returns wxHTML_REDIRECT,
// it must set *redirect to the new URL
virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
const wxString& WXUNUSED(url),
wxString *WXUNUSED(redirect)) const
{ return wxHTML_OPEN; }
-
+
#if wxUSE_CLIPBOARD
// Helper functions to select parts of page:
void SelectWord(const wxPoint& pos);
void SelectLine(const wxPoint& pos);
void SelectAll();
-
+
// Convert selection to text:
wxString SelectionToText() { return DoSelectionToText(m_selection); }
// Converts current page to text:
wxString ToText();
-#endif
+#endif // wxUSE_CLIPBOARD
+
+ virtual void OnInternalIdle();
- virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))
- { /* do nothing */ }
-
protected:
void Init();
// Scrolls to anchor of this name. (Anchor is #news
// or #features etc. it is part of address sometimes:
// http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
- // Return value : TRUE if anchor exists, FALSE otherwise
+ // Return value : true if anchor exists, false otherwise
bool ScrollToAnchor(const wxString& anchor);
// Prepares layout (= fill m_PosX, m_PosY for fragments) based on
void OnMouseLeave(wxMouseEvent& event);
#endif // wxUSE_CLIPBOARD
- virtual void OnInternalIdle();
-
// Returns new filter (will be stored into m_DefaultFilter variable)
virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
protected:
wxString DoSelectionToText(wxHtmlSelection *sel);
-
+
// 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)
wxHtmlContainerCell *m_Cell;
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;
+#endif // wxUSE_STATUSBAR
// borders (free space between text and window borders)
// defaults to 10 pixels.
#if wxUSE_CLIPBOARD
// time of the last doubleclick event, used to detect tripleclicks
// (tripleclicks are used to select whole line):
- wxLongLong m_lastDoubleClick;
+ wxMilliClock_t m_lastDoubleClick;
// helper class to automatically scroll the window if the user is selecting
// text and the mouse leaves wxHtmlWindow:
// window content for double buffered rendering:
wxBitmap *m_backBuffer;
+ // background image, may be invalid
+ wxBitmap m_bmpBg;
+
// variables used when user is selecting text
wxPoint m_tmpSelFromPos;
wxHtmlCell *m_tmpSelFromCell;
- // a flag indicated if mouse moved
- // (if TRUE we will try to change cursor in last call to OnIdle)
- bool m_tmpMouseMoved;
// contains last link name
wxHtmlLinkInfo *m_tmpLastLink;
// contains the last (terminal) cell which contained the mouse
// this filter is used when no filter is able to read some file
static wxHtmlFilter *m_DefaultFilter;
- wxHtmlHistoryArray *m_History;
+ // html processors array:
+ wxHtmlProcessorList *m_Processors;
+ static wxHtmlProcessorList *m_GlobalProcessors;
+
// browser history
+ wxHtmlHistoryArray *m_History;
int m_HistoryPos;
// if this FLAG is false, items are not added to history
bool m_HistoryOn;
- // html processors array:
- wxHtmlProcessorList *m_Processors;
- static wxHtmlProcessorList *m_GlobalProcessors;
+ // a flag indicated if mouse moved
+ // (if true we will try to change cursor in last call to OnIdle)
+ bool m_tmpMouseMoved;
+
+ // a flag set if we need to erase background in OnPaint() (otherwise this
+ // is supposed to have been done in OnEraseBackground())
+ bool m_eraseBgInOnPaint;
DECLARE_EVENT_TABLE()
DECLARE_NO_COPY_CLASS(wxHtmlWindow)
projects / wxWidgets.git / blobdiff