CascadeSpinnerWidget.h

Go to the documentation of this file.

//
// CascadeSpinnerWidget.h - interface of class CascadeSpinnerWidget
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//
#ifndef _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADESPINNERWIDGET_H
#define _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADESPINNERWIDGET_H

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

class CascadeSpinnerWidget : public CascadeWidget
{
public:
    CascadeSpinnerWidget();
    virtual ~CascadeSpinnerWidget();
public:

    void SetBitmapHighlight(CascadeBitmap * pBitmap);
                
    void SetBitmapNormal(CascadeBitmap * pBitmap);

    void SetTextOptions(const CascadeString* inStringList, u32 nCount);

    typedef void (ChoiceChangeCallback)(const CascadeSpinnerWidget * pSpinner,const u32 & newChoice, void * pClientData);
                
    void RegisterChoiceChangeCallback(ChoiceChangeCallback * pCallback, void * pClientData);

    void SetSpinOnSelect(bool bSpinOnSelect) { m_bSpinOnSelect = bSpinOnSelect; }
    
    bool GetSpinOnSelect() { return m_bSpinOnSelect; }
    
    u32 GetCurrentChoiceIndex() const { return m_nCurrentChoice; }
                
    bool SetCurrentChoiceIndex(u32 inNewChoiceIndex);
                
    bool SetCurrentChoiceString(const CascadeString& inNewChoiceString);
    
protected: // virtual functions overridden from base classes
    virtual bool OnKeyDown(u32 nKey);

    virtual void OnPaint(CascadeBitmap & bitmap);

    virtual bool OnNavKey(u32 nKey, CascadeWindow * & pProposedNewFocusWnd);
        
                
protected:
    const CascadeString*   m_textChoices;
    u32              m_nNumChoices;
    u32              m_nCurrentChoice;
    CascadeBitmap*  m_pBitmapHighlight;
    CascadeBitmap*  m_pBitmapNormal;
    ChoiceChangeCallback * m_pCallback;
    void * m_pClientData;
    bool m_bSpinOnSelect;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_WIDGETS_CASCADESPINNERWIDGET_H

//  LOG
//  06-Mar-03   pellis      created
//  31-Jul-03   dwoodward   made GetCurrentChoiceIndex const
//  31-Jul-03   dwoodward   added GetSpinOnSelect and SetSpinOnSelect

---