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 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_ui_dialogs_XFilePickerListener_idl__ 25#define __com_sun_star_ui_dialogs_XFilePickerListener_idl__ 26 27#ifndef __com_sun_star_lang_XEventListener_idl__ 28#include <com/sun/star/lang/XEventListener.idl> 29#endif 30 31#ifndef __com_sun_star_ui_dialogs_FilePickerEvent_idl__ 32#include <com/sun/star/ui/dialogs/FilePickerEvent.idl> 33#endif 34 35//============================================================================= 36 37module com { module sun { module star { module ui { module dialogs { 38 39//============================================================================= 40 41//============================================================================= 42/** Interface to be implemented by a FilePicker listener. 43 44 <p> The <type>XFilePickerListener</type> interface must be implemented by 45 the clients of the FilePicker service which need to be informed about 46 events while the FilePicker service is displayed.</p> 47*/ 48 49published interface XFilePickerListener: com::sun::star::lang::XEventListener 50{ 51 //------------------------------------------------------------------------- 52 /** A client receives this event if the file selection within the 53 FilePicker service dialog changes. 54 55 @param aEvent 56 of type <type>FilePickerEvent</type> that describes the event 57 58 @see com::sun::star::ui::dialogs::FilePickerEvent 59 */ 60 void fileSelectionChanged( [in] FilePickerEvent aEvent ); 61 62 63 //------------------------------------------------------------------------- 64 /** A client receives this event if the directory selection within the 65 FilePicker dialog changes. 66 67 @param aEvent 68 Of type <type>FilePickerEvent</type> that describes the event. 69 70 @see com::sun::star::ui::dialogs::FilePickerEvent 71 */ 72 void directoryChanged( [in] FilePickerEvent aEvent ); 73 74 //------------------------------------------------------------------------- 75 /** A client receives this event if the F1 key or the help button was 76 pressed. 77 78 @param aEvent 79 of type <type>FilePickerEvent</type> that describes the event 80 81 @returns 82 A help string which the FilePicker dialog should use to display 83 a help for a specific control. If the returned string is empty it is 84 undefined how the FilePicker implementation will behave. 85 It may show a message 'no help available' or may show no 86 help at all. 87 88 @see com::sun::star::ui::dialogs::FilePickerEvent 89 */ 90 string helpRequested( [in] FilePickerEvent aEvent ); 91 92 //------------------------------------------------------------------------- 93 /** A client receives this event if the state of a control within the 94 FilePicker service dialog changes. 95 96 @param aEvent 97 of type <type>FilePickerEvent</type> that describes the event. 98 99 @see com::sun::star::ui::dialogs::FilePickerEvent 100 */ 101 void controlStateChanged( [in] FilePickerEvent aEvent ); 102 103 //------------------------------------------------------------------------- 104 /** A client receives this event if the size of the FilePicker dialog 105 has changed. If the FilePicker dialog contains a preview the client 106 may ask for the new dimension of the preview area. 107 */ 108 void dialogSizeChanged( ); 109}; 110 111//============================================================================= 112 113}; }; }; }; }; 114 115 116#endif 117