platform_font.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef UI_GFX_PLATFORM_FONT_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_GFX_PLATFORM_FONT_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/string16.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/ui_export.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/native_widget_types.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace gfx { 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Font; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class UI_EXPORT PlatformFont : public base::RefCounted<PlatformFont> { 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates an appropriate PlatformFont implementation. 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static PlatformFont* CreateDefault(); 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static PlatformFont* CreateFromNativeFont(NativeFont native_font); 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a PlatformFont implementation with the specified |font_name| 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (encoded in UTF-8) and |font_size| in pixels. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static PlatformFont* CreateFromNameAndSize(const std::string& font_name, 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int font_size); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a new Font derived from the existing font. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |size_delta| is the size in pixels to add to the current font. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The style parameter specifies the new style for the font, and is a 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // bitmask of the values: BOLD, ITALIC and UNDERLINED. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual Font DeriveFont(int size_delta, int style) const = 0; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the number of vertical pixels needed to display characters from 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the specified font. This may include some leading, i.e. height may be 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // greater than just ascent + descent. Specifically, the Windows and Mac 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // implementations include leading and the Linux one does not. This may 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // need to be revisited in the future. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetHeight() const = 0; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the baseline, or ascent, of the font. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetBaseline() const = 0; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the average character width for the font. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetAverageCharacterWidth() const = 0; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the number of horizontal pixels needed to display the specified 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // string. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetStringWidth(const string16& text) const = 0; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the expected number of horizontal pixels needed to display the 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // specified length of characters. Call GetStringWidth() to retrieve the 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // actual number. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetExpectedTextWidth(int length) const = 0; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the style of the font. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetStyle() const = 0; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the font name in UTF-8. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual std::string GetFontName() const = 0; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the font size in pixels. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetFontSize() const = 0; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the native font handle. 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual NativeFont GetNativeFont() const = 0; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PlatformFont() {} 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class base::RefCounted<PlatformFont>; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace gfx 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_GFX_PLATFORM_FONT_H_ 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 80