widget/nsIPrintSettingsWin.idl
author Nicholas Nethercote <nnethercote@mozilla.com>
Wed, 25 Oct 2017 10:22:38 +1100
changeset 387909 3d0093f961eec929caa370444cd0f7fcbfbc82bc
parent 385663 396ff2a152d77a0c28f09fefc8b0a96659f2d4ba
child 470305 0f12aebacdd6845bed9e7f2cbf8e33dbd9b50b8b
permissions -rw-r--r--
Bug 1410794 - Change some |string| occurrences in nsIPrefBranch.idl to |ACString|. r=erahm. This makes the code nicer. In particular, it removes many getter_Copies() calls. The patch also converts a lot of nsCStrings to nsAutoCString, which will avoid heap allocation in the common case. The patch also renames PREF_CopyCharPref() as PREF_GetCStringPref(), because it's actually getting a string, not a char, and that matches the existing GetCString() and GetDefaultCString() methods. Correspondingly, it also renames PREF_SetCharPref() as PREF_SetCStringPref(). The |aPrefName| arguments in nsIPrefBranch.idl remain as |string| because they almost always involve passing in C string literals, and passing "foo" is much nicer than passing NS_LITERAL_CSTRING("foo"). It's worth noting that early versions of this patch used |AUTF8String| instead of |ACString|. But it turns out that libpref stores prefs internally as Latin1. And |ACString| is compatible with Latin1 but |AUTF8String| isn't, because non-ASCII Latin1 strings are not valid UTF-8!

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

%{ C++
#include "windows.h"
%}

/**
 * Native types
 */
  [ptr] native nsDevMode(DEVMODEW);
  native nsHdc(HDC);

/**
 * Simplified PrintSettings for Windows interface 
 */
[scriptable, uuid(c63eed41-6ac5-459e-8a64-033eb9ad770a)]

interface nsIPrintSettingsWin : nsISupports
{
  /**
   * Data Members
   *
   * Each of these data members make a copy 
   * of the contents. If you get the value, 
   * you own the memory.
   *
   * The following three pieces of data are needed
   * to create a DC for printing. These are typcially 
   * gotten via the PrintDLG call ro can be obtained
   * via the "m_pd" data member of the CPrintDialog
   * in MFC.
   */
  [noscript] attribute AString deviceName;
  [noscript] attribute AString driverName;

  [noscript] attribute nsDevMode devMode;

  /**
   * On Windows we use the printable width and height for the printing surface.
   * We don't want to have to create native print device contexts in the content
   * process, so we need to store these in the settings.
   * Storing in Inches is most convenient as they are retrieved from the device
   * using fields which are in pixels and pixels per inch.
   * Note these are stored in portrait format to ensure that we can take account
   * of our own changes to the orientation print setting.
   */
  [noscript] attribute double printableWidthInInches;
  [noscript] attribute double printableHeightInInches;

  /**
   * Copy relevant print settings from native Windows device.
   *
   * @param hdc HDC to copy from
   * @param devMode DEVMODE to copy from
   */
  [notxpcom] void copyFromNative(in nsHdc hdc, in nsDevMode devMode);

  /**
   * Copy relevant print settings to native windows structures.
   *
   * @param devMode DEVMODE to be populated.
   */
  [notxpcom] void copyToNative(in nsDevMode devMode);
};