Added the trunk/branches/tags directories at repository root, and moved previous root into trunk/

git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/trunk@1002 4e206d99-4929-0410-ac5d-dfc041789085
2009-01-28 16:18:34 +00:00 · 2009-01-28 16:18:34 +00:00 · 2f524481c1
commit 2f524481c1
974 changed files with 295448 additions and 0 deletions
--- a/include/SFML/Window/Window.hpp
+++ b/include/SFML/Window/Window.hpp
@ -0,0 +1,326 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+//    you must not claim that you wrote the original software.
+//    If you use this software in a product, an acknowledgment
+//    in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+//    and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_WINDOW_HPP
+#define SFML_WINDOW_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include <SFML/Window/Event.hpp>
+#include <SFML/Window/Input.hpp>
+#include <SFML/Window/VideoMode.hpp>
+#include <SFML/Window/WindowHandle.hpp>
+#include <SFML/Window/WindowListener.hpp>
+#include <SFML/Window/WindowSettings.hpp>
+#include <SFML/Window/WindowStyle.hpp>
+#include <SFML/System/Clock.hpp>
+#include <SFML/System/NonCopyable.hpp>
+#include <queue>
+#include <string>
+
+
+namespace sf
+{
+namespace priv
+{
+    class WindowImpl;
+}
+
+////////////////////////////////////////////////////////////
+/// Window is a rendering window ; it can create a new window
+/// or connect to an existing one
+////////////////////////////////////////////////////////////
+class SFML_API Window : public WindowListener, NonCopyable
+{
+public :
+
+    ////////////////////////////////////////////////////////////
+    /// Default constructor
+    ///
+    ////////////////////////////////////////////////////////////
+    Window();
+
+    ////////////////////////////////////////////////////////////
+    /// Construct a new window
+    ///
+    /// \param Mode :        Video mode to use
+    /// \param Title :       Title of the window
+    /// \param WindowStyle : Window style (Resize | Close by default)
+    /// \param Params :      Creation parameters (see default constructor for default values)
+    ///
+    ////////////////////////////////////////////////////////////
+    Window(VideoMode Mode, const std::string& Title, unsigned long WindowStyle = Style::Resize | Style::Close, const WindowSettings& Params = WindowSettings());
+
+    ////////////////////////////////////////////////////////////
+    /// Construct the window from an existing control
+    ///
+    /// \param Handle : Platform-specific handle of the control
+    /// \param Params : Creation parameters (see default constructor for default values)
+    ///
+    ////////////////////////////////////////////////////////////
+    Window(WindowHandle Handle, const WindowSettings& Params = WindowSettings());
+
+    ////////////////////////////////////////////////////////////
+    /// Destructor
+    ///
+    ////////////////////////////////////////////////////////////
+    virtual ~Window();
+
+    ////////////////////////////////////////////////////////////
+    /// Create (or recreate) the window
+    ///
+    /// \param Mode :        Video mode to use
+    /// \param Title :       Title of the window
+    /// \param WindowStyle : Window style (Resize | Close by default)
+    /// \param Params :      Creation parameters (see default constructor for default values)
+    ///
+    ////////////////////////////////////////////////////////////
+    void Create(VideoMode Mode, const std::string& Title, unsigned long WindowStyle = Style::Resize | Style::Close, const WindowSettings& Params = WindowSettings());
+
+    ////////////////////////////////////////////////////////////
+    /// Create (or recreate) the window from an existing control
+    ///
+    /// \param Handle : Platform-specific handle of the control
+    /// \param Params : Creation parameters (see default constructor for default values)
+    ///
+    ////////////////////////////////////////////////////////////
+    void Create(WindowHandle Handle, const WindowSettings& Params = WindowSettings());
+
+    ////////////////////////////////////////////////////////////
+    /// Close (destroy) the window.
+    /// The sf::Window instance remains valid and you can call
+    /// Create to recreate the window
+    ///
+    ////////////////////////////////////////////////////////////
+    void Close();
+
+    ////////////////////////////////////////////////////////////
+    /// Tell whether or not the window is opened (ie. has been created).
+    /// Note that a hidden window (Show(false))
+    /// will still return true
+    ///
+    /// \return True if the window is opened
+    ///
+    ////////////////////////////////////////////////////////////
+    bool IsOpened() const;
+
+    ////////////////////////////////////////////////////////////
+    /// Get the width of the rendering region of the window
+    ///
+    /// \return Width in pixels
+    ///
+    ////////////////////////////////////////////////////////////
+    unsigned int GetWidth() const;
+
+    ////////////////////////////////////////////////////////////
+    /// Get the height of the rendering region of the window
+    ///
+    /// \return Height in pixels
+    ///
+    ////////////////////////////////////////////////////////////
+    unsigned int GetHeight() const;
+
+    ////////////////////////////////////////////////////////////
+    /// Get the creation settings of the window
+    ///
+    /// \return Structure containing the creation settings
+    ///
+    ////////////////////////////////////////////////////////////
+    const WindowSettings& GetSettings() const;
+
+    ////////////////////////////////////////////////////////////
+    /// Get the event on top of events stack, if any, and pop it
+    ///
+    /// \param EventReceived : Event to fill, if any
+    ///
+    /// \return True if an event was returned, false if events stack was empty
+    ///
+    ////////////////////////////////////////////////////////////
+    bool GetEvent(Event& EventReceived);
+
+    ////////////////////////////////////////////////////////////
+    /// Enable / disable vertical synchronization
+    ///
+    /// \param Enabled : True to enable v-sync, false to deactivate
+    ///
+    ////////////////////////////////////////////////////////////
+    void UseVerticalSync(bool Enabled);
+
+    ////////////////////////////////////////////////////////////
+    /// Show or hide the mouse cursor
+    ///
+    /// \param Show : True to show, false to hide
+    ///
+    ////////////////////////////////////////////////////////////
+    void ShowMouseCursor(bool Show);
+
+    ////////////////////////////////////////////////////////////
+    /// Change the position of the mouse cursor
+    ///
+    /// \param Left : Left coordinate of the cursor, relative to the window
+    /// \param Top :  Top coordinate of the cursor, relative to the window
+    ///
+    ////////////////////////////////////////////////////////////
+    void SetCursorPosition(unsigned int Left, unsigned int Top);
+
+    ////////////////////////////////////////////////////////////
+    /// Change the position of the window on screen.
+    /// Only works for top-level windows
+    ///
+    /// \param Left : Left position
+    /// \param Top :  Top position
+    ///
+    ////////////////////////////////////////////////////////////
+    void SetPosition(int Left, int Top);
+
+    ////////////////////////////////////////////////////////////
+    /// Change the size of the rendering region of the window
+    ///
+    /// \param Width :  New width
+    /// \param Height : New height
+    ///
+    ////////////////////////////////////////////////////////////
+    void SetSize(unsigned int Width, unsigned int Height);
+
+    ////////////////////////////////////////////////////////////
+    /// Show or hide the window
+    ///
+    /// \param State : True to show, false to hide
+    ///
+    ////////////////////////////////////////////////////////////
+    void Show(bool State);
+
+    ////////////////////////////////////////////////////////////
+    /// Enable or disable automatic key-repeat.
+    /// Automatic key-repeat is enabled by default
+    ///
+    /// \param Enabled : True to enable, false to disable
+    ///
+    ////////////////////////////////////////////////////////////
+    void EnableKeyRepeat(bool Enabled);
+
+    ////////////////////////////////////////////////////////////
+    /// Change the window's icon
+    ///
+    /// \param Width :  Icon's width, in pixels
+    /// \param Height : Icon's height, in pixels
+    /// \param Pixels : Pointer to the pixels in memory, format must be RGBA 32 bits
+    ///
+    ////////////////////////////////////////////////////////////
+    void SetIcon(unsigned int Width, unsigned int Height, const Uint8* Pixels);
+
+    ////////////////////////////////////////////////////////////
+    /// Activate of deactivate the window as the current target
+    /// for rendering
+    ///
+    /// \param Active : True to activate, false to deactivate (true by default)
+    ///
+    /// \return True if operation was successful, false otherwise
+    ///
+    ////////////////////////////////////////////////////////////
+    bool SetActive(bool Active = true) const;
+
+    ////////////////////////////////////////////////////////////
+    /// Display the window on screen
+    ///
+    ////////////////////////////////////////////////////////////
+    void Display();
+
+    ////////////////////////////////////////////////////////////
+    /// Get the input manager of the window
+    ///
+    /// \return Reference to the input
+    ///
+    ////////////////////////////////////////////////////////////
+    const Input& GetInput() const;
+
+    ////////////////////////////////////////////////////////////
+    /// Limit the framerate to a maximum fixed frequency
+    ///
+    /// \param Limit : Framerate limit, in frames per seconds (use 0 to disable limit)
+    ///
+    ////////////////////////////////////////////////////////////
+    void SetFramerateLimit(unsigned int Limit);
+
+    ////////////////////////////////////////////////////////////
+    /// Get time elapsed since last frame
+    ///
+    /// \return Time elapsed, in seconds
+    ///
+    ////////////////////////////////////////////////////////////
+    float GetFrameTime() const;
+
+    ////////////////////////////////////////////////////////////
+    /// Change the joystick threshold, ie. the value below which
+    /// no move event will be generated
+    ///
+    /// \param Threshold : New threshold, in range [0, 100]
+    ///
+    ////////////////////////////////////////////////////////////
+    void SetJoystickThreshold(float Threshold);
+
+private :
+
+    ////////////////////////////////////////////////////////////
+    /// Called after the window has been created
+    ///
+    ////////////////////////////////////////////////////////////
+    virtual void OnCreate();
+
+    ////////////////////////////////////////////////////////////
+    /// /see WindowListener::OnEvent
+    ///
+    /// \param EventReceived : Event received
+    ///
+    ////////////////////////////////////////////////////////////
+    virtual void OnEvent(const Event& EventReceived);
+
+    ////////////////////////////////////////////////////////////
+    /// Initialize internal window
+    ///
+    /// \param Impl : New internal window implementation
+    ///
+    ////////////////////////////////////////////////////////////
+    void Initialize(priv::WindowImpl* Impl);
+
+    ////////////////////////////////////////////////////////////
+    // Member data
+    ////////////////////////////////////////////////////////////
+    priv::WindowImpl* myWindow;         ///< Platform-specific implementation of window
+    std::queue<Event> myEvents;         ///< Queue of received events
+    Input             myInput;          ///< Input manager connected to window
+    Clock             myClock;          ///< Clock for measuring the elapsed time between frames
+    WindowSettings    mySettings;       ///< Creation settings of the window
+    float             myLastFrameTime;  ///< Time elapsed since last frame
+    bool              myIsExternal;     ///< Tell whether the window is internal or external (created by SFML or not)
+    unsigned int      myFramerateLimit; ///< Current framerate limit
+    int               mySetCursorPosX;  ///< X coordinate passed to the last call to SetCursorPosition
+    int               mySetCursorPosY;  ///< Y coordinate passed to the last call to SetCursorPosition
+};
+
+} // namespace sf
+
+
+#endif // SFML_WINDOW_HPP