STLSoft: winstl/window/window_redraw

00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        winstl/window/window_redraw_scope.hpp
00003  *
00004  * Purpose:     Window redraw-state scoping class.
00005  *
00006  * Created:     5th January 1996
00007  * Updated:     10th August 2009
00008  *
00009  * Home:        http://stlsoft.org/
00010  *
00011  * Copyright (c) 1996-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 
00047 #ifndef WINSTL_INCL_WINSTL_WINDOW_HPP_WINDOW_REDRAW_SCOPE
00048 #define WINSTL_INCL_WINSTL_WINDOW_HPP_WINDOW_REDRAW_SCOPE
00049 
00050 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00051 # define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_REDRAW_SCOPE_MAJOR      5
00052 # define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_REDRAW_SCOPE_MINOR      1
00053 # define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_REDRAW_SCOPE_REVISION   1
00054 # define WINSTL_VER_WINSTL_WINDOW_HPP_WINDOW_REDRAW_SCOPE_EDIT       76
00055 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00056 
00057 /* /////////////////////////////////////////////////////////////////////////
00058  * Includes
00059  */
00060 
00061 #ifndef WINSTL_INCL_WINSTL_H_WINSTL
00062 # include <winstl/winstl.h>
00063 #endif /* !WINSTL_INCL_WINSTL_H_WINSTL */
00064 #ifndef WINSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND
00065 # include <winstl/shims/attribute/get_HWND.hpp>
00066 #endif /* !WINSTL_INCL_SHIMS_ATTRIBUTE_HPP_GET_HWND */
00067 
00068 /* /////////////////////////////////////////////////////////////////////////
00069  * Namespace
00070  */
00071 
00072 #ifndef _WINSTL_NO_NAMESPACE
00073 # if defined(_STLSOFT_NO_NAMESPACE) || \
00074      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00075 /* There is no stlsoft namespace, so must define ::winstl */
00076 namespace winstl
00077 {
00078 # else
00079 /* Define stlsoft::winstl_project */
00080 
00081 namespace stlsoft
00082 {
00083 
00084 namespace winstl_project
00085 {
00086 
00087 # endif /* _STLSOFT_NO_NAMESPACE */
00088 #endif /* !_WINSTL_NO_NAMESPACE */
00089 
00090 /* /////////////////////////////////////////////////////////////////////////
00091  * Classes
00092  */
00093 
00094 // window_redraw_scope
00102 class window_redraw_scope
00103 {
00104 public:
00106     typedef window_redraw_scope class_type;
00107 
00108 // Construction
00109 public:
00117 #ifdef STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT
00118     template <ss_typename_param_k W>
00119     ss_explicit_k window_redraw_scope(W &wnd, ws_bool_t bInvalidateOnUnlock = true)
00120         : m_hwnd(get_HWND(wnd))
00121 #else
00122     ss_explicit_k window_redraw_scope(HWND wnd, ws_bool_t bInvalidateOnUnlock = true)
00123         : m_hwnd(wnd)
00124 #endif /* STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT */
00125         , m_bInvalidateOnUnlock(bInvalidateOnUnlock)
00126     {
00127         ::SendMessage(m_hwnd, WM_SETREDRAW, false, 0L);
00128     }
00129 
00131     ~window_redraw_scope() stlsoft_throw_0()
00132     {
00133         ::SendMessage(m_hwnd, WM_SETREDRAW, true, 0L);
00134 
00135         if(m_bInvalidateOnUnlock)
00136         {
00137             ::InvalidateRect(m_hwnd, NULL, true);
00138         }
00139     }
00140 
00141 // Members
00142 private:
00143     HWND        m_hwnd;
00144     ws_bool_t   m_bInvalidateOnUnlock;
00145 
00146 // Not to be implemented
00147 private:
00148     window_redraw_scope(class_type const& rhs);
00149     class_type const& operator =(class_type const& rhs);
00150 };
00151 
00152 /* ////////////////////////////////////////////////////////////////////// */
00153 
00154 #ifndef _WINSTL_NO_NAMESPACE
00155 # if defined(_STLSOFT_NO_NAMESPACE) || \
00156      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00157 } // namespace winstl
00158 # else
00159 } // namespace winstl_project
00160 } // namespace stlsoft
00161 # endif /* _STLSOFT_NO_NAMESPACE */
00162 #endif /* !_WINSTL_NO_NAMESPACE */
00163 
00164 /* ////////////////////////////////////////////////////////////////////// */
00165 
00166 #endif /* WINSTL_INCL_WINSTL_WINDOW_HPP_WINDOW_REDRAW_SCOPE */
00167 
00168 /* ///////////////////////////// end of file //////////////////////////// */