1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_XLoadable_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_form_XLoadable_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_XLoadListener_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/form/XLoadListener.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski module com { module sun { module star { module form { 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski/** provides functionality to implement objects which may be loaded. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p>The object is typically implemented by high-level objects which can connect to a data source.</p> 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski @see XLoadListener 45*b1cdbd2cSJim Jagielski */ 46*b1cdbd2cSJim Jagielskipublished interface XLoadable: com::sun::star::uno::XInterface 47*b1cdbd2cSJim Jagielski{ 48*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski /** loads the data. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p>If the data is already loaded (->isLoaded), then the method returns silently. 53*b1cdbd2cSJim Jagielski In this case, you should use ->reload.</p> 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski [oneway] void load(); 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski /** unloads the data. 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski [oneway] void unload(); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** does a smart refresh of the object. 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski <p>The final state will be the same as if unload and load were called, but reload 68*b1cdbd2cSJim Jagielski is the more efficient way to do the same. If the object isn't loaded, nothing happens.</p> 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski [oneway] void reload(); 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski /** returns if the object is in loaded state. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski boolean isLoaded(); 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski /** adds the specified listener to receive load-related events 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski @param aListener 83*b1cdbd2cSJim Jagielski the listener to add. 84*b1cdbd2cSJim Jagielski */ 85*b1cdbd2cSJim Jagielski [oneway] void addLoadListener( [in] com::sun::star::form::XLoadListener aListener ); 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** removes the specified listener. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @param aListener 92*b1cdbd2cSJim Jagielski the listener to remove. 93*b1cdbd2cSJim Jagielski */ 94*b1cdbd2cSJim Jagielski [oneway] void removeLoadListener( [in] com::sun::star::form::XLoadListener aListener ); 95*b1cdbd2cSJim Jagielski}; 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski}; }; }; }; 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski#endif 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski/*============================================================================= 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski=============================================================================*/ 104