diff options
Diffstat (limited to 'offapi/com/sun/star/document/XInteractionFilterSelect.idl')
-rw-r--r-- | offapi/com/sun/star/document/XInteractionFilterSelect.idl | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/offapi/com/sun/star/document/XInteractionFilterSelect.idl b/offapi/com/sun/star/document/XInteractionFilterSelect.idl new file mode 100644 index 000000000000..99b046923b4f --- /dev/null +++ b/offapi/com/sun/star/document/XInteractionFilterSelect.idl @@ -0,0 +1,80 @@ +/************************************************************************* + * + * 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_document_XInteractionFilterSelect_idl__ +#define __com_sun_star_document_XInteractionFilterSelect_idl__ + +#ifndef __com_sun_star_task_XInteractionContinuation_idl__ +#include <com/sun/star/task/XInteractionContinuation.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module document { + +//============================================================================= +/** continuation used by interaction mechanism at filter detection during + loading documents + + <p> + If during loading time the filter can't be detected and wasn't given at calling time, + a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used. + (it's a a part of used <type>MediaDescriptor</type>) + A <type>NoSuchFilterRequest</type> will be used then to start right interaction on that to + get a decision which filter should be used for given URL. A possible continuation + of that can be this XInteractionFilterSelect. It will transport the decision back to + generic filter detection and force using of it. Of course it's possible to abort + the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>. + </p> + + @see MediaDescriptor + @see com::sun::star::task::InteractionHandler + @see NoSuchFilterRequest + @see com::sun::star::task::XInteractionAbort + */ +published interface XInteractionFilterSelect : com::sun::star::task::XInteractionContinuation +{ + //------------------------------------------------------------------------- + /** used by interaction to set selected filter + + <p> + This value must be save till another one will be set + and must be provided on getFilter() for interest users. + </p> + */ + void setFilter( [in] string Name ); + + //------------------------------------------------------------------------- + /** used by detection to get selected filter + */ + string getFilter(); +}; + +//============================================================================= + +}; }; }; }; + +#endif |