diff options
Diffstat (limited to 'offapi/com/sun/star/text/XTextMarkup.idl')
-rw-r--r-- | offapi/com/sun/star/text/XTextMarkup.idl | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XTextMarkup.idl b/offapi/com/sun/star/text/XTextMarkup.idl new file mode 100644 index 000000000000..05bc80081458 --- /dev/null +++ b/offapi/com/sun/star/text/XTextMarkup.idl @@ -0,0 +1,93 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XTextMarkup.idl,v $ + * $Revision: 1.3 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_text_XTextMarkup_idl__ +#define __com_sun_star_text_XTextMarkup_idl__ + +#ifndef __com_sun_star_container_XStringKeyMap_idl__ +#include <com/sun/star/container/XStringKeyMap.idl> +#endif + +#ifndef __com_sun_star_text_TextMarkupType_idl__ +#include <com/sun/star/text/TextMarkupType.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module text { + +//============================================================================= + +/** provides functionality to markup text. + + @since OOo 2.3.0 + */ + +interface XTextMarkup +{ + //------------------------------------------------------------------------- + /** obtains a container to store additional user defined text markup + information. + + @return + a container to store additional user defined text markup + information. + */ + com::sun::star::container::XStringKeyMap getMarkupInfoContainer(); + + + //------------------------------------------------------------------------- + /** submits a new markup range. + + @param nType + Type of text markup see <type>TextMarkupType</type>. + + @param aIdentifier + A string used to identify the caller. + + @param nStart + Start of the markup range. + + @param nLength + Length of the markup range. + + @param xMarkupInfoContainer + contains additional information about the markup. + */ + void commitTextMarkup( [in] long nType, + [in] string aIdentifier, + [in] long nStart, + [in] long nLength, + [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer ); +}; + +}; }; }; }; + +#endif |