diff options
Diffstat (limited to 'offapi/com/sun/star/text/XAutoTextGroup.idl')
-rw-r--r-- | offapi/com/sun/star/text/XAutoTextGroup.idl | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XAutoTextGroup.idl b/offapi/com/sun/star/text/XAutoTextGroup.idl new file mode 100644 index 000000000000..f4a3b653a0ff --- /dev/null +++ b/offapi/com/sun/star/text/XAutoTextGroup.idl @@ -0,0 +1,175 @@ +/************************************************************************* + * + * $RCSfile: XAutoTextGroup.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:20 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 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 + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_text_XAutoTextGroup_idl__ +#define __com_sun_star_text_XAutoTextGroup_idl__ + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_container_ElementExistException_idl__ +#include <com/sun/star/container/ElementExistException.idl> +#endif + +#ifndef __com_sun_star_io_IOException_idl__ +#include <com/sun/star/io/IOException.idl> +#endif + +#ifndef __com_sun_star_text_XAutoTextEntry_idl__ +#include <com/sun/star/text/XAutoTextEntry.idl> +#endif + +#ifndef __com_sun_star_text_XTextRange_idl__ +#include <com/sun/star/text/XTextRange.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module text { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::text::XAutoTextGroup +/** The interface provide methods to insert, rename and delete autotext entries from the current autotext group. + */ +[ uik(E2281218-33D6-11D1-AABE00A0-249D5590), ident( "XAutoTextGroup", 1.0 ) ] +interface XAutoTextGroup: com::sun::star::container::XNameAccess +{ + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::text::XAutoTextGroup::getTitles + /** returns the titles of all autotext entries. The order of the entries + corresponds to the output of the function getElementNames(). + */ + sequence<string> getTitles(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::text::XAutoTextGroup::renameByName + /** renames an entry in the autotext group. + + + + <p>The position of the autotext entry is not changed. + + </p> + */ + void renameByName( [in] string aElementName, + [in] string aNewElementName, + [in] string aNewElementTitle ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::ElementExistException, + com::sun::star::io::IOException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::text::XAutoTextGroup::insertNewByName + /** creates a new <type>AutoTextEntry</type> entry. + */ + com::sun::star::text::XAutoTextEntry insertNewByName( [in] string aName, + [in] string aTitle, + [in] com::sun::star::text::XTextRange xTextRange ) + raises( com::sun::star::container::ElementExistException ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::text::XAutoTextGroup::removeByName + /** removes the specified autotext entry. + */ + void removeByName( [in] string aEntryName ) + raises( com::sun::star::container::NoSuchElementException ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:36:04 hjs + initial import + + Revision 1.5 2000/09/11 11:53:02 mi + documentation merged from XML + + Revision 1.3 2000/03/31 11:53:57 os + #74034# Documentation changed + + Revision 1.2 2000/02/07 11:25:03 mi + zu #70728# missing documentation marked + + Revision 1.1.1.1 1999/11/11 09:48:46 jsc + new + + +=============================================================================*/ +#endif |