Migrate Event API methods to Google Style.

views/events/event.h

 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef VIEWS_EVENT_H_
 #define VIEWS_EVENT_H_
 #pragma once
 
 #include "base/basictypes.h"
 #include "base/time.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/gfx/point.h"
+#include "views/native_types.h"
 
 #if defined(OS_LINUX)
 typedef struct _GdkEventKey GdkEventKey;
 #endif
 
 #if defined(TOUCH_UI)
 typedef union _XEvent XEvent;
 #endif
 
 namespace ui {
@@ skipping 46 matching lines @@
   enum EventFlags { EF_CAPS_LOCK_DOWN     = 1 << 0,
                     EF_SHIFT_DOWN         = 1 << 1,
                     EF_CONTROL_DOWN       = 1 << 2,
                     EF_ALT_DOWN           = 1 << 3,
                     EF_LEFT_BUTTON_DOWN   = 1 << 4,
                     EF_MIDDLE_BUTTON_DOWN = 1 << 5,
                     EF_RIGHT_BUTTON_DOWN  = 1 << 6,
                     EF_COMMAND_DOWN       = 1 << 7,  // Only useful on OSX
   };
 
-  // Return the event type
-  EventType GetType() const {
-    return type_;
-  }
+  const NativeEvent& native_event() const { return native_event_; }
+  EventType type() const { return type_; }
+  const base::Time& time_stamp() const { return time_stamp_; }
+  int flags() const { return flags_; }
+  void set_flags(int flags) { flags_ = flags; }
 
-  // Return the event time stamp.
-  const base::Time& GetTimeStamp() const {
-    return time_stamp_;
-  }
-
-  // Return the flags
-  int GetFlags() const {
-    return flags_;
-  }
-
-  void set_flags(int flags) {
-    flags_ = flags;
-  }
-
-  // Return whether the shift modifier is down
-  bool IsShiftDown() const {
-    return (flags_ & EF_SHIFT_DOWN) != 0;
-  }
-
-  // Return whether the control modifier is down
-  bool IsControlDown() const {
-    return (flags_ & EF_CONTROL_DOWN) != 0;
-  }
-
-  bool IsCapsLockDown() const {
-    return (flags_ & EF_CAPS_LOCK_DOWN) != 0;
-  }
-
-  // Return whether the alt modifier is down
-  bool IsAltDown() const {
-    return (flags_ & EF_ALT_DOWN) != 0;
-  }
+  // The following methods return true if the respective keys were pressed at
+  // the time the event was created.
+  bool IsShiftDown() const { return (flags_ & EF_SHIFT_DOWN) != 0; }
+  bool IsControlDown() const { return (flags_ & EF_CONTROL_DOWN) != 0; }
+  bool IsCapsLockDown() const { return (flags_ & EF_CAPS_LOCK_DOWN) != 0; }
+  bool IsAltDown() const { return (flags_ & EF_ALT_DOWN) != 0; }
 
   bool IsMouseEvent() const {
     return type_ == ET_MOUSE_PRESSED ||
            type_ == ET_MOUSE_DRAGGED ||
            type_ == ET_MOUSE_RELEASED ||
            type_ == ET_MOUSE_MOVED ||
            type_ == ET_MOUSE_ENTERED ||
            type_ == ET_MOUSE_EXITED ||
            type_ == ET_MOUSEWHEEL;
   }
@@ skipping 16 matching lines @@
   static int ConvertWindowsFlags(uint32 win_flags);
 #elif defined(OS_LINUX)
   // Convert the state member on a GdkEvent to views::Event flags
   static int GetFlagsFromGdkState(int state);
 #endif
 
  protected:
   Event(EventType type, int flags);
 
   Event(const Event& model)
-      : type_(model.GetType()),
-        time_stamp_(model.GetTimeStamp()),
-        flags_(model.GetFlags()) {
+      : native_event_(model.native_event()),
+        type_(model.type()),
+        time_stamp_(model.time_stamp()),
+        flags_(model.flags()) {
   }
 
  private:
   void operator=(const Event&);
 
+  NativeEvent native_event_;
   EventType type_;
   base::Time time_stamp_;
   int flags_;
 };
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // LocatedEvent class
 //
 // A generic event that is used for any events that is located at a specific
 // position in the screen.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class LocatedEvent : public Event {
  public:
   LocatedEvent(EventType type, const gfx::Point& location, int flags)
       : Event(type, flags),
         location_(location) {
   }
 
   // Create a new LocatedEvent which is identical to the provided model.
   // If from / to views are provided, the model location will be converted
   // from 'from' coordinate system to 'to' coordinate system
   LocatedEvent(const LocatedEvent& model, View* from, View* to);
 
-  // Returns the X location.
-  int x() const {
-    return location_.x();
-  }
-
-  // Returns the Y location.
-  int y() const {
-    return location_.y();
-  }
-
-  // Returns the location.
-  const gfx::Point& location() const {
-    return location_;
-  }
+  int x() const { return location_.x(); }
+  int y() const { return location_.y(); }
+  const gfx::Point& location() const { return location_; }
 
  private:
   gfx::Point location_;
 };
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // MouseEvent class
 //
 // A mouse event is used for any input event related to the mouse.
@@ skipping 26 matching lines @@
   // from 'from' coordinate system to 'to' coordinate system
   MouseEvent(const MouseEvent& model, View* from, View* to);
 
 #if defined(TOUCH_UI)
   // Create a mouse event from an X mouse event.
   explicit MouseEvent(XEvent* xevent);
 #endif
 
   // Conveniences to quickly test what button is down
   bool IsOnlyLeftMouseButton() const {
-    return (GetFlags() & EF_LEFT_BUTTON_DOWN) &&
-      !(GetFlags() & (EF_MIDDLE_BUTTON_DOWN | EF_RIGHT_BUTTON_DOWN));
+    return (flags() & EF_LEFT_BUTTON_DOWN) &&
+      !(flags() & (EF_MIDDLE_BUTTON_DOWN | EF_RIGHT_BUTTON_DOWN));
   }
 
   bool IsLeftMouseButton() const {
-    return (GetFlags() & EF_LEFT_BUTTON_DOWN) != 0;
+    return (flags() & EF_LEFT_BUTTON_DOWN) != 0;
   }
 
   bool IsOnlyMiddleMouseButton() const {
-    return (GetFlags() & EF_MIDDLE_BUTTON_DOWN) &&
-      !(GetFlags() & (EF_LEFT_BUTTON_DOWN | EF_RIGHT_BUTTON_DOWN));
+    return (flags() & EF_MIDDLE_BUTTON_DOWN) &&
+      !(flags() & (EF_LEFT_BUTTON_DOWN | EF_RIGHT_BUTTON_DOWN));
   }
 
   bool IsMiddleMouseButton() const {
-    return (GetFlags() & EF_MIDDLE_BUTTON_DOWN) != 0;
+    return (flags() & EF_MIDDLE_BUTTON_DOWN) != 0;
   }
 
   bool IsOnlyRightMouseButton() const {
-    return (GetFlags() & EF_RIGHT_BUTTON_DOWN) &&
-      !(GetFlags() & (EF_LEFT_BUTTON_DOWN | EF_MIDDLE_BUTTON_DOWN));
+    return (flags() & EF_RIGHT_BUTTON_DOWN) &&
+      !(flags() & (EF_LEFT_BUTTON_DOWN | EF_MIDDLE_BUTTON_DOWN));
   }
 
   bool IsRightMouseButton() const {
-    return (GetFlags() & EF_RIGHT_BUTTON_DOWN) != 0;
+    return (flags() & EF_RIGHT_BUTTON_DOWN) != 0;
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(MouseEvent);
 };
 
 #if defined(TOUCH_UI)
 ////////////////////////////////////////////////////////////////////////////////
 //
 // TouchEvent class
@@ skipping 20 matching lines @@
 
   // Create a new TouchEvent which is identical to the provided model.
   // If from / to views are provided, the model location will be converted
   // from 'from' coordinate system to 'to' coordinate system.
   TouchEvent(const TouchEvent& model, View* from, View* to);
 
 #if defined(HAVE_XINPUT2)
   explicit TouchEvent(XEvent* xev);
 #endif
 
-  // Return the touch point for this event.
-  bool identity() const {
-    return touch_id_;
-  }
+  bool identity() const { return touch_id_; }
 
  private:
   // The identity (typically finger) of the touch starting at 0 and incrementing
   // for each separable additional touch that the hardware can detect.
   const int touch_id_;
 
   DISALLOW_COPY_AND_ASSIGN(TouchEvent);
 };
 #endif
 
@@ skipping 25 matching lines @@
 #if defined(OS_LINUX)
   explicit KeyEvent(const GdkEventKey* event);
 
   const GdkEventKey* native_event() const { return native_event_; }
 #endif
 #if defined(TOUCH_UI)
   // Create a key event from an X key event.
   explicit KeyEvent(XEvent* xevent);
 #endif
 
-  // This returns a VKEY_ value as defined in app/keyboard_codes.h which is
-  // the Windows value.
-  // On GTK, you can use the methods in keyboard_code_conversion_gtk.cc to
-  // convert this value back to a GDK value if needed.
-  ui::KeyboardCode GetKeyCode() const {
-    return key_code_;
-  }
+  ui::KeyboardCode key_code() const { return key_code_; }
 
 #if defined(OS_WIN)
   bool IsExtendedKey() const;
 
-  UINT message() const {
-    return message_;
-  }
+  UINT message() const { return message_; }
 #endif
 
-  int GetRepeatCount() const {
-    return repeat_count_;
-  }
+  int repeat_count() const { return repeat_count_; }
 
 #if defined(OS_WIN)
   static int GetKeyStateFlags();
 #endif
 
  private:
 
   ui::KeyboardCode key_code_;
   int repeat_count_;
   int message_flags_;
@@ skipping 18 matching lines @@
   // Create a new key event
   MouseWheelEvent(int offset, int x, int y, int flags)
       : LocatedEvent(ET_MOUSEWHEEL, gfx::Point(x, y), flags),
         offset_(offset) {
   }
 
 #if defined(TOUCH_UI)
   explicit MouseWheelEvent(XEvent* xev);
 #endif
 
-  int GetOffset() const {
-    return offset_;
-  }
+  int offset() const { return offset_; }
 
  private:
   int offset_;
 
   DISALLOW_COPY_AND_ASSIGN(MouseWheelEvent);
 };
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // DropTargetEvent class
 //
 // A DropTargetEvent is sent to the view the mouse is over during a drag and
 // drop operation.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class DropTargetEvent : public LocatedEvent {
  public:
   DropTargetEvent(const OSExchangeData& data,
                   int x,
                   int y,
                   int source_operations)
       : LocatedEvent(ET_DROP_TARGET_EVENT, gfx::Point(x, y), 0),
         data_(data),
         source_operations_(source_operations) {
   }
 
+  const OSExchangeData& data() const { return data_; }
+  int source_operations() const { return source_operations_; }
+
+ private:
   // Data associated with the drag/drop session.
-  const OSExchangeData& GetData() const { return data_; }
+  const OSExchangeData& data_;
 
   // Bitmask of supported ui::DragDropTypes::DragOperation by the source.
-  int GetSourceOperations() const { return source_operations_; }
-
- private:
-  const OSExchangeData& data_;
   int source_operations_;
 
   DISALLOW_COPY_AND_ASSIGN(DropTargetEvent);
 };
 
 }  // namespace views
 
 #endif  // VIEWS_EVENT_H_