| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_form_XLoadable_idl__ |
| #define __com_sun_star_form_XLoadable_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| |
| #ifndef __com_sun_star_form_XLoadListener_idl__ |
| #include <com/sun/star/form/XLoadListener.idl> |
| #endif |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module form { |
| |
| //============================================================================= |
| |
| /** provides functionality to implement objects which may be loaded. |
| |
| <p>The object is typically implemented by high-level objects which can connect to a data source.</p> |
| |
| @see XLoadListener |
| */ |
| published interface XLoadable: com::sun::star::uno::XInterface |
| { |
| //------------------------------------------------------------------------- |
| |
| /** loads the data. |
| |
| <p>If the data is already loaded (->isLoaded), then the method returns silently. |
| In this case, you should use ->reload.</p> |
| */ |
| [oneway] void load(); |
| |
| //------------------------------------------------------------------------- |
| |
| /** unloads the data. |
| */ |
| [oneway] void unload(); |
| |
| //------------------------------------------------------------------------- |
| |
| /** does a smart refresh of the object. |
| |
| <p>The final state will be the same as if unload and load were called, but reload |
| is the more efficient way to do the same. If the object isn't loaded, nothing happens.</p> |
| */ |
| [oneway] void reload(); |
| |
| //------------------------------------------------------------------------- |
| |
| /** returns if the object is in loaded state. |
| */ |
| boolean isLoaded(); |
| |
| //------------------------------------------------------------------------- |
| |
| /** adds the specified listener to receive load-related events |
| |
| @param aListener |
| the listener to add. |
| */ |
| [oneway] void addLoadListener( [in] com::sun::star::form::XLoadListener aListener ); |
| |
| //------------------------------------------------------------------------- |
| |
| /** removes the specified listener. |
| |
| @param aListener |
| the listener to remove. |
| */ |
| [oneway] void removeLoadListener( [in] com::sun::star::form::XLoadListener aListener ); |
| }; |
| |
| }; }; }; }; |
| |
| #endif |
| |
| /*============================================================================= |
| |
| =============================================================================*/ |