Window/Window.hpp

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Window

Window/Window.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 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;
}

class SFML_API Window : public WindowListener, NonCopyable
{
public :

    Window();

    Window(VideoMode Mode, const std::string& Title, unsigned long WindowStyle = Style::Resize | Style::Close, const WindowSettings& Params = WindowSettings());

    Window(WindowHandle Handle, const WindowSettings& Params = WindowSettings());

    virtual ~Window();

    void Create(VideoMode Mode, const std::string& Title, unsigned long WindowStyle = Style::Resize | Style::Close, const WindowSettings& Params = WindowSettings());

    void Create(WindowHandle Handle, const WindowSettings& Params = WindowSettings());

    void Close();

    bool IsOpened() const;

    unsigned int GetWidth() const;

    unsigned int GetHeight() const;

    const WindowSettings& GetSettings() const;

    bool GetEvent(Event& EventReceived);

    void UseVerticalSync(bool Enabled);

    void ShowMouseCursor(bool Show);

    void SetCursorPosition(unsigned int Left, unsigned int Top);

    void SetPosition(int Left, int Top);

    void SetSize(unsigned int Width, unsigned int Height);

    void Show(bool State);

    void EnableKeyRepeat(bool Enabled);

    void SetIcon(unsigned int Width, unsigned int Height, const Uint8* Pixels);

    bool SetActive(bool Active = true) const;

    void Display();

    const Input& GetInput() const;

    void SetFramerateLimit(unsigned int Limit);

    float GetFrameTime() const;

    void SetJoystickThreshold(float Threshold);
 
private :

    virtual void OnCreate();

    virtual void OnEvent(const Event& EventReceived);

    void Initialize(priv::WindowImpl* Impl);

    // Member data
    priv::WindowImpl* myWindow;         
    std::queue<Event> myEvents;         
    Input             myInput;          
    Clock             myClock;          
    WindowSettings    mySettings;       
    float             myLastFrameTime;  
    bool              myIsExternal;     
    unsigned int      myFramerateLimit; 
    int               mySetCursorPosX;  
    int               mySetCursorPosY;  
};
 
} // namespace sf
 
 
#endif // SFML_WINDOW_HPP