It is used by @ref overview_handlers "tag handlers".
@library{wxhtml}
- @category{FIXME}
+ @category{html}
*/
class wxHtmlTag
{
-public:
+protected:
/**
Constructor. You will probably never have to construct a wxHtmlTag object
yourself. Feel free to ignore the constructor parameters.
int end_pos, wxHtmlTagsCache* cache,
wxHtmlEntitiesParser* entParser);
+public:
/**
Returns a string containing all parameters.
Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to
/**
Constructor. The parameters are the same as wxScrolled::wxScrolled()
constructor.
-
+
@param style
Window style. See wxHtmlWindow.
*/
/**
Appends HTML fragment to currently displayed text and refreshes the window.
-
+
@param source
HTML code fragment
-
+
@return @false if an error occurred, @true otherwise.
*/
bool AppendToPage(const wxString& source);
/**
Loads HTML page from file and displays it.
-
+
@return @false if an error occurred, @true otherwise
-
+
@see LoadPage()
*/
bool LoadFile(const wxFileName& filename);
/**
Unlike SetPage this function first loads HTML page from @a location
and then displays it. See example:
-
+
@param location
The address of document. See wxFileSystem for details on address format and
behaviour of "opener".
-
+
@return @false if an error occurred, @true otherwise
-
+
@see LoadFile()
*/
virtual bool LoadPage(const wxString& location);
- /**
- This method is called when a mouse button is clicked inside wxHtmlWindow.
- The default behaviour is to emit a wxHtmlCellEvent
- and, if the event was not processed or skipped, call
- OnLinkClicked() if the cell contains an
- hypertext link.
- Overloading this method is deprecated; intercept the event instead.
-
- @param cell
- The cell inside which the mouse was clicked, always a simple
- (i.e. non-container) cell
- @param x, y
- The logical coordinates of the click point
- @param event
- The mouse event containing other information about the click
-
- @return @true if a link was clicked, @false otherwise.
- */
- virtual bool OnCellClicked(wxHtmlCell cell, wxCoord x, wxCoord y,
- const wxMouseEvent& event);
-
- /**
- This method is called when a mouse moves over an HTML cell.
- Default behaviour is to emit a wxHtmlCellEvent.
- Overloading this method is deprecated; intercept the event instead.
-
- @param cell
- The cell inside which the mouse is currently, always a simple
- (i.e. non-container) cell
- @param x, y
- The logical coordinates of the click point
- */
- virtual void OnCellMouseHover(wxHtmlCell cell, wxCoord x,
- wxCoord y);
-
/**
Called when user clicks on hypertext link. Default behaviour is to emit a
wxHtmlLinkEvent and, if the event was not processed
You can override OnOpeningURL to selectively block some
URLs (e.g. for security reasons) or to redirect them elsewhere. Default
behaviour is to always return @c wxHTML_OPEN.
-
+
@param type
Indicates type of the resource. Is one of
-
-
-
-
-
-
+
+
+
+
+
+
wxHTML_URL_PAGE
-
-
-
-
+
+
+
+
Opening a HTML page.
-
-
-
-
-
+
+
+
+
+
wxHTML_URL_IMAGE
-
-
-
-
+
+
+
+
Opening an image.
-
-
-
-
-
+
+
+
+
+
wxHTML_URL_OTHER
-
-
-
-
+
+
+
+
Opening a resource that doesn't fall into
any other category.
@param url
if given, otherwise it saves info into currently selected path.
The values are stored in sub-path @c wxHtmlWindow
Read values: all things set by SetFonts, SetBorders.
-
+
@param cfg
wxConfig from which you want to read the configuration.
@param path
/**
Selects all text in the window.
-
+
@see SelectLine(), SelectWord()
*/
void SelectAll();
is relative to the top of displayed page, not to window's origin, use
wxScrolled::CalcUnscrolledPosition()
to convert physical coordinate.
-
+
@see SelectAll(), SelectWord()
*/
void SelectLine(const wxPoint& pos);
is relative to the top of displayed page, not to window's origin, use
wxScrolled::CalcUnscrolledPosition()
to convert physical coordinate.
-
+
@see SelectAll(), SelectLine()
*/
void SelectWord(const wxPoint& pos);
/**
This function sets the space between border of window and HTML contents. See
image:
-
+
@param b
indentation from borders in pixels
*/
/**
This function sets font sizes and faces.
-
+
@param normal_face
This is face name for normal (i.e. non-fixed) font.
It can be either empty string (then the default face is chosen) or
/**
Sets HTML page and display it. This won't @b load the page!!
It will display the @e source. See example:
-
+
If you want to load a document from some location use
LoadPage() instead.
-
+
@param source
The HTML document source to be displayed.
-
+
@return @false if an error occurred, @true otherwise.
*/
virtual bool SetPage(const wxString& source);
Regardless of whether the path is given or not, the function creates sub-path
@c wxHtmlWindow.
Saved values: all things set by SetFonts, SetBorders.
-
+
@param cfg
wxConfig to which you want to save the configuration.
@param path
*/
virtual void WriteCustomization(wxConfigBase cfg,
wxString path = wxEmptyString);
+
+protected:
+
+ /**
+ This method is called when a mouse button is clicked inside wxHtmlWindow.
+ The default behaviour is to emit a wxHtmlCellEvent
+ and, if the event was not processed or skipped, call
+ OnLinkClicked() if the cell contains an
+ hypertext link.
+ Overloading this method is deprecated; intercept the event instead.
+
+ @param cell
+ The cell inside which the mouse was clicked, always a simple
+ (i.e. non-container) cell
+ @param x, y
+ The logical coordinates of the click point
+ @param event
+ The mouse event containing other information about the click
+
+ @return @true if a link was clicked, @false otherwise.
+ */
+ virtual bool OnCellClicked(wxHtmlCell cell, wxCoord x, wxCoord y,
+ const wxMouseEvent& event);
+
+ /**
+ This method is called when a mouse moves over an HTML cell.
+ Default behaviour is to emit a wxHtmlCellEvent.
+ Overloading this method is deprecated; intercept the event instead.
+
+ @param cell
+ The cell inside which the mouse is currently, always a simple
+ (i.e. non-container) cell
+ @param x, y
+ The logical coordinates of the click point
+ */
+ virtual void OnCellMouseHover(wxHtmlCell cell, wxCoord x, wxCoord y);
};
*/
virtual wxColour GetSelectedTextColour(const wxColour& colFg) const;
- /**
- This method must be implemented in the derived class and should return
- the body (i.e. without @c html nor @c body tags) of the HTML fragment
- for the given item.
- Note that this function should always return a text fragment for the @a n item
- which renders with the same height both when it is selected and when it's not:
- i.e. if you call, inside your OnGetItem() implementation, @c IsSelected(n) to
- make the items appear differently when they are selected, then you should make
- sure
- that the returned HTML fragment will render with the same height or else you'll
- see some artifacts when the user selects an item.
- */
- wxString OnGetItem(size_t n) const;
-
/**
This function may be overridden to decorate HTML returned by
OnGetItem().
@see See also wxHtmlLinkInfo.
*/
virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);
+
+protected:
+ /**
+ This method must be implemented in the derived class and should return
+ the body (i.e. without @c html nor @c body tags) of the HTML fragment
+ for the given item.
+ Note that this function should always return a text fragment for the @a n item
+ which renders with the same height both when it is selected and when it's not:
+ i.e. if you call, inside your OnGetItem() implementation, @c IsSelected(n) to
+ make the items appear differently when they are selected, then you should make
+ sure
+ that the returned HTML fragment will render with the same height or else you'll
+ see some artifacts when the user selects an item.
+ */
+ wxString OnGetItem(size_t n) const;
};
*/
virtual bool CanSave() const;
- /**
- Override to load content from @a stream into @a buffer.
- */
- bool DoLoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
-
- /**
- Override to save content to @a stream from @a buffer.
- */
- bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
-
/**
Returns the encoding associated with the handler (if any).
*/
load and save dialogs).
*/
virtual void SetVisible(bool visible);
+
+protected:
+ /**
+ Override to load content from @a stream into @a buffer.
+ */
+ bool DoLoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
+
+ /**
+ Override to save content to @a stream from @a buffer.
+ */
+ bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
};
*/
virtual ~wxStackWalker();
- /**
- This function must be overrided to process the given frame.
- */
- void OnStackFrame(const wxStackFrame& frame);
-
/**
Enumerate stack frames from the current location, skipping the initial
number of them (this can be useful when Walk() is called from some known
Up to @a maxDepth frames are walked from the innermost to the outermost one.
*/
virtual void WalkFromException(size_t maxDepth = 200);
+
+protected:
+ /**
+ This function must be overrided to process the given frame.
+ */
+ void OnStackFrame(const wxStackFrame& frame);
};
*/
virtual ~wxThreadHelper();
- /**
- Creates a new thread.
-
- The thread object is created in the suspended state, and you
- should call @ref wxThread::Run GetThread()-Run to start running it.
-
- You may optionally specify the stack size to be allocated to it (ignored
- on platforms that don't support setting it explicitly, eg. Unix).
-
- @return One of the ::wxThreadError enum values.
- */
- wxThreadError Create(unsigned int stackSize = 0);
-
/**
This is the entry point of the thread.
*/
virtual ExitCode Entry();
+ /**
+ Creates a new thread.
+
+ The thread object is created in the suspended state, and you
+ should call @ref wxThread::Run GetThread()-Run to start running it.
+
+ You may optionally specify the stack size to be allocated to it (ignored
+ on platforms that don't support setting it explicitly, eg. Unix).
+
+ @return One of the ::wxThreadError enum values.
+ */
+ wxThreadError Create(unsigned int stackSize = 0);
+
/**
This is a public function that returns the wxThread object
associated with the thread.
*/
wxThreadError Delete();
- /**
- This is the entry point of the thread.
-
- This function is pure virtual and must be implemented by any derived class.
- The thread execution will start here.
-
- The returned value is the thread exit code which is only useful for
- joinable threads and is the value returned by Wait().
- This function is called by wxWidgets itself and should never be called
- directly.
- */
- virtual ExitCode Entry();
-
- /**
- This is a protected function of the wxThread class and thus can only be called
- from a derived class. It also can only be called in the context of this
- thread, i.e. a thread can only exit from itself, not from another thread.
-
- This function will terminate the OS thread (i.e. stop the associated path of
- execution) and also delete the associated C++ object for detached threads.
- OnExit() will be called just before exiting.
- */
- void Exit(ExitCode exitcode = 0);
-
/**
Returns the number of system CPUs or -1 if the value is unknown.
See also Sleep().
*/
static void Yield();
+
+protected:
+
+ /**
+ This is the entry point of the thread.
+
+ This function is pure virtual and must be implemented by any derived class.
+ The thread execution will start here.
+
+ The returned value is the thread exit code which is only useful for
+ joinable threads and is the value returned by Wait().
+ This function is called by wxWidgets itself and should never be called
+ directly.
+ */
+ virtual ExitCode Entry();
+
+ /**
+ This is a protected function of the wxThread class and thus can only be called
+ from a derived class. It also can only be called in the context of this
+ thread, i.e. a thread can only exit from itself, not from another thread.
+
+ This function will terminate the OS thread (i.e. stop the associated path of
+ execution) and also delete the associated C++ object for detached threads.
+ OnExit() will be called just before exiting.
+ */
+ void Exit(ExitCode exitcode = 0);
};
*/
virtual void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const;
- /**
- The derived class must implement this function to actually draw the
- item with the given index on the provided DC.
-
- @param dc
- The device context to use for drawing.
- @param rect
- The bounding rectangle for the item being drawn (DC clipping
- region is set to this rectangle before calling this function).
- @param n
- The index of the item to be drawn.
-
- @todo Change this function signature to non-const.
- */
- virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const;
-
/**
This method may be used to draw separators between the lines. The
rectangle passed to it may be modified, typically to deflate it a bit
*/
virtual void OnDrawSeparator(wxDC& dc, wxRect& rect, size_t n) const;
- /**
- The derived class must implement this method to return the height of
- the specified item (in pixels).
- */
- virtual wxCoord OnMeasureItem(size_t n) const;
-
/**
Selects or deselects the specified item which must be valid (i.e. not
equal to @c wxNOT_FOUND).
@see Select()
*/
void Toggle(size_t item);
+
+protected:
+
+ /**
+ The derived class must implement this function to actually draw the
+ item with the given index on the provided DC.
+
+ @param dc
+ The device context to use for drawing.
+ @param rect
+ The bounding rectangle for the item being drawn (DC clipping
+ region is set to this rectangle before calling this function).
+ @param n
+ The index of the item to be drawn.
+
+ @todo Change this function signature to non-const.
+ */
+ virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const;
+
+ /**
+ The derived class must implement this method to return the height of
+ the specified item (in pixels).
+ */
+ virtual wxCoord OnMeasureItem(size_t n) const;
};
*/
bool IsVisible(size_t unit) const;
- /**
- This function must be overridden in the derived class, and should
- return the size of the given unit in pixels.
- */
- virtual wxCoord OnGetUnitSize(size_t unit) const;
-
/**
This function doesn't have to be overridden but it may be useful to do
so if calculating the units' sizes is a relatively expensive operation
last item).
*/
int VirtualHitTest(wxCoord coord) const;
+
+
+protected:
+
+ /**
+ This function must be overridden in the derived class, and should
+ return the size of the given unit in pixels.
+ */
+ virtual wxCoord OnGetUnitSize(size_t unit) const;
};
*/
bool IsRowVisible(size_t row) const;
- /**
- This function must be overridden in the derived class, and should
- return the height of the given row in pixels.
- */
- virtual wxCoord OnGetRowHeight(size_t row) const;
-
/**
This function doesn't have to be overridden but it may be useful to do
so if calculating the rows' sizes is a relatively expensive operation
@see GetRowCount()
*/
void SetRowCount(size_t rowCount);
+
+protected:
+
+ /**
+ This function must be overridden in the derived class, and should
+ return the height of the given row in pixels.
+ */
+ virtual wxCoord OnGetRowHeight(size_t row) const;
};
*/
bool IsColumnVisible(size_t column) const;
- /**
- This function must be overridden in the derived class, and should
- return the width of the given column in pixels.
- */
- virtual wxCoord OnGetColumnWidth(size_t column) const;
-
/**
This function doesn't have to be overridden but it may be useful to do
so if calculating the columns' sizes is a relatively expensive
@see GetColumnCount()
*/
void SetColumnCount(size_t columnCount);
+
+protected:
+
+ /**
+ This function must be overridden in the derived class, and should
+ return the width of the given column in pixels.
+ */
+ virtual wxCoord OnGetColumnWidth(size_t column) const;
};
projects / wxWidgets.git / commitdiff
