Window.h

Go to the documentation of this file.

//**********************************************************************
//
//  REGCOM: Regimental Command
//  Copyright (C) 2008 Randi J. Relander
//    <rjrelander@users.sourceforge.net>
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//  
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//  
//  You should have received a copy of the GNU General Public
//  License along with this program.  If not, see 
//  <http://www.gnu.org/licenses/>.
//  
//**********************************************************************

#ifndef REGCOM_GUI_WINDOW_H
#define REGCOM_GUI_WINDOW_H

// SYSTEM INCLUDES
#include <string>

// LIBRARY INCLUDES
#include "SDL.h"

// PROJECT INCLUDES
#include "regcom/gui/Rect.h"
#include "regcom/gui/Point.h"

// NAMESPACES
namespace regcom {
namespace gui {

// FORWARD REFERENCES
class Surface;
class Color;

//  CLASS: Window
class Window
{
public:

    // PUBLIC METHODS

    Window();

    virtual ~Window();

    virtual void Update(Rect rect);

    virtual void UpdateChild(Window* child, Rect rect);

    virtual void Draw(Rect rect);
    
    void DrawSurface(Surface* surface, Rect rect);

    void DrawSurface(Surface* surface, Rect src, int x, int y);

    void FillRect(const Rect& rRect, const Color& rColor);

    virtual void OnMouseMove(Point point);

    virtual void OnMouseDown(int n, Point point);

    virtual void OnMouseUp(int n, Point point);

    virtual void Invalidate(Rect rect);

    virtual void Invalidate();

    Rect Bounds() {return Rect(0,0,m_Frame.w,m_Frame.h); }

    Rect Frame() { return m_Frame; }

    void ResizeTo(int w, int h);

    void ResizeBy(int w, int h);

    void OffsetTo(int x, int y);

    void OffsetBy(int x, int y);

    virtual void FrameMoved(Point point);

    virtual void FrameResized(int w, int h);

    int Width() { return m_Frame.w; }

    int Height() { return m_Frame.h; }

    virtual int Contains(Point point) { return m_Frame.Contains(point); }

    void AddChild(Window* window);

    virtual Window* FindWindow(Point point);

    Point ConvertFromScreen(Point point)
    {
        int x = point.GetX() - m_Frame.x;
        int y = point.GetY() - m_Frame.y;
        
        if (m_pParent)
            return m_pParent->ConvertFromScreen(Point(x,y));
        else return Point(x,y);
    }

    Point ConvertToScreen(Point point)
    {
        int x = point.GetX() + m_Frame.x;
        int y = point.GetY() + m_Frame.y;
        
        if (m_pParent)
            return m_pParent->ConvertToScreen(Point(x,y));
        else return Point(x,y);
    }

    void CaptureMouse(Rect rect);

    void ReleaseMouse();

    Window* GetCaptureView();

    Rect GetCaptureRect();

    void SetMouseOverride(bool override);

    bool GetMouseOverride();

    void SetMousePosition(Point position);

    Point GetMousePosition();

    Window* GetParent() { return m_pParent; }

    void SetParent(Window* window) { m_pParent = window; }

    virtual bool CanFocus() { return false; }

    virtual void OnFocus(bool hasFocus) { }

    virtual void OnMouseButtonDown(SDL_MouseButtonEvent sdlEvent) { }

    virtual void OnMouseButtonUp(SDL_MouseButtonEvent sdlEvent) { }

    virtual void OnKeyDown(SDL_KeyboardEvent sdlEvent) { }

    virtual void OnKeyUp(SDL_KeyboardEvent sdlEvent) { }

    virtual void OnTimer(float deltaTime);

    Window* GetNextWindow()
    {
        if (m_pFirstChild) return m_pFirstChild;
        if (m_pNextSibling) return m_pNextSibling;

        Window* pWindow = this;

        while (pWindow->m_pParent)
        {
            pWindow = pWindow->m_pParent;

            if (pWindow->m_pNextSibling) return pWindow->m_pNextSibling;
        }

        return pWindow;
    }

private:

    // MEMBER VARIABLES

    Rect m_Frame;

    static Window* s_pCaptureView;

    static Rect s_CaptureRect;

    static Point s_MousePosition;

    static bool s_MouseOverride;

    Window* m_pParent;

    Window* m_pFirstChild;

    Window* m_pLastChild;

    Window* m_pPrevSibling;

    Window* m_pNextSibling;
};

} // namespace gui
} // namespace regcom

#endif

Navigation

Home Page
Screen Shots
Developers
Documentation

Doxygen

Namespace List
Class List
Class Hierarchy
File List
Todo List

Links

SDL Library
License
SourceForge Project
Forums
Download

Regimental Command
Copyright © 2008
Randi J. Relander