CATListBox.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
/// \file CATListBox.h
/// \brief list box for GUI
/// \ingroup CATGUI
///
/// Copyright (c) 2003-2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-24 06:27:32 -0600 (Thu, 24 Jan 2008) $
// $Revision:   $
// $NoKeywords: $
//
//
//---------------------------------------------------------------------------
#ifndef _GGListBox_H_
#define _GGListBox_H_

#include "CATControlWnd.h"
#include <vector>

class CATListBox;

struct CATLISTINFO
{
    CATString       DisplayText;
    void*           ListInfo;
    CATListBox*     BaseListBox;
};


/// \class CATListBox
/// \brief list box for GUI
/// \\ingroup CATGUI
class CATListBox : public CATControlWnd
{
public:
    CATListBox(  const CATString&             element, 
        const CATString&             rootDir);

    virtual ~CATListBox();

    virtual bool OnControlEvent( const CATEvent& event,  CATInt32& result);
    virtual CATResult OnEvent(const CATEvent& event, CATInt32& retVal);

    virtual void SetFocused(bool focused);

    virtual CATString GetHint() const   ;

    virtual void OnEscapeChange();

    virtual void OnParentCreate();
    virtual void OnParentDestroy();

    virtual CATInt32    GetCount() const;

    virtual CATInt32    GetCurIndex() const;

    virtual CATResult  SetCurSel( CATInt32 index = -1);

    virtual CATString  GetText( CATInt32 index = -1) const;

    virtual CATResult  SetCurSelByName( const CATString& displayText);

    virtual CATResult  Insert( const CATString&  displayText,
        void*            dataPtr,
        CATInt32           index = -1);

    virtual CATResult  Remove( CATInt32    index);

    virtual CATResult  RemoveByName( const CATString& displayText);


    virtual CATResult  Get( CATInt32       index,
        CATString&    displayTextRef,
        void*&       dataRef) const;

    virtual CATResult  GetByName(  const CATString& displayTextRef,
        void*&          dataRef) const;

    virtual CATResult  Clear    ();

    virtual CATCommand GetCommand() const ;

    // GetString retrieves current string, which is either the nulltext
    // or whatever is selected.
    virtual CATString GetString () const;

    virtual void   OSOnMeasureItem( CATLISTINFO* listItem, CATUInt32& width, CATUInt32& height);
    virtual void   OSOnDrawItem(        CATLISTINFO* listItem, bool selected, CATDRAWCONTEXT hDC, CATRect rect );
protected:

    CATResult OSEvent(const CATEvent& event, CATInt32& retVal);

    void     OSClearList    ();
    CATResult OSAddItem      ( CATInt32 index, const CATString& displayText, const CATLISTINFO* listInfo);
    CATResult OSRemoveItem   ( CATInt32 index );
    CATInt32   OSGetCurSel    ();
    CATResult OSSetCurSel    ( CATInt32 index );

#ifdef _WIN32
    virtual CATUInt32     GetAccessRole() {return CAT_ROLE_SYSTEM_LIST;}
#endif

protected:
    CATFONT      fFont;

    CATInt32      fCurSel;
    std::vector   <CATLISTINFO*> fList;
};

#endif // _GGListBox_H_

---