diff options
Diffstat (limited to 'offapi/com/sun/star/gallery')
| -rw-r--r-- | offapi/com/sun/star/gallery/GalleryItem.idl | 100 | ||||
| -rw-r--r-- | offapi/com/sun/star/gallery/GalleryItemType.idl | 62 | ||||
| -rw-r--r-- | offapi/com/sun/star/gallery/GalleryTheme.idl | 57 | ||||
| -rw-r--r-- | offapi/com/sun/star/gallery/GalleryThemeProvider.idl | 73 | ||||
| -rw-r--r-- | offapi/com/sun/star/gallery/XGalleryItem.idl | 59 | ||||
| -rw-r--r-- | offapi/com/sun/star/gallery/XGalleryTheme.idl | 172 | ||||
| -rw-r--r-- | offapi/com/sun/star/gallery/XGalleryThemeProvider.idl | 94 | ||||
| -rw-r--r-- | offapi/com/sun/star/gallery/makefile.mk | 51 |
8 files changed, 668 insertions, 0 deletions
diff --git a/offapi/com/sun/star/gallery/GalleryItem.idl b/offapi/com/sun/star/gallery/GalleryItem.idl new file mode 100644 index 000000000000..ab588f988b67 --- /dev/null +++ b/offapi/com/sun/star/gallery/GalleryItem.idl @@ -0,0 +1,100 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_gallery_GalleryItem_idl__ +#define __com_sun_star_gallery_GalleryItem_idl__ + +#ifndef __com_sun_star_gallery_XGalleryItem_idl__ +#include <com/sun/star/gallery/XGalleryItem.idl> +#endif +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_graphic_XGraphic_idl__ +#include <com/sun/star/graphic/XGraphic.idl> +#endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module gallery { + +//============================================================================= + +/** service to get access to the properties of a single Gallery item + */ +service GalleryItem +{ + interface ::com::sun::star::gallery::XGalleryItem; + + interface ::com::sun::star::beans::XPropertySet; + + /** The type of the Gallery item + + @see GalleryItemType + */ + [readonly, property] byte GalleryItemType; + + /** the URL of the Gallery item + + <p>The interpretation of the URL depends on the type + of the Gallery item. In case of graphic and media items, + the URL is a 'real' URL, in case of drawings it is a private + URL</p> + */ + [readonly, property] string URL; + + /** the title of the Gallery item + */ + [property] string Title; + + /** the thumbnail of the Gallery item + + <p>The thumbnail may be either a pixel or a vector graphic</p> + */ + [readonly, property] com::sun::star::graphic::XGraphic Thumbnail; + + /** the graphic content of the Gallery item + + <p>This is an optional property and may not available for every item</p> + */ + [optional, readonly, property ] ::com::sun::star::graphic::XGraphic Graphic; + + /** the drawing content of the Gallery item + + <p>This is an optional property and may not available for every item</p> + */ + [optional, readonly, property ] ::com::sun::star::lang::XComponent Drawing; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/gallery/GalleryItemType.idl b/offapi/com/sun/star/gallery/GalleryItemType.idl new file mode 100644 index 000000000000..f8bf62056080 --- /dev/null +++ b/offapi/com/sun/star/gallery/GalleryItemType.idl @@ -0,0 +1,62 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_gallery_GalleryItemType_idl__ +#define __com_sun_star_gallery_GalleryItemType_idl__ + +module com { module sun { module star { module gallery { + +/** Constants that describe the type of graphic +*/ +constants GalleryItemType +{ + //------------------------------------------------------------------------- + /** Item is empty + */ + const byte EMPTY = 0; + + //------------------------------------------------------------------------- + /** Item represents a graphic + */ + const byte GRAPHIC = 1; + + //------------------------------------------------------------------------- + /** Item represents a media file + */ + const byte MEDIA = 2; + + //------------------------------------------------------------------------- + /** Item represents a drawing + */ + const byte DRAWING = 3; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/gallery/GalleryTheme.idl b/offapi/com/sun/star/gallery/GalleryTheme.idl new file mode 100644 index 000000000000..207aec2c73a6 --- /dev/null +++ b/offapi/com/sun/star/gallery/GalleryTheme.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_gallery_GalleryTheme_idl__ +#define __com_sun_star_gallery_GalleryTheme_idl__ + +#ifndef __com_sun_star_gallery_XGalleryTheme_idl__ +#include <com/sun/star/gallery/XGalleryTheme.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module gallery { + +//============================================================================= + +/** provides access to a container of Gallery items and makes it + possible for you to manipulate them. + + @see XGalleryTheme + */ +service GalleryTheme +{ + /** lets you access and create Gallery items + */ + interface com::sun::star::gallery::XGalleryTheme; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/gallery/GalleryThemeProvider.idl b/offapi/com/sun/star/gallery/GalleryThemeProvider.idl new file mode 100644 index 000000000000..f08b8756f20f --- /dev/null +++ b/offapi/com/sun/star/gallery/GalleryThemeProvider.idl @@ -0,0 +1,73 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_gallery_GalleryThemeProvider_idl__ +#define __com_sun_star_gallery_GalleryThemeProvider_idl__ + +#ifndef __com_sun_star_gallery_XGalleryThemeProvider_idl__ +#include <com/sun/star/gallery/XGalleryThemeProvider.idl> +#endif +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module gallery { + +//============================================================================= + +/** provides access to a container of <type>GalleryTheme</type>s + and makes it possible for you to manipulate them. + + @see XGalleryThemeProvider + */ +service GalleryThemeProvider +{ + /** lets you access and create <type>GalleryTheme</type>s + */ + interface com::sun::star::gallery::XGalleryThemeProvider; + + /** allows initializing the provider + <p>You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments + method of your <type scope="com::sun::star::lang">XMultiServiceFactory</type>.</p> + + <p>You specify a parameter by passing one (or more) + <type scope="com::sun::star::beans">PropertyValue</type> + object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect + you want to affect, and the <em>Value</em> field containing a value.</p> + + <p>Currently, there are no public properties available</p> + */ + interface com::sun::star::lang::XInitialization; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/gallery/XGalleryItem.idl b/offapi/com/sun/star/gallery/XGalleryItem.idl new file mode 100644 index 000000000000..fac404145e3b --- /dev/null +++ b/offapi/com/sun/star/gallery/XGalleryItem.idl @@ -0,0 +1,59 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_gallery_XGalleryItem_idl__ +#define __com_sun_star_gallery_XGalleryItem_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module gallery { + +//============================================================================= + +/** provides access to a single item of a Gallery theme. + */ +interface XGalleryItem : com::sun::star::uno::XInterface +{ + /** retrieves the type of the Gallery item + + @returns + The type of the Gallery item + + @see GalleryItemType + */ + byte getType(); +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/gallery/XGalleryTheme.idl b/offapi/com/sun/star/gallery/XGalleryTheme.idl new file mode 100644 index 000000000000..ed8ac5230335 --- /dev/null +++ b/offapi/com/sun/star/gallery/XGalleryTheme.idl @@ -0,0 +1,172 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_gallery_XGalleryTheme_idl__ +#define __com_sun_star_gallery_XGalleryTheme_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> +#endif +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif +#ifndef __com_sun_star_graphic_XGraphic_idl__ +#include <com/sun/star/graphic/XGraphic.idl> +#endif +#ifndef __com_sun_star_gallery_XGalleryItem_idl__ +#include <com/sun/star/gallery/XGalleryItem.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module gallery { + +//============================================================================= + +/** provides access to the items of a Gallery themes. It also allows + inserting and removing of single items. + + <p>This interface extends the interface + <type scope="com::sun::star::container">XIndexAccess</type> which provides + access to existing Gallery items collection.</p> + + @see com::sun::star::container::XIndexAccess + @see com::sun::star::sheet::DataPilotTable + */ +interface XGalleryTheme : com::sun::star::container::XIndexAccess +{ + /** retrieves the name of the Gallery theme + + @returns + The name of the Gallery theme + */ + string getName(); + + /** updates the theme + + <p>This method iterates over each item of the Gallery theme + and updates it accordingly. Main purpose is to automatically + regenerate the thumbnails and to remove invalid items, that is items + who have got an URL that has become invalid. This method also + optimizes underlying data structures.</p> + */ + void update(); + + /** inserts an item + + @param URL + The URL of a graphic or media object, that should + be added to the collection + + @param Index + The zero based index of the position where to insert + the new object inside the collection. If the index is larger than + or equal to the number of already inserted items, the + item is inserted at the end of the collection. If the index + is smaller than 0, the item is inserted at the beginning of + the collection. + + @returns + The zero based position at which the object was inserted. + If the object could not be inserted, -1 is returned. + + @see XGalleryItem + @see com::sun::star::lang::WrappedTargetException + */ + long insertURLByIndex( [in] string URL, [in] long Index ) + raises ( com::sun::star::lang::WrappedTargetException ); + /** inserts an item + + @param Graphic + The <type scope="com::sun::star::graphic">XGraphic</type> object + that should be added to the collection + + @param Index + The zero based index of the position where to insert + the new object inside the collection. If the index is larger than + or equal to the number of already inserted items, the + item is inserted at the end of the collection. If the index + is smaller than 0, the item is inserted at the beginning of + the collection. + + @returns + The zero based position at which the object was inserted. + If the object could not be inserted, -1 is returned. + + @see com::sun::star::graphic::XGraphic + @see XGalleryItem + @see com::sun::star::lang::WrappedTargetException + */ + long insertGraphicByIndex( [in] com::sun::star::graphic::XGraphic Graphic, [in] long Index ) + raises ( com::sun::star::lang::WrappedTargetException ); + + /** inserts an item + + @param Drawing + A drawing model that should be added to the collection + + @param Index + The zero based index of the position where to insert + the new object inside the collection. If the index is larger than + or equal to the number of already inserted items, the + item is inserted at the end of the collection. If the index + is smaller than 0, the item is inserted at the beginning of + the collection. + + @returns + The zero based position at which the object was inserted. + If the object could not be inserted, -1 is returned. + + @see XGalleryItem + @see com::sun::star::lang::WrappedTargetException + */ + long insertDrawingByIndex( [in] com::sun::star::lang::XComponent Drawing, [in] long Index ) + raises ( com::sun::star::lang::WrappedTargetException ); + + /** deletes an item from the collection + + @param Index + The position of the item to be removed. The + position is zero based. + + @see com::sun::star::container::NoSuchElementException + */ + void removeByIndex( [in] long Index ) + raises ( com::sun::star::lang::IndexOutOfBoundsException ); +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/gallery/XGalleryThemeProvider.idl b/offapi/com/sun/star/gallery/XGalleryThemeProvider.idl new file mode 100644 index 000000000000..c7fa2dbfdc17 --- /dev/null +++ b/offapi/com/sun/star/gallery/XGalleryThemeProvider.idl @@ -0,0 +1,94 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_gallery_XGalleryThemeProvider_idl__ +#define __com_sun_star_gallery_XGalleryThemeProvider_idl__ + +#ifndef __com_sun_star_gallery_XGalleryTheme_idl__ +#include <com/sun/star/gallery/XGalleryTheme.idl> +#endif +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif +#ifndef __com_sun_star_container_ElementExistException_idl__ +#include <com/sun/star/container/ElementExistException.idl> +#endif +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module gallery { + +//============================================================================= + +/** provides access to the Gallery themes. It also allows inserting and + removing of Gallery themes by name. + + <p>This interface extends the interface + <type scope="com::sun::star::container">XNameAccess</type> which provides + access to existing Gallery themes collection.</p> + + @see com::sun::star::container::XNameAccess + */ +interface XGalleryThemeProvider : com::sun::star::container::XNameAccess +{ + /** creates a new Gallery theme and adds it to the collection. + + @param ThemeName + The name of the Gallery theme to be added to the collection. + The name must be unique. + + @returns XGalleryTheme + The created theme interface + + @see com::sun::star::container::ElementExistException + */ + XGalleryTheme insertNewByName( [in] string ThemeName ) + raises ( com::sun::star::container::ElementExistException ); + + //------------------------------------------------------------------------- + + /** deletes a Gallery theme from the collection. + + @param ThemeName + The name of the Gallery theme to be removed. The + theme with the given name must exist. + + @see com::sun::star::container::NoSuchElementException + */ + void removeByName( [in] string ThemeName ) + raises ( com::sun::star::container::NoSuchElementException ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/gallery/makefile.mk b/offapi/com/sun/star/gallery/makefile.mk new file mode 100644 index 000000000000..49a9c908df65 --- /dev/null +++ b/offapi/com/sun/star/gallery/makefile.mk @@ -0,0 +1,51 @@ +#************************************************************************* +# +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +# +# Copyright 2000, 2010 Oracle and/or its affiliates. +# +# OpenOffice.org - a multi-platform office productivity suite +# +# This file is part of OpenOffice.org. +# +# OpenOffice.org is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License version 3 +# only, as published by the Free Software Foundation. +# +# OpenOffice.org 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 version 3 for more details +# (a copy is included in the LICENSE file that accompanied this code). +# +# You should have received a copy of the GNU Lesser General Public License +# version 3 along with OpenOffice.org. If not, see +# <http://www.openoffice.org/license.html> +# for a copy of the LGPLv3 License. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. +PRJNAME=offapi +TARGET=cssgallery +PACKAGE=com$/sun$/star$/gallery + +# --- Settings ----------------------------------------------------- + +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + GalleryThemeProvider.idl \ + GalleryTheme.idl \ + GalleryItem.idl \ + GalleryItemType.idl \ + XGalleryThemeProvider.idl \ + XGalleryTheme.idl \ + XGalleryItem.idl + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |