udkapi/com/sun/star/container/XContainerQuery.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module container {
  22
  23 /** supports simple query feature on a container
  24
  25     <p>
  26     This interface makes it possible to create sub sets of container items
  27     which serve specified search criterion.
  28     <p>
  29  */
  30 published interface XContainerQuery: com::sun::star::uno::XInterface
  31 {
  32     /** creates a sub set of container items which match given query command
  33
  34         <p>
  35         Items of this sub set must match used query string. Format of query depends
  36         from real implementation. Using of "param=value" pairs isn't necessary.
  37         So it's possible to combine different parameters as one simple command
  38         string.
  39         <p>
  40
  41         @param Query    items of sub set must match to this query<br>
  42                         example:<br>
  43                         (1)<br>
  44                         query as parameter sequence to return all elements which match
  45                         the name pattern and supports a special feature; sort it ascending<br>
  46                         "name=*myname_??_;sort=ascending;feature=VISIBLE"<br>
  47                         (2)<br>
  48                         query as command to return all elements which support special feature
  49                         and match by name pattern;ascending sort is the default<br>
  50                         "getAllVisible(*myname_??_)"<br>
  51
  52         @returns an sub set of container items as an enumeration.
  53      */
  54     XEnumeration createSubSetEnumerationByQuery( [in] string Query );
  55
  56     /** creates a sub set of container items which supports searched properties as minimum
  57
  58         <p>
  59         It's not possible to use special commands or search specific parameters here.
  60         You can match by properties only. Enumerated elements must provide queried
  61         properties as minimum. Not specified properties will not be used for searching.
  62         <p>
  63
  64         @param Properties   items of sub set must support given properties as minimum<br>
  65                             example:<br>
  66                             (supported)<br>
  67                             search for items which match the name pattern and supports the VISIBLE feature<br>
  68                             Parameters[0].Name  = "name"<br>
  69                             Parameters[0].Value = "*myname_??_"<br>
  70                             Parameters[1].Name  = "feature"<br>
  71                             Parameters[1].Value = "VISIBLE"<br>
  72                             ...<br>
  73                             (unsupported)<br>
  74                             "sort" isn't a property of a container item!
  75                             Parameters[0].Name  = "sort"<br>
  76                             Parameters[0].Value = "ascending"<br>
  77                             ...<br>
  78
  79         @returns an sub set of container items as an enumeration.
  80      */
  81     XEnumeration createSubSetEnumerationByProperties( [in] sequence< com::sun::star::beans::NamedValue > Properties );
  82 };
  83
  84
  85 }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */