diff options
author | Vladimir Glazounov <vg@openoffice.org> | 2009-01-21 15:28:14 +0000 |
---|---|---|
committer | Vladimir Glazounov <vg@openoffice.org> | 2009-01-21 15:28:14 +0000 |
commit | ab1da007dda06689ade0e35d16a059c9af857387 (patch) | |
tree | 66d6f1de76d445234912785d2fbcc926b94383c1 /offapi | |
parent | 95016235633008ab0fefd829035a3c5e6f44cbe2 (diff) |
CWS-TOOLING: integrate CWS fwk95
2009-01-15 13:24:14 +0100 cd r266366 : #i96390# Change method name to use UNO AWT style for mnemonics
2009-01-15 13:23:30 +0100 cd r266365 : #i96390# Change method name to use UNO AWT style for mnemonics
2009-01-12 17:25:13 +0100 cd r266174 : #i97983# Check pointer returned by dynamic_cast
2009-01-12 15:31:40 +0100 cd r266162 : #i97983# Create toolkit popup menus via service manager instead of implementation class
2008-12-11 15:04:34 +0100 cd r265305 : #i95863# Remove user defined properties
2008-12-11 14:56:45 +0100 cd r265302 : #i95606# Update documentation for textfields
2008-12-11 10:06:20 +0100 cd r265250 : #i96390# Fix warning on Solaris compiler
2008-12-09 17:27:32 +0100 cd r265119 : CWS-TOOLING: rebase CWS fwk95 to trunk@264807 (milestone: DEV300:m37)
2008-12-01 13:29:43 +0100 cd r264597 : #i96390# New interfaces and structures for complete UNO AWT menu API
2008-12-01 13:25:22 +0100 cd r264596 : #i96390# Added implementation of the new UNO AWT interfaces and structures for menus
2008-11-28 13:55:19 +0100 cd r264553 : #i96640# Fixed wrong property type for MenuBarCloser
2008-11-28 13:53:56 +0100 cd r264552 : #i96621# Fixed ambiguous usage of && and ||
2008-11-18 16:05:45 +0100 cd r263781 : #i95316# Initialize SvtTabAppearanceCfg to enable system settings changed notiifcation code
2008-11-18 16:05:43 +0100 cd r263780 : #i96155# Fix wrong statement to check for enabled argument
2008-10-20 16:54:37 +0200 cd r262328 : #i10000# migrate CWS fwk95 to SVN.
Diffstat (limited to 'offapi')
36 files changed, 969 insertions, 143 deletions
diff --git a/offapi/com/sun/star/awt/MenuItemType.idl b/offapi/com/sun/star/awt/MenuItemType.idl new file mode 100644 index 000000000..a69c9d451 --- /dev/null +++ b/offapi/com/sun/star/awt/MenuItemType.idl @@ -0,0 +1,71 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: MenuItemType.idl,v $ + * $Revision: 1.0 $ + * + * 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_awt_MenuItemType_idl__ +#define __com_sun_star_awt_MenuItemType_idl__ + + +//============================================================================= + + module com { module sun { module star { module awt { + +//============================================================================= + +/** specifies the type of a menu item, as returned by + <member scope="com::sun::star::awt">XMenuExtended2::getItemType()</member>. + */ +enum MenuItemType +{ + /** specifies that the menu item type is unkown. + */ + DONTKNOW, + + /** specifies that the menu item has a text. + */ + STRING, + + /** specifies that the menu item has an image. + */ + IMAGE, + + /** specifies that the menu item has a text <b>and</b> an image. + */ + STRINGIMAGE, + + /** specifies that the menu item is a separator. + */ + SEPARATOR + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/MenuLogo.idl b/offapi/com/sun/star/awt/MenuLogo.idl new file mode 100755 index 000000000..a7b4b9414 --- /dev/null +++ b/offapi/com/sun/star/awt/MenuLogo.idl @@ -0,0 +1,73 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: MenuLogo.idl,v $ + * $Revision: 1.0 $ + * + * 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_awt_MenuLogo_idl__ +#define __com_sun_star_awt_MenuLogo_idl__ + +#ifndef com_sun_star_graphic_XGraphic_idl +#include <com/sun/star/graphic/XGraphic.idl> +#endif + +#ifndef __com_sun_star_util_color_idl__ +#include <com/sun/star/util/Color.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module awt { + +//============================================================================= + +/** specifies a logo to be displayed on a menu, with a background gradient. + */ +struct MenuLogo +{ + /** specifies the logo image. + */ + ::com::sun::star::graphic::XGraphic Graphic; + + //------------------------------------------------------------------------- + + /** specifies the color at the start point of the gradient. + */ + ::com::sun::star::util::Color StartColor; + + //------------------------------------------------------------------------- + + /** specifies the color at the end point of the gradient. + */ + ::com::sun::star::util::Color EndColor; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/XMenuBarExtended.idl b/offapi/com/sun/star/awt/XMenuBarExtended.idl new file mode 100755 index 000000000..518c2d050 --- /dev/null +++ b/offapi/com/sun/star/awt/XMenuBarExtended.idl @@ -0,0 +1,72 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XMenuBarExtended.idl,v $ + * $Revision: 1.0 $ + * + * 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_awt_XMenuBarExtended_idl__ +#define __com_sun_star_awt_XMenuBarExtended_idl__ + +#ifndef __com_sun_star_awt_XMenuBar_idl__ +#include <com/sun/star/awt/XMenuBar.idl> +#endif + +#ifndef __com_sun_star_awt_XMenuExtended2_idl__ +#include <com/sun/star/awt/XMenuExtended2.idl> +#endif + +#ifndef com_sun_star_graphic_XGraphic_idl +#include <com/sun/star/graphic/XGraphic.idl> +#endif + +#ifndef __com_sun_star_awt_Rectangle_idl__ +#include <com/sun/star/awt/Rectangle.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module awt { + + interface XMenuBarButtonListener; + +//============================================================================= + +/** multiple-inheritance interface designed to ease the use of all functions + available for a <type scope="com::sun::star::awt">MenuBar</type>. + + @since OOo 3.1 + */ + interface XMenuBarExtended +{ + interface com::sun::star::awt::XMenuExtended2; + interface com::sun::star::awt::XMenuBar; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/XMenuExtended.idl b/offapi/com/sun/star/awt/XMenuExtended.idl index ebfe98cdf..e493ebdde 100644 --- a/offapi/com/sun/star/awt/XMenuExtended.idl +++ b/offapi/com/sun/star/awt/XMenuExtended.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2008 by Sun Microsystems, Inc. * * OpenOffice.org - a multi-platform office productivity suite @@ -27,16 +27,16 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_awt_XMenu_idl__ -#define __com_sun_star_awt_XMenu_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif +#ifndef __com_sun_star_awt_XMenuExtended_idl__ +#define __com_sun_star_awt_XMenuExtended_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif -//============================================================================= - -module com { module sun { module star { module awt { +//============================================================================= + +module com { module sun { module star { module awt { /** specifies extended menu functions. */ @@ -52,14 +52,14 @@ interface XMenuExtended: com::sun::star::uno::XInterface specifies the command for the menu item. */ void setCommand( [in] short nItemId, [in] string aCommand ); - + /** retrieves the command string for the menu item. @param nItemId specifies the menu item ID for which the command URL should be set. */ string getCommand( [in] short nItemId ); - + /** sets the help command string for the menu item. @param nItemId @@ -69,15 +69,15 @@ interface XMenuExtended: com::sun::star::uno::XInterface specifies the help command for the menu item. */ void setHelpCommand( [in] short nItemId, [in] string aHelp ); - + /** retrieves the help command string for the menu item. @param nItemId specifies the menu item ID for which the help command should be set. */ string getHelpCommand( [in] short nItemId ); -}; - -}; }; }; }; - -#endif +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/XMenuExtended2.idl b/offapi/com/sun/star/awt/XMenuExtended2.idl new file mode 100755 index 000000000..367b90fa3 --- /dev/null +++ b/offapi/com/sun/star/awt/XMenuExtended2.idl @@ -0,0 +1,115 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XMenuExtended2.idl,v $ + * $Revision: 1.0 $ + * + * 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_awt_XMenuExtended2_idl__ +#define __com_sun_star_awt_XMenuExtended2_idl__ + +#ifndef __com_sun_star_awt_XMenu_idl__ +#include <com/sun/star/awt/XMenu.idl> +#endif + +#ifndef __com_sun_star_awt_XMenuExtended_idl__ +#include <com/sun/star/awt/XMenuExtended.idl> +#endif + +#ifndef __com_sun_star_awt_MenuItemType_idl__ +#include <com/sun/star/awt/MenuItemType.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module awt { + +/** specifies extended menu functions. + */ + +interface XMenuExtended2 +{ + /** specifies some extended menu functions, like setting a command URL and a help command for a menu item.<br> + These functions are available for both menu bar and popup menu. + */ + interface com::sun::star::awt::XMenuExtended; + + /** specifies basic menu functions. + */ + interface com::sun::star::awt::XMenu; + + + //========================================================================= + + /** checks whether an <type>XMenu</type> is an <type>XPopupMenu</type>. + + @return + <TRUE/> if the menu is a <type>PopupMenu</type>, <FALSE/> if it is a <type>MenuBar</type>. + */ + boolean isPopupMenu(); + + //......................................................................... + + /** removes all items from the menu. + */ + void clear(); + + //......................................................................... + + /** retrieves the type of the menu item. + + @param nItemPos + specifies the position of the menu item for which the item type is queried. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item in the position specified in <var>nItemPos</var>. + + @see MenuItemType + */ + ::com::sun::star::awt::MenuItemType getItemType( [in] short nItemPos ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + //......................................................................... + + /** specifies whether disabled menu entries should be hidden, or not. + + @param bHide + if <TRUE/>, disabled menu entries are hidden. + + @see + <member scope="com::sun::star::awt">XMenu::enableItem()</member> + */ + void hideDisabledEntries( [in] boolean bHide ); + + +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/XPopupMenuExtended.idl b/offapi/com/sun/star/awt/XPopupMenuExtended.idl new file mode 100755 index 000000000..e8ea2ba5d --- /dev/null +++ b/offapi/com/sun/star/awt/XPopupMenuExtended.idl @@ -0,0 +1,364 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XPopupMenuExtended.idl,v $ + * $Revision: 1.0 $ + * + * 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_awt_XPopupMenuExtended_idl__ +#define __com_sun_star_awt_XPopupMenuExtended_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_awt_XPopupMenu_idl__ +#include <com/sun/star/awt/XPopupMenu.idl> +#endif + +#ifndef __com_sun_star_awt_XMenuExtended2_idl__ +#include <com/sun/star/awt/XMenuExtended2.idl> +#endif + +#ifndef __com_sun_star_awt_MenuLogo_idl__ +#include <com/sun/star/awt/MenuLogo.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + +#ifndef __com_sun_star_awt_KeyEvent_idl__ +#include <com/sun/star/awt/KeyEvent.idl> +#endif + +#ifndef com_sun_star_graphic_XGraphic_idl +#include <com/sun/star/graphic/XGraphic.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module awt { + +/** specifies extended functions for a <type scope="com::sun::star::awt">PopupMenu</type>. + + @since OOo 3.1 + */ +interface XPopupMenuExtended +{ + /** specifies basic functions for a popup menu. + */ + interface ::com::sun::star::awt::XPopupMenu; + + /** specifies extended menu functions, available for both + <type scope="com::sun::star::awt">MenuBar</type> and + <type scope="com::sun::star::awt">PopupMenu</type>. + */ + interface ::com::sun::star::awt::XMenuExtended2; + + //========================================================================= + + /** queries if the <type scope="com::sun::star::awt">PopupMenu</type> + is being executed as a result of invoking + <member scope="com::sun::star::awt">XPopupMenu::execute()</member>; that is, + for a <type>PopupMenu</type> activated by a <type>MenuBar</type> item, + this methods returns <FALSE/>. + + @return + <TRUE/> if the <type scope="com::sun::star::awt">PopupMenu</type> + is being executed, <FALSE/> otherwise. + + @see <member scope="com::sun::star::awt">XPopupMenu::execute()</member> + + @since OOo 3.1 + */ + boolean isInExecute(); + + /** ends the execution of the <type scope="com::sun::star::awt">PopupMenu</type>. + <member scope="com::sun::star::awt">XPopupMenu::execute()</member> will then return 0. + + @see <member scope="com::sun::star::awt">XPopupMenu::execute()</member> + + @since OOo 3.1 + */ + void endExecute(); + + //============================================================================= + + /** sets the <type>MenuLogo</type> for this <type>PopupMenu</type>. + + @param aMenuLogo + the <type>MenuLogo</type>. + + @since OOo 3.1 + */ + void setLogo( [in] ::com::sun::star::awt::MenuLogo aMenuLogo ); + + /** retrieves the <type>MenuLogo</type> for this <type>PopupMenu</type>. + + @return + the <type>MenuLogo</type>. + + @since OOo 3.1 + */ + ::com::sun::star::awt::MenuLogo getLogo(); + + + //========================================================================= + + + /** specifies whether mnemonics are automatically assigned to menu items, or not. + + @param bEnable + if <TRUE/>, mnemonics are automatically assigned to menu items. + */ + void enableAutoMnemonics( [in] boolean bEnable ); + + + //========================================================================= + + /** sets the <type>KeyEvent</type> for the menu item. + + <p>The <type>KeyEvent</type> is <b>only</b> used as a container to transport + the shortcut information, this methods only draws the text corresponding to + this keyboard shortcut. The client code is responsible for listening to + keyboard events (typicaly done via <type>XUserInputInterception</type>), + and dispatch the respective command.</p> + + @param nItemId + specifies the menu item identifier for which the <type>KeyEvent</type> should be set. + + @param aKeyEvent + specifies the <type>KeyEvent</type> for the menu item. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + void setAcceleratorKeyEvent( [in] short nItemId, [in] ::com::sun::star::awt::KeyEvent aKeyEvent ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + /** retrieves the <type>KeyEvent</type> for the menu item. + + <p>The <type>KeyEvent</type> is <b>only</b> used as a container to transport + the shortcut information, so that in this case + <member scope="::com::sun::star::lang::">EventObject::Source</member> is <NULL/>.</p> + + @param nItemId + specifies the menu item identifier for which the <type>KeyEvent</type> should be retrieved. + + @return + the <type>KeyEvent</type> struct assigned to the requested menu item. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + ::com::sun::star::awt::KeyEvent getAcceleratorKeyEvent( [in] short nItemId ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + //============================================================================= + + /** sets the help text for the menu item. + + @param nItemId + specifies the menu item identifier for which the help text should be set. + + @param sHelpText + specifies the help text for the menu item. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + void setHelpText( [in] short nItemId, [in] string sHelpText ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + /** retrieves the help text for the menu item. + + @param nItemId + specifies the menu item identifier for which the help text should be retrieved. + + @return + a string with the help text. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + string getHelpText( [in] short nItemId ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + //============================================================================= + + /** sets the tip help text for the menu item. + + @param nItemId + specifies the menu item identifier for which the tip help text should be set. + + @param sTipHelpText + specifies the tip help text for the menu item. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + void setTipHelpText( [in] short nItemId, [in] string sTipHelpText ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + /** retrieves the tip help text for the menu item. + + @param nItemId + specifies the menu item identifier for which the tip help text should be retrieved. + + @return + a string with the tip help text. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + string getTipHelpText( [in] short nItemId ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + //============================================================================= + + /** sets the image for the menu item. + + @param nItemId + specifies the menu item identifier for which the image should be set. + + @param xGraphic + specifies the image for the menu item. + + @param bScale + if <TRUE/>, the image will be scaled to the standard size used internally by + the implementation. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + void setItemImage( [in] short nItemId, + [in] ::com::sun::star::graphic::XGraphic xGraphic, + [in] boolean bScale ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + /** retrieves the image for the menu item. + + @param nItemId + specifies the menu item identifier for which the image should be retrieved. + + @return + a <type scope="::com::sun::star::graphic::">XGraphic</type> reference + to the current image for the requested menu item. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + ::com::sun::star::graphic::XGraphic getItemImage( [in] short nItemId ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + //............................................................................. + + + /** sets the rotation angle of a menu item image. + + @param nItemId + specifies the menu item identifier for which the image angle should be set. + + @param nAngle + specifies the rotation angle for the menu item image. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + void setItemImageAngle( [in] short nItemId, [in] long nAngle ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + /** retrieves the rotation angle of a menu item image. + + @param nItemId + specifies the menu item identifier for which the rotation angle should be retrieved. + + @return the rotation angle of the menu item image, or 0 if it has no rotation. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + long getItemImageAngle( [in] short nItemId ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + //............................................................................. + + /** sets the mirror mode of a menu item image. + + @param nItemId + specifies the menu item identifier for which the mirror mode should be set. + + @param bMirror + if <TRUE/>, the item image is mirrored. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + void setItemImageMirrorMode( [in] short nItemId, [in] boolean bMirror ) + raises ( ::com::sun::star::container::NoSuchElementException ); + + /** indicates whether the menu item image is mirrored. + + @param nItemId + specifies the menu item identifier for which the image mirror mode should be checked. + + @return <TRUE/> if the item image is mirrored, <FALSE/> otherwise. + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if there is no menu item with the identifier specified in <var>nItemId</var>. + + @since OOo 3.1 + */ + boolean isItemImageInMirrorMode( [in] short nItemId ) + raises ( ::com::sun::star::container::NoSuchElementException ); + +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/makefile.mk b/offapi/com/sun/star/awt/makefile.mk index 48db14da1..ff4d827a2 100644 --- a/offapi/com/sun/star/awt/makefile.mk +++ b/offapi/com/sun/star/awt/makefile.mk @@ -1,7 +1,7 @@ #************************************************************************* # # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -# +# # Copyright 2008 by Sun Microsystems, Inc. # # OpenOffice.org - a multi-platform office productivity suite @@ -325,7 +325,12 @@ IDLFILES=\ XLayoutFlow.idl\ XLayoutFlowContainer.idl\ XLayoutRoot.idl\ - XLayoutUnit.idl + XLayoutUnit.idl \ + MenuItemType.idl \ + MenuLogo.idl \ + XMenuExtended2.idl \ + XMenuBarExtended.idl \ + XPopupMenuExtended.idl # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/text/AutoTextEntry.idl b/offapi/com/sun/star/text/AutoTextEntry.idl index 4fe0843ea..daa07979e 100644 --- a/offapi/com/sun/star/text/AutoTextEntry.idl +++ b/offapi/com/sun/star/text/AutoTextEntry.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: AutoTextEntry.idl,v $ - * $Revision: 1.11 $ + * $Revision: 1.11.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,25 +29,26 @@ ************************************************************************/ #ifndef __com_sun_star_text_AutoTextEntry_idl__ #define __com_sun_star_text_AutoTextEntry_idl__ - + #ifndef __com_sun_star_text_XAutoTextEntry_idl__ #include <com/sun/star/text/XAutoTextEntry.idl> #endif - + #ifndef __com_sun_star_text_XText_idl__ #include <com/sun/star/text/XText.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: service com::sun::star::text::AutoTextEntry /** provides access to a text block in a group of - an <type>AutoTextContainer</type>.@see com::sun::star::text::AutoTextContainer + an <type>AutoTextContainer</type>. + @see com::sun::star::text::AutoTextContainer @see com::sun::star::text::AutoTextGroup */ published service AutoTextEntry @@ -57,8 +58,7 @@ published service AutoTextEntry // DocMerge from xml: service com::sun::star::text::AutoTextEntry: interface com::sun::star::text::XText - /** provides access to the <type scope="com::sun::star::drawing">Text</type> of this entry. - + /** provides access to the <type>Text</type> of this entry. */ interface com::sun::star::text::XText; @@ -67,5 +67,5 @@ published service AutoTextEntry //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/DefaultNumberingProvider.idl b/offapi/com/sun/star/text/DefaultNumberingProvider.idl index 4b84c9b5e..0451f6765 100644 --- a/offapi/com/sun/star/text/DefaultNumberingProvider.idl +++ b/offapi/com/sun/star/text/DefaultNumberingProvider.idl @@ -1,3 +1,33 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: DefaultNumberingProvider.idl,v $ + * $Revision: 1.3.818.1 $ + * + * 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_text_DefaultNumberingProvider_idl__ #define __com_sun_star_text_DefaultNumberingProvider_idl__ @@ -8,7 +38,6 @@ module com { module sun { module star { module text { //============================================================================= - /** provides access to language dependent numbering types and supports formatting of those numberings. */ @@ -19,5 +48,6 @@ published service DefaultNumberingProvider //============================================================================= }; }; }; }; + #endif diff --git a/offapi/com/sun/star/text/Shape.idl b/offapi/com/sun/star/text/Shape.idl index 6577453a4..8bd8c029d 100644 --- a/offapi/com/sun/star/text/Shape.idl +++ b/offapi/com/sun/star/text/Shape.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Shape.idl,v $ - * $Revision: 1.14 $ + * $Revision: 1.14.122.1 $ * * This file is part of OpenOffice.org. * @@ -75,7 +75,7 @@ published service Shape [property] com::sun::star::text::XTextFrame AnchorFrame; //------------------------------------------------------------------------- /** specifies how the text content is attached to its surrounding - <type scope="com::sun::star::drawing">Text</type>. + <type>Text</type>. */ [optional, property] com::sun::star::text::TextContentAnchorType AnchorType; //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/text/TextContent.idl b/offapi/com/sun/star/text/TextContent.idl index 458ab79a4..02d8d5f53 100644 --- a/offapi/com/sun/star/text/TextContent.idl +++ b/offapi/com/sun/star/text/TextContent.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextContent.idl,v $ - * $Revision: 1.10 $ + * $Revision: 1.10.122.1 $ * * This file is part of OpenOffice.org. * @@ -49,7 +49,7 @@ module com { module sun { module star { module text { //============================================================================= /** is an object which can be anchored in a text, like instances of - <type>TextFrame</type> or <type>TextFields</type>. + <type>TextFrame</type> or <type>TextField</type>. <p>If the concrete <type>TextContent</type> has a textual representation which fades into the surrounding text, then @@ -71,13 +71,12 @@ published service TextContent /** This interface is used for the attachment of this text content to the surrounding text. - */ interface com::sun::star::text::XTextContent; //------------------------------------------------------------------------- /** specifies how the text content is attached to its surrounding - <type scope="com::sun::star::drawing">Text</type>. + <type>Text</type>. */ [optional, property] com::sun::star::text::TextContentAnchorType AnchorType; diff --git a/offapi/com/sun/star/text/TextCursor.idl b/offapi/com/sun/star/text/TextCursor.idl index 919fad9d2..83093fad4 100644 --- a/offapi/com/sun/star/text/TextCursor.idl +++ b/offapi/com/sun/star/text/TextCursor.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextCursor.idl,v $ - * $Revision: 1.15 $ + * $Revision: 1.15.122.1 $ * * This file is part of OpenOffice.org. * @@ -79,7 +79,8 @@ // DocMerge from xml: service com::sun::star::text::TextCursor /** A <type>TextCursor</type> is a <type>TextRange</type> which can be moved - within a <type scope="com::sun::star::drawing">Text</type> object.@see TextRange + within a <type>Text</type> object. + @see TextRange */ published service TextCursor { diff --git a/offapi/com/sun/star/text/TextField.idl b/offapi/com/sun/star/text/TextField.idl index c8ce90110..07c32b77b 100644 --- a/offapi/com/sun/star/text/TextField.idl +++ b/offapi/com/sun/star/text/TextField.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextField.idl,v $ - * $Revision: 1.11 $ + * $Revision: 1.11.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,27 +29,27 @@ ************************************************************************/ #ifndef __com_sun_star_text_TextField_idl__ #define __com_sun_star_text_TextField_idl__ - + #ifndef __com_sun_star_beans_XPropertySet_idl__ #include <com/sun/star/beans/XPropertySet.idl> #endif - + #ifndef __com_sun_star_text_TextContent_idl__ #include <com/sun/star/text/TextContent.idl> #endif - + #ifndef __com_sun_star_text_XTextField_idl__ #include <com/sun/star/text/XTextField.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= -/** A <type scope="com::sun::star::form::component">TextField</type> is a <type>TextContent</type> which fades its +/** A <type>TextField</type> is a <type>TextContent</type> which fades its textual representation into the text range to which it is anchored. */ published service TextField @@ -97,5 +97,5 @@ published service TextField //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/TextFields.idl b/offapi/com/sun/star/text/TextFields.idl index 883fdfdfc..674dc6ff4 100644 --- a/offapi/com/sun/star/text/TextFields.idl +++ b/offapi/com/sun/star/text/TextFields.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextFields.idl,v $ - * $Revision: 1.10 $ + * $Revision: 1.10.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,33 +29,32 @@ ************************************************************************/ #ifndef __com_sun_star_text_TextFields_idl__ #define __com_sun_star_text_TextFields_idl__ - + #ifndef __com_sun_star_container_XEnumerationAccess_idl__ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - + #ifndef __com_sun_star_util_XRefreshable_idl__ #include <com/sun/star/util/XRefreshable.idl> #endif - + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: service com::sun::star::text::TextFields -/** This is a collection of <type scope="com::sun::star::form::component">TextField</type> instances. +/** This is a collection of <type>TextField</type> instances. */ published service TextFields { - // DocMerge from xml: service com::sun::star::text::TextFields: interface com::sun::star::container::XEnumerationAccess /** This interface makes it possible to create an enumeration through all text fields in this container. - <p>All elements are of type <type>XTextField</type>. + <p>All elements are of type <type>XTextField</type>.</p> */ interface com::sun::star::container::XEnumerationAccess; @@ -69,5 +68,5 @@ published service TextFields //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/TextFrame.idl b/offapi/com/sun/star/text/TextFrame.idl index b8e7676c0..73c895235 100644 --- a/offapi/com/sun/star/text/TextFrame.idl +++ b/offapi/com/sun/star/text/TextFrame.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextFrame.idl,v $ - * $Revision: 1.14 $ + * $Revision: 1.14.122.1 $ * * This file is part of OpenOffice.org. * @@ -44,8 +44,8 @@ //============================================================================= -/** specifies a rectangular shape which contains a <type scope="com::sun::star::drawing">Text</type> object - and is attached to a piece of surrounding <type scope="com::sun::star::drawing">Text</type>. +/** specifies a rectangular shape which contains a <type>Text</type> object + and is attached to a piece of surrounding <type>Text</type>. @see Text diff --git a/offapi/com/sun/star/text/TextGraphicObject.idl b/offapi/com/sun/star/text/TextGraphicObject.idl index 01d001ca1..a6c42482c 100644 --- a/offapi/com/sun/star/text/TextGraphicObject.idl +++ b/offapi/com/sun/star/text/TextGraphicObject.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextGraphicObject.idl,v $ - * $Revision: 1.12 $ + * $Revision: 1.12.122.1 $ * * This file is part of OpenOffice.org. * @@ -57,7 +57,7 @@ //============================================================================= -/** specifies a graphic which can be embedded in <type scope="com::sun::star::drawing">Text</type>. +/** specifies a graphic which can be embedded in <type>Text</type>. */ published service TextGraphicObject { diff --git a/offapi/com/sun/star/text/TextLayoutCursor.idl b/offapi/com/sun/star/text/TextLayoutCursor.idl index a78366a50..57e6a7c88 100644 --- a/offapi/com/sun/star/text/TextLayoutCursor.idl +++ b/offapi/com/sun/star/text/TextLayoutCursor.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextLayoutCursor.idl,v $ - * $Revision: 1.9 $ + * $Revision: 1.9.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,25 +29,25 @@ ************************************************************************/ #ifndef __com_sun_star_text_TextLayoutCursor_idl__ #define __com_sun_star_text_TextLayoutCursor_idl__ - + #ifndef __com_sun_star_text_TextCursor_idl__ #include <com/sun/star/text/TextCursor.idl> #endif - + #ifndef __com_sun_star_text_XPageCursor_idl__ #include <com/sun/star/text/XPageCursor.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: service com::sun::star::text::TextLayoutCursor /** A <type>TextLayoutCursor</type> is a <type>TextRange</type> which can - travel within a layout of a <type scope="com::sun::star::drawing">Text</type> object. + travel within a layout of a <type>Text</type> object. */ published service TextLayoutCursor { @@ -62,5 +62,5 @@ published service TextLayoutCursor //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/TextSection.idl b/offapi/com/sun/star/text/TextSection.idl index 4bbabb1d2..dccd7928f 100644 --- a/offapi/com/sun/star/text/TextSection.idl +++ b/offapi/com/sun/star/text/TextSection.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextSection.idl,v $ - * $Revision: 1.13 $ + * $Revision: 1.13.40.1 $ * * This file is part of OpenOffice.org. * @@ -69,7 +69,7 @@ module com { module sun { module star { module text { //============================================================================= -/** A <type>TextSection</type> is a range of complete paragraphs within a text. @ +/** A <type>TextSection</type> is a range of complete paragraphs within a text. <p>The content of the section may be the content of a link into another document, a link from the same document, or the result of a DDE diff --git a/offapi/com/sun/star/text/TextTable.idl b/offapi/com/sun/star/text/TextTable.idl index 8335f8372..d3f8d4bc1 100644 --- a/offapi/com/sun/star/text/TextTable.idl +++ b/offapi/com/sun/star/text/TextTable.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextTable.idl,v $ - * $Revision: 1.19 $ + * $Revision: 1.19.122.1 $ * * This file is part of OpenOffice.org. * @@ -93,7 +93,19 @@ /** is a table of text cells which is anchored to a surrounding text. - Create and insert a TextTable: + <p>Note: The anchor of the actual implementation for text tables + does not have a position in the text. Thus that anchor can not be + used for some operation like <member>XTextContent::attach</member> or + <member>XText::insertTextContent</member> + or other function that require the object to have a position in the text.</p> + + <p>The reason why a text table still needs an anchor is that for example + tables should be insertable via <member>XText::insertTextContent</member> + and that interface uses a parameter of that type.</p> + + @example + + <p>Create and insert a TextTable:</p> <listing> xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" ) @@ -104,17 +116,6 @@ xTextDoc.getText.insertTextContent( xTextRange, xTable, false ) </listing> - - <p>Note: The anchor of the actual implementation for text tables - does not have a position in the text. Thus that anchor can not be - used for some operation like <member>attach</member> for example or - <member scope="com::sun::star::text">insertTextContent</member> - or other function that require the object to have a position in the text.</p> - - <p>The reason why a text table still needs an anchor is that for example - tables should be insertable via <member scope="com::sun::star::text">insertTextContent</member> - and that interface uses a parameter of that type.</p> - @see com::sun::star::text::Cell @see com::sun::star::text::CellRange @see com::sun::star::text::TableColumns diff --git a/offapi/com/sun/star/text/TextViewCursor.idl b/offapi/com/sun/star/text/TextViewCursor.idl index b263842ad..86fb16f67 100644 --- a/offapi/com/sun/star/text/TextViewCursor.idl +++ b/offapi/com/sun/star/text/TextViewCursor.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: TextViewCursor.idl,v $ - * $Revision: 1.10 $ + * $Revision: 1.10.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,25 +29,26 @@ ************************************************************************/ #ifndef __com_sun_star_text_TextViewCursor_idl__ #define __com_sun_star_text_TextViewCursor_idl__ - + #ifndef __com_sun_star_text_TextLayoutCursor_idl__ #include <com/sun/star/text/TextLayoutCursor.idl> #endif - + #ifndef __com_sun_star_view_XScreenCursor_idl__ #include <com/sun/star/view/XScreenCursor.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: service com::sun::star::text::TextViewCursor /** A <type>TextViewCursor</type> is a <type>TextRange</type> which can travel - within a view of a <type scope="com::sun::star::drawing">Text</type> object.@see TextDocumentView + within a view of a <type>Text</type> object. + @see TextDocumentView */ published service TextViewCursor { @@ -62,5 +63,5 @@ published service TextViewCursor //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/XHeaderFooter.idl b/offapi/com/sun/star/text/XHeaderFooter.idl index 91402eadd..054b2b281 100644 --- a/offapi/com/sun/star/text/XHeaderFooter.idl +++ b/offapi/com/sun/star/text/XHeaderFooter.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XHeaderFooter.idl,v $ - * $Revision: 1.10 $ + * $Revision: 1.10.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,24 +29,25 @@ ************************************************************************/ #ifndef __com_sun_star_text_XHeaderFooter_idl__ #define __com_sun_star_text_XHeaderFooter_idl__ - + #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> #endif - + #ifndef __com_sun_star_text_XText_idl__ #include <com/sun/star/text/XText.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: interface com::sun::star::text::XHeaderFooter -/** @deprecated +/** @deprecated Use the properties of + <type scope="com::sun::star::style">PageProperties</type> instead */ published interface XHeaderFooter: com::sun::star::uno::XInterface { @@ -71,5 +72,5 @@ published interface XHeaderFooter: com::sun::star::uno::XInterface //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/XHeaderFooterPageStyle.idl b/offapi/com/sun/star/text/XHeaderFooterPageStyle.idl index 083ab1e9d..08414afae 100644 --- a/offapi/com/sun/star/text/XHeaderFooterPageStyle.idl +++ b/offapi/com/sun/star/text/XHeaderFooterPageStyle.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XHeaderFooterPageStyle.idl,v $ - * $Revision: 1.10 $ + * $Revision: 1.10.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,24 +29,25 @@ ************************************************************************/ #ifndef __com_sun_star_text_XHeaderFooterPageStyle_idl__ #define __com_sun_star_text_XHeaderFooterPageStyle_idl__ - + #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> #endif - + #ifndef __com_sun_star_text_XHeaderFooter_idl__ #include <com/sun/star/text/XHeaderFooter.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: interface com::sun::star::text::XHeaderFooterPageStyle -/** @deprecated +/** @deprecated Use the properties of + <type scope="com::sun::star::style">PageProperties</type> instead */ published interface XHeaderFooterPageStyle: com::sun::star::uno::XInterface { @@ -71,6 +72,6 @@ published interface XHeaderFooterPageStyle: com::sun::star::uno::XInterface //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/XTextAppendAndConvert.idl b/offapi/com/sun/star/text/XTextAppendAndConvert.idl index b096feef8..0983e914f 100644 --- a/offapi/com/sun/star/text/XTextAppendAndConvert.idl +++ b/offapi/com/sun/star/text/XTextAppendAndConvert.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XTextAppendAndConvert.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.44.1 $ * * This file is part of OpenOffice.org. * @@ -29,7 +29,7 @@ ************************************************************************/ #ifndef __com_sun_star_text_XTextAppendAndConvert_idl__ #define __com_sun_star_text_XTextAppendAndConvert_idl__ - + #ifndef __com_sun_star_text_XTextAppend_idl__ #include <com/sun/star/text/XTextAppend.idl> @@ -42,12 +42,13 @@ #endif //============================================================================= - + module com { module sun { module star { module text { //============================================================================= -/** merges the functions of XTextAppend, XTextContentAppend and XTextConvert. +/** merges the functions of <type>XTextAppend</type>, + <type>XTextContentAppend</type> and <type>XTextConvert</type>. */ interface XTextAppendAndConvert { @@ -59,5 +60,5 @@ //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/XTextFieldsSupplier.idl b/offapi/com/sun/star/text/XTextFieldsSupplier.idl index e4f126c8e..64af76fa3 100644 --- a/offapi/com/sun/star/text/XTextFieldsSupplier.idl +++ b/offapi/com/sun/star/text/XTextFieldsSupplier.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XTextFieldsSupplier.idl,v $ - * $Revision: 1.11 $ + * $Revision: 1.11.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,22 +29,22 @@ ************************************************************************/ #ifndef __com_sun_star_text_XTextFieldsSupplier_idl__ #define __com_sun_star_text_XTextFieldsSupplier_idl__ - + #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> #endif - + #ifndef __com_sun_star_container_XEnumerationAccess_idl__ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - + #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= @@ -60,7 +60,7 @@ published interface XTextFieldsSupplier: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::text::XTextFieldsSupplier::getTextFields /** @returns - the collection of <type scope="com::sun::star::form::component">TextField</type> instances + the collection of <type>TextField</type> instances in this context (i.e. this document). */ com::sun::star::container::XEnumerationAccess getTextFields(); @@ -79,5 +79,5 @@ published interface XTextFieldsSupplier: com::sun::star::uno::XInterface //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/XTextFrame.idl b/offapi/com/sun/star/text/XTextFrame.idl index 40a3e900f..532b6338f 100644 --- a/offapi/com/sun/star/text/XTextFrame.idl +++ b/offapi/com/sun/star/text/XTextFrame.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XTextFrame.idl,v $ - * $Revision: 1.11 $ + * $Revision: 1.11.122.1 $ * * This file is part of OpenOffice.org. * @@ -29,24 +29,25 @@ ************************************************************************/ #ifndef __com_sun_star_text_XTextFrame_idl__ #define __com_sun_star_text_XTextFrame_idl__ - + #ifndef __com_sun_star_text_XTextContent_idl__ #include <com/sun/star/text/XTextContent.idl> #endif - + #ifndef __com_sun_star_text_XText_idl__ #include <com/sun/star/text/XText.idl> #endif - - + + //============================================================================= - + module com { module sun { module star { module text { //============================================================================= // DocMerge from xml: interface com::sun::star::text::XTextFrame -/** provides access to the <type scope="com::sun::star::drawing">Text</type> of a <type>TextFrame</type>.@see TextFrame +/** provides access to the <type>Text</type> of a <type>TextFrame</type>. + @see TextFrame */ published interface XTextFrame: com::sun::star::text::XTextContent { @@ -55,7 +56,7 @@ published interface XTextFrame: com::sun::star::text::XTextContent // DocMerge from idl: method com::sun::star::text::XTextFrame::getText /** @returns the text within this frame. The returned interface belongs - to an object which implements the service <type scope="com::sun::star::drawing">Text</type>. + to an object which implements the service <type>Text</type>. */ com::sun::star::text::XText getText(); @@ -64,5 +65,5 @@ published interface XTextFrame: com::sun::star::text::XTextContent //============================================================================= }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/text/textfield/docinfo/Custom.idl b/offapi/com/sun/star/text/textfield/docinfo/Custom.idl new file mode 100644 index 000000000..7d422b5cc --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/Custom.idl @@ -0,0 +1,73 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: Custom.idl,v $ + * $Revision: 1.1.2.1 $ + * + * 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_text_textfield_docinfo_Custom_idl__ +#define __com_sun_star_text_textfield_docinfo_Custom_idl_ + +#include <com/sun/star/text/TextField.idl> + +//============================================================================= + +module com { module sun { module star { + module text { module textfield { module docinfo { + +//============================================================================= +/** specifies service of a text field that refers to the content of a + user-defined field in the document information. + + @since OOo 3.0 + + @see com::sun::star::text::TextField +*/ +published service Custom +{ + service com::sun::star::text::TextField; + + /** the name of the user-defined property that this field refers to. + */ + [property] string Name; + + /** contains the current content of the text field. + <p>This property is useful for import/export purposes.</p> + */ + [property] string CurrentPresentation; + + /** If this flag is set to <FALSE/>, the content is updated when + the document information changes. + */ + [property] boolean IsFixed; +}; + +//============================================================================= + +}; }; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/text/textfield/docinfo/Description.idl b/offapi/com/sun/star/text/textfield/docinfo/Description.idl index 69c851025..d8291b66e 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Description.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Description.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Description.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.1 $ * * This file is part of OpenOffice.org. * @@ -45,6 +45,8 @@ module com { module sun { module star { */ published service Description { + service com::sun::star::text::TextField; + /** contains content information. */ [property] string Content; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Info0.idl b/offapi/com/sun/star/text/textfield/docinfo/Info0.idl index a73cf3771..8623d3fd9 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Info0.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Info0.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Info0.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.2 $ * * This file is part of OpenOffice.org. * @@ -41,6 +41,8 @@ module com { module sun { module star { //============================================================================= /** specifies service of a text field that provides the Info0 field that is contained in the document information. + @deprecated this service is no longer implemented as of OOo 3.0; + use com::sun::star::text::textfield::docinfo::Custom instead. @see com::sun::star::text::TextField */ published service Info0 diff --git a/offapi/com/sun/star/text/textfield/docinfo/Info1.idl b/offapi/com/sun/star/text/textfield/docinfo/Info1.idl index 9060f3e75..b439e9522 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Info1.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Info1.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Info1.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.2 $ * * This file is part of OpenOffice.org. * @@ -41,6 +41,8 @@ module com { module sun { module star { //============================================================================= /** specifies service of a text field that provides the Info1 field that is contained in the document information. + @deprecated this service is no longer implemented as of OOo 3.0; + use com::sun::star::text::textfield::docinfo::Custom instead. @see com::sun::star::text::TextField */ published service Info1 diff --git a/offapi/com/sun/star/text/textfield/docinfo/Info2.idl b/offapi/com/sun/star/text/textfield/docinfo/Info2.idl index 1846cfae4..9bcc6570a 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Info2.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Info2.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Info2.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.2 $ * * This file is part of OpenOffice.org. * @@ -41,6 +41,8 @@ module com { module sun { module star { //============================================================================= /** specifies service of a text field that provides the Info2 field that is contained in the document information. + @deprecated this service is no longer implemented as of OOo 3.0; + use com::sun::star::text::textfield::docinfo::Custom instead. @see com::sun::star::text::TextField */ published service Info2 diff --git a/offapi/com/sun/star/text/textfield/docinfo/Info3.idl b/offapi/com/sun/star/text/textfield/docinfo/Info3.idl index fcee565df..fefaca4f8 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Info3.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Info3.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Info3.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.2 $ * * This file is part of OpenOffice.org. * @@ -41,6 +41,8 @@ module com { module sun { module star { //============================================================================= /** specifies service of a text field that provides the Info3 field that is contained in the document information. + @deprecated this service is no longer implemented as of OOo 3.0; + use com::sun::star::text::textfield::docinfo::Custom instead. @see com::sun::star::text::TextField */ published service Info3 diff --git a/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl b/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl index a18862f27..03e519fab 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Keywords.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.1 $ * * This file is part of OpenOffice.org. * @@ -45,6 +45,8 @@ module com { module sun { module star { */ published service Keywords { + service com::sun::star::text::TextField; + /** contains content information. */ [property] string Content; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Revision.idl b/offapi/com/sun/star/text/textfield/docinfo/Revision.idl index 10af5c446..4d1daadfb 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Revision.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Revision.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Revision.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.1 $ * * This file is part of OpenOffice.org. * @@ -45,6 +45,8 @@ module com { module sun { module star { */ published service Revision { + service com::sun::star::text::TextField; + /** contains content information. */ [property] string Content; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Subject.idl b/offapi/com/sun/star/text/textfield/docinfo/Subject.idl index 15cfc1d40..030485235 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Subject.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Subject.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Subject.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.1 $ * * This file is part of OpenOffice.org. * @@ -45,6 +45,8 @@ module com { module sun { module star { */ published service Subject { + service com::sun::star::text::TextField; + /** contains content information. */ [property] string Content; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Title.idl b/offapi/com/sun/star/text/textfield/docinfo/Title.idl index bd80d2df8..bd8b586e2 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Title.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Title.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: Title.idl,v $ - * $Revision: 1.4 $ + * $Revision: 1.4.122.1 $ * * This file is part of OpenOffice.org. * @@ -45,6 +45,8 @@ module com { module sun { module star { */ published service Title { + service com::sun::star::text::TextField; + /** contains content information. */ [property] string Content; diff --git a/offapi/com/sun/star/text/textfield/docinfo/makefile.mk b/offapi/com/sun/star/text/textfield/docinfo/makefile.mk index d6afcea06..3c7a877d8 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/makefile.mk +++ b/offapi/com/sun/star/text/textfield/docinfo/makefile.mk @@ -8,7 +8,7 @@ # # $RCSfile: makefile.mk,v $ # -# $Revision: 1.5 $ +# $Revision: 1.5.122.1 $ # # This file is part of OpenOffice.org. # @@ -46,7 +46,7 @@ IDLFILES=\ ChangeDateTime.idl\ CreateAuthor.idl\ CreateDateTime.idl\ - ChangeAuthor.idl\ + Custom.idl\ Description.idl\ EditTime.idl\ Info0.idl\ |