added documentation of return value of ToggleWindowStyle()

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43797 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-12-04 11:19:30 +00:00
parent d63312a977
commit e23d401900

View File

@@ -3526,7 +3526,7 @@ exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}.
\membersection{wxWindow::ToggleWindowStyle}\label{wxwindowtogglewindowstyle} \membersection{wxWindow::ToggleWindowStyle}\label{wxwindowtogglewindowstyle}
\func{void}{ToggleWindowStyle}{\param{int }{flag}} \func{bool}{ToggleWindowStyle}{\param{int }{flag}}
Turns the given \arg{flag} on if it's currently turned off and vice versa. Turns the given \arg{flag} on if it's currently turned off and vice versa.
This function cannot be used if the value of the flag is $0$ (which is often This function cannot be used if the value of the flag is $0$ (which is often
@@ -3535,6 +3535,11 @@ the case for default flags).
Also, please notice that not all styles can be changed after the control Also, please notice that not all styles can be changed after the control
creation. creation.
\wxheading{Return value}
Returns \true if the style was turned on by this function, \false if it was
switched off.
\wxheading{See also} \wxheading{See also}
\helpref{wxWindow::SetWindowStyleFlag}{wxwindowsetwindowstyleflag},\rtfsp \helpref{wxWindow::SetWindowStyleFlag}{wxwindowsetwindowstyleflag},\rtfsp