Various minor corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53749 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2008-05-26 07:49:54 +00:00
parent 7adc2e2ea1
commit 962fb6d22e

View File

@@ -17,13 +17,11 @@
Please note that all children of the window will be deleted automatically by Please note that all children of the window will be deleted automatically by
the destructor before the window itself is deleted which means that you don't the destructor before the window itself is deleted which means that you don't
have to worry about deleting them manually. Please see the @ref have to worry about deleting them manually. Please see the @ref
overview_windowdeletionoverview "window overview_windowdeletion "window deletion overview" for more information.
deletion overview" for more information.
Also note that in this, and many others, wxWidgets classes some Also note that in this, and many others, wxWidgets classes some
@c GetXXX() methods may be overloaded (as, for example, @c GetXXX() methods may be overloaded (as, for example,
wxWindow::GetSize or wxWindow::GetSize or wxWindow::GetClientSize). In this case, the overloads
wxWindow::GetClientSize). In this case, the overloads
are non-virtual because having multiple virtual functions with the same name are non-virtual because having multiple virtual functions with the same name
results in a virtual function name hiding at the derived class level (in results in a virtual function name hiding at the derived class level (in
English, this means that the derived class has to override all overloaded English, this means that the derived class has to override all overloaded
@@ -129,8 +127,8 @@
@library{wxcore} @library{wxcore}
@category{FIXME} @category{FIXME}
@see @ref overview_eventhandlingoverview, @ref overview_windowsizingoverview @see @ref overview_eventhandling "Event handling overview",
"Window sizing overview" @ref overview_windowsizing "Window sizing overview"
*/ */
class wxWindow : public wxEvtHandler class wxWindow : public wxEvtHandler
{ {
@@ -189,7 +187,7 @@ public:
@see AcceptsFocusFromKeyboard() @see AcceptsFocusFromKeyboard()
*/ */
bool AcceptsFocus() const; virtual bool AcceptsFocus() const;
/** /**
This method may be overridden in the derived classes to return @false to This method may be overridden in the derived classes to return @false to
@@ -197,7 +195,14 @@ public:
clicks it with the mouse, it shouldn't be included in the TAB traversal chain clicks it with the mouse, it shouldn't be included in the TAB traversal chain
when using the keyboard. when using the keyboard.
*/ */
bool AcceptsFocusFromKeyboard() const; virtual bool AcceptsFocusFromKeyboard() const;
/**
Overridden to indicate wehter this window or one of its children accepts
focus. Usually it's the same as AcceptsFocus() but is overridden for
container windows
*/
virtual bool AcceptsFocusRecursively() const;
/** /**
Adds a child window. This is called automatically by window creation Adds a child window. This is called automatically by window creation
@@ -321,8 +326,8 @@ public:
@param pt @param pt
The client position for the second form of the function. The client position for the second form of the function.
*/ */
virtual void ClientToScreen(int* x, int* y) const; void ClientToScreen(int* x, int* y) const;
virtual wxPoint ClientToScreen(const wxPoint& pt) const; wxPoint ClientToScreen(const wxPoint& pt) const;
//@} //@}
/** /**
@@ -636,7 +641,7 @@ public:
@see SetBackgroundColour(), SetForegroundColour(), @see SetBackgroundColour(), SetForegroundColour(),
GetForegroundColour() GetForegroundColour()
*/ */
virtual wxColour GetBackgroundColour() const; wxColour GetBackgroundColour() const;
/** /**
Returns the background style of the window. The background style can be one of: Returns the background style of the window. The background style can be one of:
@@ -767,7 +772,7 @@ public:
Return the sizer that this window is a member of, if any, otherwise Return the sizer that this window is a member of, if any, otherwise
@NULL. @NULL.
*/ */
const wxSizer* GetContainingSizer() const; wxSizer* GetContainingSizer() const;
/** /**
Return the cursor associated with this window. Return the cursor associated with this window.
@@ -839,7 +844,7 @@ public:
@see SetForegroundColour(), SetBackgroundColour(), @see SetForegroundColour(), SetBackgroundColour(),
GetBackgroundColour() GetBackgroundColour()
*/ */
virtual wxColour GetForegroundColour(); wxColour GetForegroundColour();
/** /**
Returns the grandparent of a window, or @NULL if there isn't one. Returns the grandparent of a window, or @NULL if there isn't one.
@@ -1005,7 +1010,7 @@ public:
@see GetScreenPosition() @see GetScreenPosition()
*/ */
virtual void GetPosition(int* x, int* y) const; void GetPosition(int* x, int* y) const;
wxPoint GetPosition() const; wxPoint GetPosition() const;
//@} //@}
@@ -1025,7 +1030,7 @@ public:
@see GetScreenRect() @see GetScreenRect()
*/ */
virtual wxRect GetRect() const; wxRect GetRect() const;
//@{ //@{
/** /**
@@ -1039,8 +1044,8 @@ public:
@see GetPosition() @see GetPosition()
*/ */
virtual void GetScreenPosition(int* x, int* y) const; void GetScreenPosition(int* x, int* y) const;
const wxPoint GetScreenPosition() const; wxPoint GetScreenPosition() const;
//@} //@}
/** /**
@@ -1049,7 +1054,7 @@ public:
@see GetRect() @see GetRect()
*/ */
virtual wxRect GetScreenRect() const; wxRect GetScreenRect() const;
/** /**
Returns the built-in scrollbar position. Returns the built-in scrollbar position.
@@ -2304,16 +2309,6 @@ public:
virtual void SetSize(const wxSize& size); virtual void SetSize(const wxSize& size);
//@} //@}
/**
Use of this function for windows which are not toplevel windows
(such as wxDialog or wxFrame) is discouraged. Please use
SetMinSize() and SetMaxSize()
instead.
@see wxTopLevelWindow::SetSizeHints.
*/
/** /**
Sets the window to have the given layout sizer. The window Sets the window to have the given layout sizer. The window
will then own the object, and will take care of its deletion. will then own the object, and will take care of its deletion.
@@ -2392,34 +2387,6 @@ public:
void SetVirtualSize(const wxSize& size); void SetVirtualSize(const wxSize& size);
//@} //@}
//@{
/**
Allows specification of minimum and maximum virtual window sizes.
If a pair of values is not set (or set to -1), the default values
will be used.
@param minW
Specifies the minimum width allowable.
@param minH
Specifies the minimum height allowable.
@param maxW
Specifies the maximum width allowable.
@param maxH
Specifies the maximum height allowable.
@param minSize
Minimum size.
@param maxSize
Maximum size.
@remarks If this function is called, the user will not be able to size
the virtual area of the window outside the given bounds.
*/
virtual void SetVirtualSizeHints(int minW, int minH, int maxW = -1,
int maxH = -1);
void SetVirtualSizeHints(const wxSize& minSize = wxDefaultSize,
const wxSize& maxSize = wxDefaultSize);
//@}
/** /**
Identical to SetWindowStyleFlag(). Identical to SetWindowStyleFlag().
*/ */