ui/base/webui/web_ui_util.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_BASE_WEBUI_WEB_UI_UTIL_H_
   6 #define UI_BASE_WEBUI_WEB_UI_UTIL_H_
   7
   8 #include <string>
   9
  10 #include "base/strings/string_piece.h"
  11 #include "base/values.h"
  12 #include "ui/base/ui_base_export.h"
  13 #include "ui/base/window_open_disposition.h"
  14
  15 class GURL;
  16 class SkBitmap;
  17
  18 namespace webui {
  19
  20 // Convenience routine to convert SkBitmap object to data url
  21 // so that it can be used in WebUI.
  22 UI_BASE_EXPORT std::string GetBitmapDataUrl(const SkBitmap& bitmap);
  23
  24 // Convenience routine to get data url that corresponds to given
  25 // resource_id as a bitmap. This function does not check if the
  26 // resource for the |resource_id| is a bitmap, therefore it is the
  27 // caller's responsibility to make sure the resource is indeed a
  28 // bitmap. Returns empty string if a resource does not exist for given
  29 // |resource_id|.
  30 UI_BASE_EXPORT std::string GetBitmapDataUrlFromResource(int resource_id);
  31
  32 // Extracts a disposition from click event arguments. |args| should contain
  33 // an integer button and booleans alt key, ctrl key, meta key, and shift key
  34 // (in that order), starting at |start_index|.
  35 UI_BASE_EXPORT WindowOpenDisposition
  36     GetDispositionFromClick(const base::ListValue* args, int start_index);
  37
  38 // Pares a formatted scale factor string into float and sets to |scale_factor|.
  39 UI_BASE_EXPORT bool ParseScaleFactor(const base::StringPiece& identifier,
  40                                      float* scale_factor);
  41
  42 // Parses a URL containing some path @{scale}x. If it does not contain a scale
  43 // factor then the default scale factor is returned.
  44 UI_BASE_EXPORT void ParsePathAndScale(const GURL& url,
  45                                       std::string* path,
  46                                       float* scale_factor);
  47
  48 // Helper function to set some default values (e.g., font family, size,
  49 // language, and text direction) into the given dictionary. Requires an
  50 // application locale (i.e. g_browser_process->GetApplicationLocale()).
  51 UI_BASE_EXPORT void SetLoadTimeDataDefaults(
  52     const std::string& app_locale,
  53     base::DictionaryValue* localized_strings);
  54
  55 // Get a CSS declaration for common text styles for all of Web UI.
  56 UI_BASE_EXPORT std::string GetWebUiCssTextDefaults();
  57
  58 // Appends the CSS declaration returned by GetWebUiCssTextDefaults() as an
  59 // inline stylesheet.
  60 UI_BASE_EXPORT void AppendWebUiCssTextDefaults(std::string* html);
  61
  62 // Get some common font styles for all of WebUI.
  63 UI_BASE_EXPORT std::string GetFontFamily();
  64 UI_BASE_EXPORT std::string GetFontSize();
  65 UI_BASE_EXPORT std::string GetTextDirection();
  66
  67 }  // namespace webui
  68
  69 #endif  // UI_BASE_WEBUI_WEB_UI_UTIL_H_