diff options
author | Tino Rachui <tra@openoffice.org> | 2001-08-30 09:21:21 +0000 |
---|---|---|
committer | Tino Rachui <tra@openoffice.org> | 2001-08-30 09:21:21 +0000 |
commit | 748f9fa0b6c7aa6b954723b93073072ccc648646 (patch) | |
tree | 8e72c92b04027a9fa271d39bb6d1ecd4b39be7ea /offapi/com/sun/star/ui | |
parent | 49c4014d0f731db73d749e57021efdf3384c51ed (diff) |
#88584#moved from drafts
Diffstat (limited to 'offapi/com/sun/star/ui')
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl | 96 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl | 137 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/FilePicker.idl | 166 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl | 95 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl | 87 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/FolderPicker.idl | 114 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl | 123 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/TemplateDescription.idl | 157 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilePicker.idl | 209 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl | 195 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl | 154 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl | 115 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilePreview.idl | 174 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilterManager.idl | 157 | ||||
-rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFolderPicker.idl | 162 |
15 files changed, 2141 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl b/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl new file mode 100644 index 000000000000..90ec3f443423 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: CommonFilePickerElementIds.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:19:58 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_CommonFilePickerElementIds_idl__ +#define __com_sun_star_ui_dialogs_CommonFilePickerElementIds_idl__ + + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** These constants are used to specify common controls of a FilePicker dialog. + Prefix BTN means button. + + */ + +constants CommonFilePickerElementIds +{ + //--------------------------------------------------------------------- + /** The control id of the OK button. + */ + const short PUSHBUTTON_OK = 1; + + //--------------------------------------------------------------------- + /** The control id of the Cancel button. + */ + const short PUSHBUTTON_CANCEL = 2; + + //--------------------------------------------------------------------- + /** The filter listbox of a FilePicker dialog. + */ + const short LISTBOX_FILTER = 3; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl b/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl new file mode 100644 index 000000000000..ae022d1e0142 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl @@ -0,0 +1,137 @@ +/************************************************************************* + * + * $RCSfile: ExtendedFilePickerElementIds.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:19:42 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_ExtendedFilePickerElementIds_idl__ +#define __com_sun_star_ui_dialogs_ExtendedFilePickerElementIds_idl__ + + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** These constants are used to specify common controls of a FilePicker dialog. + Prefix BTN means button. + + */ + +constants ExtendedFilePickerElementIds +{ + //--------------------------------------------------------------------- + /** + */ + const short CHECKBOX_AUTOEXTENSION = 100; + + //--------------------------------------------------------------------- + /** + */ + const short CHECKBOX_PASSWORD = 101; + + //--------------------------------------------------------------------- + /** + */ + const short CHECKBOX_FILTEROPTIONS = 102; + + //--------------------------------------------------------------------- + /** + */ + const short CHECKBOX_READONLY = 103; + + //--------------------------------------------------------------------- + /** + */ + const short CHECKBOX_LINK = 104; + + //--------------------------------------------------------------------- + /** + */ + const short CHECKBOX_PREVIEW = 105; + + //--------------------------------------------------------------------- + /** + */ + const short PUSHBUTTON_PLAY = 106; + + //--------------------------------------------------------------------- + /** + */ + const short LISTBOX_VERSION = 107; + + //--------------------------------------------------------------------- + /** + */ + const short LISTBOX_TEMPLATE = 108; + + + //--------------------------------------------------------------------- + /** + */ + const short LISTBOX_IMAGE_TEMPLATE = 109; + + //--------------------------------------------------------------------- + /** + */ + const short CHECKBOX_SELECTION = 110; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/FilePicker.idl b/offapi/com/sun/star/ui/dialogs/FilePicker.idl new file mode 100644 index 000000000000..882d093a9b25 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/FilePicker.idl @@ -0,0 +1,166 @@ +/************************************************************************* + * + * $RCSfile: FilePicker.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:19:50 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_FilePicker_idl__ +#define __com_sun_star_ui_dialogs_FilePicker_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + +#ifndef __com_sun_star_lang_XTypeProvider_idl__ +#include <com/sun/star/lang/XTypeProvider.idl> +#endif + +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= + +//============================================================================= +/** A FilePicker. + + @see XFilePicker +*/ + +interface XFilePicker; +interface XFilePickerNotifier; +interface XFilePickerControlAccess; +interface XFilterManager; +interface XFilePreview; + +service FilePicker +{ + //------------------------------------------------------------------------- + /** Provides access to the basic FilePicker functionality. + + @see XFilePicker + */ + interface XFilePicker; + + //------------------------------------------------------------------------- + /** provides the ability to request notifications about changes. + */ + interface XFilePickerNotifier; + + //------------------------------------------------------------------------- + /** provides the ability to add different filter, query for the current + filters and set a current filter + */ + interface XFilterManager; + + //------------------------------------------------------------------------- + /** provides the ability to show a preview of a selected file + */ + [optional] interface XFilePreview; + + //------------------------------------------------------------------------- + /** provides the ability manage additional controls offered by an extended + FilePicker like checkboxes, comboboxes etc. + */ + [optional] interface XFilePickerControlAccess; + + //------------------------------------------------------------------------- + /** Provides the ability to choose between different custom templates for + the FileOpen dialog. Implementers may omit this interface if the FileOpen + dialog doesn't support custom templates. In this case a createInstance + will create an ordinary FileOpen dialog without any custom elements. + The client has to provide one of the specified constants in + TemplateDescription. + + <p>Notes for the implementation of a FileSave dialog: The implementation + of a FileSave dialog should automatically check for existens of a file + and issue a warning if a file with the same name already exist.</p> + + @see TemplateDescription + */ + [optional] interface com::sun::star::lang::XInitialization; + + //------------------------------------------------------------------------- + /** for shutdown and listener support. + */ + interface com::sun::star::lang::XComponent; + + //------------------------------------------------------------------------- + /** service should always support this interface. + */ + interface com::sun::star::lang::XServiceInfo; + + //------------------------------------------------------------------------- + /** service should always support this interface. + */ + interface com::sun::star::lang::XTypeProvider; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl b/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl new file mode 100644 index 000000000000..fb61b54efddf --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl @@ -0,0 +1,95 @@ +/************************************************************************* + * + * $RCSfile: FilePickerEvent.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:19:34 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_FilePickerEvent_idl__ +#define __com_sun_star_ui_dialogs_FilePickerEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= + +//============================================================================= +/** Context information in case of a FilePicker event + + @see com::sun::star::lang::EventObject +*/ +struct FilePickerEvent: com::sun::star::lang::EventObject +{ + //------------------------------------------------------------------------- + /** + @param ElementId + identifies the affected element + */ + short ElementId; +}; + +//============================================================================= + +}; }; }; }; }; + + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl new file mode 100644 index 000000000000..5dafa9289b11 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl @@ -0,0 +1,87 @@ +/************************************************************************* + * + * $RCSfile: FilePreviewImageFormats.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:04 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_FilePreviewImageFormats_idl__ +#define __com_sun_star_ui_dialogs_FilePreviewImageFormats_idl__ + + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** These constants are used to specify supported image formats of a + FilePreview implementation. + */ + +constants FilePreviewImageFormats +{ + //--------------------------------------------------------------------- + /** A OpenOffice bitmap which is similar to the device independent bitmap + (DIB) format on windows. + The bitmap data should be provided as a sequence of sal_Int8. + */ + const short BITMAP = 1; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/FolderPicker.idl b/offapi/com/sun/star/ui/dialogs/FolderPicker.idl new file mode 100644 index 000000000000..4fd97ee79de9 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/FolderPicker.idl @@ -0,0 +1,114 @@ +/************************************************************************* + * + * $RCSfile: FolderPicker.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:13 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_FolderPicker_idl__ +#define __com_sun_star_ui_dialogs_FolderPicker_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + +#ifndef __com_sun_star_lang_XTypeProvider_idl__ +#include <com/sun/star/lang/XTypeProvider.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= + +interface XFolderPicker; + +//============================================================================= +/** A FolderPicker service. + + @see XFolderPicker +*/ + +service FolderPicker +{ + //------------------------------------------------------------------------- + /** Provides the ability to execute a FolderPicker dialog and + browse for and select folders. + */ + interface XFolderPicker; + + //------------------------------------------------------------------------- + /** service should always support this interface. + */ + interface com::sun::star::lang::XServiceInfo; + + //------------------------------------------------------------------------- + /** service should always support this interface. + */ + interface com::sun::star::lang::XTypeProvider; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl b/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl new file mode 100644 index 000000000000..0a17182d5f83 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * $RCSfile: ListboxControlActions.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:21 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialog_ListboxControlActions_idl__ +#define __com_sun_star_ui_dialog_ListboxControlActions_idl__ + + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** + */ + +constants ListboxControlActions +{ + //--------------------------------------------------------------------- + /** Adds an item to the content of the listbox. The given item has to + be a string. + */ + const short ADD_ITEM = 1; + + //--------------------------------------------------------------------- + /** Adds a sequence of strings to the content of the listbox. + */ + const short ADD_ITEMS = 2; + + //--------------------------------------------------------------------- + /** Removes an item from a listbox. The given value has to be a + position. If the position is invalid an exception will be thrown. + The index of the first position is 0. + The value should be a sal_Int32. + */ + const short DELETE_ITEM = 3; + + //--------------------------------------------------------------------- + /** Removes all items from the listbox. + */ + const short DELETE_ITEMS = 4; + + //--------------------------------------------------------------------- + /** Selects an item in a listbox. The given value has to be a position. + The index of the first position is 0. A value of -1 removes the + selection. + If the given position is invalid an exception will be thrown. + The value should be a sal_Int32. + */ + const short SET_SELECT_ITEM = 5; + + //--------------------------------------------------------------------- + /** Returns all items of the listbox as a sequence of strings. + */ + const short GET_ITEMS = 6; + + //--------------------------------------------------------------------- + /** Returns the currently selected item. The returned item is an empty + string if the listbox is empty or no item is selected. + */ + const short GET_SELECTED_ITEM = 7; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl b/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl new file mode 100644 index 000000000000..f16826287a5c --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl @@ -0,0 +1,157 @@ +/************************************************************************* + * + * $RCSfile: TemplateDescription.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:29 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_TemplateDescription_idl__ +#define __com_sun_star_ui_dialogs_TemplateDescription_idl__ + + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** + */ + +constants TemplateDescription +{ + //--------------------------------------------------------------------- + /** A FileOpen dialog without any additional controls. + */ + const short FILEOPEN_SIMPLE = 0; + + //--------------------------------------------------------------------- + /** A FileSave dialog without any additional controls. + */ + const short FILESAVE_SIMPLE = 1; + + //--------------------------------------------------------------------- + /** A FileSave dialog with: + 1. A checkbox "Auto Extension" + 2. A checkbox "Password" + */ + const short FILESAVE_AUTOEXTENSION_PASSWORD = 2; + + //--------------------------------------------------------------------- + /** A FileSave dialog with: + 1. A checkbox "Auto Extension" + 2. A checkbox "Password" + 3. A checkbox "Filter Options" + */ + const short FILESAVE_AUTOEXTENSION_PASSWORD_FILTEROPTIONS = 3; + + //--------------------------------------------------------------------- + /** A FileSave dialog with: + 1. A checkbox "Auto Extension" + 2. A checkbox "Selection" + */ + const short FILESAVE_AUTOEXTENSION_SELECTION = 4; + + //--------------------------------------------------------------------- + /** A FileSave dialog with: + 1. A checkbox "Auto Extension" + 2. A listbox "Template" for selecting different templates + */ + const short FILESAVE_AUTOEXTENSION_TEMPLATE = 5; + + //--------------------------------------------------------------------- + /** A FileOpen dialog with: + 1. A checkbox "Insert as link" + 2. A checkbox "Show Preview" + 3. A listbox "Image Template" for inserting an image with + different styles. + 4. A window for displaying a file preview + */ + const short FILEOPEN_LINK_PREVIEW_IMAGE_TEMPLATE = 6; + + //--------------------------------------------------------------------- + /** A FileOpen dialog with: + 1. A push button "Play" + */ + const short FILEOPEN_PLAY = 7; + + //--------------------------------------------------------------------- + /** A FileOpen dialog with: + 1. A checkbox "Read only" + 2. A listbox "Version" for selecting a document version + */ + const short FILEOPEN_READONLY_VERSION = 8; + + //--------------------------------------------------------------------- + /** + A FileOpen dialog with: + 1. A checkbox "Insert as link" + 2. A checkbox "Show Preview" + 3. A window for displaying a file preview + */ + const short FILEOPEN_LINK_PREVIEW = 9; + + //--------------------------------------------------------------------- + /** A FileSave dialog with: + 1. A checkbox "Auto Extension" + */ + const short FILESAVE_AUTOEXTENSION = 10; + +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl new file mode 100644 index 000000000000..e7e05638894d --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl @@ -0,0 +1,209 @@ +/************************************************************************* + * + * $RCSfile: XFilePicker.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:36 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__ +#define __com_sun_star_ui_dialogs_XFilePicker_idl__ + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__ +#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** specifies an interface for a filepicker +*/ + +interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog +{ + + //------------------------------------------------------------------------- + /** enable/disable multiselection mode + + <p>If the multiselection mode is enabled multiple files + may be selected else only one selection is possible</p> + + @param bMode + True enables multiselection mode, + False disables multiselection mode this is the default + value + */ + void setMultiSelectionMode( [in] boolean bMode ); + + //------------------------------------------------------------------------- + /** Sets the default string that appears in the edit field of the FilePicker + dialog where the user may enter a file name. + + @param aName + <p> Specifies the default file name, displayed when the FilePicker + will be shown. The implementation may accept any string and doesn't + have to check for a valid file name, if the file exist etc. + </p> + */ + void setDefaultName( [in] string aName ); + + //------------------------------------------------------------------------- + /** Sets the directory that the file dialog initially displays. + + @param aDirectory + Specifies the initial directory in url format. The given URL has to + follow the rules of rfc1738. + + @throws com::sun::star::lang::IllegalArgumentException + If the url is invalid (doesn't conform to rfc1738). + */ + void setDisplayDirectory( [in] string aDirectory ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + //------------------------------------------------------------------------- + /** Returns the directory that the file dialog is currently showing or + was lastly showing before closing the dialog with ok. If the user + did cancel the dialog the returned value is undefined. + + @returns + The directory in url format. + */ + string getDisplayDirectory(); + + //------------------------------------------------------------------------- + /** Returns a sequence of the selected files including path information in + url format. + If the user closed the dialog with cancel an empty sequence will be + returned. + If the dialogs is in execution mode only a single file url will be + returned or an empty sequence if multiple files have been selected or + the current selected file is not a valid file name or any other error + occurs. + + @returns + <p> The complete path of the file or directory currently selected + in url format. There are two different cases: + 1. Multiselection is disabled: + The first and only entry of the sequence contains the complete + path/filename in url format. + + 2. Multiselection is enabled: + If only one file is selected, the first entry + of the sequence contains the complet path/filename in url format. + If multiple files are selected, the first entry of the sequence contains + the path in url format, each other entry contains one of the selected + file names. + + <p>Notes for the implementation of a FileSave dialog: If there exist + a checkbox "Automatic File Extension" and it is checked the dialog should + automatically add an extension to the file name if one is selected in the + filter listbox.</p> + </p> + */ + sequence< string > getFiles(); +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.4 2001/07/06 13:03:20 tra + documentation update + + Revision 1.3 2001/06/28 13:46:32 tra + moved to offapi + + Revision 1.2 2001/06/07 14:04:30 tra + *** empty log message *** + + Revision 1.1 2001/06/06 15:01:02 tra + new dialogs interfaces + + Revision 1.5 2001/04/26 13:11:14 tra + *** empty log message *** + + Revision 1.4 2001/03/16 16:41:51 jsc + remove interfaceheader with uik and remove [const] in method definitions + + Revision 1.3 2000/11/08 12:45:14 mi + moved from api + + Revision 1.2 2000/10/20 07:58:15 tra + minor changed and improvment of the documentation + + Revision 1.1.1.1 2000/09/18 23:36:18 hjs + initial import + + Revision 1.1 2000/09/05 14:55:11 tra + initial version filepicker interface + + +=============================================================================*/ + +#endif + diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl new file mode 100644 index 000000000000..acf4b955f3ef --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl @@ -0,0 +1,195 @@ +/************************************************************************* + * + * $RCSfile: XFilePickerControlAccess.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:44 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__ +#define __com_sun_star_ui_dialogs_XFilePickerControlAccess_idl__ + +#ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__ +#include <com/sun/star/ui/dialogs/XFilePicker.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** Specifies extension of a file picker. + + <p> A FilePicker may contain additional elements according to the needs + of the different applications. These additional elements can be + addresed by this interface.</p> +*/ +interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker +{ + +//------------------------------------------------------------------------- +/** Set the value of an additional element within a FilePicker. + + @param ControlId + Identifies the element which value is to be set. + + @param aControlAction + Specifies an action to perform with the given value. + Currently this value is only valid for listbox controls + in case of a checkbox this value should be 0. + For listbox controls aControlAction has to one of the + values defined in ListboxControlActions + + @param aValue + The value to set. For checkboxes aValue should be a boolean, which + should be true if the checkbox should be checked else false. + + @see ListboxControlActions +*/ +void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue ); + +//------------------------------------------------------------------------- +/** Get the value of an additional element within a FilePicker + + @param aControlId + Identifies the element which value is to set. + + @param aControlAction + Specifies which value to retrieve. Currently this value + is only valid for listbox controls + in case of a checkbox this value should be 0. + + @returns + The value of the specified element. If the specified control + is a checkbox the returned value is a boolean, which is true + if the checkbox is checked else false. + If the specified element doesn't exist or the specified element + doesn't support the specidfied control action an empty any will be + returned. +*/ +any getValue( [in] short aControlId, [in] short aControlAction ); + +//------------------------------------------------------------------------- +/** Set the label of the specified element. If the specified element + doesn't support setting a label, this method has no effect. +*/ +void setLabel( [in] short aControlId, [in] string aLabel ); + +//------------------------------------------------------------------------- +/** Returns the lable of the specified element. + + @returns + The label of the specified element or an empty string if + the specified element has no or supports no label or the + specified element doesn't exist. +*/ +string getLabel( [in] short aControlId ); + +//------------------------------------------------------------------------- +/** Enables or disables a control. + + @param ControlId + Identifies the control. + + @param bEnable + If true the specified control will be enabled. + If false the specified control will be disabled. +*/ +void enableControl( [in] short aControlId, [in] boolean bEnable ); +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.4 2001/07/02 08:05:54 tra + removed IllegalArgumentException specification from interface methods + + Revision 1.3 2001/06/08 09:06:31 tra + *** empty log message *** + + Revision 1.2 2001/06/07 14:04:30 tra + *** empty log message *** + + Revision 1.1 2001/06/06 15:01:02 tra + new dialogs interfaces + + Revision 1.1 2001/04/10 06:43:06 tra + replacement for XExtendedFilePicker + + Revision 1.4 2001/03/16 16:41:51 jsc + remove interfaceheader with uik and remove [const] in method definitions + + Revision 1.3 2000/11/08 12:45:14 mi + moved from api + + Revision 1.2 2000/10/20 07:58:15 tra + minor changed and improvment of the documentation + + Revision 1.1.1.1 2000/09/18 23:36:17 hjs + initial import + + Revision 1.1 2000/09/05 14:55:11 tra + initial version filepicker interface + + +=============================================================================*/ + +#endif + diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl new file mode 100644 index 000000000000..daeb79ea1119 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl @@ -0,0 +1,154 @@ +/************************************************************************* + * + * $RCSfile: XFilePickerListener.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:51 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XFilePickerListener_idl__ +#define __com_sun_star_ui_dialogs_XFilePickerListener_idl__ + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + +#ifndef __com_sun_star_ui_dialogs_FilePickerEvent_idl__ +#include <com/sun/star/ui/dialogs/FilePickerEvent.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= + +//============================================================================= +/** Interface to be implemented by all FilePicker service clients. + + <p> The <type>XFilePickerListener</type> interface must be implemented by + the clients of the FilePicker service which need to be informed about + events while the FilePicker service is displayed.</p> +*/ + +interface XFilePickerListener: com::sun::star::lang::XEventListener +{ + //------------------------------------------------------------------------- + /** A client receives this event if the file selection within the + FilePicker service dialog changes. + + @param aEvent + of type <type>FilePickerEvent</type> that describes the event + + @see FilePickerEvent + */ + void fileSelectionChanged( [in] FilePickerEvent aEvent ); + + + //------------------------------------------------------------------------- + /** A client receives this event if the directory selection within the + FilePicker service dialog changes. + + @param aEvent + Of type <type>FilePickerEvent</type> that describes the event. + + @see FilePickerEvent + */ + void directoryChanged( [in] FilePickerEvent aEvent ); + + //------------------------------------------------------------------------- + /** A client receives this event if the F1 key or the help button was + pressed. + + @param aEvent + of type <type>FilePickerEvent</type> that describes the event + + @returns + A help string which the FilePicker dialog should display + in a tooltip window. If the returned string is empty it is + undefined how the FilePicker implementation will behave. + It may show a message 'no help available' or may show no + tooltip window at all etc. + + @see FilePickerEvent + */ + string helpRequested( [in] FilePickerEvent aEvent ); + + //------------------------------------------------------------------------- + /** A client receives this event if the state of a control within the + FilePicker service dialog changes. + + @param aEvent + of type <type>FilePickerEvent</type> that describes the event. + + @see FilePickerEvent + */ + void controlStateChanged( [in] FilePickerEvent aEvent ); + + //------------------------------------------------------------------------- + /** A client receives this event if the size of the FilePicker dialog + has changed. If the FilePicker dialog contains a preview the client + may ask for the new dimension of the preview area. + */ + void dialogSizeChanged( ); +}; + +//============================================================================= + +}; }; }; }; }; + + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl new file mode 100644 index 000000000000..215057f6dd6e --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl @@ -0,0 +1,115 @@ +/************************************************************************* + * + * $RCSfile: XFilePickerNotifier.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:20:59 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XFilePickerNotifier_idl__ +#define __com_sun_star_ui_dialogs_XFilePickerNotifier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_ui_dialogs_XFilePickerListener_idl__ +#include <com/sun/star/ui/dialogs/XFilePickerListener.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= + +//============================================================================= +/** Interface to be implemented by all FilePicker service clients. + + <p> The <type>XFilePickerListener</type> interface must be implemented by + the clients of the FilePicker service which need to be notified about + events while the FilePicker service is displayed. +*/ +interface XFilePickerNotifier: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** Interface for clients to register as XFilePickerListener + + @param xListener + the <type>XFilePickerListener</type> interface of the object that + wants to receive FilePickerEvents. + + @see XFilePickerListener + */ + [oneway] void addFilePickerListener( [in] XFilePickerListener xListener ); + + //------------------------------------------------------------------------- + /** Interface for clients to unregister as XFilePickerListener. + + @param xListener + The <type>XFilePickerListener</type> interface of the object that + wants to receive FilePickerEvents. + + @see XFilePickerListener + */ + [oneway] void removeFilePickerListener( [in] XFilePickerListener xListener ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/XFilePreview.idl b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl new file mode 100644 index 000000000000..4bab7f277d5c --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl @@ -0,0 +1,174 @@ +/************************************************************************* + * + * $RCSfile: XFilePreview.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:21:07 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XFilePreview_idl__ +#define __com_sun_star_ui_dialogs_XFilePreview_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** + +*/ + +interface XFilePreview: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** The method returns all image formats that the preview supports. + + @returns + a sequence of all supported preview formats + + @see ::com::sun::star::ui::dialogs::PreviewImageFormats + */ + sequence< short > getSupportedImageFormats( ); + + //------------------------------------------------------------------------- + /** The method returns the supported color depth of the target device. + + @returns + the color depth in bit, e.g. 8 bit, 16 bit, 32 bit + */ + long getTargetColorDepth( ); + + //------------------------------------------------------------------------- + /** The method returns the available width of the preview window + even if the window is invisible or could not be created. + If a service implementation doesn't support a file preview + 0 will be returned. + + @returns + the width of the preview window in pixel + */ + long getAvailableWidth( ); + + //------------------------------------------------------------------------- + /** The method returns the available height of the preview window + even if the window is invisible or could not be created. + If a service implementation doesn't support a file preview + 0 will be returned. + + @param + the heigth of the preview window in pixel + */ + long getAvailableHeight( ); + + //------------------------------------------------------------------------- + /** Sets a new image. If the preview is currently hidden the + image will be ignored. An empty any will clear the preview window. + + @param aImageFormat + specifies the format of the data that will be delivered + + @param aImage + the image data, the image format defines how + the image data have to be delivered + + @throws ::com::sun::star::lang::IllegalArgumentException + if the specified image format is invalid or not + supported by the preview implementation + + @see ::com::sun::star::ui::dialogs::PreviewImageFormats + */ + void setImage( [in] short aImageFormat, [in] any aImage ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + //------------------------------------------------------------------------- + /** Optionally sets the current show state of the preview. It is possible + that the preview implementation doesn't support hiding the preview. + + @param bShowState + True shows the preview window. + False hides the preview window. + + @returns + True on success. + False if the operation fails for any reason or the preview + implementation doesn't support hiding the preview. + */ + boolean setShowState( [in] boolean bShowState ); + + //------------------------------------------------------------------------- + /** Returns the current show state of the preview. + + @returns + True if the preview window is visible. + False if the preview window is invisible. + */ + boolean getShowState( ); +}; + +//============================================================================= + +}; }; }; }; }; + + +#endif diff --git a/offapi/com/sun/star/ui/dialogs/XFilterManager.idl b/offapi/com/sun/star/ui/dialogs/XFilterManager.idl new file mode 100644 index 000000000000..f9d821fcf5f3 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XFilterManager.idl @@ -0,0 +1,157 @@ +/************************************************************************* + * + * $RCSfile: XFilterManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:21:15 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_ui_dialogs_XFilterManager_idl__ +#define __com_sun_star_ui_dialogs_XFilterManager_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** Specifies a filter manager interface for a file picker +*/ + +interface XFilterManager: com::sun::star::uno::XInterface +{ + + //------------------------------------------------------------------------- + /** Adds a filter identified by a title. + + @param aTitle + Specifies the name of the filter as shown in the filter box of the + FilePicker dialog. + + @param aFilter + Specifies the extensions of the filter. Multiple filters should be + semicolon separated. The semicolon may not be used as character in + a filter expresion. A typical filter is for instance '*.txt'. + + @throws ::com::sun::star::lang::IllegalArgumentException + If a filter with the specified title already exists. + + */ + void appendFilter( [in] string aTitle, [in] string aFilter ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + //------------------------------------------------------------------------- + /** Sets the current filter. + + @param aTitle + Specifies the name of the filter to be set. + + @throws com::sun::star::lang::IllegalArgumentException + If the specified filter was not found. + */ + void setCurrentFilter( [in] string aTitle ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + //------------------------------------------------------------------------- + /** Returns the currently selected filter. + + @returns + The the name of the selected filter or an empty string if + there is no filter or no filter is currently selected. + */ + string getCurrentFilter( ); +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.2 2001/07/06 13:03:20 tra + documentation update + + Revision 1.1 2001/06/06 15:01:02 tra + new dialogs interfaces + + Revision 1.4 2001/03/16 16:41:51 jsc + remove interfaceheader with uik and remove [const] in method definitions + + Revision 1.3 2000/11/08 12:45:14 mi + moved from api + + Revision 1.2 2000/10/20 07:58:15 tra + minor changed and improvment of the documentation + + Revision 1.1.1.1 2000/09/18 23:36:18 hjs + initial import + + Revision 1.1 2000/09/05 14:55:11 tra + initial version filepicker interface + + +=============================================================================*/ + +#endif + diff --git a/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl b/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl new file mode 100644 index 000000000000..a61d105a2246 --- /dev/null +++ b/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl @@ -0,0 +1,162 @@ +/************************************************************************* + * + * $RCSfile: XFolderPicker.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-08-30 10:21:21 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_ui_dialogs_XFolderPicker_idl__ +#define __com_sun_star_ui_dialogs_XFolderPicker_idl__ + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__ +#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ui { module dialogs { + +//============================================================================= +/** Specifies a FolderPicker interface. +*/ + +interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog +{ + //------------------------------------------------------------------------- + /** Sets the root directory that the FolderPicker should display. + It is not specified which root directory the FolderPicker + chooses if the specified root directory doesn't exist. + + @param aDirectory + Specifies the root directory in url format. + + @throws ::com::sun::star::lang::IllegalArgumentException + If the given url is invalid. + */ + void setDisplayDirectory( [in] string aDirectory ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + //------------------------------------------------------------------------- + /** Returns the root directory that the FolderPicker is showing. The + return value is undefined if the client did not choose a root directory + or the previously specified root directory doesn't exist. + + @returns + The the directory in url format. + */ + string getDisplayDirectory(); + + //------------------------------------------------------------------------- + /** Returns the selected directory as url. + + @returns + The selected directory as url if the user did close the dialog with ok + else the returned value is undefined. + */ + string getDirectory( ); + + //------------------------------------------------------------------------- + /** The implementation may optionally show the given text as a description + for the user. If the client doesn't set a description the dialog may + show a default description. + */ + void setDescription( [in] string aDescription ); +}; + +//============================================================================= + +}; }; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.3 2001/06/26 13:20:04 tra + #88797#added a method to set a description + + Revision 1.2 2001/06/07 14:04:30 tra + *** empty log message *** + + Revision 1.1 2001/06/06 15:01:02 tra + new dialogs interfaces + + Revision 1.4 2001/03/16 16:41:51 jsc + remove interfaceheader with uik and remove [const] in method definitions + + Revision 1.3 2000/11/08 12:45:14 mi + moved from api + + Revision 1.2 2000/10/20 07:58:15 tra + minor changed and improvment of the documentation + + Revision 1.1.1.1 2000/09/18 23:36:18 hjs + initial import + + Revision 1.1 2000/09/05 14:55:11 tra + initial version filepicker interface + + +=============================================================================*/ + +#endif + |