blob: 33244c19fc3b1c27c65014f8edd2ad29cde97b58 [file] [log] [blame]
// Copyright 2014 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.
#include <windows.h>
#include <shobjidl.h>
#include <stddef.h>
#include <wrl/client.h>
#include <string>
#include <vector>
#include "base/command_line.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "ui/gfx/image/image_skia.h"
// Represents a class used for creating an IShellLink object.
// Even though an IShellLink also needs the absolute path to an application to
// be executed, this class does not have any variables for it because current
// users always use "chrome.exe" as the application.
class ShellLinkItem : public base::RefCountedThreadSafe<ShellLinkItem> {
const base::string16& title() const { return title_; }
const base::string16& icon_path() const { return icon_path_; }
const std::string& url() const { return url_; }
int icon_index() const { return icon_index_; }
const gfx::ImageSkia& icon_image() const { return icon_image_; }
base::string16 GetArguments() const;
base::CommandLine* GetCommandLine();
void set_title(const base::string16& title) { title_ = title; }
void set_icon(const base::string16& path, int index) {
icon_path_ = path;
icon_index_ = index;
void set_url(const std::string& url) { url_ = url; }
void set_icon_image(const gfx::ImageSkia& image) {
icon_image_ = image;
friend class base::RefCountedThreadSafe<ShellLinkItem>;
// Used for storing and appending command-line arguments.
base::CommandLine command_line_;
// The string to be displayed in a JumpList.
base::string16 title_;
// The absolute path to an icon to be displayed in a JumpList.
base::string16 icon_path_;
// The tab URL corresponding to this link's favicon.
std::string url_;
// The icon index in the icon file. If an icon file consists of two or more
// icons, set this value to identify the icon. If an icon file consists of
// one icon, this value is 0.
int icon_index_;
// Icon image. Used by the browser JumpList.
// Note that an icon path must be supplied to IShellLink, so users of this
// class must save icon data to disk.
gfx::ImageSkia icon_image_;
typedef std::vector<scoped_refptr<ShellLinkItem> > ShellLinkItemList;
// A utility class that hides the boilerplate for updating Windows JumpLists.
// Note that JumpLists are available in Windows 7 and later only.
// Example of usage:
// JumpListUpdater updater(app_id);
// if (updater.BeginUpdate()) {
// updater.AddTasks(...);
// updater.AddCustomCategory(...);
// updater.CommitUpdate();
// }
// Note:
// - Each JumpListUpdater instance is expected to be used once only.
// - The JumpList must be updated in its entirety, i.e. even if a category has
// not changed, all its items must be added in each update.
class JumpListUpdater {
explicit JumpListUpdater(const base::string16& app_user_model_id);
// Returns true if JumpLists are enabled on this OS.
static bool IsEnabled();
// Returns the current user setting for the maximum number of items to display
// in JumpLists. The setting is retrieved in BeginUpdate().
size_t user_max_items() const { return user_max_items_; }
// Starts a transaction that updates the JumpList of this application.
// This must be called prior to updating the JumpList. If this function
// returns false, this instance should not be used.
bool BeginUpdate();
// Commits the update.
bool CommitUpdate();
// Updates the predefined "Tasks" category of the JumpList.
bool AddTasks(const ShellLinkItemList& link_items);
// Updates an unregistered category of the JumpList.
// This function cannot update registered categories (such as "Tasks")
// because special steps are required for updating them.
// |max_items| specifies the maximum number of items from |link_items| to add
// to the JumpList.
bool AddCustomCategory(const base::string16& category_name,
const ShellLinkItemList& link_items,
size_t max_items);
// The app ID.
base::string16 app_user_model_id_;
// Windows API interface used to modify JumpLists.
Microsoft::WRL::ComPtr<ICustomDestinationList> destination_list_;
// The current user setting for "Number of recent items to display in Jump
// Lists" option in the "Taskbar and Start Menu Properties".
size_t user_max_items_;