You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

382 lines
11 KiB

/* /////////////////////////////////////////////////////////////////////////
* File: winstl/controls/commctrl_functionals.hpp
*
* Purpose: Functionals for application to common controls.
*
* Created: 8th October 2002
* Updated: 10th August 2009
*
* Home: http://stlsoft.org/
*
* Copyright (c) 2002-2009, Matthew Wilson and Synesis Software
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
* any contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* ////////////////////////////////////////////////////////////////////// */
/** \file winstl/controls/commctrl_functionals.hpp
*
* \brief [C++ only] Functionals for application to common controls
* (\ref group__library__windows_controls "Windows Controls" Library).
*/
#ifndef WINSTL_INCL_WINSTL_CONTROLS_HPP_COMMCTRL_FUNCTIONALS
#define WINSTL_INCL_WINSTL_CONTROLS_HPP_COMMCTRL_FUNCTIONALS
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define WINSTL_VER_WINSTL_CONTROLS_HPP_COMMCTRL_FUNCTIONALS_MAJOR 4
# define WINSTL_VER_WINSTL_CONTROLS_HPP_COMMCTRL_FUNCTIONALS_MINOR 1
# define WINSTL_VER_WINSTL_CONTROLS_HPP_COMMCTRL_FUNCTIONALS_REVISION 4
# define WINSTL_VER_WINSTL_CONTROLS_HPP_COMMCTRL_FUNCTIONALS_EDIT 75
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
/* /////////////////////////////////////////////////////////////////////////
* Compatibility
*/
/*
[Incompatibilies-start]
STLSOFT_COMPILER_IS_DMC: __DMC__<0x0850
STLSOFT_COMPILER_IS_GCC: __GNUC__<3
[Incompatibilies-end]
*/
/* /////////////////////////////////////////////////////////////////////////
* Includes
*/
#ifndef WINSTL_INCL_WINSTL_H_WINSTL
# include <winstl/winstl.h>
#endif /* !WINSTL_INCL_WINSTL_H_WINSTL */
#if defined(STLSOFT_COMPILER_IS_GCC) && \
__GNUC__ < 3
# error winstl_commctrl_functionals.h is not compatible with GNU C++ prior to 3.0
#endif /* compiler */
#ifndef STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING
# include <stlsoft/shims/access/string.hpp>
#endif /* !STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING */
#ifndef STLSOFT_INCL_STLSOFT_ITERATORS_HPP_UNARY_FUNCTION_OUTPUT_ITERATOR_ADAPTOR
# include <stlsoft/iterators/unary_function_output_iterator_adaptor.hpp>
#endif /* !STLSOFT_INCL_STLSOFT_ITERATORS_HPP_UNARY_FUNCTION_OUTPUT_ITERATOR_ADAPTOR */
#ifndef WINSTL_INCL_WINSTL_SHIMS_ACCESS_HPP_STRING
# include <winstl/shims/access/string.hpp>
#endif /* !WINSTL_INCL_WINSTL_SHIMS_ACCESS_HPP_STRING */
#ifndef STLSOFT_INCL_H_COMMCTRL
# define STLSOFT_INCL_H_COMMCTRL
# include <commctrl.h>
#endif /* !STLSOFT_INCL_H_COMMCTRL */
/* /////////////////////////////////////////////////////////////////////////
* Namespace
*/
#ifndef _WINSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
/* There is no stlsoft namespace, so must define ::winstl */
namespace winstl
{
# else
/* Define stlsoft::winstl_project */
namespace stlsoft
{
namespace winstl_project
{
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */
/* /////////////////////////////////////////////////////////////////////////
* Classes
*/
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
template <ws_bool_t BACK>
struct listview_inserter;
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
/** \brief A function class used to insert items into list views
*
* \ingroup group__library__windows_controls
*/
template <ws_bool_t BACK = true>
// [[synesis:class:unary-functor: listview_inserter]]
struct listview_inserter
#if !defined(STLSOFT_COMPILER_IS_DMC) || \
__DMC__ > 0x0850
: public stlsoft_ns_qual(unary_function_output_iterator_adaptor)<listview_inserter<BACK> >
#endif /* compiler */
{
public:
/// This type
typedef listview_inserter class_type;
enum
{
#ifdef I_IMAGENONE
image_none = I_IMAGENONE
#else
image_none = -2
#endif /* I_IMAGENONE */
};
public:
/// Construct with the target list-view window
ss_explicit_k listview_inserter(HWND hwndListview, ws_int_t iImage = image_none)
: m_hwndListview(hwndListview)
, m_iImage(iImage)
{}
listview_inserter(class_type const& rhs)
: m_hwndListview(rhs.m_hwndListview)
, m_iImage(rhs.m_iImage)
{}
#ifdef STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT
/// Function call operator taking the item string
template <ss_typename_param_k S>
ws_int_t operator ()(S const& s)
{
return insert_item(stlsoft_ns_qual(c_str_ptr)(s));
}
#endif // STLSOFT_CF_MEMBER_TEMPLATE_FUNCTION_SUPPORT
/// Function call operator taking the item string
ws_int_t operator ()(ws_char_a_t const* s)
{
return insert_item(s);
}
/// Function call operator taking the item string
ws_int_t operator ()(ws_char_w_t const* s)
{
return insert_item(s);
}
private:
ws_int_t insert_index() const;
ws_int_t insert_item(ws_char_a_t const* s)
{
LV_ITEMA item;
item.mask = LVIF_TEXT;
item.pszText = const_cast<ws_char_a_t *>(s);
item.iItem = insert_index();
item.iSubItem = 0;
if(image_none != m_iImage)
{
item.mask |= LVIF_IMAGE;
item.iImage = m_iImage;
}
return (int)::SendMessage(m_hwndListview, LVM_INSERTITEMA, 0, reinterpret_cast<LPARAM>(&item));
}
ws_int_t insert_item(ws_char_w_t const* s)
{
LV_ITEMW item;
item.mask = LVIF_TEXT;
item.pszText = const_cast<ws_char_w_t *>(s);
item.iItem = insert_index();
item.iSubItem = 0;
if(image_none != m_iImage)
{
item.mask |= LVIF_IMAGE;
item.iImage = m_iImage;
}
return (int)::SendMessage(m_hwndListview, LVM_INSERTITEMW, 0, reinterpret_cast<LPARAM>(&item));
}
private:
HWND m_hwndListview;
ws_int_t m_iImage;
};
STLSOFT_TEMPLATE_SPECIALISATION
inline ws_int_t listview_inserter<false>::insert_index() const
{
return 0; // Front insertion
}
STLSOFT_TEMPLATE_SPECIALISATION
inline ws_int_t listview_inserter<true>::insert_index() const
{
return static_cast<ws_int_t>(::SendMessage(m_hwndListview, LVM_GETITEMCOUNT, 0, 0L)); // Back insertion
}
/** \brief A function class used to insert items at the front of list-views
*
* \ingroup group__library__windows_controls
*/
typedef listview_inserter<false> listview_front_inserter;
/** \brief A function class used to insert items at the back of list-views
*
* \ingroup group__library__windows_controls
*/
typedef listview_inserter<true> listview_back_inserter;
/** \brief A function class used to insert items into tree views
*
* \ingroup group__library__windows_controls
*/
// [[synesis:class:unary-functor: treeview_inserter]]
struct treeview_inserter
#if !defined(STLSOFT_COMPILER_IS_DMC) || \
__DMC__ > 0x0850
: public stlsoft_ns_qual(unary_function_output_iterator_adaptor)<treeview_inserter>
#endif /* compiler */
{
enum
{
#ifdef I_IMAGENONE
image_none = I_IMAGENONE
#else
image_none = -2
#endif /* I_IMAGENONE */
};
public:
typedef void argument_type;
typedef HTREEITEM result_type;
public:
ss_explicit_k treeview_inserter(HWND hwndTree, HTREEITEM hParent)
: m_hwndTree(hwndTree)
, m_hParent(hParent)
, m_hInsertAfter(TVI_LAST)
, m_iImage(image_none)
{}
ss_explicit_k treeview_inserter(HWND hwndTree, HTREEITEM hParent, HTREEITEM hInsertAfter)
: m_hwndTree(hwndTree)
, m_hParent(hParent)
, m_hInsertAfter(hInsertAfter)
, m_iImage(image_none)
{}
ss_explicit_k treeview_inserter(HWND hwndTree, HTREEITEM hParent, int iImage)
: m_hwndTree(hwndTree)
, m_hParent(hParent)
, m_hInsertAfter(TVI_LAST)
, m_iImage(iImage)
{}
public:
template <ss_typename_param_k S>
HTREEITEM operator () (S const& s)
{
return insert_item(stlsoft_ns_qual(c_str_ptr)(s));
}
HTREEITEM operator () (char const* s)
{
return insert_item(stlsoft_ns_qual(c_str_ptr)(s));
}
HTREEITEM operator () (wchar_t const* s)
{
return insert_item(stlsoft_ns_qual(c_str_ptr)(s));
}
private:
HTREEITEM insert_item(char const* s)
{
TV_INSERTSTRUCTA tvis;
tvis.hParent = m_hParent;
tvis.hInsertAfter = m_hInsertAfter;
tvis.item.mask = TVIF_TEXT;
tvis.item.pszText = const_cast<char*>(s);
if(image_none != m_iImage)
{
tvis.item.mask |= TVIF_IMAGE;
tvis.item.iImage = m_iImage;
}
return (HTREEITEM)::SendMessage(m_hwndTree, TVM_INSERTITEMA, 0, (LPARAM)&tvis);
}
HTREEITEM insert_item(wchar_t const* s)
{
TV_INSERTSTRUCTW tvis;
tvis.hParent = m_hParent;
tvis.hInsertAfter = m_hInsertAfter;
tvis.item.mask = TVIF_TEXT;
tvis.item.pszText = const_cast<wchar_t*>(s);
if(image_none != m_iImage)
{
tvis.item.mask |= TVIF_IMAGE;
tvis.item.iImage = m_iImage;
}
return (HTREEITEM)::SendMessage(m_hwndTree, TVM_INSERTITEMW, 0, (LPARAM)&tvis);
}
private:
HWND m_hwndTree;
HTREEITEM m_hParent;
HTREEITEM m_hInsertAfter;
int m_iImage;
};
////////////////////////////////////////////////////////////////////////////
// Unit-testing
#ifdef STLSOFT_UNITTEST
# include "./unittest/commctrl_functionals_unittest_.h"
#endif /* STLSOFT_UNITTEST */
/* ////////////////////////////////////////////////////////////////////// */
#ifndef _WINSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
} // namespace winstl
# else
} // namespace winstl_project
} // namespace stlsoft
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */
/* ////////////////////////////////////////////////////////////////////// */
#endif /* WINSTL_INCL_WINSTL_CONTROLS_HPP_COMMCTRL_FUNCTIONALS */
/* ///////////////////////////// end of file //////////////////////////// */