From 28a08d9071ab2d69cefd1269c66f56225198c404 Mon Sep 17 00:00:00 2001 From: Dmitry Marakasov Date: Fri, 26 Dec 2014 21:51:16 +0300 Subject: [PATCH] Document new Window methods --- SDL2pp/Window.hh | 70 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/SDL2pp/Window.hh b/SDL2pp/Window.hh index 7ee6943..4a745b7 100644 --- a/SDL2pp/Window.hh +++ b/SDL2pp/Window.hh @@ -146,15 +146,85 @@ public: //////////////////////////////////////////////////////////// SDL_Window* Get() const; + //////////////////////////////////////////////////////////// + /// \brief Make a window as large as possible + /// + /// \see http://wiki.libsdl.org/SDL_MaximizeWindow + /// + //////////////////////////////////////////////////////////// void Maximize(); + + //////////////////////////////////////////////////////////// + /// \brief Minimize a window to an iconic representation + /// + /// \see http://wiki.libsdl.org/SDL_MinimizeWindow + /// + //////////////////////////////////////////////////////////// void Minimize(); + + //////////////////////////////////////////////////////////// + /// \brief Hide a window + /// + /// \see http://wiki.libsdl.org/SDL_HideWindow + /// + //////////////////////////////////////////////////////////// void Hide(); + + //////////////////////////////////////////////////////////// + /// \brief Restore the size and position of a minimized or maximized window + /// + /// \see http://wiki.libsdl.org/SDL_RestoreWindow + /// + //////////////////////////////////////////////////////////// void Restore(); + + //////////////////////////////////////////////////////////// + /// \brief Raise a window above other windows and set the input focus + /// + /// \see http://wiki.libsdl.org/SDL_RaiseWindow + /// + //////////////////////////////////////////////////////////// void Raise(); + + //////////////////////////////////////////////////////////// + /// \brief Show a window + /// + /// \see http://wiki.libsdl.org/SDL_ShowWindow + /// + //////////////////////////////////////////////////////////// void Show(); + //////////////////////////////////////////////////////////// + /// \brief Set a window's fullscreen state + /// + /// \param flags SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP or 0 + /// + /// \throws SDL2pp::Exception + /// + /// \see http://wiki.libsdl.org/SDL_SetWindowFullscreen + /// + //////////////////////////////////////////////////////////// void SetFullscreen(int flags); + + //////////////////////////////////////////////////////////// + /// \brief Set the size of a window's client area + /// + /// \param w Width of the window in pixles + /// \param h Height of the window in pixles + /// + /// \see http://wiki.libsdl.org/SDL_SetWindowSize + /// + //////////////////////////////////////////////////////////// void SetSize(int w, int h); + + //////////////////////////////////////////////////////////// + /// \brief Set the size of a window's client area + /// + /// \param size Point representin window dimensions + /// + /// \see http://wiki.libsdl.org/SDL_SetWindowSize + /// + //////////////////////////////////////////////////////////// void SetSize(const Point& size); };