gfx/src/nsIFontEnumerator.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Communicator.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corp.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Erik van der Poel
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41
  42 [scriptable, uuid(924d98d9-3518-4cb4-8708-c74fe8e3ec3c)]
  43 interface nsIFontEnumerator : nsISupports
  44 {
  45   /**
  46    * Return a sorted array of the names of all installed fonts.
  47    *
  48    * @param  aCount     returns number of names returned
  49    * @param  aResult    returns array of names
  50    * @return void
  51    */
  52   void EnumerateAllFonts(out PRUint32 aCount,
  53     [retval, array, size_is(aCount)] out wstring aResult);
  54
  55   /**
  56    * Return a sorted array of names of fonts that support the given language
  57    * group and are suitable for use as the given CSS generic font.
  58    *
  59    * @param  aLangGroup language group
  60    * @param  aGeneric   CSS generic font
  61    * @param  aCount     returns number of names returned
  62    * @param  aResult    returns array of names
  63    * @return void
  64    */
  65   void EnumerateFonts(in string aLangGroup, in string aGeneric,
  66     out PRUint32 aCount, [retval, array, size_is(aCount)] out wstring aResult);
  67
  68   /**
  69     @param  aLangGroup language group
  70     @return bool do we have a font for this language group
  71    */
  72   void HaveFontFor(in string aLangGroup, [retval] out boolean aResult);
  73
  74   /**
  75    * @param  aLangGroup language group
  76    * @param  aGeneric CSS generic font
  77    * @return suggested default font for this language group and generic family
  78    */
  79   wstring getDefaultFont(in string aLangGroup, in string aGeneric);
  80
  81   /**
  82    * update the global font list
  83    * return true if font list is changed
  84    */
  85   boolean updateFontList();
  86
  87   /**
  88    * get the standard family name on the system from given family
  89    * @param  aName family name which may be alias
  90    * @return the standard family name on the system, if given name does not
  91    *         exist, returns empty string
  92    */
  93   wstring getStandardFamilyName(in wstring aName);
  94 };