xpcom/io/nsIUnicharOutputStream.idl

   1 /* vim:set expandtab ts=4 sw=4 sts=4 cin: */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org unicode stream converter code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Christian Biesinger <cbiesinger@web.de>.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 /**
  41  * An interface that allows writing unicode data.
  42  */
  43 [scriptable, uuid(2d00b1bb-8b21-4a63-bcc6-7213f513ac2e)]
  44 interface nsIUnicharOutputStream : nsISupports
  45 {
  46     /**
  47      * Write a single character to the stream. When writing many characters,
  48      * prefer the string-taking write method.
  49      *
  50      * @retval true The character was written successfully
  51      * @retval false Not all bytes of the character could be written.
  52      */
  53     boolean write(in unsigned long aCount,
  54                   [const, array, size_is(aCount)] in PRUnichar c);
  55
  56     /**
  57      * Write a string to the stream.
  58      *
  59      * @retval true The string was written successfully
  60      * @retval false Not all bytes of the string could be written.
  61      */
  62     boolean writeString(in AString str);
  63
  64     /**
  65      * Flush the stream. This finishes the conversion and writes any bytes that
  66      * finish the current byte sequence.
  67      *
  68      * It does NOT flush the underlying stream.
  69      *
  70      * @see nsIUnicodeEncoder::Finish
  71      */
  72     void flush();
  73
  74     /**
  75      * Close the stream and free associated resources. This also closes the
  76      * underlying stream.
  77      */
  78     void close();
  79 };