offapi/com/sun/star/rendering/StringContext.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_rendering_StringContext_idl__
  28 #define __com_sun_star_rendering_StringContext_idl__
  29
  30 module com { module sun { module star { module rendering {
  31
  32 /** Collection of string-related arguments used on all canvas text
  33     interfaces.<p>
  34
  35     A possibly much larger string than later rendered is necessary
  36     here, because in several languages, glyph selection is context
  37     dependent.<p>
  38
  39     @since OOo 2.0.0
  40  */
  41 struct StringContext
  42 {
  43     /** The complete text, from which a subset is selected by the
  44         parameters below.
  45      */
  46     string  Text;
  47
  48     //-------------------------------------------------------------------------
  49
  50     /** Start position within the string.<p>
  51
  52         The first character has index 0.<p>
  53      */
  54     long    StartPosition;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** Length of the substring to actually use.<p>
  59
  60         Must be within the range [0,INTMAX].<p>
  61     */
  62     long    Length;
  63
  64 };
  65
  66 }; }; }; };
  67
  68 #endif