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.
151 lines
5.3 KiB
151 lines
5.3 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: atlstl/shims/attribute/get_HWND.hpp
|
|
*
|
|
* Purpose: Contains access shims for windows.
|
|
*
|
|
* Created: 10th January 2003
|
|
* Updated: 10th August 2009
|
|
*
|
|
* Home: http://stlsoft.org/
|
|
*
|
|
* Copyright (c) 2003-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 atlstl/shims/attribute/get_HWND.hpp
|
|
*
|
|
* \brief [C++ only] Definition of stlsoft::get_HWND attribute shim
|
|
* functions for ATL types
|
|
* (\ref group__library__shims__window_attribute "Window Attribute Shims").
|
|
*/
|
|
|
|
#ifndef ATLSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND
|
|
#define ATLSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
# define ATLSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_MAJOR 4
|
|
# define ATLSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_MINOR 1
|
|
# define ATLSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_REVISION 1
|
|
# define ATLSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_EDIT 43
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Includes
|
|
*/
|
|
|
|
#ifndef ATLSTL_INCL_ATLSTL_HPP_ATLSTL
|
|
# include <atlstl/atlstl.hpp>
|
|
#endif /* !ATLSTL_INCL_ATLSTL_HPP_ATLSTL */
|
|
|
|
#if defined(STLSOFT_COMPILER_IS_BORLAND)
|
|
# pragma warn -8013 /* Suppresses "Possible use of 'f' before definition in '. . .'" */
|
|
# pragma warn -8084 /* Suppresses "Suggest parentheses to clarify precedence in function 'f()'" */
|
|
#endif /* compiler */
|
|
|
|
#ifndef STLSOFT_INCL_SYS_H_ATLWIN
|
|
# define STLSOFT_INCL_SYS_H_ATLWIN
|
|
# include <atlwin.h>
|
|
#endif /* !STLSOFT_INCL_SYS_H_ATLWIN */
|
|
|
|
#if defined(STLSOFT_COMPILER_IS_BORLAND)
|
|
# pragma warn .8013 /* Suppresses "Possible use of 'f' before definition in '. . .'" */
|
|
# pragma warn .8084 /* Suppresses "Suggest parentheses to clarify precedence in function 'f()'" */
|
|
#endif /* compiler */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Namespace
|
|
*/
|
|
|
|
#ifndef _ATLSTL_NO_NAMESPACE
|
|
# if defined(_STLSOFT_NO_NAMESPACE) || \
|
|
defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
|
|
/* There is no stlsoft namespace, so must define ::atlstl */
|
|
namespace atlstl
|
|
{
|
|
# else
|
|
/* Define stlsoft::atlstl_project */
|
|
|
|
namespace stlsoft
|
|
{
|
|
|
|
namespace atlstl_project
|
|
{
|
|
|
|
# endif /* _STLSOFT_NO_NAMESPACE */
|
|
#endif /* !_ATLSTL_NO_NAMESPACE */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* get_HWND
|
|
*
|
|
* This can be applied to an expression, and the return value is the
|
|
* corresponding HWND.
|
|
*/
|
|
|
|
/* HWND */
|
|
|
|
/** \brief Access the HWND of the given CWindow instance
|
|
*
|
|
* \ingroup group__library__shims__window_attribute
|
|
*
|
|
* This access <a href = "http://stlsoft.org/white_papers.html#shims">shim</a> retrieves the
|
|
* HWND window handle for the given CWindow instance.
|
|
*
|
|
* \param w A reference to the CWindow instance whose HWND will be retrieved
|
|
* \return The HWND corresponding to the given CWindow instance \c w
|
|
*
|
|
*/
|
|
inline HWND get_HWND(CWindow const& w)
|
|
{
|
|
return w.m_hWnd;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Unit-testing
|
|
|
|
#ifdef STLSOFT_UNITTEST
|
|
# include "./unittest/get_HWND_unittest_.h"
|
|
#endif /* STLSOFT_UNITTEST */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#ifndef _ATLSTL_NO_NAMESPACE
|
|
# if defined(_STLSOFT_NO_NAMESPACE) || \
|
|
defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
|
|
} // namespace atlstl
|
|
# else
|
|
} // namespace atlstl_project
|
|
} // namespace stlsoft
|
|
# endif /* _STLSOFT_NO_NAMESPACE */
|
|
#endif /* !_ATLSTL_NO_NAMESPACE */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#endif /* ATLSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|