rubenwardy
/
TGUI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added warnings to Widget documentation where the function only has effect when the widget has already been added to the parent

0.8
Bruno Van de Velde 2017-08-08 16:28:50 +02:00
parent 0cf09ff141
commit 999fe00a63
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/TGUI/Widget.hpp
View File

@ -293,9 +293,7 @@ namespace tgui
///
/// The previously focused widget will be unfocused.
///
/// @see unfocus
/// @see focusNextWidget
///
/// @warning This function only has an effect when the widget was already added to its parent (e.g. the Gui).
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
virtual void focus();
@ -303,9 +301,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @brief Unfocus the widget
///
/// @see focus
/// @see focusNextWidget
///
/// @warning This function only has an effect when the widget was already added to its parent (e.g. the Gui).
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
virtual void unfocus();
@ -346,6 +342,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @brief Places the widget before all other widgets
///
/// @warning This function only has an effect when the widget was already added to its parent (e.g. the Gui).
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
virtual void moveToFront();
@ -353,6 +350,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @brief Places the widget behind all other widgets
///
/// @warning This function only has an effect when the widget was already added to its parent (e.g. the Gui).
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
virtual void moveToBack();