Humble Framework for SkyOS

---

HCheckbox.h

Go to the documentation of this file.

/****************************************************************************
**
**  $Header: /SkyOS.root/HFramework/HCheckBox.h 2     4/17/05 12:29p Lee Neuse $
**
****************************************************************************/
#ifndef HCHECKBOX_H
#   define  HCHECKBOX_H

#ifndef HWIDGET_H
#   include "HWidget.h"
#endif

class HCheckbox :   public HWidget,
                    public HID
    {
    typedef HWidget     base_class;
    static StringPtr    ClassName(void) { return "HCheckbox"; }
/*  ----------------------------------------------------------------------
    CTOR/DTOR
    ----------------------------------------------------------------------  */
public:
    HCheckbox(int32 id = 0) : HWidget(), HID(id)
        { /* EMPTY CTOR */ }

    virtual             
    ~HCheckbox(void)
        { Destroy(); }
/*  ----------------------------------------------------------------------
    MESSAGE HANDLERS
    ----------------------------------------------------------------------  */
protected:
    BEGIN_MSG_MAP("HCheckbox")
        CHAIN_MAP( base_class )
    END_MSG_MAP
/*  ----------------------------------------------------------------------
    METHODS
    ----------------------------------------------------------------------  */
public:
    ErrCode
    Create(HANDLE hParent, int32 id, StringPtr pstrLabel, 
            HRect * prBounds = NULL, uint32 uStyle = 0)
        {
        HRect       rBounds;
        ErrCode     ec = HError::NoError();
        
        if (GOOD_HND(m_hMe))
            ec = HError::Set(ERR_DUPLICATE, __FILE__, __LINE__);
        else if (NULL_HND(hParent) || id == 0)
            ec = HError::Set(ERR_BAD_PARAMETER, __FILE__, __LINE__);
        else
            {
            int32           nX, nY,
                            nXDim, nYDim;
            
            if (NULL_PTR(prBounds) || prBounds->IsEmpty())
                nX = nY = nXDim = nYDim = 0;
            else
                {
                nX = prBounds->x1;
                nY = prBounds->y1;
                nXDim = prBounds->GetWidth();
                nYDim = prBounds->GetHeight();
                }
                
            m_hMe  = GI_create_widget_check(hParent, TEXT(pstrLabel), 
                                                nX, nY, nXDim, nYDim, 
                                                uStyle, id);
            if (NULL_HND(m_hMe))
                ec = HError::Set(ERR_API_ERROR, __FILE__, __LINE__);
            else    // all is well
                {
                m_id = id;
                DEBUG_LOG(  "HCheckbox[%p]::Create() => m_hMe = 0x%08lX\n", 
                            this, int32(m_hMe));
                }
            }

        return ec;
        }
/*  ----------------------------------------------------------------------
    GETTERS & SETTERS
    ----------------------------------------------------------------------  */
public:
    COLOR               GetBackColor(void) const
                            { 
                            widget_check *  pwc = getWidgetData();
                            return GOOD_PTR(pwc) ? pwc->ulBackGround : cWhite;
                            }
    static inline int32 GetPreferredHeight(void)
                            { return 20; }
    inline int32        GetState(void) const
                            { return IsValid() ? GI_widget_check_get(m_hMe) : 0; }
    ErrCode             SetEnabled(const bool bEnable = true)
                            {
                            ErrCode     ec = HError::NoError();
                            
                            if (IsValid())
                                {
                                HRESULT hr = (bEnable) ?    GI_widget_check_enable(m_hMe) :
                                                            GI_widget_check_disable(m_hMe);
                                    
                                if (hr != S_OK)
                                    ec = HError::Set(ERR_API_ERROR, __FILE__, __LINE__);
                                }
                            else
                                ec = HError::Set(ERR_NOT_INITIALIZED, __FILE__, __LINE__);
                            
                            return ec;
                            }
    ErrCode             SetState(int32 nState)
                            {
                            ErrCode     ec = HError::NoError();

                            if (IsValid())
                                {
                                if (widget_check_set(m_hMe, nState) != S_OK)
                                    ec = HError::Set(ERR_API_ERROR, __FILE__, __LINE__);
                                }
                            else
                                ec = HError::Set(ERR_NOT_INITIALIZED, __FILE__, __LINE__);
                            
                            return ec;
                            }
    ErrCode             SetText(StringPtr pstrLabel)
                            {
                            ErrCode     ec = HError::NoError();

                            if (!IsValid())
                                ec = HError::Set(ERR_NOT_INITIALIZED, __FILE__, __LINE__);
                            else if (STR_EMPTY(pstrLabel))
                                ec = HError::Set(ERR_BAD_PARAMETER, __FILE__, __LINE__);
                            else if (GI_widget_check_set_text(m_hMe, TEXT(pstrLabel)) != S_OK)
                                ec = HError::Set(ERR_API_ERROR, __FILE__, __LINE__);
                                                            
                            return ec;
                            }
protected:
    widget_check *      getWidgetData(void) const
                            { 
                            s_window *  pw = GetWindow();
                            return GOOD_PTR(pw) ? reinterpret_cast<widget_check *>(pw->windowData) : NULL;
                            }
/*  ----------------------------------------------------------------------
    INLINES
    ----------------------------------------------------------------------  */
public:
    inline bool         IsChecked(void) const
                            { return (GetState() != 0); }   
    };

#endif  // HCHECKBOX_H
/****************************************************************************
**
**  $History: HCheckBox.h $
 * 
 * *****************  Version 2  *****************
 * User: Lee Neuse    Date: 4/17/05    Time: 12:29p
 * Updated in $/SkyOS.root/HFramework
 * Development snapshot 050417
 * 
 * *****************  Version 1  *****************
 * User: Neusel       Date: 12/23/04   Time: 1:34p
 * Created in $/SkyOS.root/pig/Humble
 * Posted as HFramework-debug 20041223
**
**  -------------------------------------------------------------------------
**
**  End of HCheckbox.h
**
****************************************************************************/

---