Skip to content

Commit

Permalink
enhancement: Guisan: improve widget help text
Browse files Browse the repository at this point in the history
  • Loading branch information
midwan committed Sep 5, 2024
1 parent 66b2cdc commit c38644b
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions external/libguisan/include/guisan/widget.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -861,9 +861,23 @@ namespace gcn
virtual const std::list<FocusListener*>& _getFocusListeners();

/**
* Gets the area of the widget that the widget's children occupy.
*
* @return The area of the widget that the widget's children occupy.
* Gets the area of the widget occupied by the widget's children.
* By default this method returns an empty rectangle as not all
* widgets are containers. If you want to make a container this
* method should return the area where the children resides. This
* method is used when drawing children of a widget when computing
* clip rectangles for the children.
*
* An example of a widget that overloads this method is ScrollArea.
* A ScrollArea has a view of its contant and that view is the
* children area. The size of a ScrollArea's children area might
* vary depending on if the scroll bars of the ScrollArea is shown
* or not.
*
* @return The area of the widget occupied by the widget's children.
* @see BasicContainer
* @see BasicContainer::getChildrenArea
* @see BasicContainer::drawChildren
* @since 0.1.0
*/
virtual Rectangle getChildrenArea();
Expand Down

0 comments on commit c38644b

Please sign in to comment.