i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

BWindow docs: Improve function descriptions

Browse Source 
* Clarify what information BWindow::WorkspacesChanged provides
* Clarify when BWindow::WorkspaceActivated is called

Change-Id: Ifcb041bcf67db1ee5c1c514a2b97baa49f8c4dcc
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6257
Tested-by: Automation <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
This commit is contained in:
Yourself
2023-03-24 14:01:56 +00:00
committed by waddlesplash
parent b6356b9116
commit a231654f09
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/interface/Window.dox
+7 -3
View File
@@ -1056,10 +1056,11 @@
/*! /*!
\fn void BWindow::WorkspacesChanged(uint32 oldWorkspaces, \fn void BWindow::WorkspacesChanged(uint32 oldWorkspaces,
uint32 newWorkspaces) uint32 newWorkspaces)
\brief Hook method that gets called when the number of workspaces changes. \brief Hook method that gets called whenever the workspaces the window is
in changes.
\param oldWorkspaces The old number of workspaces. \param oldWorkspaces The old set of workspaces the window was visible in.
\param newWorkspaces The new number of workspaces. \param newWorkspaces The new set of workspaces the window is visible in.
\since BeOS R3 \since BeOS R3
*/ */
@@ -1069,6 +1070,9 @@
\fn void BWindow::WorkspaceActivated(int32 workspace, bool state) \fn void BWindow::WorkspaceActivated(int32 workspace, bool state)
\brief Hook method that gets called when the active workspace changes. \brief Hook method that gets called when the active workspace changes.
This method is only called when a workspace in which the window resides
is activated or deactivated.
\param workspace The \a workspace number that was activated/deactivated. \param workspace The \a workspace number that was activated/deactivated.
\param state \c true if activated, \c false if deactivated. \param state \c true if activated, \c false if deactivated.