Files
loongoffice/offapi/com/sun/star/text/XAutoTextContainer.idl
2011-04-02 00:08:53 +02:00

98 lines
3.3 KiB
Plaintext

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_XAutoTextContainer_idl__
#define __com_sun_star_text_XAutoTextContainer_idl__
#include <com/sun/star/container/XNameAccess.idl>
#include <com/sun/star/text/XAutoTextGroup.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/container/ElementExistException.idl>
#include <com/sun/star/container/NoSuchElementException.idl>
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
// DocMerge from xml: interface com::sun::star::text::XAutoTextContainer
/** handles blocks of <type>AutoTextEntry</type>.
@example <pre>
AutoTextPath=d:\office\autotext;f:\user\autotext
groupname: "standard*0"
-&amp;amp;gt; the group file is located n the path d:\office\autotext
groupname: "all*1"
-&amp;amp;gt; the group file is located in the path f:\user\autotext\
</pre>
<p>If the path extension is not specified, then the first directory
is used. For automatic text expansion, the name of an actual group is
set to search first in this group.
</p>@see AutoTextContainer
*/
published interface XAutoTextContainer: com::sun::star::container::XNameAccess
{
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::text::XAutoTextContainer::insertNewByName
/** creates a new AutoText group.
*/
com::sun::star::text::XAutoTextGroup insertNewByName( [in] string aGroupName )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::container::ElementExistException );
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::text::XAutoTextContainer::removeByName
/** deletes the specified AutoText group.
*/
void removeByName( [in] string aGroupName )
raises( com::sun::star::container::NoSuchElementException );
};
//=============================================================================
}; }; }; };
#endif