Add WindowsTaskbar class

windows/windows_taskbar.cc

@@ -0,0 +1,149 @@
+/// This file is a part of windows_taskbar
+/// (https://github.com/alexmercerind/windows_taskbar).
+///
+/// Copyright (c) 2021 & 2022, Hitesh Kumar Saini <saini123hitesh@gmail.com>.
+/// All rights reserved.
+/// Use of this source code is governed by MIT license that can be found in the
+/// LICENSE file.
+
+#include "windows_taskbar.h"
+
+#include "utils.h"
+
+WindowsTaskbar::WindowsTaskbar(HWND window) : window_(window) {
+  ::CoCreateInstance(CLSID_TaskbarList, NULL, CLSCTX_INPROC_SERVER,
+                     IID_PPV_ARGS(&taskbar_));
+}
+
+WindowsTaskbar::~WindowsTaskbar() {
+  taskbar_->Release();
+  taskbar_ = nullptr;
+}
+
+bool WindowsTaskbar::SetProgressMode(int32_t mode) {
+  HRESULT hr = taskbar_->SetProgressState(window_, static_cast<TBPFLAG>(mode));
+  return SUCCEEDED(hr);
+}
+
+bool WindowsTaskbar::SetProgress(int32_t completed, int32_t total) {
+  HRESULT hr = taskbar_->SetProgressValue(window_, completed, total);
+  return SUCCEEDED(hr);
+}
+
+bool WindowsTaskbar::SetThumbnailToolbar(
+    std::vector<ThumbnailToolbarButton> buttons) {
+  if (buttons.size() > kMaxThumbButtonCount) return false;
+  HRESULT hr = taskbar_->HrInit();
+  if (SUCCEEDED(hr)) {
+    auto image_list = ::ImageList_Create(::GetSystemMetrics(SM_CXSMICON),
+                                         ::GetSystemMetrics(SM_CXSMICON),
+                                         ILC_MASK | ILC_COLOR32, 0, 0);
+    // Add all images to the |image_list| & set using |ThumbBarSetImageList|.
+    for (const auto& button : buttons) {
+      // Using |IMAGE_ICON| as default image type since it allows transparency.
+      ImageList_AddIcon(
+          image_list,
+          (HICON)LoadImage(0, Utf16FromUtf8(button.icon).c_str(), IMAGE_ICON,
+                           GetSystemMetrics(SM_CXSMICON),
+                           GetSystemMetrics(SM_CXSMICON),
+                           LR_LOADFROMFILE | LR_LOADTRANSPARENT));
+    }
+    if (image_list) {
+      hr = taskbar_->ThumbBarSetImageList(window_, image_list);
+      // |ITaskbarList3| can have a maximum of 7 buttons.
+      // The number of buttons set using |ThumbBarAddButtons| cannot be changed
+      // afterwards during whole window's lifecycle. Thus, setting maximum i.e.
+      // 7 buttons on every call & adding |THBF_HIDDEN| flag to hide the
+      // remaining additional buttons. On subsequent calls,
+      // |ThumbBarUpdateButtons| is used to update the thumbnail toolbar buttons
+      // again adding |THBF_HIDDEN| flag to remaining additional buttons.
+      THUMBBUTTON thumb_buttons[kMaxThumbButtonCount];
+      if (SUCCEEDED(hr)) {
+        for (uint32_t i = 0; i < kMaxThumbButtonCount; i++) {
+          // Adding required buttons with |THBF_ENABLED| flag at the start of
+          // |thumb_buttons|.
+          if (i < buttons.size()) {
+            auto button = buttons[i];
+            thumb_buttons[i].dwMask = THB_BITMAP | THB_TOOLTIP | THB_FLAGS;
+            thumb_buttons[i].dwFlags =
+                (THUMBBUTTONFLAGS)buttons[i].mode | THBF_ENABLED;
+            thumb_buttons[i].iId = kMinThumbButtonId + i;
+            thumb_buttons[i].iBitmap = i;
+            ::StringCchCopy(thumb_buttons[i].szTip,
+                            ARRAYSIZE(thumb_buttons[i].szTip),
+                            Utf16FromUtf8(buttons[i].tooltip).c_str());
+          }
+          // Adding remaining buttons with |THBF_HIDDEN| flag.
+          else {
+            thumb_buttons[i].dwMask = THB_FLAGS;
+            thumb_buttons[i].dwFlags = THBF_HIDDEN;
+            thumb_buttons[i].iId = kMinThumbButtonId + i;
+          }
+        }
+        // First call, thus using |ThumbBarAddButtons|.
+        if (!thumb_buttons_added_) {
+          hr = taskbar_->ThumbBarAddButtons(window_, kMaxThumbButtonCount,
+                                            thumb_buttons);
+          thumb_buttons_added_ = true;
+        } else {
+          hr = taskbar_->ThumbBarUpdateButtons(window_, kMaxThumbButtonCount,
+                                               thumb_buttons);
+        }
+        if (SUCCEEDED(hr)) {
+          // Freed the |image_list|.
+          hr = ::ImageList_Destroy(image_list);
+          return SUCCEEDED(hr);
+        }
+      }
+    }
+  }
+  return false;
+}
+
+bool WindowsTaskbar::ResetThumbnailToolbar() {
+  return WindowsTaskbar::SetThumbnailToolbar({});
+}
+
+bool WindowsTaskbar::SetThumbnailTooltip(std::string tooltip) {
+  HRESULT hr =
+      taskbar_->SetThumbnailTooltip(window_, Utf16FromUtf8(tooltip).c_str());
+  return SUCCEEDED(hr);
+}
+
+bool WindowsTaskbar::SetFlashTaskbarAppIcon(int32_t mode, int32_t flash_count,
+                                            int32_t timeout) {
+  FLASHWINFO flash_info;
+  flash_info.cbSize = sizeof(flash_info);
+  flash_info.dwFlags = mode;
+  flash_info.dwTimeout = timeout;
+  flash_info.hwnd = window_;
+  flash_info.uCount = flash_count;
+  HRESULT hr = ::FlashWindowEx(&flash_info);
+  return SUCCEEDED(hr);
+}
+
+bool WindowsTaskbar::ResetFlashTaskbarAppIcon() {
+  FLASHWINFO flash_info;
+  flash_info.cbSize = sizeof(flash_info);
+  flash_info.dwFlags = FLASHW_STOP;
+  flash_info.dwTimeout = 0;
+  flash_info.hwnd = window_;
+  flash_info.uCount = 0;
+  HRESULT hr = ::FlashWindowEx(&flash_info);
+  return SUCCEEDED(hr);
+}
+
+bool WindowsTaskbar::SetOverlayIcon(std::string icon, std::string tooltip) {
+  // Using |IMAGE_ICON|.
+  auto image = (HICON)LoadImage(
+      0, Utf16FromUtf8(icon).c_str(), IMAGE_ICON, GetSystemMetrics(SM_CXSMICON),
+      GetSystemMetrics(SM_CXSMICON), LR_LOADFROMFILE | LR_LOADTRANSPARENT);
+  HRESULT hr =
+      taskbar_->SetOverlayIcon(window_, image, Utf16FromUtf8(tooltip).c_str());
+  return SUCCEEDED(hr);
+}
+
+bool WindowsTaskbar::ResetOverlayIcon() {
+  HRESULT hr = taskbar_->SetOverlayIcon(window_, NULL, L"");
+  return SUCCEEDED(hr);
+}

windows/windows_taskbar.h

@@ -0,0 +1,59 @@
+/// This file is a part of windows_taskbar
+/// (https://github.com/alexmercerind/windows_taskbar).
+///
+/// Copyright (c) 2021 & 2022, Hitesh Kumar Saini <saini123hitesh@gmail.com>.
+/// All rights reserved.
+/// Use of this source code is governed by MIT license that can be found in the
+/// LICENSE file.
+
+#ifndef WINDOWS_TASKBAR_H_
+#define WINDOWS_TASKBAR_H_
+
+#include <ShObjIdl.h>
+#include <Windows.h>
+
+#include <cstdint>
+#include <string>
+#include <vector>
+
+struct ThumbnailToolbarButton {
+  std::string icon;
+  std::string tooltip;
+  int32_t mode;
+};
+
+static constexpr uint32_t kMinThumbButtonId = 40001;
+static constexpr uint32_t kMaxThumbButtonCount = 7;
+
+class WindowsTaskbar {
+ public:
+  WindowsTaskbar(HWND window);
+
+  ~WindowsTaskbar();
+
+  bool SetProgressMode(int32_t mode);
+
+  bool SetProgress(int32_t completed, int32_t total);
+
+  bool SetThumbnailToolbar(std::vector<ThumbnailToolbarButton> buttons);
+
+  bool ResetThumbnailToolbar();
+
+  bool SetThumbnailTooltip(std::string tooltip);
+
+  bool SetFlashTaskbarAppIcon(int32_t mode, int32_t flash_count,
+                              int32_t timeout);
+
+  bool ResetFlashTaskbarAppIcon();
+
+  bool SetOverlayIcon(std::string icon, std::string tooltip);
+
+  bool ResetOverlayIcon();
+
+ private:
+  HWND window_ = nullptr;
+  ITaskbarList3* taskbar_ = nullptr;
+  bool thumb_buttons_added_ = false;
+};
+
+#endif