Add RenderText DirectionalityMode enum and support; etc.

ui/views/controls/label.h

 // Copyright (c) 2012 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 UI_VIEWS_CONTROLS_LABEL_H_
 #define UI_VIEWS_CONTROLS_LABEL_H_
 
 #include <string>
 
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/string16.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/gfx/font.h"
+#include "ui/gfx/text_constants.h"
 #include "ui/views/view.h"
 
 namespace views {
 
 /////////////////////////////////////////////////////////////////////////////
 //
 // Label class
 //
 // A label is a view subclass that can display a string.
 //
 /////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT Label : public View {
  public:
+  // TODO(msw): Use gfx::HorizontalAlignment instead.
   enum Alignment { ALIGN_LEFT = 0,
                    ALIGN_CENTER,
                    ALIGN_RIGHT };
 
-  // The following enum is used to indicate whether using the Chrome UI's
-  // directionality as the label's directionality, or auto-detecting the label's
-  // directionality.
-  //
-  // If the label text originates from the Chrome UI, we should use the Chrome
-  // UI's directionality as the label's directionality.
-  //
-  // If the text originates from a web page, its directionality is determined
-  // based on its first character with strong directionality, disregarding what
-  // directionality the Chrome UI is.
-  enum DirectionalityMode {
-    USE_UI_DIRECTIONALITY = 0,
-    AUTO_DETECT_DIRECTIONALITY
-  };
-
   // The view class name.
   static const char kViewClassName[];
 
   // The padding for the focus border when rendering focused text.
   static const int kFocusBorderPadding;
 
   Label();
   explicit Label(const string16& text);
   Label(const string16& text, const gfx::Font& font);
   virtual ~Label();
@@ skipping 33 matching lines @@
   // Enables a drop shadow underneath the text.
   void SetShadowColors(SkColor enabled_color, SkColor disabled_color);
 
   // Sets the drop shadow's offset from the text.
   void SetShadowOffset(int x, int y);
 
   // Disables shadows.
   void ClearEmbellishing();
 
   // Sets horizontal alignment. If the locale is RTL, and the directionality
-  // mode is USE_UI_DIRECTIONALITY, the alignment is flipped around.
+  // mode is gfx::DIRECTIONALITY_FROM_UI, the alignment is flipped around.
   //
   // Caveat: for labels originating from a web page, the directionality mode
-  // should be reset to AUTO_DETECT_DIRECTIONALITY before the horizontal
+  // should be reset to gfx::DIRECTIONALITY_FROM_TEXT before the horizontal
   // alignment is set. Otherwise, the label's alignment specified as a parameter
   // will be flipped in RTL locales.
   void SetHorizontalAlignment(Alignment alignment);
 
   Alignment horizontal_alignment() const { return horiz_alignment_; }
 
-  // Sets the directionality mode. The directionality mode is initialized to
-  // USE_UI_DIRECTIONALITY when the label is constructed. USE_UI_DIRECTIONALITY
-  // applies to every label that originates from the Chrome UI. However, if the
-  // label originates from a web page, its directionality is auto-detected.
-  void set_directionality_mode(DirectionalityMode mode) {
+  // Sets the directionality mode; initialized to gfx::DIRECTIONALITY_FROM_UI
+  // when the label is constructed. gfx::DIRECTIONALITY_FROM_UI applies to every
+  // label that originates from the Chrome UI. However, if the label originates
+  // from a web page, its directionality is auto-detected.
+  void set_directionality_mode(gfx::DirectionalityMode mode) {
     directionality_mode_ = mode;
   }
 
-  DirectionalityMode directionality_mode() const {
+  gfx::DirectionalityMode directionality_mode() const {
     return directionality_mode_;
   }
 
   // Sets whether the label text can wrap on multiple lines.
   // Default is false.
   void SetMultiLine(bool multi_line);
 
   // Returns whether the label text can wrap on multiple lines.
   bool is_multi_line() const { return is_multi_line_; }
 
@@ skipping 138 matching lines @@
   bool allow_character_break_;
   bool elide_in_middle_;
   bool is_email_;
   Alignment horiz_alignment_;
   string16 tooltip_text_;
   // Whether the mouse is over this label.
   bool contains_mouse_;
   scoped_ptr<Background> mouse_over_background_;
   // Whether to collapse the label when it's not visible.
   bool collapse_when_hidden_;
-  // The following member variable is used to control whether the
-  // directionality is auto-detected based on first strong directionality
-  // character or is determined by chrome UI's locale.
-  DirectionalityMode directionality_mode_;
+  // Controls whether the base text directionality is inherited from the text's
+  // first strong directionality character or from the UI's locale.

[Alexei Svitkine (slow), 2012/07/30 22:29:16]

Could also be forced right? Perhaps the comment doesn't need to go into so much
detail.

[msw, 2012/07/31 03:03:06]

Reverted this portion of the CL; will address in a followup CL.

+  gfx::DirectionalityMode directionality_mode_;
   // When embedded in a larger control that is focusable, setting this flag
   // allows this view to be painted as focused even when it is itself not.
   bool paint_as_focused_;
   // When embedded in a larger control that is focusable, setting this flag
   // allows this view to reserve space for a focus border that it otherwise
   // might not have because it is not itself focusable.
   bool has_focus_border_;
 
   // Colors for shadow.
   SkColor enabled_shadow_color_;
   SkColor disabled_shadow_color_;
 
   // Space between text and shadow.
   gfx::Point shadow_offset_;
 
   // Should a shadow be drawn behind the text?
   bool has_shadow_;
 
 
   DISALLOW_COPY_AND_ASSIGN(Label);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_CONTROLS_LABEL_H_