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); void Clear(bool delete_windows = false);
/** /**
Computes client area size for @a window so that it matches the Computes client area size for @a window so that it matches the sizer's
sizer's minimal size. Unlike GetMinSize(), this minimal size. Unlike GetMinSize(), this method accounts for other
method accounts for other constraints imposed on @e window, namely display's constraints imposed on @e window, namely display's size (returned size
size (returned size will never be too large for the display) and maximum will never be too large for the display) and maximum window size if
window size if previously set by previously set by wxWindow::SetMaxSize(). The returned value is
wxWindow::SetMaxSize. suitable for passing to wxWindow::SetClientSize() or
The returned value is suitable for passing to wxWindow::SetMinClientSize().
wxWindow::SetClientSize or
wxWindow::SetMinClientSize. @since 2.8.8
@see ComputeFittingWindowSize(), Fit() @see ComputeFittingWindowSize(), Fit()
*/ */
wxSize ComputeFittingClientSize(wxWindow* window); wxSize ComputeFittingClientSize(wxWindow* window);
/** /**
Like ComputeFittingClientSize(), Like ComputeFittingClientSize(), but converts the result into window
but converts the result into window size. size. The returned value is suitable for passing to wxWindow::SetSize()
The returned value is suitable for passing to or wxWindow::SetMinSize().
wxWindow::SetSize or
wxWindow::SetMinSize. @since 2.8.8
@see ComputeFittingClientSize(), Fit() @see ComputeFittingClientSize(), Fit()
*/ */
wxSize ComputeFittingWindowSize(wxWindow* window); 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 Converts client area size @a size to corresponding window size. In
words, the returned value is what would GetSize() other words, the returned value is what would GetSize() return if this
return if this window had client area of given size. window had client area of given size. Components with wxDefaultCoord
Components with wxDefaultCoord value are left unchanged. value are left unchanged. Note that the conversion is not always
Note that the conversion is not always exact, it assumes that non-client area exact, it assumes that non-client area doesn't change and so doesn't
doesn't change and so doesn't take into account things like menu bar take into account things like menu bar (un)wrapping or (dis)appearance
(un)wrapping or (dis)appearance of the scrollbars. of the scrollbars.
@since 2.8.8
@see WindowToClientSize() @see WindowToClientSize()
*/ */
virtual wxSize ClientToWindowSize(const wxSize& size); 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 This function simply generates a wxCloseEvent whose
handler usually tries to close the window. It doesn't close the window itself, handler usually tries to close the window. It doesn't close the window
however. itself, however.
@param force @param force
@false if the window's close handler should be able to veto the destruction @false if the window's close handler should be able to veto the destruction
of this window, @true if it cannot. of this window, @true if it cannot.