access-specifier fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56274 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-13 11:29:37 +00:00
parent 9861dc94bb
commit 551266a969
8 changed files with 206 additions and 190 deletions

View File

@@ -13,11 +13,11 @@
It is used by @ref overview_handlers "tag handlers". It is used by @ref overview_handlers "tag handlers".
@library{wxhtml} @library{wxhtml}
@category{FIXME} @category{html}
*/ */
class wxHtmlTag class wxHtmlTag
{ {
public: protected:
/** /**
Constructor. You will probably never have to construct a wxHtmlTag object Constructor. You will probably never have to construct a wxHtmlTag object
yourself. Feel free to ignore the constructor parameters. yourself. Feel free to ignore the constructor parameters.
@@ -27,6 +27,7 @@ public:
int end_pos, wxHtmlTagsCache* cache, int end_pos, wxHtmlTagsCache* cache,
wxHtmlEntitiesParser* entParser); wxHtmlEntitiesParser* entParser);
public:
/** /**
Returns a string containing all parameters. Returns a string containing all parameters.
Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to

View File

@@ -159,41 +159,6 @@ public:
*/ */
virtual bool LoadPage(const wxString& location); 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 Called when user clicks on hypertext link. Default behaviour is to emit a
wxHtmlLinkEvent and, if the event was not processed wxHtmlLinkEvent and, if the event was not processed
@@ -404,6 +369,42 @@ public:
*/ */
virtual void WriteCustomization(wxConfigBase cfg, virtual void WriteCustomization(wxConfigBase cfg,
wxString path = wxEmptyString); 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);
}; };

View File

@@ -93,20 +93,6 @@ public:
*/ */
virtual wxColour GetSelectedTextColour(const wxColour& colFg) const; 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 This function may be overridden to decorate HTML returned by
OnGetItem(). OnGetItem().
@@ -125,6 +111,21 @@ public:
@see See also wxHtmlLinkInfo. @see See also wxHtmlLinkInfo.
*/ */
virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link); 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;
}; };

View File

@@ -949,16 +949,6 @@ public:
*/ */
virtual bool CanSave() 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). Returns the encoding associated with the handler (if any).
*/ */
@@ -1048,6 +1038,17 @@ public:
load and save dialogs). load and save dialogs).
*/ */
virtual void SetVisible(bool visible); 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);
}; };

View File

@@ -55,11 +55,6 @@ public:
*/ */
virtual ~wxStackWalker(); 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 Enumerate stack frames from the current location, skipping the initial
number of them (this can be useful when Walk() is called from some known number of them (this can be useful when Walk() is called from some known
@@ -77,6 +72,12 @@ public:
Up to @a maxDepth frames are walked from the innermost to the outermost one. Up to @a maxDepth frames are walked from the innermost to the outermost one.
*/ */
virtual void WalkFromException(size_t maxDepth = 200); virtual void WalkFromException(size_t maxDepth = 200);
protected:
/**
This function must be overrided to process the given frame.
*/
void OnStackFrame(const wxStackFrame& frame);
}; };

View File

@@ -310,19 +310,6 @@ public:
*/ */
virtual ~wxThreadHelper(); 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. This is the entry point of the thread.
@@ -337,6 +324,19 @@ public:
*/ */
virtual ExitCode Entry(); 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 This is a public function that returns the wxThread object
associated with the thread. associated with the thread.
@@ -634,30 +634,6 @@ public:
*/ */
wxThreadError Delete(); 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. Returns the number of system CPUs or -1 if the value is unknown.
@@ -883,6 +859,32 @@ public:
See also Sleep(). See also Sleep().
*/ */
static void Yield(); 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);
}; };

View File

@@ -203,22 +203,6 @@ public:
*/ */
virtual void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const; 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 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 rectangle passed to it may be modified, typically to deflate it a bit
@@ -237,12 +221,6 @@ public:
*/ */
virtual void OnDrawSeparator(wxDC& dc, wxRect& rect, size_t n) const; 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 Selects or deselects the specified item which must be valid (i.e. not
equal to @c wxNOT_FOUND). equal to @c wxNOT_FOUND).
@@ -332,5 +310,29 @@ public:
@see Select() @see Select()
*/ */
void Toggle(size_t item); 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;
}; };

View File

@@ -141,12 +141,6 @@ public:
*/ */
bool IsVisible(size_t unit) 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 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 so if calculating the units' sizes is a relatively expensive operation
@@ -190,6 +184,15 @@ public:
last item). last item).
*/ */
int VirtualHitTest(wxCoord coord) const; 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;
}; };
@@ -257,12 +260,6 @@ public:
*/ */
bool IsRowVisible(size_t row) 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 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 so if calculating the rows' sizes is a relatively expensive operation
@@ -324,6 +321,14 @@ public:
@see GetRowCount() @see GetRowCount()
*/ */
void SetRowCount(size_t rowCount); 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;
}; };
@@ -392,12 +397,6 @@ public:
*/ */
bool IsColumnVisible(size_t column) 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 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 so if calculating the columns' sizes is a relatively expensive
@@ -460,6 +459,14 @@ public:
@see GetColumnCount() @see GetColumnCount()
*/ */
void SetColumnCount(size_t columnCount); 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;
}; };