svl/source/inc/stringio.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SVL_SOURCE_INC_STRINGIO_HXX
  21 #define INCLUDED_SVL_SOURCE_INC_STRINGIO_HXX
  22
  23 /** Read in a Unicode string from a streamed byte string representation.
  24
  25     @param rStream  Some (input) stream.  Its Stream/TargetCharSets must
  26     be set to correct values!
  27
  28     @return  On success, returns the reconstructed Unicode string.
  29  */
  30 OUString readByteString(SvStream & rStream);
  31
  32 /** Write a byte string representation of a Unicode string into a stream.
  33
  34     @param rStream  Some (output) stream.  Its Stream/TargetCharSets must
  35     be set to correct values!
  36
  37     @param rString  Some Unicode string.
  38  */
  39 void writeByteString(SvStream & rStream, const OUString& rString);
  40
  41 /** Read in a Unicode string from either a streamed Unicode or byte string
  42     representation.
  43
  44     @param rStream  Some (input) stream.  If bUnicode is false, its
  45     Stream/TargetCharSets must be set to correct values!
  46
  47     @param bUnicode  Whether to read in a stream Unicode (true) or byte
  48     string (false) representation.
  49
  50     @return          On success, returns the reconstructed Unicode string.
  51  */
  52 OUString readUnicodeString(SvStream & rStream, bool bUnicode);
  53
  54 /** Write a Unicode string representation of a Unicode string into a
  55     stream.
  56
  57     @param rStream  Some (output) stream.
  58
  59     @param rString  Some Unicode string.
  60  */
  61 void writeUnicodeString(SvStream & rStream, const OUString& rString);
  62
  63
  64 #endif // INCLUDED_SVL_SOURCE_INC_STRINGIO_HXX
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */