widget/cocoa/MOZIconHelper.mm

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /*
   7  * Creates icons for display in native menu items on macOS.
   8  */
   9
  10 #include "MOZIconHelper.h"
  11
  12 #include "imgIContainer.h"
  13 #include "nsCocoaUtils.h"
  14
  15 @implementation MOZIconHelper
  16
  17 // Returns an autoreleased empty NSImage.
  18 + (NSImage*)placeholderIconWithSize:(NSSize)aSize {
  19   return [[[NSImage alloc] initWithSize:aSize] autorelease];
  20 }
  21
  22 // Returns an autoreleased NSImage.
  23 + (NSImage*)iconImageFromImageContainer:(imgIContainer*)aImage
  24                                withSize:(NSSize)aSize
  25                              svgContext:
  26                                  (const mozilla::SVGImageContext*)aSVGContext
  27                             scaleFactor:(CGFloat)aScaleFactor {
  28   bool isEntirelyBlack = false;
  29   NSImage* retainedImage = nil;
  30   nsresult rv;
  31   if (aScaleFactor != 0.0f) {
  32     rv = nsCocoaUtils::CreateNSImageFromImageContainer(
  33         aImage, imgIContainer::FRAME_CURRENT, aSVGContext, aSize,
  34         &retainedImage, aScaleFactor, &isEntirelyBlack);
  35   } else {
  36     rv = nsCocoaUtils::CreateDualRepresentationNSImageFromImageContainer(
  37         aImage, imgIContainer::FRAME_CURRENT, aSVGContext, aSize,
  38         &retainedImage, &isEntirelyBlack);
  39   }
  40
  41   NSImage* image = [retainedImage autorelease];
  42
  43   if (NS_FAILED(rv) || !image) {
  44     return nil;
  45   }
  46
  47   // If all the color channels in the image are black, treat the image as a
  48   // template. This will cause macOS to use the image's alpha channel as a mask
  49   // and it will fill it with a color that looks good in the context that it's
  50   // used in. For example, for regular menu items, the image will be black, but
  51   // when the menu item is hovered (and its background is blue), it will be
  52   // filled with white.
  53   [image setTemplate:isEntirelyBlack];
  54
  55   [image setSize:aSize];
  56
  57   return image;
  58 }
  59
  60 @end