cXListBox.h

Go to the documentation of this file.

//
//
#ifndef _INC_cXListBox_H
#define _INC_cXListBox_H
#pragma once
 
#include "cXCheckBox.h"
#include "cXButton.h"
#include "cXScrollBar.h"
 
namespace GrayGUI
{
        typedef cXCheckBox cXListItem;  // same thing.
        typedef cXCheckBoxPtr cXListItemPtr;            // same thing.
 
        class cXListBox : public cXWindowText
        {
                friend class cXComboBox;
                typedef cXWindowText SUPER_t;
        public:
                cXListBox(cXWindow* pParent, DLGID_t id, bool bCheckSelected = true, bool bCollapsable = false);
                virtual ~cXListBox();
                virtual bool InitXWindow(void);
                virtual HRESULT DisposeThis();
 
                virtual bool OnMouseWheel(MBUTTON_TYPE uButton, PIXELS_t x, PIXELS_t y, short nWheelChange);
                virtual bool OnChar(VK_TYPE vKey);
                virtual bool OnCommand(DLGID_t id, cXWindow* pCtrl, WORD wNotify);
 
                virtual void OnContextMenu(cXMenu* pMenu, cXWindow* pCtrl);
                virtual void OnScroll(int iPos, cXWindow* pCtrl);
                virtual void OnSize(UINT uType, PIXELS_t cx, PIXELS_t cy);
 
                int get_ItemCount(void) const
                {
                        return m_aChildren.GetSize();
                }
                void AddNewItemCtrl(cXListItem* pItem, int index = -1, bool bUpdate = true);
                cXListItemPtr AddNewItem(const GChar_t* pszCaption, cVariant& vData = cVariant());
                bool RemoveListAt(int i);
                void RemoveListItem(cXListItem* Item);
                void RemoveListAll();
                void ClearItems();
                void UpdateItemOrder(bool bReSize);
                bool UpdateScroller(bool bSetSize);
                void UpdateChildren();
                void UpdateView();
                void QSort();
                int FindString(cString strItem, bool bPartialMatch = false) const;
                cXListItemPtr FindStringPtr(cString strItem, bool bPartialMatch = false) const;
                cXListItemPtr get_ItemUnderCursor() const;
 
                // Display of items.
                PIXELS_t get_ItemHeight() const
                {
                        return m_lListItemHeight;       // from g_XStylePrefs.GetFontSize(FONTSCALE_Medium)
                }
                void put_ItemHeight(PIXELS_t lHeight)
                {
                        m_lListItemHeight = lHeight;
                        UpdateMaxItemsCanShow();
                }
                void ScrollToTop(int nItem);
                void ScrollToView(int nItem);
 
                // Selection of items.
                cXListItemPtr get_Selected() const
                {
                        return m_pSelectedItem;
                }
                int get_SelectedID() const
                {
                        //  should be same as m_nSelectedItem. USE DLGID_t??
                        if (m_pSelectedItem == nullptr)
                                return -1;
                        return m_pSelectedItem->get_DlgID();
                }
                cVariant get_SelectedItemData(void) const
                {
                        if (m_pSelectedItem == nullptr)
                                return cVariant();
                        return m_pSelectedItem->get_UserData();
                }
                void put_Selected(cXListItem* pSelect);
                void put_SelectedItem(int nItem);
                void put_SelectedItemString(cString strItem, bool bPartialMatch = false);
 
                cXListItemPtr GetItemAt(long iSlot);
                void put_ColorType(bool bColorType)
                {
                        m_bColorType = bColorType;
                }
                int get_MaxItemsCanShow() const
                {
                        // given the size of the window . how many elements can i show?
                        return m_iMaxItemsCanShow;
                }
 
                cXScrollBarPtr get_ScrollBar() const
                {
                        return m_pScrollBar;
                }
 
                PIXELS_t get_ScrollBarWidth() const
                {
                        return m_pScrollBar->get_Width();
                }
 
                void DrawListItemsOpaque(void);
 
                virtual void put_BackAlpha(COLOR_ELEM_t bAlpha);
 
                bool get_CheckSelected() const
                {
                        return m_bCheckSelected;
                }
                void put_CheckSelected(bool bCheckSelected)
                {
                        if (m_bCheckSelected == bCheckSelected)
                                return;
                        m_bCheckSelected = bCheckSelected;
                }
                int get_TopDisplay() const
                {
                        return m_iTopDisplay;
                }
 
                int get_ItemsExpanded() const
                {
                        // How many items are actually expanded now, for the scroll bar.
                        return m_iItemsExpanded;
                }
 
                void put_ExpandedAll(bool bExpandAll);
 
                void put_Collapsable(bool bCollapsable);
                bool get_Collapsable(void) const
                {
                        return m_bCollapsable;
                }
 
        protected:
                void SetItemAlpha(cXListItem* pItem, bool bSelect, int iAlpha);
                void SetItemState(cXListItem* pItem, bool bSelect);
 
                bool get_WantScrollBar() const;
                void UpdateMaxItemsCanShow();
                int FindNextExpanded(int iDelta) const;
 
        public:
                cArraySortName<cXListItem> m_aChildren;
 
        protected:
                cXScrollBarPtr m_pScrollBar;
 
                int m_iTopDisplay;                                                      // item currently at the top of the window.
                int m_iMaxItemsCanShow;                                         // number of items i can show at once. given OnSize()
                PIXELS_t m_lListItemHeight;                                             // in pixels
 
                int m_nSelectedItem;                                            // enum id of the selected item.
                cXListItemPtr m_pSelectedItem;
 
                bool m_bColorType;
                bool m_bCheckSelected;                                          // whether the list treats selected items as checkboxes or buttons
 
                // NOT YET WORKING! ???                                         // with a truth value that we'll later read?
                // bool m_bAllowMultiSelect;
 
                // All collapsability code now in cXListBox
                bool m_bCollapsable;                                            //denotes this listbox as being collapable. inserts cXListItemHeaders.
                int m_iItemsExpanded;                                           //size of list, collapsed states considered. Updated from UpdateItemOrder
        };
 
        typedef cRefPtr<cXListBox> cXListBoxPtr;
};
 
#endif