Home | History | Annotate | Download | only in win 
      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/gfx_export.h"
     12 #include "ui/gfx/native_widget_types.h"
     13 #include "ui/gfx/rect.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   // Initializes the Window with a parent and an initial desired size.
     45   void Init(HWND parent, const gfx::Rect& bounds);
     46 
     47   // Returns the default window icon to use for windows of this type.
     48   virtual HICON GetDefaultWindowIcon() const;
     49 
     50   // Returns the HWND associated with this Window.
     51   HWND hwnd() const { return hwnd_; }
     52 
     53   // Sets the window styles. This is ONLY used when the window is created.
     54   // In other words, if you invoke this after invoking Init, nothing happens.
     55   void set_window_style(DWORD style) { window_style_ = style; }
     56   DWORD window_style() const { return window_style_; }
     57 
     58   // Sets the extended window styles. See comment about |set_window_style|.
     59   void set_window_ex_style(DWORD style) { window_ex_style_ = style; }
     60   DWORD window_ex_style() const { return window_ex_style_; }
     61 
     62   // Sets the class style to use. The default is CS_DBLCLKS.
     63   void set_initial_class_style(UINT class_style) {
     64     // We dynamically generate the class name, so don't register it globally!
     65     DCHECK_EQ((class_style & CS_GLOBALCLASS), 0u);
     66     class_style_ = class_style;
     67   }
     68   UINT initial_class_style() const { return class_style_; }
     69 
     70  protected:
     71   // Handles the WndProc callback for this object.
     72   virtual LRESULT OnWndProc(UINT message, WPARAM w_param, LPARAM l_param);
     73 
     74   // Subclasses must call this method from their destructors to ensure that
     75   // this object is properly disassociated from the HWND during destruction,
     76   // otherwise it's possible this object may still exist while a subclass is
     77   // destroyed.
     78   void ClearUserData();
     79 
     80  private:
     81   friend class ClassRegistrar;
     82 
     83   // The window procedure used by all Windows.
     84   static LRESULT CALLBACK WndProc(HWND window,
     85                                   UINT message,
     86                                   WPARAM w_param,
     87                                   LPARAM l_param);
     88 
     89   // Gets the window class atom to use when creating the corresponding HWND.
     90   // If necessary, this registers the window class.
     91   ATOM GetWindowClassAtom();
     92 
     93   // All classes registered by WindowImpl start with this name.
     94   static const wchar_t* const kBaseClassName;
     95 
     96   // Window Styles used when creating the window.
     97   DWORD window_style_;
     98 
     99   // Window Extended Styles used when creating the window.
    100   DWORD window_ex_style_;
    101 
    102   // Style of the class to use.
    103   UINT class_style_;
    104 
    105   // Our hwnd.
    106   HWND hwnd_;
    107 
    108   // For debugging.
    109   // TODO(sky): nuke this when get crash data.
    110   bool got_create_;
    111   bool got_valid_hwnd_;
    112   bool* destroyed_;
    113 
    114   DISALLOW_COPY_AND_ASSIGN(WindowImpl);
    115 };
    116 
    117 }  // namespace gfx
    118 
    119 #endif  // UI_GFX_WIN_WINDOW_IMPL_H_
    120