1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XContainerQuery_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_container_XContainerQuery_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XEnumeration_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XEnumeration.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_NamedValue_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/NamedValue.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module container { 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski//============================================================================= 43*b1cdbd2cSJim Jagielski/** supports simple query feature on a container 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski <p> 46*b1cdbd2cSJim Jagielski This interface makes it possible to create sub sets of container items 47*b1cdbd2cSJim Jagielski which serve specified search criterion. 48*b1cdbd2cSJim Jagielski <p> 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielskipublished interface XContainerQuery: com::sun::star::uno::XInterface 51*b1cdbd2cSJim Jagielski{ 52*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 53*b1cdbd2cSJim Jagielski /** creates a sub set of container items which match given query command 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski <p> 56*b1cdbd2cSJim Jagielski Items of this sub set must match used query string. Format of query depends 57*b1cdbd2cSJim Jagielski from real implementation. Using of "param=value" pairs isn't neccessary. 58*b1cdbd2cSJim Jagielski So it's possible to combine different parameters as one simple command 59*b1cdbd2cSJim Jagielski string. 60*b1cdbd2cSJim Jagielski <p> 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski @param Query items of sub set must match to this query<br> 63*b1cdbd2cSJim Jagielski example:<br> 64*b1cdbd2cSJim Jagielski (1)<br> 65*b1cdbd2cSJim Jagielski query as parameter sequence to return all elements wich match 66*b1cdbd2cSJim Jagielski the name pattern and supports a special feature; sort it ascending<br> 67*b1cdbd2cSJim Jagielski "name=*myname_??_;sort=ascending;feature=VISIBLE"<br> 68*b1cdbd2cSJim Jagielski (2)<br> 69*b1cdbd2cSJim Jagielski query as command to return all elements which support special feature 70*b1cdbd2cSJim Jagielski and match by name pattern;ascending sort is the default<br> 71*b1cdbd2cSJim Jagielski "getAllVisible(*myname_??_)"<br> 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski @returns an sub set of container items as an enumeration. 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski XEnumeration createSubSetEnumerationByQuery( [in] string Query ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 78*b1cdbd2cSJim Jagielski /** creates a sub set of container items which supports searched properties as minimum 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski <p> 81*b1cdbd2cSJim Jagielski It's not possible to use special commands or search specific parameters here. 82*b1cdbd2cSJim Jagielski You can match by properties only. Enumerated elements must provide queried 83*b1cdbd2cSJim Jagielski properties as minimum. Not specified properties willn't be used for searching. 84*b1cdbd2cSJim Jagielski <p> 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski @param Properties items of sub set must support given properties as minimum<br> 87*b1cdbd2cSJim Jagielski example:<br> 88*b1cdbd2cSJim Jagielski (supported)<br> 89*b1cdbd2cSJim Jagielski search for items wich match the name pattern and supports the VISIBLE feature<br> 90*b1cdbd2cSJim Jagielski Parameters[0].Name = "name"<br> 91*b1cdbd2cSJim Jagielski Parameters[0].Value = "*myname_??_"<br> 92*b1cdbd2cSJim Jagielski Parameters[1].Name = "feature"<br> 93*b1cdbd2cSJim Jagielski Parameters[1].Value = "VISIBLE"<br> 94*b1cdbd2cSJim Jagielski ...<br> 95*b1cdbd2cSJim Jagielski (unsupported)<br> 96*b1cdbd2cSJim Jagielski "sort" isn't a property of a container item! 97*b1cdbd2cSJim Jagielski Parameters[0].Name = "sort"<br> 98*b1cdbd2cSJim Jagielski Parameters[0].Value = "ascending"<br> 99*b1cdbd2cSJim Jagielski ...<br> 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @returns an sub set of container items as an enumeration. 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski XEnumeration createSubSetEnumerationByProperties( [in] sequence< com::sun::star::beans::NamedValue > Properties ); 104*b1cdbd2cSJim Jagielski}; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski//============================================================================= 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski}; }; }; }; 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski#endif 111