LibreOffice
LibreOffice 7.3 SDK API Reference
XFilterController.idl
Go to the documentation of this file.
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 #ifndef __com_sun_star_form_runtime_XFilterController_idl__
21 #define __com_sun_star_form_runtime_XFilterController_idl__
22 
25 
26 
27 module com { module sun { module star { module form { module runtime {
28 
29 
30 interface XFilterControllerListener;
31 
70 {
77 
81 
87  [attribute, readonly] long FilterComponents;
88 
91  [attribute, readonly] long DisjunctiveTerms;
92 
95  [attribute] long ActiveTerm
96  {
98  };
99 
116  void
117  setPredicateExpression( [in] long Component, [in] long Term, [in] string PredicateExpression )
119 
136  getFilterComponent( [in] long Component )
138 
144  sequence< sequence< string > >
146 
156  void
157  removeDisjunctiveTerm( [in] long Term )
159 
162  void
164 };
165 
166 
167 }; }; }; }; };
168 
169 
170 #endif
171 
172 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
identifies a control.
Definition: XControl.idl:51
is implemented by components listening for events fired by an XFilterController.
Definition: XFilterControllerListener.idl:35
provides access to a form based filter for a database form
Definition: XFilterController.idl:70
::com::sun::star::awt::XControl getFilterComponent([in] long Component)
retrieves the filter component with the given index.
long FilterComponents
is the number of filter components, or filter controls, which the filter controller is responsible fo...
Definition: XFilterController.idl:87
void appendEmptyDisjunctiveTerm()
appends an empty disjunctive term to the list of terms.
void removeFilterControllerListener([in] XFilterControllerListener Listener)
revokes a listener which was previously registered to be notified of certain changes in the form base...
void removeDisjunctiveTerm([in] long Term)
removes a given disjunctive term
void addFilterControllerListener([in] XFilterControllerListener Listener)
registers a listener to be notified of certain changes in the form based filter.
sequence< sequence< string > > getPredicateExpressions()
retrieves the entirety of the predicate expressions represented by the filter controller.
long DisjunctiveTerms
is the number of disjunctive terms of the filter expression represented by the form based filter.
Definition: XFilterController.idl:91
void setPredicateExpression([in] long Component, [in] long Term, [in] string PredicateExpression)
sets a given predicate expression
Definition: Ambiguous.idl:22