CascadeWidget.h

Go to the documentation of this file.

//
// CascadeWidget.h - interface of class CascadeWidget
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADEWIDGET_H
#define _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADEWIDGET_H

#include <cascade/app/CascadeWindow.h>
#include <cascade/graphics/CascadeBitmap.h>
#include <cascade/graphics/CascadeColor.h>
#include <cascade/graphics/CascadeFont.h>

class CascadeWidget : public CascadeWindow
{
public:
    CascadeWidget();
    virtual ~CascadeWidget();
public:
    enum Scheme {
        kActiveNormal = 0,              
        kActiveFocus = 1,               
        kInactiveNormal = 2,            
        kInactiveFocus = 3,             
        kDisabled = 4,                  
        kNumSchemes = kDisabled + 1
    };
public:
    inline CascadeColor GetColorHi();      // the hilight color for 3d elements
    inline CascadeColor GetColorLo();      // the lolight color for 3d elements
    inline CascadeColor GetColorMid();     // the background or mid color for 3d elements
    inline CascadeColor GetColorText();    // the color text should be rendered in
    inline CascadeFont  GetFont();         // the font text should be rendered in
    void SetDisabled(bool bDisabled, bool bRedraw = true);
    inline bool IsDisabled() const ;

    Scheme GetScheme();
            
public:
    static CascadeColor GetColorHi(Scheme scheme);
    static CascadeColor GetColorLo(Scheme scheme);
    static CascadeColor GetColorMid(Scheme scheme);
    static CascadeColor GetColorText(Scheme scheme);
    static CascadeFont  GetFont(Scheme scheme);

    static void SetColorHi(const CascadeColor & color, Scheme scheme);
    static void SetColorLo(const CascadeColor & color, Scheme scheme);
    static void SetColorMid(const CascadeColor & color, Scheme scheme);
    static void SetColorText(const CascadeColor & color, Scheme scheme);
    static void SetFont(const CascadeFont & font, Scheme scheme);

    static void NotifyParametersChanged();

public:
    virtual bool WillAcceptFocus() { return (! m_bDisabled); }

protected:
    bool m_bDisabled;
private:

#ifndef DOXY_SKIP
    friend class CascadeApp;
#endif

    static void ReCacheSharedParameters();
};

// class CascadeWidget inline functions
inline CascadeColor CascadeWidget::GetColorHi()     { return GetColorHi(GetScheme());   }
inline CascadeColor CascadeWidget::GetColorLo()     { return GetColorLo(GetScheme());  }
inline CascadeColor CascadeWidget::GetColorMid()    { return GetColorMid(GetScheme());   }
inline CascadeColor CascadeWidget::GetColorText()   { return GetColorText(GetScheme()); }
inline CascadeFont  CascadeWidget::GetFont()        { return GetFont(GetScheme());      }
inline bool         CascadeWidget::IsDisabled() const     { return m_bDisabled;         }

#endif // #ifndef _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADEWIDGET_H

//  LOG
//  06-Mar-03   dwoodward   created
//  25-Apr-03   dwoodward   changed SetFont() to take a font, not font attributes
//  25-Apr-03   dwoodward   added SetDisabled(), IsDisabled(), m_bDisabled
//  14-May-03   dwoodward   doxygenated
//  14-May-03   dwoodward   fixed GetColorLo and GetColorMid
//  22-May-03   dwoodward   renamed Initialize() to ReCacheSharedParameters()

---