sprint/gtl/ListBox.h

Go to the documentation of this file.

/******************************************************************************
 *  GTL: GUI Template Library 
 *    A Cross Platform C++ Wrapper for Win32 users
 *  Copyright (C) 2007-2011 Paolo Medici (www.pmx.it)
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *******************************************************************************/

#ifndef _SPRINT_LISTBOX_H
#define _SPRINT_LISTBOX_H

#include <sprint/gtl/Window.h>

namespace sprint {
        namespace gtl {

class ListBox : public CWindow
{
public:
// Constructors
        ListBox(HWND hWnd = NULL) : CWindow(hWnd)
        { }

/*
        HWND Create(HWND hWndParent, ATL::_U_RECT rect = NULL, LPCTSTR szWindowName = NULL,
                        DWORD dwStyle = 0, DWORD dwExStyle = 0,
                        ATL::_U_MENUorID MenuOrID = 0U, LPVOID lpCreateParam = NULL)
        {
                return TBase::Create(GetWndClassName(), hWndParent, rect.m_lpRect, szWindowName, dwStyle, dwExStyle, MenuOrID.m_hMenu, lpCreateParam);
        }
*/
// Attributes
        static LPCTSTR GetWndClassName()
        {
                return "LISTBOX";
        }

        // for entire listbox
        int GetCount() const
        {
                return (int)::SendMessage(m_hwnd, LB_GETCOUNT, 0, 0L);
        }

#ifndef _WIN32_WCE
        int SetCount(int cItems)
        {
                return (int)::SendMessage(m_hwnd, LB_SETCOUNT, cItems, 0L);
        }
#endif // !_WIN32_WCE

        int GetHorizontalExtent() const
        {
                return (int)::SendMessage(m_hwnd, LB_GETHORIZONTALEXTENT, 0, 0L);
        }

        void SetHorizontalExtent(int cxExtent)
        {
                ::SendMessage(m_hwnd, LB_SETHORIZONTALEXTENT, cxExtent, 0L);
        }

        int GetTopIndex() const
        {
                return (int)::SendMessage(m_hwnd, LB_GETTOPINDEX, 0, 0L);
        }

        int SetTopIndex(int nIndex)
        {
                return (int)::SendMessage(m_hwnd, LB_SETTOPINDEX, nIndex, 0L);
        }

        LCID GetLocale() const
        {
                return (LCID)::SendMessage(m_hwnd, LB_GETLOCALE, 0, 0L);
        }

        LCID SetLocale(LCID nNewLocale)
        {
                return (LCID)::SendMessage(m_hwnd, LB_SETLOCALE, (WPARAM)nNewLocale, 0L);
        }

#if (WINVER >= 0x0500) && !defined(_WIN32_WCE)
        DWORD GetListBoxInfo() const
        {
#if (_WIN32_WINNT >= 0x0501)
                return (DWORD)::SendMessage(m_hwnd, LB_GETLISTBOXINFO, 0, 0L);
#else // !(_WIN32_WINNT >= 0x0501)
                return ::GetListBoxInfo(m_hwnd);
#endif // !(_WIN32_WINNT >= 0x0501)
        }
#endif // (WINVER >= 0x0500) && !defined(_WIN32_WCE)

        // for single-selection listboxes
        int GetCurSel() const
        {
                return (int)::SendMessage(m_hwnd, LB_GETCURSEL, 0, 0L);
        }

        int SetCurSel(int nSelect)
        {
                return (int)::SendMessage(m_hwnd, LB_SETCURSEL, nSelect, 0L);
        }

        // for multiple-selection listboxes
        int GetSel(int nIndex) const           // also works for single-selection
        {
                return (int)::SendMessage(m_hwnd, LB_GETSEL, nIndex, 0L);
        }

        int SetSel(int nIndex, BOOL bSelect = TRUE)
        {
                return (int)::SendMessage(m_hwnd, LB_SETSEL, bSelect, nIndex);
        }

        int GetSelCount() const
        {
                return (int)::SendMessage(m_hwnd, LB_GETSELCOUNT, 0, 0L);
        }

        int GetSelItems(int nMaxItems, LPINT rgIndex) const
        {
                return (int)::SendMessage(m_hwnd, LB_GETSELITEMS, nMaxItems, (LPARAM)rgIndex);
        }

        int GetAnchorIndex() const
        {
                return (int)::SendMessage(m_hwnd, LB_GETANCHORINDEX, 0, 0L);
        }

        void SetAnchorIndex(int nIndex)
        {
                ::SendMessage(m_hwnd, LB_SETANCHORINDEX, nIndex, 0L);
        }

        int GetCaretIndex() const
        {
                return (int)::SendMessage(m_hwnd, LB_GETCARETINDEX, 0, 0);
        }

        int SetCaretIndex(int nIndex, BOOL bScroll = TRUE)
        {
                return (int)::SendMessage(m_hwnd, LB_SETCARETINDEX, nIndex, MAKELONG(bScroll, 0));
        }

        // for listbox items
        DWORD_PTR GetItemData(int nIndex) const
        {
                return (DWORD_PTR)::SendMessage(m_hwnd, LB_GETITEMDATA, nIndex, 0L);
        }

        int SetItemData(int nIndex, DWORD_PTR dwItemData)
        {
                return (int)::SendMessage(m_hwnd, LB_SETITEMDATA, nIndex, (LPARAM)dwItemData);
        }

        void* GetItemDataPtr(int nIndex) const
        {
                return (void*)::SendMessage(m_hwnd, LB_GETITEMDATA, nIndex, 0L);
        }

        int SetItemDataPtr(int nIndex, void* pData)
        {
                return SetItemData(nIndex, (DWORD_PTR)pData);
        }

        int GetItemRect(int nIndex, LPRECT lpRect) const
        {
                return (int)::SendMessage(m_hwnd, LB_GETITEMRECT, nIndex, (LPARAM)lpRect);
        }

        int GetText(int nIndex, LPTSTR lpszBuffer) const
        {
                return (int)::SendMessage(m_hwnd, LB_GETTEXT, nIndex, (LPARAM)lpszBuffer);
        }

        int GetTextLen(int nIndex) const
        {
                return (int)::SendMessage(m_hwnd, LB_GETTEXTLEN, nIndex, 0L);
        }

        int GetItemHeight(int nIndex) const
        {
                return (int)::SendMessage(m_hwnd, LB_GETITEMHEIGHT, nIndex, 0L);
        }

        int SetItemHeight(int nIndex, UINT cyItemHeight)
        {
                return (int)::SendMessage(m_hwnd, LB_SETITEMHEIGHT, nIndex, MAKELONG(cyItemHeight, 0));
        }

        // Settable only attributes
        void SetColumnWidth(int cxWidth)
        {
                ::SendMessage(m_hwnd, LB_SETCOLUMNWIDTH, cxWidth, 0L);
        }

        BOOL SetTabStops(int nTabStops, LPINT rgTabStops)
        {
                return (BOOL)::SendMessage(m_hwnd, LB_SETTABSTOPS, nTabStops, (LPARAM)rgTabStops);
        }

        BOOL SetTabStops()
        {
                return (BOOL)::SendMessage(m_hwnd, LB_SETTABSTOPS, 0, 0L);
        }

        BOOL SetTabStops(const int& cxEachStop)    // takes an 'int'
        {
                return (BOOL)::SendMessage(m_hwnd, LB_SETTABSTOPS, 1, (LPARAM)(LPINT)&cxEachStop);
        }

// Operations
        int InitStorage(int nItems, UINT nBytes)
        {
                return (int)::SendMessage(m_hwnd, LB_INITSTORAGE, (WPARAM)nItems, nBytes);
        }

        void ResetContent()
        {
                ::SendMessage(m_hwnd, LB_RESETCONTENT, 0, 0L);
        }

        UINT ItemFromPoint(POINT pt, BOOL& bOutside) const
        {
                DWORD dw = (DWORD)::SendMessage(m_hwnd, LB_ITEMFROMPOINT, 0, MAKELPARAM(pt.x, pt.y));
                bOutside = (BOOL)HIWORD(dw);
                return (UINT)LOWORD(dw);
        }

        // manipulating listbox items
        int AddString(LPCTSTR lpszItem)
        {
                return (int)::SendMessage(m_hwnd, LB_ADDSTRING, 0, (LPARAM)lpszItem);
        }

        int DeleteString(UINT nIndex)
        {
                return (int)::SendMessage(m_hwnd, LB_DELETESTRING, nIndex, 0L);
        }

        int InsertString(int nIndex, LPCTSTR lpszItem)
        {
                return (int)::SendMessage(m_hwnd, LB_INSERTSTRING, nIndex, (LPARAM)lpszItem);
        }

#ifndef _WIN32_WCE
        int Dir(UINT attr, LPCTSTR lpszWildCard)
        {
                return (int)::SendMessage(m_hwnd, LB_DIR, attr, (LPARAM)lpszWildCard);
        }

        int AddFile(LPCTSTR lpstrFileName)
        {
                return (int)::SendMessage(m_hwnd, LB_ADDFILE, 0, (LPARAM)lpstrFileName);
        }
#endif // !_WIN32_WCE

        // selection helpers
        int FindString(int nStartAfter, LPCTSTR lpszItem) const
        {
                return (int)::SendMessage(m_hwnd, LB_FINDSTRING, nStartAfter, (LPARAM)lpszItem);
        }

        int FindStringExact(int nIndexStart, LPCTSTR lpszFind) const
        {
                return (int)::SendMessage(m_hwnd, LB_FINDSTRINGEXACT, nIndexStart, (LPARAM)lpszFind);
        }

        int SelectString(int nStartAfter, LPCTSTR lpszItem)
        {
                return (int)::SendMessage(m_hwnd, LB_SELECTSTRING, nStartAfter, (LPARAM)lpszItem);
        }

        int SelItemRange(BOOL bSelect, int nFirstItem, int nLastItem)
        {
                return bSelect ? (int)::SendMessage(m_hwnd, LB_SELITEMRANGEEX, nFirstItem, nLastItem) : (int)::SendMessage(m_hwnd, LB_SELITEMRANGEEX, nLastItem, nFirstItem);
        }

#ifdef WIN32_PLATFORM_WFSP   // SmartPhone only messages
        DWORD GetInputMode(BOOL bCurrentMode = TRUE)
        {
                return SendMessage(LB_GETINPUTMODE, 0, (LPARAM)bCurrentMode);
        }

        BOOL SetInputMode(DWORD dwMode)
        {
                return SendMessage(LB_SETINPUTMODE, 0, (LPARAM)dwMode);
        }
#endif // WIN32_PLATFORM_WFSP
};

}
}

#endif