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

added back docs for wxWindow::WindowToClientSize, added some missing @since tags

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52584 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2008-03-17 16:14:21 +00:00
parent c767a8eefb
commit 491a5ece42
2 changed files with 45 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
interface/sizer.h
View File

@@ -875,27 +875,27 @@ public:
void Clear(bool delete_windows = false);
/**
Computes client area size for @a window so that it matches the
sizer's minimal size. Unlike GetMinSize(), this
method accounts for other constraints imposed on @e window, namely display's
size (returned size will never be too large for the display) and maximum
window size if previously set by
wxWindow::SetMaxSize.
The returned value is suitable for passing to
wxWindow::SetClientSize or
wxWindow::SetMinClientSize.
Computes client area size for @a window so that it matches the sizer's
minimal size. Unlike GetMinSize(), this method accounts for other
constraints imposed on @e window, namely display's size (returned size
will never be too large for the display) and maximum window size if
previously set by wxWindow::SetMaxSize(). The returned value is
suitable for passing to wxWindow::SetClientSize() or
wxWindow::SetMinClientSize().
@since 2.8.8
@see ComputeFittingWindowSize(), Fit()
*/
wxSize ComputeFittingClientSize(wxWindow* window);
/**
Like ComputeFittingClientSize(),
but converts the result into window size.
The returned value is suitable for passing to
wxWindow::SetSize or
wxWindow::SetMinSize.
Like ComputeFittingClientSize(), but converts the result into window
size. The returned value is suitable for passing to wxWindow::SetSize()
or wxWindow::SetMinSize().
@since 2.8.8
@see ComputeFittingClientSize(), Fit()
*/
wxSize ComputeFittingWindowSize(wxWindow* window);

40
interface/window.h
View File

@@ -324,23 +324,41 @@ public:
//@}
/**
Converts client area size @a size to corresponding window size. In other
words, the returned value is what would GetSize()
return if this window had client area of given size.
Components with wxDefaultCoord value are left unchanged.
Note that the conversion is not always exact, it assumes that non-client area
doesn't change and so doesn't take into account things like menu bar
(un)wrapping or (dis)appearance of the scrollbars.
Converts client area size @a size to corresponding window size. In
other words, the returned value is what would GetSize() return if this
window had client area of given size. Components with wxDefaultCoord
value are left unchanged. Note that the conversion is not always
exact, it assumes that non-client area doesn't change and so doesn't
take into account things like menu bar (un)wrapping or (dis)appearance
of the scrollbars.
@since 2.8.8
@see WindowToClientSize()
*/
virtual wxSize ClientToWindowSize(const wxSize& size);
/**
Converts window size @a size to corresponding client area size. In
other words, the returned value is what would GetClientSize() return if
this window had given window size. Components with wxDefaultCoord value
are left unchanged.
Note that the conversion is not always exact, it assumes that
non-client area doesn't change and so doesn't take into account things
like menu bar (un)wrapping or (dis)appearance of the scrollbars.
@since 2.8.8
@see ClientToWindowSize()
*/
virtual wxSize WindowToClientSize(const wxSize& size);
/**
This function simply generates a wxCloseEvent whose
handler usually tries to close the window. It doesn't close the window itself,
however.
handler usually tries to close the window. It doesn't close the window
itself, however.
@param force
@false if the window's close handler should be able to veto the destruction
of this window, @true if it cannot.