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.
209 lines
7.3 KiB
209 lines
7.3 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: winstl/window/window_visible_scope.hpp
|
|
*
|
|
* Purpose: Window visible-state scoping class.
|
|
*
|
|
* Created: 26th May 2004
|
|
* Updated: 10th August 2009
|
|
*
|
|
* Home: http://stlsoft.org/
|
|
*
|
|
* Copyright (c) 2004-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/window/window_visible_scope.hpp
|
|
*
|
|
* \brief [C++ only] Definition of the winstl::window_visible_scope class
|
|
* (\ref group__library__windows_window "Windows Window" Library).
|
|
*/
|
|
|
|
#ifndef WINSTL_INCL_WINSTL_WINDOW_HPP_WINDOW_VISIBLE_SCOPE
|
|
#define WINSTL_INCL_WINSTL_WINDOW_HPP_WINDOW_VISIBLE_SCOPE
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
# define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_VISIBLE_SCOPE_MAJOR 4
|
|
# define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_VISIBLE_SCOPE_MINOR 1
|
|
# define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_VISIBLE_SCOPE_REVISION 1
|
|
# define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_VISIBLE_SCOPE_EDIT 39
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Includes
|
|
*/
|
|
|
|
#ifndef WINSTL_INCL_WINSTL_H_WINSTL
|
|
# include <winstl/winstl.h>
|
|
#endif /* !WINSTL_INCL_WINSTL_H_WINSTL */
|
|
#ifndef WINSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND
|
|
# include <winstl/shims/attribute/get_HWND.hpp>
|
|
#endif /* !WINSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* 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
|
|
*/
|
|
|
|
// window_visible_scope
|
|
/** \brief Provides scoping of the visible status of a window.
|
|
*
|
|
* \ingroup group__library__windows_window
|
|
*
|
|
* This class provides scoping of the visible status of a window via the API
|
|
* function ShowWindow().
|
|
*/
|
|
class window_visible_scope
|
|
{
|
|
public:
|
|
/// This type
|
|
typedef window_visible_scope class_type;
|
|
|
|
// Construction
|
|
public:
|
|
/// \brief Toggles the window visible state
|
|
///
|
|
/// Takes a HWND and changes it's current visible-status, which is set back to
|
|
/// the original state in the destructor.
|
|
///
|
|
/// \param wnd The window whose visible state is to be controlled
|
|
ss_explicit_k window_visible_scope(HWND wnd)
|
|
: m_hwnd(wnd)
|
|
, m_stateOnDtor(::IsWindowVisible(m_hwnd) ? SW_SHOW : SW_HIDE)
|
|
{
|
|
::ShowWindow(m_hwnd, (SW_SHOW == m_stateOnDtor) ? SW_HIDE : SW_SHOW);
|
|
}
|
|
|
|
#ifdef STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT
|
|
/// \brief Toggles the window visible state
|
|
///
|
|
/// Takes a HWND and changes it's current visible-status, which is set back to
|
|
/// the original state in the destructor.
|
|
///
|
|
/// \param wnd The window whose visible state is to be controlled
|
|
template <ss_typename_param_k W>
|
|
ss_explicit_k window_visible_scope(W &wnd)
|
|
: m_hwnd(get_HWND(wnd))
|
|
, m_stateOnDtor(::IsWindowVisible(m_hwnd) ? SW_SHOW : SW_HIDE)
|
|
{
|
|
::ShowWindow(m_hwnd, (SW_SHOW == m_stateOnDtor) ? SW_HIDE : SW_SHOW);
|
|
}
|
|
#endif /* STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT */
|
|
|
|
/// Modifies the window visible state
|
|
///
|
|
/// \param wnd The window whose visible state is to be controlled
|
|
/// \param stateOnCtor The state to set in the constructor
|
|
/// \param stateOnDtor The state it is reset to in the destructor
|
|
window_visible_scope(HWND wnd, ws_int_t stateOnCtor, ws_int_t stateOnDtor)
|
|
: m_hwnd(wnd)
|
|
, m_stateOnDtor(stateOnDtor)
|
|
{
|
|
::ShowWindow(m_hwnd, stateOnCtor);
|
|
}
|
|
#ifdef STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT
|
|
/// Modifies the window visible state
|
|
///
|
|
/// \param wnd The window whose visible state is to be controlled
|
|
/// \param stateOnCtor The state to set in the constructor
|
|
/// \param stateOnDtor The state it is reset to in the destructor
|
|
template <ss_typename_param_k W>
|
|
window_visible_scope(W &wnd, ws_int_t stateOnCtor, ws_int_t stateOnDtor)
|
|
: m_hwnd(get_HWND(wnd))
|
|
, m_stateOnDtor(stateOnDtor)
|
|
{
|
|
::ShowWindow(m_hwnd, stateOnCtor);
|
|
}
|
|
#endif /* STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT */
|
|
|
|
/// Resets the visible status
|
|
~window_visible_scope() stlsoft_throw_0()
|
|
{
|
|
#ifdef STLSOFT_CF_USE_RAW_OFFSETOF_IN_STATIC_ASSERT
|
|
WINSTL_STATIC_ASSERT(STLSOFT_RAW_OFFSETOF(class_type, m_hwnd) < STLSOFT_RAW_OFFSETOF(class_type, m_stateOnDtor));
|
|
#endif /* STLSOFT_CF_USE_RAW_OFFSETOF_IN_STATIC_ASSERT */
|
|
|
|
::ShowWindow(m_hwnd, m_stateOnDtor);
|
|
}
|
|
|
|
// Members
|
|
private:
|
|
HWND const m_hwnd;
|
|
ws_int_t const m_stateOnDtor;
|
|
|
|
// Not to be implemented
|
|
private:
|
|
window_visible_scope(class_type const& rhs);
|
|
class_type const& operator =(class_type const& rhs);
|
|
};
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Unit-testing
|
|
|
|
#ifdef STLSOFT_UNITTEST
|
|
# include "./unittest/window_visible_scope_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_WINDOW_HPP_WINDOW_VISIBLE_SCOPE */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|