XContainerQuery.idl (408a4873) XContainerQuery.idl (86e1cf34)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance

--- 40 unchanged lines hidden (view full) ---

49 */
50published interface XContainerQuery: com::sun::star::uno::XInterface
51{
52 //-------------------------------------------------------------------------
53 /** creates a sub set of container items which match given query command
54
55 <p>
56 Items of this sub set must match used query string. Format of query depends
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance

--- 40 unchanged lines hidden (view full) ---

49 */
50published interface XContainerQuery: com::sun::star::uno::XInterface
51{
52 //-------------------------------------------------------------------------
53 /** creates a sub set of container items which match given query command
54
55 <p>
56 Items of this sub set must match used query string. Format of query depends
57 from real implementation. Using of "param=value" pairs isn't neccessary.
57 from real implementation. Using of "param=value" pairs isn't necessary.
58 So it's possible to combine different parameters as one simple command
59 string.
60 <p>
61
62 @param Query items of sub set must match to this query<br>
63 example:<br>
64 (1)<br>
58 So it's possible to combine different parameters as one simple command
59 string.
60 <p>
61
62 @param Query items of sub set must match to this query<br>
63 example:<br>
64 (1)<br>
65 query as parameter sequence to return all elements wich match
65 query as parameter sequence to return all elements which match
66 the name pattern and supports a special feature; sort it ascending<br>
67 "name=*myname_??_;sort=ascending;feature=VISIBLE"<br>
68 (2)<br>
69 query as command to return all elements which support special feature
70 and match by name pattern;ascending sort is the default<br>
71 "getAllVisible(*myname_??_)"<br>
72
73 @returns an sub set of container items as an enumeration.

--- 7 unchanged lines hidden (view full) ---

81 It's not possible to use special commands or search specific parameters here.
82 You can match by properties only. Enumerated elements must provide queried
83 properties as minimum. Not specified properties willn't be used for searching.
84 <p>
85
86 @param Properties items of sub set must support given properties as minimum<br>
87 example:<br>
88 (supported)<br>
66 the name pattern and supports a special feature; sort it ascending<br>
67 "name=*myname_??_;sort=ascending;feature=VISIBLE"<br>
68 (2)<br>
69 query as command to return all elements which support special feature
70 and match by name pattern;ascending sort is the default<br>
71 "getAllVisible(*myname_??_)"<br>
72
73 @returns an sub set of container items as an enumeration.

--- 7 unchanged lines hidden (view full) ---

81 It's not possible to use special commands or search specific parameters here.
82 You can match by properties only. Enumerated elements must provide queried
83 properties as minimum. Not specified properties willn't be used for searching.
84 <p>
85
86 @param Properties items of sub set must support given properties as minimum<br>
87 example:<br>
88 (supported)<br>
89 search for items wich match the name pattern and supports the VISIBLE feature<br>
89 search for items which match the name pattern and supports the VISIBLE feature<br>
90 Parameters[0].Name = "name"<br>
91 Parameters[0].Value = "*myname_??_"<br>
92 Parameters[1].Name = "feature"<br>
93 Parameters[1].Value = "VISIBLE"<br>
94 ...<br>
95 (unsupported)<br>
96 "sort" isn't a property of a container item!
97 Parameters[0].Name = "sort"<br>

--- 13 unchanged lines hidden ---
90 Parameters[0].Name = "name"<br>
91 Parameters[0].Value = "*myname_??_"<br>
92 Parameters[1].Name = "feature"<br>
93 Parameters[1].Value = "VISIBLE"<br>
94 ...<br>
95 (unsupported)<br>
96 "sort" isn't a property of a container item!
97 Parameters[0].Name = "sort"<br>

--- 13 unchanged lines hidden ---