/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: StringContext.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 02:54:11 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_rendering_StringContext_idl__
#define __com_sun_star_rendering_StringContext_idl__

module com { module sun { module star { module rendering {

/** Collection of string-related arguments used on all canvas text
    interfaces.<p>

    A possibly much larger string than later rendered is necessary
    here, because in several languages, glyph selection is context
    dependent.<p>

    @since OOo 2.0.0
 */
struct StringContext
{
    /** The complete text, from which a subset is selected by the
        parameters below.
     */
    string  Text;

    //-------------------------------------------------------------------------

    /** Start position within the string.<p>

        The first character has index 0.<p>
     */
    long    StartPosition;

    //-------------------------------------------------------------------------

    /** Length of the substring to actually use.<p>

        Must be within the range [0,INTMAX].<p>
    */
    long    Length;

};

}; }; }; };

#endif
