Create a unified UIElement interface for Widget, View and Window.

ash/devtools/ui_element.h

Index: ash/devtools/ui_element.h
diff --git a/ash/devtools/ui_element.h b/ash/devtools/ui_element.h
new file mode 100644
index 0000000000000000000000000000000000000000..00b5ebdf088efee85195d6b96699c296825c5219
--- /dev/null
+++ b/ash/devtools/ui_element.h
@@ -0,0 +1,78 @@
+// Copyright 2017 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 ASH_DEVTOOLS_UI_ELEMENT_H_
+#define ASH_DEVTOOLS_UI_ELEMENT_H_
+
+#include <vector>
+
+#include "ash/ash_export.h"
+#include "base/macros.h"
+#include "ui/aura/window.h"
+#include "ui/gfx/geometry/rect.h"
+#include "ui/views/view.h"
+
+namespace ash {
+namespace devtools {
+
+class UIElementDelegate;
+
+// UIElement type.
+enum UIElementType { WINDOW, WIDGET, VIEW };
+
+class ASH_EXPORT UIElement {
+ public:
+  int node_id() const { return node_id_; };
+  std::string GetTypeName() const;
+  UIElement* parent() const { return parent_; };
+  UIElementDelegate* delegate() const { return delegate_; };
+  UIElementType type() const { return type_; };
+  const std::vector<UIElement*>& children() const { return children_; };
+
+  // |child| is inserted in front of |before|. If |before| is null, it
+  // is inserted at the end.

[sadrul, 2017/05/17 21:54:13]

Add a comment that the parent takes ownership of the child added.

[thanhph, 2017/05/18 14:28:15]

Done.

+  void AddChild(UIElement* child, UIElement* before = nullptr);
+
+  // Remove |child| out of vector |children_|.

[sadrul, 2017/05/17 21:54:13]

Make a note that |child| is not destroyed when removed using RemoveChild(), and
the caller is responsible for destroying |child|.

[thanhph, 2017/05/18 14:28:15]

Done.

+  void RemoveChild(UIElement* child);
+
+  // Move |child| to position new_index in |children_|.
+  void ReorderChild(UIElement* child, int new_index);
+
+  virtual void Destroy() = 0;

[sadrul, 2017/05/17 21:54:13]

All the overrides just do 'delete this'. Can the callers just do 'delete
element' directly instead?

[thanhph, 2017/05/18 14:28:16]

Yes, done. I move ~UIElement() back to public method to enable this.

+  virtual void GetBounds(gfx::Rect* bounds) const = 0;
+  virtual void SetBounds(const gfx::Rect& bounds) = 0;
+  virtual void GetVisible(bool* visible) const = 0;
+  virtual void SetVisible(bool visible) = 0;
+
+  // If element exists, return its associated native window and its bounds.
+  // Otherwise, return null and empty bounds.
+  virtual std::pair<aura::Window*, gfx::Rect> GetNodeWindowAndBounds()
+      const = 0;
+
+  template <typename BackingT, typename T>
+  static BackingT* GetBackingElement(UIElement* element) {
+    return T::From(element);
+  };
+
+ protected:
+  UIElement(const UIElementType type,
+            UIElementDelegate* delegate,
+            UIElement* parent);
+  virtual ~UIElement();
+
+ private:
+  const int node_id_;
+  const UIElementType type_;
+  std::vector<UIElement*> children_;
+  UIElement* parent_;
+  UIElementDelegate* delegate_;
+
+  DISALLOW_COPY_AND_ASSIGN(UIElement);
+};
+
+}  // namespace devtools
+}  // namespace ash
+
+#endif  // ASH_DEVTOOLS_UI_ELEMENT_H_