diff options
Diffstat (limited to 'offapi/com/sun/star/ucb/SearchInfo.idl')
-rw-r--r-- | offapi/com/sun/star/ucb/SearchInfo.idl | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/SearchInfo.idl b/offapi/com/sun/star/ucb/SearchInfo.idl new file mode 100644 index 000000000000..5137db204c5c --- /dev/null +++ b/offapi/com/sun/star/ucb/SearchInfo.idl @@ -0,0 +1,90 @@ +/************************************************************************* + * + * 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_ucb_SearchInfo_idl__ +#define __com_sun_star_ucb_SearchInfo_idl__ + +#ifndef __com_sun_star_ucb_SearchCriterium_idl__ +#include <com/sun/star/ucb/SearchCriterium.idl> +#endif + +#ifndef __com_sun_star_ucb_SearchRecursion_idl__ +#include <com/sun/star/ucb/SearchRecursion.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module ucb { + +//============================================================================= +/** information needed to (recursively) search an object. +*/ +published struct SearchInfo +{ + //------------------------------------------------------------------------- + /** the search criteria. + */ + sequence<com::sun::star::ucb::SearchCriterium> Criteria; + + //------------------------------------------------------------------------- + /** the mode of recursion to use. + */ + com::sun::star::ucb::SearchRecursion Recursion; + + //------------------------------------------------------------------------- + /** whether to include the object itself in the search or only (some of) + its sub-objects. + */ + boolean IncludeBase; + + //------------------------------------------------------------------------- + /** whether to respect the "view restrictions" specified for the folders + hierarchically contained within an object (e.g., only searches through + subscribed folders). + */ + boolean RespectFolderViewRestrictions; + + //------------------------------------------------------------------------- + /** whether to respect the "view restrictions" specified for the documents + hierarchically contained within an object (e.g., only searches through + marked documents). + */ + boolean RespectDocViewRestrictions; + + //------------------------------------------------------------------------- + /** whether to follow indirections (link objects) and search through their + respective targets also. + */ + boolean FollowIndirections; + +}; + +//============================================================================= + +}; }; }; }; + +#endif |