blob: f4abcb6c846c2eddb48fc4a3fc6c9a109c584cae [file] [log] [blame]
// Copyright 2013 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 <stddef.h>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "ash/app_list/model/app_list_item.h"
#include "ash/app_list/model/app_list_item_list_observer.h"
#include "ash/app_list/model/app_list_item_observer.h"
#include "ash/app_list/model/app_list_model_export.h"
#include "ash/app_list/model/folder_image.h"
#include "ash/public/cpp/app_list/app_list_config_provider.h"
#include "ash/public/cpp/app_list/app_list_types.h"
#include "base/macros.h"
#include "base/scoped_observer.h"
namespace gfx {
class Rect;
} // namespace gfx
namespace ash {
class AppListConfig;
class AppListItemList;
// AppListFolderItem implements the model/controller for folders.
class APP_LIST_MODEL_EXPORT AppListFolderItem
: public AppListItem,
public FolderImageObserver,
public AppListConfigProvider::Observer {
// The folder type affects folder behavior.
enum FolderType {
// Default folder type.
// Items can not be moved to/from OEM folders in the UI.
static const char kItemType[];
explicit AppListFolderItem(const std::string& id);
~AppListFolderItem() override;
// Returns the target icon bounds for |item| to fly back to its parent folder
// icon in animation UI. If |item| is one of the top item icon, this will
// match its corresponding top item icon in the folder icon. Otherwise,
// the target icon bounds is centered at the |folder_icon_bounds| with
// the same size of the top item icon.
// The Rect returned is in the same coordinates of |folder_icon_bounds|.
gfx::Rect GetTargetIconRectInFolderForItem(
const AppListConfig& app_list_config,
AppListItem* item,
const gfx::Rect& folder_icon_bounds);
AppListItemList* item_list() { return item_list_.get(); }
const AppListItemList* item_list() const { return item_list_.get(); }
FolderType folder_type() const { return folder_type_; }
// AppListItem overrides:
const char* GetItemType() const override;
AppListItem* FindChildItem(const std::string& id) override;
size_t ChildItemCount() const override;
// AppListConfigProvider::Observer override:
void OnAppListConfigCreated(AppListConfigType config_type) override;
// Persistent folders will be retained even if there is 1 app in them.
bool IsPersistent() const;
void SetIsPersistent(bool is_persistent);
// Returns true if this folder is a candidate for auto-removal (based on its
// type and the number of children it has).
bool ShouldAutoRemove() const;
// Returns an id for a new folder.
static std::string GenerateId();
// FolderImageObserver overrides:
void OnFolderImageUpdated(AppListConfigType config_type) override;
// Informs the folder item of an item being dragged, that it may notify its
// image.
void NotifyOfDraggedItem(AppListItem* dragged_item);
FolderImage* GetFolderImageForTesting(AppListConfigType type) const;
// Creates FolderImages for config types in |config_types| that also exist in
// AppListConfigProvider, and adds them to |folder_images_|.
// |request_icon_update| - Whether FolderImage::UpdateIcon() should be called
// on the created icon images - this should be set if called outside app
// list model initialization (i.e. outside constructor).
void EnsureIconsForAvailableConfigTypes(
const std::vector<AppListConfigType>& config_types,
bool request_icon_update);
// The type of folder; may affect behavior of folder views.
const FolderType folder_type_;
// List of items in the folder.
std::unique_ptr<AppListItemList> item_list_;
std::map<AppListConfigType, std::unique_ptr<FolderImage>> folder_images_;
// Set when a folder item is being dragged.
AppListItem* dragged_item_ = nullptr;
ScopedObserver<AppListConfigProvider, AppListConfigProvider::Observer>
} // namespace ash