| public |
Inheritance Graph
graph BT
Window
Window --> Container
click Window "classGUI_1_1Window"
click Container "classGUI_1_1Container"
Description
Public Static Attributes
| const Util::StringIdentifier | ACTION_onWindowClosed |
| const flag_t | NO_CLOSE_BUTTON |
| const flag_t | NO_MINIMIZE_BUTTON |
| const flag_t | NO_RESIZE_PANEL |
| const flag_t | HIDDEN_WINDOW Only the content of the window is shown, if it is not selected. |
| const flag_t | ONE_TIME_WINDOW |
| const flag_t | SNAP_TO_BORDER Destroy the content when closed. |
Public Functions
| Window( GUI_Manager & gui, const Geometry::Rect & r, const std::string & title, flag_t flags) | |
| ~Window() | |
| Container * | getHeader() const |
| Container * | clientArea() const |
| bool | isMinimized() const |
| void | minimize() |
| void | restore() |
| void | restoreRect() |
| void | setTitle(const std::string & title) |
| std::string | getTitle() const |
| void | setLogo( Component * newLogo) |
| Component * | getLogo() const |
| float | getOpacity() const |
| void | setOpacity(float f) |
| void | close() start the closing animation, when the animation is finished, onClosed() is called. |
| void | _onClosed() (internal) Called when the closing animation has finished. |
| void | addContent(const Ref & child) |
| void | removeContent(const Ref & child) |
| size_t | getContentsCount() const |
| std::vector< Component * > | getContents() |
| void | clearContents() |
| void | insertAfter(const Ref & child, const Ref & after) |
| void | insertBefore(const Ref & child, const Ref & after) |
| Geometry::Rect | getInnerRect() const |
| void | invalidateRegion() |
| void | doLayout() |
| bool | onSelect() |
| bool | onUnselect() |
Documentation
variable
GUI::Window::ACTION_onWindowClosed
| public | static |
| const Util::StringIdentifier ACTION_onWindowClosed |
Defined in GUI/Components/Window.h:30
variable
GUI::Window::NO_CLOSE_BUTTON
| public | static |
| const flag_t NO_CLOSE_BUTTON |
Defined in GUI/Components/Window.h:33
variable
GUI::Window::NO_MINIMIZE_BUTTON
| public | static |
| const flag_t NO_MINIMIZE_BUTTON |
Defined in GUI/Components/Window.h:34
variable
GUI::Window::NO_RESIZE_PANEL
| public | static |
| const flag_t NO_RESIZE_PANEL |
Defined in GUI/Components/Window.h:35
variable
GUI::Window::HIDDEN_WINDOW
| public | static |
| const flag_t HIDDEN_WINDOW |
Only the content of the window is shown, if it is not selected.
Defined in GUI/Components/Window.h:36
variable
GUI::Window::ONE_TIME_WINDOW
| public | static |
| const flag_t ONE_TIME_WINDOW |
Defined in GUI/Components/Window.h:37
variable
GUI::Window::SNAP_TO_BORDER
| public | static |
| const flag_t SNAP_TO_BORDER |
Destroy the content when closed.
Defined in GUI/Components/Window.h:38
function
GUI::Window::Window
| public |
| Window( | GUI_Manager & | gui, |
| const Geometry::Rect & | r, | |
| const std::string & | title, | |
| flag_t | flags | |
| ) |
Defined in GUI/Components/Window.h:40
function
GUI::Window::~Window
| public | virtual |
| ~Window( | ) |
Defined in GUI/Components/Window.h:41
function
GUI::Window::getHeader
| public | const | inline |
| Container * getHeader( | ) const |
Defined in GUI/Components/Window.h:43
function
GUI::Window::clientArea
| public | const | inline |
| Container * clientArea( | ) const |
Defined in GUI/Components/Window.h:44
function
GUI::Window::isMinimized
| public | const | inline |
| bool isMinimized( | ) const |
Defined in GUI/Components/Window.h:45
function
GUI::Window::minimize
| public |
| void minimize( | ) |
Defined in GUI/Components/Window.h:46
function
GUI::Window::restore
| public |
| void restore( | ) |
Defined in GUI/Components/Window.h:47
function
GUI::Window::restoreRect
| public |
| void restoreRect( | ) |
Defined in GUI/Components/Window.h:48
function
GUI::Window::setTitle
| public |
| void setTitle( | const std::string & | title ) |
Defined in GUI/Components/Window.h:50
function
GUI::Window::getTitle
| public | const |
| std::string getTitle( | ) const |
Defined in GUI/Components/Window.h:51
function
GUI::Window::setLogo
| public |
| void setLogo( | Component * | newLogo ) |
Defined in GUI/Components/Window.h:53
function
GUI::Window::getLogo
| public | const | inline |
| Component * getLogo( | ) const |
Defined in GUI/Components/Window.h:54
function
GUI::Window::getOpacity
| public | const | inline |
| float getOpacity( | ) const |
Defined in GUI/Components/Window.h:56
function
GUI::Window::setOpacity
| public | inline |
| void setOpacity( | float | f ) |
Defined in GUI/Components/Window.h:57
function
GUI::Window::close
| public |
| void close( | ) |
start the closing animation, when the animation is finished, onClosed() is called.
Defined in GUI/Components/Window.h:60
function
GUI::Window::_onClosed
| public |
| void _onClosed( | ) |
(internal) Called when the closing animation has finished.
Defined in GUI/Components/Window.h:63
function
GUI::Window::addContent
| public | inline | virtual |
| void addContent( | const Ref & | child ) |
Defined in GUI/Components/Window.h:66
function
GUI::Window::removeContent
| public | inline | virtual |
| void removeContent( | const Ref & | child ) |
Defined in GUI/Components/Window.h:67
function
GUI::Window::getContentsCount
| public | const | inline | virtual |
| size_t getContentsCount( | ) const |
Defined in GUI/Components/Window.h:68
function
GUI::Window::getContents
| public | inline | virtual |
| std::vector< Component * > getContents( | ) |
Defined in GUI/Components/Window.h:69
function
GUI::Window::clearContents
| public | inline | virtual |
| void clearContents( | ) |
Defined in GUI/Components/Window.h:70
function
GUI::Window::insertAfter
| public | inline | virtual |
| void insertAfter( | const Ref & | child, |
| const Ref & | after | |
| ) |
Defined in GUI/Components/Window.h:71
function
GUI::Window::insertBefore
| public | inline | virtual |
| void insertBefore( | const Ref & | child, |
| const Ref & | after | |
| ) |
Defined in GUI/Components/Window.h:74
function
GUI::Window::getInnerRect
| public | const | inline | virtual |
| Geometry::Rect getInnerRect( | ) const |
o The component’s inner rectangle defines the area, that may be covered by children (=content) (not regarding scrolling). It can be used as a hint for the maximum size of children.
Defined in GUI/Components/Window.h:79
function
GUI::Window::invalidateRegion
| public | virtual |
| void invalidateRegion( | ) |
Defined in GUI/Components/Window.h:80
function
GUI::Window::doLayout
| public | virtual |
| void doLayout( | ) |
Defined in GUI/Components/Window.h:81
function
GUI::Window::onSelect
| public | virtual |
| bool onSelect( | ) |
Defined in GUI/Components/Window.h:82
function
GUI::Window::onUnselect
| public | virtual |
| bool onUnselect( | ) |
Defined in GUI/Components/Window.h:83