summaryrefslogtreecommitdiffstats
path: root/chrome/views/label.h
diff options
context:
space:
mode:
authorinitial.commit <initial.commit@0039d316-1c4b-4281-b951-d872f2087c98>2008-07-26 23:55:29 +0000
committerinitial.commit <initial.commit@0039d316-1c4b-4281-b951-d872f2087c98>2008-07-26 23:55:29 +0000
commit09911bf300f1a419907a9412154760efd0b7abc3 (patch)
treef131325fb4e2ad12c6d3504ab75b16dd92facfed /chrome/views/label.h
parent586acc5fe142f498261f52c66862fa417c3d52d2 (diff)
downloadchromium_src-09911bf300f1a419907a9412154760efd0b7abc3.zip
chromium_src-09911bf300f1a419907a9412154760efd0b7abc3.tar.gz
chromium_src-09911bf300f1a419907a9412154760efd0b7abc3.tar.bz2
Add chrome to the repository.
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@15 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/views/label.h')
-rw-r--r--chrome/views/label.h200
1 files changed, 200 insertions, 0 deletions
diff --git a/chrome/views/label.h b/chrome/views/label.h
new file mode 100644
index 0000000..70541a8
--- /dev/null
+++ b/chrome/views/label.h
@@ -0,0 +1,200 @@
+// Copyright 2008, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+// * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#ifndef CHROME_VIEWS_LABEL_H__
+#define CHROME_VIEWS_LABEL_H__
+
+#include "chrome/common/gfx/chrome_font.h"
+#include "chrome/views/view.h"
+#include "googleurl/src/gurl.h"
+#include "SkColor.h"
+
+namespace ChromeViews {
+
+/////////////////////////////////////////////////////////////////////////////
+//
+// Label class
+//
+// A label is a view subclass that can display a string.
+//
+/////////////////////////////////////////////////////////////////////////////
+class Label : public View {
+ public:
+ enum Alignment { ALIGN_LEFT = 0,
+ ALIGN_CENTER,
+ ALIGN_RIGHT };
+
+ // The view class name.
+ static const char kViewClassName[];
+
+ // Create a new label with a default font and empty value
+ Label();
+
+ // Create a new label with a default font
+ explicit Label(const std::wstring& text);
+
+ Label(const std::wstring& text, const ChromeFont& font);
+
+ virtual ~Label();
+
+ // Overridden to compute the size required to display this label
+ virtual void GetPreferredSize(CSize* out);
+
+ // Return the height necessary to display this label with the provided width.
+ // This method is used to layout multi-line labels. It is equivalent to
+ // GetPreferredSize().cy if the receiver is not multi-line
+ virtual int GetHeightForWidth(int w);
+
+ // Returns chrome/views/Label.
+ virtual std::string GetClassName() const;
+
+ // Overridden to paint
+ virtual void Paint(ChromeCanvas* canvas);
+
+ // If the mouse is over the label, and a mouse over background has been
+ // specified, its used. Otherwise super's implementation is invoked
+ virtual void PaintBackground(ChromeCanvas* canvas);
+
+ // Set the font.
+ void SetFont(const ChromeFont& font);
+
+ // Return the font used by this label
+ ChromeFont GetFont() const;
+
+ // Set the label text.
+ void SetText(const std::wstring& text);
+
+ // Return the label text.
+ const std::wstring GetText() const;
+
+ // Set URL Value - text_ is set to spec().
+ void SetURL(const GURL& url);
+
+ // Return the label URL.
+ const GURL GetURL() const;
+
+ // Set the color
+ virtual void SetColor(const SkColor& color);
+
+ // Return a reference to the currently used color
+ virtual const SkColor GetColor() const;
+
+ // Alignment
+ void SetHorizontalAlignment(Alignment a);
+ Alignment GetHorizontalAlignment() const;
+
+ // Set whether the label text can wrap on multiple lines.
+ // Default is false
+ void SetMultiLine(bool f);
+
+ // Return whether the label text can wrap on multiple lines
+ bool IsMultiLine();
+
+ // Sets the tooltip text. Default behavior for a label (single-line) is to
+ // show the full text if it is wider than its bounds. Calling this overrides
+ // the default behavior and lets you set a custom tooltip. To revert to
+ // default behavior, call this with an empty string.
+ void SetTooltipText(const std::wstring& tooltip_text);
+
+ // Gets the tooltip text for labels that are wider than their bounds, except
+ // when the label is multiline, in which case it just returns false (no
+ // tooltip). If a custom tooltip has been specified with SetTooltipText()
+ // it is returned instead.
+ virtual bool GetTooltipText(int x, int y, std::wstring* tooltip);
+
+ // Mouse enter/exit are overridden to render mouse over background color. These
+ // invoke SetContainsMouse as necessary.
+ virtual void OnMouseMoved(const MouseEvent& e);
+ virtual void OnMouseEntered(const MouseEvent& event);
+ virtual void OnMouseExited(const MouseEvent& event);
+
+ // The background color to use when the mouse is over the label. Label
+ // takes ownership of the Background.
+ void SetMouseOverBackground(Background* background);
+ const Background* GetMouseOverBackground() const;
+
+ // Sets the enabled state. Setting the enabled state resets the color.
+ virtual void SetEnabled(bool enabled);
+
+ // Resizes the label so its width is set to the width of the longest line and
+ // its height deduced accordingly.
+ // This is only intended for multi-line labels and is useful when the label's
+ // text contains several lines separated with \n.
+ // |max_width| is the maximum width that will be used (longer lines will be
+ // wrapped). If 0, no maximum width is enforced.
+ void SizeToFit(int max_width);
+
+ // Returns the MSAA role of the current view. The role is what assistive
+ // technologies (ATs) use to determine what behavior to expect from a given
+ // control.
+ bool GetAccessibleRole(VARIANT* role);
+
+ // Returns a brief, identifying string, containing a unique, readable name.
+ bool GetAccessibleName(std::wstring* name);
+
+ // Returns the MSAA state of the current view. Sets the input VARIANT
+ // appropriately, and returns true if a change was performed successfully.
+ // Overriden from View.
+ virtual bool GetAccessibleState(VARIANT* state);
+
+ private:
+ static ChromeFont GetDefaultFont();
+
+ // If the mouse is over the text, SetContainsMouse(true) is invoked, otherwise
+ // SetContainsMouse(false) is invoked.
+ void Label::UpdateContainsMouse(const MouseEvent& event);
+
+ // Updates whether the mouse is contained in the Label. If the new value
+ // differs from the current value, and a mouse over background is specified,
+ // SchedulePaint is invoked.
+ void SetContainsMouse(bool contains_mouse);
+
+ // Returns where the text is drawn, in the receivers coordinate system.
+ gfx::Rect GetTextBounds();
+
+ int ComputeMultiLineFlags();
+ void GetTextSize(CSize* out);
+ void Init(const std::wstring& text, const ChromeFont& font);
+ std::wstring text_;
+ GURL url_;
+ ChromeFont font_;
+ SkColor color_;
+ CSize text_size_;
+ bool text_size_valid_;
+ bool is_multi_line_;
+ bool url_set_;
+ Alignment horiz_alignment_;
+ std::wstring tooltip_text_;
+ // Whether the mouse is over this label.
+ bool contains_mouse_;
+ scoped_ptr<Background> mouse_over_background_;
+};
+
+}
+#endif // CHROME_VIEWS_VIEW_H__