CascadeButtonWidget.h

Go to the documentation of this file.

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

#ifndef _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADEBUTTONWIDGET_H
#define _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADEBUTTONWIDGET_H

#include <cascade/widgets/CascadeWidget.h>
#include <cascade/util/CascadeString.h>

class CascadeButtonWidget : public CascadeWidget
{
public:
    CascadeButtonWidget();
    virtual ~CascadeButtonWidget();
public:
    enum State {
        kOff = 0,       
        kOn = 1         
    };
    enum TextVAlign {
        kTextAlignAbove = 0,        
        kTextAlignTop = 1,          
        kTextAlignMiddle = 2,       
        kTextAlignBottom = 3 ,      
        kTextAlignBelow = 4         
    };

    enum { kVAlignSpacing = 2 };    
    
    enum TextHAlign {
        kTextAlignLeft = 0,     
        kTextAlignCenter = 1,   
        kTextAlignRight = 2     
    };
public:
    inline State GetState();
        
    inline void SetState(const State & state);

    void ToggleState();

    void SetBitmapUp(CascadeBitmap * pBitmap, CascadeWidget::Scheme scheme);
    void SetBitmapDown(CascadeBitmap * pBitmap, CascadeWidget::Scheme scheme);

    void SetText(const CascadeString & string);

    inline void SetTextAlignment(TextVAlign vAlign, TextHAlign hAlign = kTextAlignCenter);
    
    typedef void (StateChangeCallback)(const CascadeButtonWidget * pButton, const State & newState, void * pClientData);
        
    void RegisterStateChangeCallback(StateChangeCallback * pCallback, void * pClientData);

protected: // class CascadeButtonWidget virtual functions
    virtual void OnStateChange(const State & newState);

protected: // virtual functions overridden from base classes
    virtual bool OnKeyDown(u32 nKey);

    virtual void OnPaint(CascadeBitmap & bitmap);

protected:
    State                   m_state;
    CascadeString           m_text;
    CascadeBitmap *         m_pBitmapsUp[CascadeWidget::kNumSchemes];
    CascadeBitmap *         m_pBitmapsDown[CascadeWidget::kNumSchemes];
    StateChangeCallback *   m_pCallback;
    void *                  m_pClientData;
    TextHAlign              m_textHAlign;
    TextVAlign              m_textVAlign;
private:
    CascadeFont m_font;
    CascadeDims m_dimsText;
};

// class CascadePictureWidget inline functions
inline CascadeButtonWidget::State
CascadeButtonWidget::GetState()
{
    return m_state;
}

inline void
CascadeButtonWidget::SetState(const CascadeButtonWidget::State & state)
{
    if (state != m_state) ToggleState();
}

inline void
CascadeButtonWidget::SetTextAlignment(TextVAlign vAlign, TextHAlign hAlign)
{
    m_textVAlign = vAlign;
    m_textHAlign  = hAlign;
}

#endif // #ifndef _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADEBUTTONWIDGET_H

//  LOG
//  06-Mar-03   dwoodward   created
//  14-May-03   dwoodward   doxygenated
//  09-Nov-04   dwoodward   added m_font and m_dimsText

---