ui/gfx/win/window_impl.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_GFX_WIN_WINDOW_IMPL_H_
   6 #define UI_GFX_WIN_WINDOW_IMPL_H_
   7
   8 #include <string>
   9
  10 #include "base/logging.h"
  11 #include "ui/gfx/geometry/rect.h"
  12 #include "ui/gfx/gfx_export.h"
  13 #include "ui/gfx/native_widget_types.h"
  14 #include "ui/gfx/win/msg_util.h"
  15
  16 namespace gfx {
  17
  18 // An interface implemented by classes that use message maps.
  19 // ProcessWindowMessage is implemented by the BEGIN_MESSAGE_MAP_EX macro.
  20 class MessageMapInterface {
  21  public:
  22   // Processes one message from the window's message queue.
  23   virtual BOOL ProcessWindowMessage(HWND window,
  24                                     UINT message,
  25                                     WPARAM w_param,
  26                                     LPARAM l_param,
  27                                     LRESULT& result,
  28                                     DWORD msg_map_id = 0) = 0;
  29 };
  30
  31 ///////////////////////////////////////////////////////////////////////////////
  32 //
  33 // WindowImpl
  34 //  A convenience class that encapsulates the details of creating and
  35 //  destroying a HWND.  This class also hosts the windows procedure used by all
  36 //  Windows.
  37 //
  38 ///////////////////////////////////////////////////////////////////////////////
  39 class GFX_EXPORT WindowImpl : public MessageMapInterface {
  40  public:
  41   WindowImpl();
  42   virtual ~WindowImpl();
  43
  44   // Causes all generated windows classes to be unregistered at exit.
  45   // This can cause result in errors for tests that don't destroy all instances
  46   // of windows, but is necessary if the tests unload the classes WndProc.
  47   static void UnregisterClassesAtExit();
  48
  49   // Initializes the Window with a parent and an initial desired size.
  50   void Init(HWND parent, const gfx::Rect& bounds);
  51
  52   // Returns the default window icon to use for windows of this type.
  53   virtual HICON GetDefaultWindowIcon() const;
  54   virtual HICON GetSmallWindowIcon() const;
  55
  56   // Returns the HWND associated with this Window.
  57   HWND hwnd() const { return hwnd_; }
  58
  59   // Sets the window styles. This is ONLY used when the window is created.
  60   // In other words, if you invoke this after invoking Init, nothing happens.
  61   void set_window_style(DWORD style) { window_style_ = style; }
  62   DWORD window_style() const { return window_style_; }
  63
  64   // Sets the extended window styles. See comment about |set_window_style|.
  65   void set_window_ex_style(DWORD style) { window_ex_style_ = style; }
  66   DWORD window_ex_style() const { return window_ex_style_; }
  67
  68   // Sets the class style to use. The default is CS_DBLCLKS.
  69   void set_initial_class_style(UINT class_style) {
  70     // We dynamically generate the class name, so don't register it globally!
  71     DCHECK_EQ((class_style & CS_GLOBALCLASS), 0u);
  72     class_style_ = class_style;
  73   }
  74   UINT initial_class_style() const { return class_style_; }
  75
  76  protected:
  77   // Handles the WndProc callback for this object.
  78   virtual LRESULT OnWndProc(UINT message, WPARAM w_param, LPARAM l_param);
  79
  80   // Subclasses must call this method from their destructors to ensure that
  81   // this object is properly disassociated from the HWND during destruction,
  82   // otherwise it's possible this object may still exist while a subclass is
  83   // destroyed.
  84   void ClearUserData();
  85
  86  private:
  87   friend class ClassRegistrar;
  88
  89   // The window procedure used by all Windows.
  90   static LRESULT CALLBACK WndProc(HWND window,
  91                                   UINT message,
  92                                   WPARAM w_param,
  93                                   LPARAM l_param);
  94
  95   // Gets the window class atom to use when creating the corresponding HWND.
  96   // If necessary, this registers the window class.
  97   ATOM GetWindowClassAtom();
  98
  99   // All classes registered by WindowImpl start with this name.
 100   static const wchar_t* const kBaseClassName;
 101
 102   // Window Styles used when creating the window.
 103   DWORD window_style_;
 104
 105   // Window Extended Styles used when creating the window.
 106   DWORD window_ex_style_;
 107
 108   // Style of the class to use.
 109   UINT class_style_;
 110
 111   // Our hwnd.
 112   HWND hwnd_;
 113
 114   // For debugging.
 115   // TODO(sky): nuke this when get crash data.
 116   bool got_create_;
 117   bool got_valid_hwnd_;
 118   bool* destroyed_;
 119
 120   DISALLOW_COPY_AND_ASSIGN(WindowImpl);
 121 };
 122
 123 }  // namespace gfx
 124
 125 #endif  // UI_GFX_WIN_WINDOW_IMPL_H_