STLSoft: winstl/shims/attribute/get

00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        winstl/shims/attribute/get_HWND.hpp
00003  *
00004  * Purpose:     Contains access shims for windows.
00005  *
00006  * Created:     7th October 2002
00007  * Updated:     10th August 2009
00008  *
00009  * Home:        http://stlsoft.org/
00010  *
00011  * Copyright (c) 2002-2009, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without
00015  * modification, are permitted provided that the following conditions are met:
00016  *
00017  * - Redistributions of source code must retain the above copyright notice, this
00018  *   list of conditions and the following disclaimer.
00019  * - Redistributions in binary form must reproduce the above copyright notice,
00020  *   this list of conditions and the following disclaimer in the documentation
00021  *   and/or other materials provided with the distribution.
00022  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
00023  *   any contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036  * POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * ////////////////////////////////////////////////////////////////////// */
00039 
00040 
00048 #ifndef WINSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND
00049 #define WINSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND
00050 
00051 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00052 # define WINSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_MAJOR     4
00053 # define WINSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_MINOR     1
00054 # define WINSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_REVISION  1
00055 # define WINSTL_VER_SHIMS_ATTRIBUTE_HPP_GET_HWND_EDIT      46
00056 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00057 
00058 /* /////////////////////////////////////////////////////////////////////////
00059  * Includes
00060  */
00061 
00062 #ifndef WINSTL_INCL_WINSTL_H_WINSTL
00063 # include <winstl/winstl.h>
00064 #endif /* !WINSTL_INCL_WINSTL_H_WINSTL */
00065 
00066 /* /////////////////////////////////////////////////////////////////////////
00067  * Namespace
00068  */
00069 
00070 #ifndef _WINSTL_NO_NAMESPACE
00071 # if defined(_STLSOFT_NO_NAMESPACE) || \
00072      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00073 /* There is no stlsoft namespace, so must define ::winstl */
00074 namespace winstl
00075 {
00076 # else
00077 /* Define stlsoft::winstl_project */
00078 
00079 namespace stlsoft
00080 {
00081 
00082 namespace winstl_project
00083 {
00084 
00085 # endif /* _STLSOFT_NO_NAMESPACE */
00086 #endif /* !_WINSTL_NO_NAMESPACE */
00087 
00088 /* /////////////////////////////////////////////////////////////////////////
00089  * get_HWND
00090  *
00091  * This can be applied to an expression, and the return value is the
00092  * corresponding HWND.
00093  */
00094 
00095 /* HWND */
00096 
00107 inline HWND get_HWND(HWND h)
00108 {
00109     return h;
00110 }
00111 
00112 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00113 inline HWND get_hwnd(HWND h)
00114 {
00115     return get_HWND(h);
00116 }
00117 
00118 template <typename W>
00119 inline HWND get_hwnd(W const& h)
00120 {
00121     return get_HWND(h);
00122 }
00123 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00124 
00126 // Unit-testing
00127 
00128 #ifdef STLSOFT_UNITTEST
00129 # include "./unittest/get_HWND_unittest_.h"
00130 #endif /* STLSOFT_UNITTEST */
00131 
00132 /* ////////////////////////////////////////////////////////////////////// */
00133 
00134 #ifndef _WINSTL_NO_NAMESPACE
00135 # if defined(_STLSOFT_NO_NAMESPACE) || \
00136      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00137 } // namespace winstl
00138 # else
00139 } // namespace winstl_project
00140 } // namespace stlsoft
00141 # endif /* _STLSOFT_NO_NAMESPACE */
00142 #endif /* !_WINSTL_NO_NAMESPACE */
00143 
00144 /* ////////////////////////////////////////////////////////////////////// */
00145 
00146 #endif /* WINSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND */
00147 
00148 /* ///////////////////////////// end of file //////////////////////////// */