LibreOffice LibreOffice 25.2 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
21module com { module sun { module star { module form { module runtime {
22
23
24 interface XFilterControllerListener;
25
63 interface XFilterController
64{
70 void addFilterControllerListener( [in] XFilterControllerListener Listener );
71
74 void removeFilterControllerListener( [in] XFilterControllerListener Listener );
75
81 [attribute, readonly] long FilterComponents;
82
85 [attribute, readonly] long DisjunctiveTerms;
86
89 [attribute] long ActiveTerm
90 {
91 set raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
92 };
93
110 void
111 setPredicateExpression( [in] long Component, [in] long Term, [in] string PredicateExpression )
112 raises( ::com::sun::star::lang::IndexOutOfBoundsException );
113
129 ::com::sun::star::awt::XControl
130 getFilterComponent( [in] long Component )
131 raises( ::com::sun::star::lang::IndexOutOfBoundsException );
132
138 sequence< sequence< string > >
139 getPredicateExpressions();
140
150 void
151 removeDisjunctiveTerm( [in] long Term )
152 raises( ::com::sun::star::lang::IndexOutOfBoundsException );
153
156 void
157 appendEmptyDisjunctiveTerm();
158};
159
160
161}; }; }; }; };
162
163
164/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:31
com::sun::star::awt::XControl
identifies a control.
Definition: XControl.idl:37
com::sun::star::form::runtime::XFilterControllerListener
is implemented by components listening for events fired by an XFilterController.
Definition: XFilterControllerListener.idl:29
com::sun::star::form::runtime::XFilterController
provides access to a form based filter for a database form
Definition: XFilterController.idl:64
com::sun::star::form::runtime::XFilterController::getFilterComponent
::com::sun::star::awt::XControl getFilterComponent([in] long Component)
retrieves the filter component with the given index.
com::sun::star::form::runtime::XFilterController::FilterComponents
long FilterComponents
is the number of filter components, or filter controls, which the filter controller is responsible fo...
Definition: XFilterController.idl:81
com::sun::star::form::runtime::XFilterController::appendEmptyDisjunctiveTerm
void appendEmptyDisjunctiveTerm()
appends an empty disjunctive term to the list of terms.
com::sun::star::form::runtime::XFilterController::removeFilterControllerListener
void removeFilterControllerListener([in] XFilterControllerListener Listener)
revokes a listener which was previously registered to be notified of certain changes in the form base...
com::sun::star::form::runtime::XFilterController::removeDisjunctiveTerm
void removeDisjunctiveTerm([in] long Term)
removes a given disjunctive term
com::sun::star::form::runtime::XFilterController::addFilterControllerListener
void addFilterControllerListener([in] XFilterControllerListener Listener)
registers a listener to be notified of certain changes in the form based filter.
com::sun::star::form::runtime::XFilterController::getPredicateExpressions
sequence< sequence< string > > getPredicateExpressions()
retrieves the entirety of the predicate expressions represented by the filter controller.
com::sun::star::form::runtime::XFilterController::DisjunctiveTerms
long DisjunctiveTerms
is the number of disjunctive terms of the filter expression represented by the form based filter.
Definition: XFilterController.idl:85
com::sun::star::form::runtime::XFilterController::setPredicateExpression
void setPredicateExpression([in] long Component, [in] long Term, [in] string PredicateExpression)
sets a given predicate expression
com
Definition: Ambiguous.idl:20