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

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