CascadeWindow.h

Go to the documentation of this file.

//
// CascadeWindow.h - header file for class CascadeWindow
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_APP_CASCADEWINDOW_H
#define _ROKU_INCLUDE_CASCADE_APP_CASCADEWINDOW_H

#include <cascade/CascadeObject.h>
#include <cascade/graphics/CascadeRect.h>
#include <cascade/graphics/CascadeBitmap.h>

class CascadeWindow : public CascadeObject
{
public:
        CascadeWindow();
        virtual ~CascadeWindow();
        
public: // dealing with top-level window visibility and z-order
    enum Plane {
        kBottomMost = 0,            
        kTopMost = 2,               
        kAppNormal = 1              
    };
    void Materialize(Plane plane = kAppNormal);
    void Vanish();
    void Redraw();
    void Redraw(const CascadeRect & rect);
    static void RedrawScreen();
public: // dealing with my geometry
    CascadeRect GetRectRelative() const;
    CascadeRect GetRectAbsolute() const;
    void SetRectRelative(const CascadeRect & rect);
    void SetRectAbsolute(const CascadeRect & rect);

 public: // dealing with my relationship to other windows
    inline CascadeWindow * GetParent();
    inline CascadeWindow * GetFirstChild();
    inline CascadeWindow * GetFirstSibling();
    void AddChild(CascadeWindow * pWndChild);
    void RemoveChild(CascadeWindow * pWndChild);
    bool IsParentOf(CascadeWindow * pWindow);
    bool IsChildOf(CascadeWindow * pWindow);
    bool IsSiblingOf(CascadeWindow * pWindow);
    CascadeWindow * GetTopLevelWindow();

public: // enumerating my child window tree
    typedef bool (EnumProc)(CascadeWindow * pWindow, void * pClientData);
    bool EnumerateTree(EnumProc * pEnumProc, void * pClientData);

public:  // dealing with painting
    virtual void OnPaint(CascadeBitmap & bitmap);
    void PaintTree(CascadeBitmap & bitmap);
        
public: // visibility
    bool IsVisible();
    
public: // dealing with materialization
    virtual void OnMaterialize();
    virtual void OnMaterialized();
    virtual void OnVanish();

public: // dealing with focus
    virtual void OnClearFocus();
    virtual void OnSetFocus();

public: // dealing with notification

    virtual bool OnKeyDown(u32 nKey);
    virtual bool OnKeyUp(u32 nKey);
    virtual bool OnNavKey(u32 nKey, CascadeWindow * & pProposedNewFocusWnd);

public: // functions dealing with focus
    virtual bool WillAcceptFocus();
    bool IsActiveFocus();
    bool IsInactiveFocus();
    bool IsFocus();
    void SetFocus(bool bRedraw = true);
    void ClearFocus(bool bRedraw = true);
    static CascadeWindow * GetFocus();

private:
    bool EnumerateRecursively(CascadeWindow * pWindow, CascadeWindow::EnumProc * pEnumProc, void * pClientData);
    static bool StaticPaintTreeEnumProc(CascadeWindow * pWindow, void * pClientData);

#ifndef DOXY_SKIP
friend class CascadeApp;
#endif

    bool ProcessNavKey(u32 nKey);

private:
    CascadeRect     m_rect;
    CascadeWindow * m_pWndParent;
    CascadeWindow * m_pWndChild;
    CascadeWindow * m_pWndSibling;
};

// class CascadeWindow inline functions
inline CascadeWindow *
CascadeWindow::GetParent()
{
    return m_pWndParent;
}

inline CascadeWindow *
CascadeWindow::GetFirstChild()
{
    return m_pWndChild;
}

inline CascadeWindow *
CascadeWindow::GetFirstSibling()
{
    return m_pWndSibling;

}

#endif // #ifndef _ROKU_INCLUDE_CASCADE_APP_CASCADEWINDOW_H

//  LOG
//  10-Feb-03   dwoodward       created
//  19-Feb-03   dwoodward   got rid of nRepeatCount parm to OnKeyDown
//  20-Feb-03   dwoodward   added WillAcceptFocus()
//  25-Feb-03   dwoodward   added Redraw()
//  25-Feb-03   dwoodward   added OnSetFocus() and OnClearFocus()
//  12-Mar-03   dwoodward   added IsVisible()
//  14-Apr-03   dwoodward   changed OnNavKey() behavior
//  14-Apr-03   dwoodward   added ProcessNavKey
//  01-May-03   dwoodward   added a version of Redraw() that takes a rect
//  05-May-03   dwoodward   doxygenated
//  04-Jun-03   dwoodward   added RedrawScreen
//  28-Jul-03   dwoodward   added bRedraw parameter to SetFocus and ClearFocus
//  07-Jul-03   mjkobb      Updated GetRectAbsolute, GetRectRelative to be
//                          const.
//  09-Sep-04   dwoodward   added OnMaterialized()

---