Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
interface/sashwin.h
View File

@@ -29,10 +29,10 @@
@endStyleTable
@beginEventTable
@event{EVT_SASH_DRAGGED(id\, func)}:
@event{EVT_SASH_DRAGGED(id, func)}:
Process a wxEVT_SASH_DRAGGED event, when the user has finished
dragging a sash.
@event{EVT_SASH_DRAGGED_RANGE(id1\, id2\, func)}:
@event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}:
Process a wxEVT_SASH_DRAGGED_RANGE event, when the user has
finished dragging a sash. The event handler is called when windows
with ids in the given range have their sashes dragged.
@@ -42,8 +42,7 @@
@category{miscwnd}
@seealso
wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview "Event
handling overview"
wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview
*/
class wxSashWindow : public wxWindow
{
@@ -54,33 +53,28 @@ public:
non-control window.
@param parent
Pointer to a parent window.
Pointer to a parent window.
@param id
Window identifier. If -1, will automatically create an identifier.
Window identifier. If -1, will automatically create an identifier.
@param pos
Window position. wxDefaultPosition is (-1, -1) which indicates that
Window position. wxDefaultPosition is (-1, -1) which indicates that
wxSashWindows
should generate a default position for the window. If using the wxSashWindow
class directly, supply
an actual position.
should generate a default position for the window. If using the
wxSashWindow class directly, supply
an actual position.
@param size
Window size. wxDefaultSize is (-1, -1) which indicates that wxSashWindows
should generate a default size for the window.
Window size. wxDefaultSize is (-1, -1) which indicates that wxSashWindows
should generate a default size for the window.
@param style
Window style. For window styles, please see wxSashWindow.
Window style. For window styles, please see wxSashWindow.
@param name
Window name.
Window name.
*/
wxSashWindow();
wxSashWindow(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxCLIP_CHILDREN | wxSW_3D,
long style = wxCLIP_CHILDREN | wxSW_3D,
const wxString& name = "sashWindow");
//@}
@@ -113,9 +107,9 @@ public:
Returns @true if a sash is visible on the given edge, @false otherwise.
@param edge
Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
@sa SetSashVisible()
@see SetSashVisible()
*/
bool GetSashVisible(wxSashEdgePosition edge);
@@ -124,9 +118,9 @@ public:
This function is obsolete since the sash border property is unused.
@param edge
Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
@sa SetSashBorder()
@see SetSashBorder()
*/
bool HasBorder(wxSashEdgePosition edge);
@@ -155,10 +149,9 @@ public:
This function is obsolete since the sash border property is unused.
@param edge
Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
@param hasBorder
@true to give the sash a border visible, @false to remove it.
@true to give the sash a border visible, @false to remove it.
*/
void SetSashBorder(wxSashEdgePosition edge, bool hasBorder);
@@ -166,12 +159,11 @@ public:
Call this function to make a sash visible or invisible on a particular edge.
@param edge
Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
@param visible
@true to make the sash visible, @false to make it invisible.
@true to make the sash visible, @false to make it invisible.
@sa GetSashVisible()
@see GetSashVisible()
*/
void SetSashVisible(wxSashEdgePosition edge, bool visible);
};
@@ -188,7 +180,7 @@ public:
@category{FIXME}
@seealso
wxSashWindow, @ref overview_eventhandlingoverview "Event handling overview"
wxSashWindow, @ref overview_eventhandlingoverview
*/
class wxSashEvent : public wxCommandEvent
{