diff options
| author | Armin Le Grand <alg@apache.org> | 2013-07-27 11:40:32 +0000 |
|---|---|---|
| committer | Armin Le Grand <alg@apache.org> | 2013-07-27 11:40:32 +0000 |
| commit | 8a6f84ce896f41a7a1f97b06d1e053c51cbba95e (patch) | |
| tree | 0865afbfa9eb147e0a5be9759f932954cfb59e32 /offapi | |
| parent | 59ee09f905e86724a2ba5cdccab9210d16686820 (diff) | |
resync to trunk (close to AOO400)
Diffstat (limited to 'offapi')
85 files changed, 2909 insertions, 3328 deletions
diff --git a/offapi/com/sun/star/awt/ImageDrawMode.idl b/offapi/com/sun/star/awt/ImageDrawMode.idl new file mode 100644 index 000000000000..95889630af3c --- /dev/null +++ b/offapi/com/sun/star/awt/ImageDrawMode.idl @@ -0,0 +1,59 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_awt_ImageDrawMode_idl__ +#define __com_sun_star_awt_ImageDrawMode_idl__ + +module com { module sun { module star { module awt { + +/** defines modes how an image is drawn onto a device + + @see <member scope="com::sun::star::awt">XGraphics2::drawImage</member> + @since Apache OpenOffice 4.0 + */ +constants ImageDrawMode +{ + /** the image is drawn as is, without any color transformation. + */ + const short NONE = 0x0000; + + /** the image is drawn as if it represented a feature whose state is disabled. + */ + const short DISABLE = 0x0001; + + /** the image is drawn as being highlighted. + See <member scope="com::sun::star::awt">XStyleSettings::HighlightColor</member>. + */ + const short HIGHLIGHT = 0x0002; + + /** the image is drawn as being deactivated. + See <member scope="com::sun::star::awt">XStyleSettings::DeactiveColor</member>. + */ + const short DEACTIVE = 0x0004; + + /** the image is drawn semi-transparent. + */ + const short SEMITRANSPARENT = 0x0010; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/ImageScaleMode.idl b/offapi/com/sun/star/awt/ImageScaleMode.idl index 68c987ec79b4..ffe47228f73c 100644 --- a/offapi/com/sun/star/awt/ImageScaleMode.idl +++ b/offapi/com/sun/star/awt/ImageScaleMode.idl @@ -19,41 +19,31 @@ * *************************************************************/ - - #ifndef __com_sun_star_awt_ImageScaleMode_idl__ #define __com_sun_star_awt_ImageScaleMode_idl__ -//============================================================================= - module com { module sun { module star { module awt { -//============================================================================= - /** defines modes how an image displayed in a given area should be scaled to fit this area */ constants ImageScaleMode { /** specifies that no scaling should happen at all */ - const short None = 0; + const short NONE = 0; /** specifies that the image should be scaled up or down to the size of the surrounding area isotropicly, i.e. by keeping its aspect ratio. */ - const short Isotropic = 1; + const short ISOTROPIC = 1; - /** specifies that the image should be scaled up or down to the size of the surrounding area anisotropicly. + /** specifies that the image should be scaled up or down to the size of the surrounding area anisotropically. <p>The image will finally cover all of the surrounding area, but its dimensions might be distorted.</p> */ - const short Anisotropic = 2; + const short ANISOTROPIC = 2; }; -//============================================================================= - }; }; }; }; -//============================================================================= - #endif diff --git a/offapi/com/sun/star/awt/MenuBar.idl b/offapi/com/sun/star/awt/MenuBar.idl index f3b569ad23d2..b72ec54fabd2 100644 --- a/offapi/com/sun/star/awt/MenuBar.idl +++ b/offapi/com/sun/star/awt/MenuBar.idl @@ -19,22 +19,14 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_MenuBar_idl__ #define __com_sun_star_awt_MenuBar_idl__ -#ifndef __com_sun_star_awt_XMenuBar_idl__ #include <com/sun/star/awt/XMenuBar.idl> -#endif - -//============================================================================= module com { module sun { module star { module awt { -//============================================================================= - /** describes a menu for top-level windows. - <p>A menu bar can only be used by top-level windows. They support the interface <type scope="com::sun::star::awt">XTopWindow</type> to set an menu bar object. @@ -45,8 +37,6 @@ published service MenuBar interface XMenuBar; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/MenuEvent.idl b/offapi/com/sun/star/awt/MenuEvent.idl index b1352bbb4968..d2108251d436 100644 --- a/offapi/com/sun/star/awt/MenuEvent.idl +++ b/offapi/com/sun/star/awt/MenuEvent.idl @@ -19,35 +19,23 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_MenuEvent_idl__ #define __com_sun_star_awt_MenuEvent_idl__ -#ifndef __com_sun_star_lang_EventObject_idl__ #include <com/sun/star/lang/EventObject.idl> -#endif - - -//============================================================================= - module com { module sun { module star { module awt { - -//============================================================================= +module com { module sun { module star { module awt { /** specifies a menu event. */ published struct MenuEvent: com::sun::star::lang::EventObject { - //------------------------------------------------------------------------- - - /** contains the item id. + /** contains the item ID. */ short MenuId; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/MenuItemStyle.idl b/offapi/com/sun/star/awt/MenuItemStyle.idl index c91e93bbf009..1a741364166c 100644 --- a/offapi/com/sun/star/awt/MenuItemStyle.idl +++ b/offapi/com/sun/star/awt/MenuItemStyle.idl @@ -23,42 +23,27 @@ #ifndef __com_sun_star_awt_MenuItemStyle_idl__ #define __com_sun_star_awt_MenuItemStyle_idl__ - -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= +module com { module sun { module star { module awt { /** These values are used to specify the properties of a menu item. - - <p>They may be expanded in future versions.</p> */ -published constants MenuItemStyle +constants MenuItemStyle { - //------------------------------------------------------------------------- - /** specifies an item which can be checked independently. */ const short CHECKABLE = 1; - //------------------------------------------------------------------------- - /** specifies an item which can be checked dependent on the neighbouring items. */ const short RADIOCHECK = 2; - //------------------------------------------------------------------------- - /** specifies to check this item automatically on select. */ const short AUTOCHECK = 4; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/MenuItemType.idl b/offapi/com/sun/star/awt/MenuItemType.idl index bae896a56eb5..d667b891e1d7 100644 --- a/offapi/com/sun/star/awt/MenuItemType.idl +++ b/offapi/com/sun/star/awt/MenuItemType.idl @@ -19,19 +19,13 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_MenuItemType_idl__ #define __com_sun_star_awt_MenuItemType_idl__ - -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= +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>. + <member scope="com::sun::star::awt">XMenu::getItemType()</member>. */ published enum MenuItemType { @@ -57,8 +51,6 @@ published enum MenuItemType }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/MenuLogo.idl b/offapi/com/sun/star/awt/MenuLogo.idl deleted file mode 100644 index 4b33af60b2db..000000000000 --- a/offapi/com/sun/star/awt/MenuLogo.idl +++ /dev/null @@ -1,66 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the 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. - */ -published 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/MessageBoxButtons.idl b/offapi/com/sun/star/awt/MessageBoxButtons.idl index b6426d7c474c..a8e7e2b1619a 100644 --- a/offapi/com/sun/star/awt/MessageBoxButtons.idl +++ b/offapi/com/sun/star/awt/MessageBoxButtons.idl @@ -19,15 +19,10 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_MessageBoxButtons_idl__ #define __com_sun_star_awt_MessageBoxButtons_idl__ -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= +module com { module sun { module star { module awt { /** defines constants for the possible message box button combinations. @@ -35,8 +30,6 @@ */ constants MessageBoxButtons { - //------------------------------------------------------------------------- - /** specifies a message with "OK" button. */ const long BUTTONS_OK = 1; @@ -86,8 +79,6 @@ constants MessageBoxButtons const long DEFAULT_BUTTON_IGNORE = 0x60000; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/MessageBoxCommand.idl b/offapi/com/sun/star/awt/MessageBoxCommand.idl deleted file mode 100644 index b8207dd1e666..000000000000 --- a/offapi/com/sun/star/awt/MessageBoxCommand.idl +++ /dev/null @@ -1,65 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - -#ifndef __com_sun_star_awt_MessageBoxCommand_idl__ -#define __com_sun_star_awt_MessageBoxCommand_idl__ - - -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= - -/** specifies a message box command. - - @deprecated - */ -published constants MessageBoxCommand -{ - //------------------------------------------------------------------------- - - const short CANCEL = 0; - - //------------------------------------------------------------------------- - - const short OK = 1; - - //------------------------------------------------------------------------- - - const short YES = 2; - - //------------------------------------------------------------------------- - - const short NO = 3; - - //------------------------------------------------------------------------- - - const short RETRY = 4; - -}; - -//============================================================================= - -}; }; }; }; - -#endif diff --git a/offapi/com/sun/star/awt/MessageBoxResults.idl b/offapi/com/sun/star/awt/MessageBoxResults.idl new file mode 100644 index 000000000000..ba551fcd9f23 --- /dev/null +++ b/offapi/com/sun/star/awt/MessageBoxResults.idl @@ -0,0 +1,58 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_awt_MessageBoxResults_idl__ +#define __com_sun_star_awt_MessageBoxResults_idl__ + +module com { module sun { module star { module awt { + +/** These constants are used to specify a result of executing a <type>XMessageBox</type>. + */ +constants MessageBoxResults +{ + /** The user canceled the <type>XMessageBox</type>, by pressing "Cancel" or "Abort" button. + */ + const short CANCEL = 0; + + /** The user pressed the "Ok" button. + */ + const short OK = 1; + + /** The user pressed the "Yes" button. + */ + const short YES = 2; + + /** The user pressed the "No" button. + */ + const short NO = 3; + + /** The user pressed the "Retry" button. + */ + const short RETRY = 4; + + /** The user pressed the "Ignore" button. + */ + const short IGNORE = 5; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl b/offapi/com/sun/star/awt/MessageBoxType.idl index f22684fbd9f5..b3bfd2d37605 100644 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl +++ b/offapi/com/sun/star/awt/MessageBoxType.idl @@ -19,36 +19,36 @@ * *************************************************************/ +#ifndef __com_sun_star_awt_MessageBoxType_idl__ +#define __com_sun_star_awt_MessageBoxType_idl__ -#ifndef __com_sun_star_awt_UnoControlSimpleAnimationModel_idl__ -#define __com_sun_star_awt_UnoControlSimpleAnimationModel_idl__ +module com { module sun { module star { module awt { -#ifndef __com_sun_star_awt_UnoControlModel_idl__ -#include <com/sun/star/awt/UnoControlModel.idl> -#endif - - -//============================================================================= +/** specifies the type of a <type>XMessageBox</type>. + */ +published enum MessageBoxType +{ + /** A normal message box. + */ + MESSAGEBOX, - module com { module sun { module star { module awt { + /** A message box to inform the user about a certain event + */ + INFOBOX, -//============================================================================= + /** A message to warn the user about a certain problem. + */ + WARNINGBOX, -/** - @since OOo 2.2 - @deprecated - You should use <type>AnimatedImagesControlModel</type>. - */ + /** A message box to provide an error message to the user. + */ + ERRORBOX, -published service UnoControlSimpleAnimationModel -{ - service com::sun::star::awt::UnoControlModel; - [property] long StepTime; - [property] boolean AutoRepeat; + /** A message box to query information from the user. + */ + QUERYBOX }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/PopupMenu.idl b/offapi/com/sun/star/awt/PopupMenu.idl index d9c4c36751be..842a95ac7693 100644 --- a/offapi/com/sun/star/awt/PopupMenu.idl +++ b/offapi/com/sun/star/awt/PopupMenu.idl @@ -19,22 +19,14 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_PopupMenu_idl__ #define __com_sun_star_awt_PopupMenu_idl__ -#ifndef __com_sun_star_awt_XPopupMenu_idl__ #include <com/sun/star/awt/XPopupMenu.idl> -#endif - -//============================================================================= module com { module sun { module star { module awt { -//============================================================================= - /** describes a popup menu which is a recursive container for commands - <p>A popup menu can be used as a standalone object to display a context menu. It's also possible to use a popup menu to integrate it into another menu.</p> @@ -44,8 +36,6 @@ published service PopupMenu interface XPopupMenu; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/PopupMenuDirection.idl b/offapi/com/sun/star/awt/PopupMenuDirection.idl index 42bf4c239628..086c5c06cfb1 100644 --- a/offapi/com/sun/star/awt/PopupMenuDirection.idl +++ b/offapi/com/sun/star/awt/PopupMenuDirection.idl @@ -19,70 +19,38 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_PopupMenuDirection_idl__ #define __com_sun_star_awt_PopupMenuDirection_idl__ - -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= +module com { module sun { module star { module awt { /** These values are used to specify the direction in which a popup menu will grow. - - <p>They may be expanded in future versions.</p> */ published constants PopupMenuDirection { - //------------------------------------------------------------------------- - - /** @deprecated - */ - const short DEFAULT = 0; - - //------------------------------------------------------------------------- - - /** @deprecated - */ - const short DOWN = 1; - - //------------------------------------------------------------------------- - /** opens on execute in a default direction. */ const short EXECUTE_DEFAULT = 0; - //------------------------------------------------------------------------- - /** opens on execute downwards. */ const short EXECUTE_DOWN = 1; - //------------------------------------------------------------------------- - /** opens on execute upwards. */ const short EXECUTE_UP = 2; - //------------------------------------------------------------------------- - /** opens on execute to the left. */ const short EXECUTE_LEFT = 4; - //------------------------------------------------------------------------- - /** opens on execute to the right. */ const short EXECUTE_RIGHT = 8; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/PrinterServer.idl b/offapi/com/sun/star/awt/PrinterServer.idl index 917fe84b1c6c..31634f3a0fe1 100644 --- a/offapi/com/sun/star/awt/PrinterServer.idl +++ b/offapi/com/sun/star/awt/PrinterServer.idl @@ -29,7 +29,7 @@ interface XPrinterServer; /** manages several printers on one machine. - @since Apache OpenOffice 3.5 + @since Apache OpenOffice 4.0 */ service PrinterServer : XPrinterServer { diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl b/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl deleted file mode 100644 index d465a1177f80..000000000000 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl +++ /dev/null @@ -1,58 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - -#ifndef __com_sun_star_awt_UnoControlSimpleAnimation_idl__ -#define __com_sun_star_awt_UnoControlSimpleAnimation_idl__ - -#ifndef __com_sun_star_awt_UnoControl_idl__ -#include <com/sun/star/awt/UnoControl.idl> -#endif - -#ifndef __com_sun_star_awt_XSimpleAnimation_idl__ -#include <com/sun/star/awt/XSimpleAnimation.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= - -/** - @since OOo 2.2 - @deprecated - You should use <type>AnimatedImagesControl</type>. - */ -published service UnoControlSimpleAnimation -{ - service com::sun::star::awt::UnoControl; - interface com::sun::star::awt::XSimpleAnimation; - -}; - -//============================================================================= - -}; }; }; }; - - -#endif diff --git a/offapi/com/sun/star/awt/UnoControlThrobber.idl b/offapi/com/sun/star/awt/UnoControlThrobber.idl deleted file mode 100644 index 6a56b7e5e0ac..000000000000 --- a/offapi/com/sun/star/awt/UnoControlThrobber.idl +++ /dev/null @@ -1,58 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - -#ifndef __com_sun_star_awt_UnoControlThrobber_idl__ -#define __com_sun_star_awt_UnoControlThrobber_idl__ - -#ifndef __com_sun_star_awt_UnoControl_idl__ -#include <com/sun/star/awt/UnoControl.idl> -#endif - -#ifndef __com_sun_star_awt_XThrobber_idl__ -#include <com/sun/star/awt/XThrobber.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= - -/** - @since OOo 2.2 - @deprecated - You should use <type>AnimatedImagesControl</type> and <type>SpinningProgressControlModel</type>. - */ -published service UnoControlThrobber -{ - service com::sun::star::awt::UnoControl; - interface com::sun::star::awt::XThrobber; - -}; - -//============================================================================= - -}; }; }; }; - - -#endif diff --git a/offapi/com/sun/star/awt/WindowDescriptor.idl b/offapi/com/sun/star/awt/WindowDescriptor.idl index b91114150af0..b22a5a1c2a32 100644 --- a/offapi/com/sun/star/awt/WindowDescriptor.idl +++ b/offapi/com/sun/star/awt/WindowDescriptor.idl @@ -106,10 +106,8 @@ published struct WindowDescriptor <li>radiobutton</li> <li>scrollbar</li> <li>scrollbarbox</li> - <li>simpleanimation</li> <li>spinbutton</li> <li>spinfield</li> - <li>throbber</li> <li>splitter</li> <li>splitwindow</li> <li>statusbar</li> diff --git a/offapi/com/sun/star/awt/XGraphics.idl b/offapi/com/sun/star/awt/XGraphics.idl index 99b74e89182c..7c0007865d95 100644 --- a/offapi/com/sun/star/awt/XGraphics.idl +++ b/offapi/com/sun/star/awt/XGraphics.idl @@ -19,132 +19,90 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_XGraphics_idl__ #define __com_sun_star_awt_XGraphics_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_util_Color_idl__ #include <com/sun/star/util/Color.idl> -#endif - -#ifndef __com_sun_star_awt_SimpleFontMetric_idl__ #include <com/sun/star/awt/SimpleFontMetric.idl> -#endif - -#ifndef __com_sun_star_awt_FontDescriptor_idl__ #include <com/sun/star/awt/FontDescriptor.idl> -#endif - -#ifndef __com_sun_star_awt_RasterOperation_idl__ #include <com/sun/star/awt/RasterOperation.idl> -#endif - -#ifndef __com_sun_star_awt_Gradient_idl__ #include <com/sun/star/awt/Gradient.idl> -#endif +#include <com/sun/star/awt/Rectangle.idl> +#include <com/sun/star/graphic/XGraphic.idl> -//============================================================================= +module com { module sun { module star { module awt { - module com { module sun { module star { module awt { - - published interface XRegion; - published interface XDisplayBitmap; - published interface XFont; - published interface XDevice; - -//============================================================================= +published interface XRegion; +published interface XDisplayBitmap; +published interface XFont; +published interface XDevice; /** provides the basic output operation of a device. */ published interface XGraphics: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - /** returns the device of this graphics. + /** the device of this graphics */ - XDevice getDevice(); + [attribute, readonly] XDevice Device; - //------------------------------------------------------------------------- - - /** returns the font metric of the current font. + /** the text color used by text operations. */ - SimpleFontMetric getFontMetric(); - - //------------------------------------------------------------------------- + [attribute] com::sun::star::util::Color TextColor; - /** sets the font used by text operations. + /** the fill color used by text operations. */ - [oneway] void setFont( [in] XFont xNewFont ); + [attribute] com::sun::star::util::Color TextFillColor; - //------------------------------------------------------------------------- - - /** creates a new font and sets the font. + /** the line color. */ - [oneway] void selectFont( [in] FontDescriptor aDescription ); - - //------------------------------------------------------------------------- + [attribute] com::sun::star::util::Color LineColor; - /** sets the text color used by text operations. + /** the fill color. */ - [oneway] void setTextColor( [in] com::sun::star::util::Color nColor ); + [attribute] com::sun::star::util::Color FillColor; - //------------------------------------------------------------------------- + /** the raster operation. - /** sets the fill color used by text operations. + <p>If the device does not support raster operations, + this attribute is ignored.</p> */ - [oneway] void setTextFillColor( [in] com::sun::star::util::Color nColor ); + [attribute] RasterOperation RasterOp; - //------------------------------------------------------------------------- - - /** sets the line color. + /** the font used by text operations. */ - [oneway] void setLineColor( [in] com::sun::star::util::Color nColor ); - - //------------------------------------------------------------------------- + [attribute] XFont Font; - /** sets the fill color. + /** the font metric of the current font. */ - [oneway] void setFillColor( [in] com::sun::star::util::Color nColor ); + [attribute, readonly] SimpleFontMetric FontMetric; - //------------------------------------------------------------------------- - - /** sets the raster operation. - - <p>If the device does not support raster operations - then this call is ignored.</p> + /** creates a new font and sets the font. */ - [oneway] void setRasterOp( [in] RasterOperation ROP ); - - //------------------------------------------------------------------------- + [oneway] void selectFont( [in] FontDescriptor aDescription ); /** sets the clip region to specified clipping. */ [oneway] void setClipRegion( [in] XRegion Clipping ); - //------------------------------------------------------------------------- - /** builds the intersection with the current region. */ [oneway] void intersectClipRegion( [in] XRegion xClipping ); - //------------------------------------------------------------------------- - /** saves all current settings (Font, TextColor, TextFillColor, LineColor, FillColor, RasterOp, ClipRegion). */ [oneway] void push(); - //------------------------------------------------------------------------- - /** restores all previous saved settings. */ [oneway] void pop(); - //------------------------------------------------------------------------- + /** clears the given rectangle on the device + + @since Apache OpenOffice 4.0 + */ + [oneway] void clear( [in] Rectangle aRect ); /** copies a rectangle of pixels from another device into this one. */ @@ -158,8 +116,6 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long nDestWidth, [in] long nDestHeight ); - //------------------------------------------------------------------------- - /** draws a part of the specified bitmap to the output device. */ [oneway] void draw( [in] XDisplayBitmap xBitmapHandle, @@ -172,15 +128,11 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long DestWidth, [in] long DestHeight ); - //------------------------------------------------------------------------- - /** sets a single pixel in the output device. */ [oneway] void drawPixel( [in] long X, [in] long Y ); - //------------------------------------------------------------------------- - /** draws a line in the output device. */ [oneway] void drawLine( [in] long X1, @@ -188,8 +140,6 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long X2, [in] long Y2 ); - //------------------------------------------------------------------------- - /** draws a rectangle in the output device. */ [oneway] void drawRect( [in] long X, @@ -197,8 +147,6 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long Width, [in] long Height ); - //------------------------------------------------------------------------- - /** draws a rectangle with rounded corners in the output device. */ [oneway] void drawRoundedRect( [in] long X, @@ -208,29 +156,21 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long nHorzRound, [in] long nVertRound ); - //------------------------------------------------------------------------- - /** draws multiple lines in the output device at once. */ [oneway] void drawPolyLine( [in] sequence<long> DataX, [in] sequence<long> DataY ); - //------------------------------------------------------------------------- - /** draws a polygon line in the output device. */ [oneway] void drawPolygon( [in] sequence<long> DataX, [in] sequence<long> DataY ); - //------------------------------------------------------------------------- - /** draws multiple polygons in the output device at once. */ [oneway] void drawPolyPolygon( [in] sequence< sequence<long> > DataX, [in] sequence< sequence<long> > DataY ); - //------------------------------------------------------------------------- - /** draws an ellipse in the output device. */ [oneway] void drawEllipse( [in] long X, @@ -238,8 +178,6 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long Width, [in] long Height ); - //------------------------------------------------------------------------- - /** draws an arc (part of a circle) in the output device. */ [oneway] void drawArc( [in] long X, @@ -251,8 +189,6 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long X2, [in] long Y2 ); - //------------------------------------------------------------------------- - /** draws a circular area in the output device. */ [oneway] void drawPie( [in] long X, @@ -264,8 +200,6 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long X2, [in] long Y2 ); - //------------------------------------------------------------------------- - /** draws a chord of a circular area in the output device. <p>A chord is a segment of a circle. You get two chords from a @@ -281,8 +215,6 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long nX2, [in] long nY2 ); - //------------------------------------------------------------------------- - /** draws a color dispersion in the output device. */ [oneway] void drawGradient( [in] long nX, @@ -291,16 +223,12 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] long Height, [in] Gradient aGradient ); - //------------------------------------------------------------------------- - /** draws text in the output device. */ [oneway] void drawText( [in] long X, [in] long Y, [in] string Text ); - //------------------------------------------------------------------------- - /** draws texts in the output device using an explicit kerning table. */ [oneway] void drawTextArray( [in] long X, @@ -308,9 +236,41 @@ published interface XGraphics: com::sun::star::uno::XInterface [in] string Text, [in] sequence<long> Longs ); -}; + /** draws a <type scope="com::sun::star::graphic">XGraphic</type> + in the output device. + + <p>Note that some devices may not support this operation.</p> + + @since Apache OpenOffice 4.0 + + @param nX + the X coordinate on the device where the graphic will be drawn -//============================================================================= + @param nY + the Y coordinate on the device where the graphic will be drawn + + @param nWidth + the width of the region on the device + + @param nHeight + the height of the region on the device + + @param nStyle + the style used to draw the image. + See <type scope="com::sun::star::awt">ImageDrawMode</type>. + + @param aGraphic + the <type scope="com::sun::star::graphic">XGraphic</type> + to be drawn onto the device + */ + [oneway] void drawImage( [in] long nX, + [in] long nY, + [in] long nWidth, + [in] long nHeight, + [in] short nStyle, + [in] ::com::sun::star::graphic::XGraphic aGraphic ); + +}; }; }; }; }; diff --git a/offapi/com/sun/star/awt/XMenu.idl b/offapi/com/sun/star/awt/XMenu.idl index 24c5467efa3c..c95f6591d976 100644 --- a/offapi/com/sun/star/awt/XMenu.idl +++ b/offapi/com/sun/star/awt/XMenu.idl @@ -19,120 +19,282 @@ * *************************************************************/ - #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 - - -//============================================================================= - - module com { module sun { module star { module awt { +#include <com/sun/star/awt/MenuItemType.idl> - published interface XPopupMenu; - published interface XMenuListener; +module com { module sun { module star { module awt { -//============================================================================= +published interface XPopupMenu; +published interface XMenuListener; /** specifies a simple menu. */ published interface XMenu: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - /** adds the specified menu listener to receive events from this menu. + + @param xListener + the <type>XMenuListener</type> to be added. */ [oneway] void addMenuListener( [in] XMenuListener xListener ); - //------------------------------------------------------------------------- - /** removes the specified menu listener so that it no longer receives events from this menu. + + @param xListener + the <type>XMenuListener</type> to be removed. */ [oneway] void removeMenuListener( [in] XMenuListener xListener ); - //------------------------------------------------------------------------- - /** inserts an item into the menu. - <p>The item is appended if the position is greater than or equal to - <code>getItemCount()</code> or if it is negative.</p> + <member>getItemCount()</member> or if it is negative.</p> + + @param nItemId + specifies the ID of the menu item to be insterted. + + @param aText + specifies the label of the menu item. + + @param nItemStyle + specifies the style of the menu item, as defined in + <type>MenuItemStyle</type>. + + @param nItemPos + specifies the position where the menu item will be insterted. */ [oneway] void insertItem( [in] short nItemId, - [in] string aText, - [in] short nItemStyle, - [in] short nPos ); - - //------------------------------------------------------------------------- + [in] string aText, + [in] short nItemStyle, + [in] short nItemPos ); /** removes one or more items from the menu. + + @param nItemPos + specifies the position of the (first) menu item to be removed. + + @param nCount + specifies the number of menu items to remove. */ - [oneway] void removeItem( [in] short nPos, - [in] short nCount ); + [oneway] void removeItem( [in] short nItemPos, + [in] short nCount ); - //------------------------------------------------------------------------- + /** removes all items from the menu. + */ + void clear(); /** returns the number of items in the menu. + + @return + the number of items in this <type>XMenu</type>. */ short getItemCount(); - //------------------------------------------------------------------------- + /** returns the ID of the item at the specified position. - /** returns the id of the item at the specified position. + @param nItemPos + specifies the position of the menu item for which the item ID is queried. + + @return + the ID of the menu item at the given position. */ - short getItemId( [in] short nPos ); + short getItemId( [in] short nItemPos ); + + /** returns the position of the item with the specified ID. - //------------------------------------------------------------------------- + @param nItemId + specifies the ID of the menu item for which the item position is queried. - /** returns the position of the item with the specified id. + @return + the position of the menu item with the specified ID. */ - short getItemPos( [in] short nId ); + short getItemPos( [in] short nItemId ); - //------------------------------------------------------------------------- + /** retrieves the type of the menu item. + + @param nItemPos + specifies the position of the menu item for which the item type is queried. + + @return + a <type>MenuItemType</type> indicating the item type. + */ + ::com::sun::star::awt::MenuItemType getItemType( [in] short nItemPos ); /** enables or disables the menu item. + + @param nItemId + specifies the menu item ID. + + @param bEnable + specifies whether the menu item should be enabled (<TRUE/>) or + disabled (<FALSE/>). */ [oneway] void enableItem( [in] short nItemId, - [in] boolean bEnable ); - - //------------------------------------------------------------------------- + [in] boolean bEnable ); /** returns the state of the menu item. + + @param nItemId + specifies the menu item ID. + + @return + <TRUE/> if the item is enabled, <FALSE/> otherwise. */ boolean isItemEnabled( [in] short nItemId ); - //------------------------------------------------------------------------- + /** specifies whether disabled menu entries should be hidden, or not. + + @param bHide + if <TRUE/>, disabled menu entries are hidden. + */ + void hideDisabledEntries( [in] boolean bHide ); + + /** 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 text for the menu item. + + @param nItemId + specifies the ID of the menu item. + + @param aText + specifies the label of the menu item. */ [oneway] void setItemText( [in] short nItemId, - [in] string aText ); - - //------------------------------------------------------------------------- + [in] string aText ); /** returns the string for the given item id. + + @param nItemId + specifies the ID of the menu item. + + @return + the label of the menu item. */ string getItemText( [in] short nItemId ); - //------------------------------------------------------------------------- + /** sets the command string for the menu item. + + @param nItemId + specifies the menu item ID for which the command should be set. + + @param aCommand + 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. + + @return + the command of the menu item. + */ + string getCommand( [in] short nItemId ); + + /** sets the help command string for the menu item. + + @param nItemId + specifies the menu item ID for which the help command URL be set. + + @param aCommand + specifies the help command for the menu item. + */ + void setHelpCommand( [in] short nItemId, + [in] string aCommand ); + + /** retrieves the help command string for the menu item. + + @param nItemId + specifies the menu item ID for which the help command should be set. + + @return + the help command of the menu item. + */ + string getHelpCommand( [in] short nItemId ); + + /** 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. + */ + void setHelpText( [in] short nItemId, + [in] string sHelpText ); + + /** 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. + */ + string getHelpText( [in] short nItemId ); + + /** 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. + */ + void setTipHelpText( [in] short nItemId, + [in] string sTipHelpText ); + + /** 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. + */ + string getTipHelpText( [in] short nItemId ); + + /** 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(); /** sets the popup menu for a specified menu item. + + @param nItemId + specifies the menu item ID for which the <type>XPopupMenu</type> should be set. + + @param aPopupMenu + specifies a <type>XPopupMenu</type>. */ [oneway] void setPopupMenu( [in] short nItemId, - [in] XPopupMenu aPopupMenu ); - - //------------------------------------------------------------------------- + [in] XPopupMenu aPopupMenu ); /** returns the popup menu from the menu item. + + @param nItemId + specifies the menu item ID for which the <type>XPopupMenu</type> should be retrieved. + + @return + a <type>XPopupMenu</type>. */ XPopupMenu getPopupMenu( [in] short nItemId ); }; - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/XMenuBar.idl b/offapi/com/sun/star/awt/XMenuBar.idl index 606eef832bb8..b5429594dd66 100644 --- a/offapi/com/sun/star/awt/XMenuBar.idl +++ b/offapi/com/sun/star/awt/XMenuBar.idl @@ -19,29 +19,19 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_XMenuBar_idl__ #define __com_sun_star_awt_XMenuBar_idl__ -#ifndef __com_sun_star_awt_XMenu_idl__ #include <com/sun/star/awt/XMenu.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module awt { - -//============================================================================= +module com { module sun { module star { module awt { /** identifies a menu bar. */ -published interface XMenuBar: com::sun::star::awt::XMenu +published interface XMenuBar: XMenu { }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/XMenuBarExtended.idl b/offapi/com/sun/star/awt/XMenuBarExtended.idl deleted file mode 100644 index 3720e095c2d1..000000000000 --- a/offapi/com/sun/star/awt/XMenuBarExtended.idl +++ /dev/null @@ -1,65 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the 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 deleted file mode 100644 index 33d6cf8ffc14..000000000000 --- a/offapi/com/sun/star/awt/XMenuExtended.idl +++ /dev/null @@ -1,76 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - -#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 { - -/** specifies extended menu functions. - */ - -published interface XMenuExtended: com::sun::star::uno::XInterface -{ - /** sets the command string for the menu item. - - @param nItemId - specifies the menu item ID for which the command should be set. - - @param aCommand - 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 - specifies the menu item ID for which the help command URL be set. - - @param aCommand - 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 diff --git a/offapi/com/sun/star/awt/XMenuExtended2.idl b/offapi/com/sun/star/awt/XMenuExtended2.idl deleted file mode 100644 index cbdb73483283..000000000000 --- a/offapi/com/sun/star/awt/XMenuExtended2.idl +++ /dev/null @@ -1,108 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the 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. - */ - -published 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/XMenuListener.idl b/offapi/com/sun/star/awt/XMenuListener.idl index cdf9ebbead79..144c3fd254d6 100644 --- a/offapi/com/sun/star/awt/XMenuListener.idl +++ b/offapi/com/sun/star/awt/XMenuListener.idl @@ -23,53 +23,33 @@ #ifndef __com_sun_star_awt_XMenuListener_idl__ #define __com_sun_star_awt_XMenuListener_idl__ -#ifndef __com_sun_star_lang_XEventListener_idl__ #include <com/sun/star/lang/XEventListener.idl> -#endif - -#ifndef __com_sun_star_awt_MenuEvent_idl__ #include <com/sun/star/awt/MenuEvent.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module awt { -//============================================================================= +module com { module sun { module star { module awt { /** makes it possible to receive menu events on a window. */ published interface XMenuListener: com::sun::star::lang::XEventListener { - //------------------------------------------------------------------------- - /** is invoked when a menu item is highlighted. */ - [oneway] void highlight( [in] com::sun::star::awt::MenuEvent rEvent ); - - //------------------------------------------------------------------------- + [oneway] void itemHighlighted( [in] MenuEvent aEvent ); /** is invoked when a menu item is selected. */ - [oneway] void select( [in] com::sun::star::awt::MenuEvent rEvent ); - - //------------------------------------------------------------------------- + [oneway] void itemSelected( [in] MenuEvent aEvent ); /** is invoked when a menu is activated. */ - [oneway] void activate( [in] com::sun::star::awt::MenuEvent rEvent ); - - //------------------------------------------------------------------------- + [oneway] void itemActivated( [in] MenuEvent aEvent ); /** is invoked when a menu is deactivated. */ - [oneway] void deactivate( [in] com::sun::star::awt::MenuEvent rEvent ); + [oneway] void itemDeactivated( [in] MenuEvent aEvent ); }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/XMessageBox.idl b/offapi/com/sun/star/awt/XMessageBox.idl index ed27f15fc8e7..951e42e4a061 100644 --- a/offapi/com/sun/star/awt/XMessageBox.idl +++ b/offapi/com/sun/star/awt/XMessageBox.idl @@ -19,61 +19,33 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_XMessageBox_idl__ #define __com_sun_star_awt_XMessageBox_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 { /** gives access to a message box. - - @deprecated */ -published interface XMessageBox: com::sun::star::uno::XInterface +published interface XMessageBox { - //------------------------------------------------------------------------- - - /** sets the caption text. - */ - [oneway] void setCaptionText( [in] string aText ); - - //------------------------------------------------------------------------- - - /** returns the caption text. + /** the caption text. */ - string getCaptionText(); - - //------------------------------------------------------------------------- - - /** sets the message text. - */ - [oneway] void setMessageText( [in] string aText ); - - //------------------------------------------------------------------------- + [attribute] string CaptionText; - /** returns the message text. + /** the message text. */ - string getMessageText(); - - //------------------------------------------------------------------------- + [attribute] string MessageText; /** shows the message box. + + @return + one of <type>MessageBoxResults</type>. */ short execute(); - }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/XMessageBoxFactory.idl b/offapi/com/sun/star/awt/XMessageBoxFactory.idl index 99875a186971..bf1b8b752a8d 100644 --- a/offapi/com/sun/star/awt/XMessageBoxFactory.idl +++ b/offapi/com/sun/star/awt/XMessageBoxFactory.idl @@ -19,86 +19,56 @@ * *************************************************************/ - - #ifndef __com_sun_star_awt_XMessageBoxFactory_idl__ #define __com_sun_star_awt_XMessageBoxFactory_idl__ -#ifndef __com_sun_star_awt_XWindowPeer_idl__ #include <com/sun/star/awt/XWindowPeer.idl> -#endif - -#ifndef __com_sun_star_awt_XMessageBox_idl__ #include <com/sun/star/awt/XMessageBox.idl> -#endif - -#ifndef __com_sun_star_awt_MessageBoxButtons_idl__ #include <com/sun/star/awt/MessageBoxButtons.idl> -#endif - -#ifndef __com_sun_star_awt_Rectangle_idl__ -#include <com/sun/star/awt/Rectangle.idl> -#endif - - -//============================================================================= +#include <com/sun/star/awt/MessageBoxType.idl> module com { module sun { module star { module awt { -//============================================================================= - /** specifies a factory interface for creating message boxes. */ published interface XMessageBoxFactory : com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - /** creates a message box. @returns - the created message box or a null reference if it cannot be - created. + the created message box or a null reference if it cannot be + created. @param aParent - a valid XWindowPeer reference which is used as a parent. This parameter - must not be null. + a valid XWindowPeer reference which is used as a parent. - @param aPosSize - a rectangle which defines the position and size of the message - box in pixel. + <p>This parameter must not be null.</p> @param aType - a string which determines the message box type. - The following strings are defined. - <ul> - <li><b>infobox</b>A message box to inform the user about a certain event. - <b>Attention:</b><br/>This type of message box ignores the argument - aButton because a info box always shows a OK button. - </li> - <li><b>warningbox</b>A message to warn the user about a certain problem.</li> - <li><b>errorbox</b>A message box to provide an error message to the user.</li> - <li><b>querybox</b>A message box to query information from the user.</li> - <li><b>messbox</b>A normal message box.</li> - </ul> + the message box type. @param aButtons - specifies which buttons should be available on the - message box. A combination of - <type scope="com::sun::star::awt">MessageBoxButtons</type>. An <b>infobox</b> - ignores this paramter and always use button "OK". + specifies which buttons should be available on the message box. + + <p>A combination of <type>MessageBoxButtons</type>.</p> + <p>A <member scope="com::sun::star::awt">MessageBoxType::INFOBOX</member> + ignores this paramter, instead it uses a + <member scope="com::sun::star::awt">MessageBoxButtons::BUTTONS_OK</member>.</p> @param aTitle - specifies the title of the message box. + specifies the title of the message box. @param aMessage - specifies text which will be shown by the message box. - Line-breaks must be added using 'CR' or 'CR+LF'. + specifies text which will be shown by the message box. + Line-breaks must be added using 'CR' or 'CR+LF'. */ - XMessageBox createMessageBox( [in] com::sun::star::awt::XWindowPeer aParent, [in] com::sun::star::awt::Rectangle aPosSize, [in] string aType, [in] long aButtons, [in] string aTitle, [in] string aMessage ); + XMessageBox createMessageBox( [in] com::sun::star::awt::XWindowPeer aParent, + [in] MessageBoxType eType, + [in] long nButtons, + [in] string sTitle, + [in] string sMessage ); }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/awt/XPopupMenu.idl b/offapi/com/sun/star/awt/XPopupMenu.idl index b0061ab39c89..ad2998ec0db5 100644 --- a/offapi/com/sun/star/awt/XPopupMenu.idl +++ b/offapi/com/sun/star/awt/XPopupMenu.idl @@ -19,73 +19,167 @@ * *************************************************************/ - #ifndef __com_sun_star_awt_XPopupMenu_idl__ #define __com_sun_star_awt_XPopupMenu_idl__ -#ifndef __com_sun_star_awt_XMenu_idl__ -#include <com/sun/star/awt/XMenu.idl> -#endif - -#ifndef __com_sun_star_awt_Rectangle_idl__ +#include <com/sun/star/awt/KeyEvent.idl> #include <com/sun/star/awt/Rectangle.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module awt { +#include <com/sun/star/awt/XMenu.idl> +#include <com/sun/star/graphic/XGraphic.idl> - published interface XWindowPeer; +module com { module sun { module star { module awt { -//============================================================================= +published interface XWindowPeer; /** controls a popup menu. */ published interface XPopupMenu: XMenu { - //------------------------------------------------------------------------- - /** inserts a separator at the specified position. - */ - [oneway] void insertSeparator( [in] short nPos ); - //------------------------------------------------------------------------- + @param nItemPos + specifies the position where the menu separator will be insterted. + */ + [oneway] void insertSeparator( [in] short nItemPos ); /** sets the menu default item. + + @param nItemId + specifies the menu item identifier. */ [oneway] void setDefaultItem( [in] short nItemId ); - //------------------------------------------------------------------------- - /** returns the menu default item. + + @return + the ID of the default item. */ short getDefaultItem(); - //------------------------------------------------------------------------- - /** sets the state of the item to be checked or unchecked. + + @param nItemId + specifies the menu item identifier. + + @param bCheck + specifies if the item is checked (<TRUE/>) or unchecked (<FALSE/>). */ [oneway] void checkItem( [in] short nItemId, - [in] boolean bCheck ); - - //------------------------------------------------------------------------- + [in] boolean bCheck ); /** returns whether the item is checked or unchecked. + + @param nItemId + specifies the menu item identifier. + + @return + <TRUE/> if the item is checked, <FALSE/> otherwise. */ boolean isItemChecked( [in] short nItemId ); - //------------------------------------------------------------------------- - /** executes the popup menu and returns the selected item or <code>0</code>, if cancelled. + + @param Parent + the parent window. + + @param Position + a <type>Rectangle</type> representing the coordinates system + where the popup menu should be executed. + + @param Direction + the direction in which a popup menu will grow, as specified + by one of the <type>PopupMenuDirection</type> constants. + + @return + returns the selected item or <code>0</code>, if cancelled. */ short execute( [in] XWindowPeer Parent, - [in] Rectangle Area, - [in] short Direction ); + [in] Rectangle Position, + [in] short Direction ); -}; + /** queries if the <type>PopupMenu</type> is being. + + <p>Returns <TRUE/> only if the <type>PopupMenu</type> is being executed + as a result of invoking <member >XPopupMenu::execute()</member>; that is, + for a <type>PopupMenu</type> activated by a <type>MenuBar</type> item, + this methods returns <FALSE/>.</p> + + @return + <TRUE/> if the <type>PopupMenu</type> is being executed, + <FALSE/> otherwise. + + @see <member >XPopupMenu::execute()</member> + */ + boolean isInExecute(); + + /** ends the execution of the <type>PopupMenu</type>. + <p><member scope="com::sun::star::awt">XPopupMenu::execute()</member> + will then return 0.</p> + + @see <member scope="com::sun::star::awt">XPopupMenu::execute()</member> + */ + void endExecute(); + + /** 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. + */ + void setAcceleratorKeyEvent( [in] short nItemId, + [in] KeyEvent aKeyEvent ); + + /** 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. + */ + KeyEvent getAcceleratorKeyEvent( [in] short nItemId ); + + /** 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. + */ + void setItemImage( [in] short nItemId, + [in] ::com::sun::star::graphic::XGraphic xGraphic, + [in] boolean bScale ); + + /** 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. + */ + ::com::sun::star::graphic::XGraphic getItemImage( [in] short nItemId ); + +}; }; }; }; }; diff --git a/offapi/com/sun/star/awt/XPopupMenuExtended.idl b/offapi/com/sun/star/awt/XPopupMenuExtended.idl deleted file mode 100644 index 7b98261ba82c..000000000000 --- a/offapi/com/sun/star/awt/XPopupMenuExtended.idl +++ /dev/null @@ -1,357 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the 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 - */ -published 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/grid/XGridColumn.idl b/offapi/com/sun/star/awt/grid/XGridColumn.idl index 61fb57d2c9ee..6508b7f6f35e 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumn.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumn.idl @@ -96,7 +96,7 @@ published interface XGridColumn */ [attribute] ::com::sun::star::style::HorizontalAlignment HorizontalAlign; - /** A title is displayed in the colum header row if <method>UnoControlGridModel::ShowRowHeader</method> is set to <true/>**/ + /** A title is displayed in the colum header row if <method>UnoControlGridModel::ShowColumnHeader</method> is set to <true/>**/ [attribute] string Title; /** is the help text associated with the column. diff --git a/offapi/com/sun/star/awt/makefile.mk b/offapi/com/sun/star/awt/makefile.mk index a89065a909e8..6aff8119ae4e 100644 --- a/offapi/com/sun/star/awt/makefile.mk +++ b/offapi/com/sun/star/awt/makefile.mk @@ -100,6 +100,7 @@ IDLFILES=\ Gradient.idl\ GradientStyle.idl\ ImageAlign.idl\ + ImageDrawMode.idl\ ImagePosition.idl\ ImageScaleMode.idl\ ImageStatus.idl\ @@ -116,7 +117,8 @@ IDLFILES=\ MenuEvent.idl\ MenuItemStyle.idl\ MessageBoxButtons.idl\ - MessageBoxCommand.idl\ + MessageBoxResults.idl\ + MessageBoxType.idl\ MouseButton.idl\ MouseEvent.idl\ MouseWheelBehavior.idl\ @@ -190,12 +192,8 @@ IDLFILES=\ UnoControlRoadmapModel.idl\ UnoControlScrollBar.idl\ UnoControlScrollBarModel.idl\ - UnoControlSimpleAnimation.idl\ - UnoControlSimpleAnimationModel.idl\ UnoControlSpinButton.idl\ UnoControlSpinButtonModel.idl\ - UnoControlThrobber.idl\ - UnoControlThrobberModel.idl\ UnoControlTimeField.idl\ UnoControlTimeFieldModel.idl\ VclContainerEvent.idl\ @@ -287,9 +285,7 @@ IDLFILES=\ XSystemDependentMenuPeer.idl\ XSystemDependentWindowPeer.idl\ SystemDependentXWindow.idl\ - XSimpleAnimation.idl\ XSimpleTabController.idl\ - XThrobber.idl\ XTabController.idl\ XTabControllerModel.idl\ XTabListener.idl\ @@ -317,7 +313,6 @@ IDLFILES=\ XWindowListener.idl\ XWindowListener2.idl\ XWindowPeer.idl\ - XMenuExtended.idl\ MaxChildrenException.idl\ XDialog2.idl\ XLayoutContainer.idl\ @@ -326,10 +321,6 @@ IDLFILES=\ XLayoutRoot.idl\ XLayoutUnit.idl \ MenuItemType.idl \ - MenuLogo.idl \ - XMenuExtended2.idl \ - XMenuBarExtended.idl \ - XPopupMenuExtended.idl \ XItemList.idl \ XItemListListener.idl \ ItemListEvent.idl \ diff --git a/offapi/com/sun/star/chart2/CurveStyle.idl b/offapi/com/sun/star/chart2/CurveStyle.idl index 2e7cf5be0fc0..97f594988f83 100644 --- a/offapi/com/sun/star/chart2/CurveStyle.idl +++ b/offapi/com/sun/star/chart2/CurveStyle.idl @@ -45,9 +45,8 @@ enum CurveStyle */ CUBIC_SPLINES, - /** Data points are connected via a smoothed B-spline curve. The - data points themselves are not necessarily part of to the - curve. + /** Data points are connected via a parametric, interpolating + B-spline curve. */ B_SPLINES, diff --git a/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl b/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl index 4ce72fadf650..5eccdc85ba1b 100644 --- a/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl +++ b/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl @@ -19,25 +19,13 @@ * *************************************************************/ - - #ifndef __com_sun_star_frame_PopupMenuControllerFactory_idl__ #define __com_sun_star_frame_PopupMenuControllerFactory_idl__ -#ifndef __com_sun_star_lang_XMultiComponentFactory_idl__ -#include <com/sun/star/lang/XMultiComponentFactory.idl> -#endif - -#ifndef __com_sun_star_frame_XUIControllerRegistration_idl__ -#include <com/sun/star/frame/XUIControllerRegistration.idl> -#endif - -//============================================================================= +#include <com/sun/star/frame/XUIControllerFactory.idl> module com { module sun { module star { module frame { -//============================================================================= - /** specifies a factory that creates instances of registered popup menu controller. <p> @@ -48,34 +36,13 @@ module com { module sun { module star { module frame { @since OOo 2.0 */ - -service PopupMenuControllerFactory +service PopupMenuControllerFactory : XUIControllerFactory { - /** this interface provides functions to create new instances of a registered popup menu controller. - - <p> - Use <member scope="com.sun.star.lang">XMultiComponentFactory::createInstanceWithArguments()</member> to create - a new popup menu controller instance. Use the CommandURL as the service specifier. - - This call supports the following arguments provided as <type scope="com::sun::star::beans">PropertyValue</type>: - <ul> - <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type> - instance to which the popup menu controller belongs to. This property must be provided to - the popup menu controller, otherwise it cannot dispatch its internal commands.</li> - <li><b>ModuleIdentifier</b><br>optional string that specifies in which module context the popup menu - controller should be created.</li> - </ul> - </p> + /** service constructor */ - interface com::sun::star::lang::XMultiComponentFactory; - - /** provides functions to query for, register and deregister a popup menu controller. - */ - interface com::sun::star::frame::XUIControllerRegistration; + create(); }; }; }; }; }; -//============================================================================= - #endif diff --git a/offapi/com/sun/star/frame/StatusbarController.idl b/offapi/com/sun/star/frame/StatusbarController.idl index 8400b8e1d7c3..a9773a55ff96 100644 --- a/offapi/com/sun/star/frame/StatusbarController.idl +++ b/offapi/com/sun/star/frame/StatusbarController.idl @@ -23,27 +23,12 @@ #ifndef __com_sun_star_frame_StatusbarController_idl__ #define __com_sun_star_frame_StatusbarController_idl__ -#ifndef __com_sun_star_lang_XInitialization_idl__ -#include <com/sun/star/lang/XInitialization.idl> -#endif - -#ifndef __com_sun_star_util_XUpdatable_idl__ -#include <com/sun/star/util/XUpdatable.idl> -#endif - -#ifndef __com_sun_star_frame_XStatusListener_idl__ -#include <com/sun/star/frame/XStatusListener.idl> -#endif - -#ifndef __com_sun_star_frame_XStatusbarController_idl__ #include <com/sun/star/frame/XStatusbarController.idl> -#endif -//============================================================================= +module com { module sun { module star { module frame { - module com { module sun { module star { module frame { +interface XStatusbarController; -//============================================================================= /** is an abstract service for a component which offers a more complex user interface to users within a status bar. @@ -62,77 +47,10 @@ @since OOo 2.0 */ - -service StatusbarController +service StatusbarController : XStatusbarController { - //------------------------------------------------------------------------- - /** with this interface a component can receive events if a feature has - changed. - - <p> - The status bar controller implementation should register itself as a - listener when its <member scope="com::sun::star::util">XUpdatable</member> - interface has been called. - </p> - */ - interface com::sun::star::frame::XStatusListener; - - /** used to initialize a component with required arguments. - - <b>A status bar controller needs at least three additional arguments - provided as <type scope="com::sun::star::beans">PropertyValue</type>: - <ul> - <li><b>Frame</b><br>a - <type scope="com::sun::star::frame">XFrame</type> instance - to which the status bar controller belongs.</li> - <li><b>CommandURL</b><br>a string which specifies the command - associated with the statusbar controller. The command is - used to identify the status bar controller - implementation.</li> - <li><b>ServiceManager</b><br>a <type scope="com::sun::star::lang"> - XMultiServiceFactory</type> instance which can be used to - create additional UNO services.</li> - <li><b>Parent</b><br>a <type scope="com::sun::star::awt">Window</type> - instance which represents the parent window (status bar - window).</li> - <li><b>Identifier</b><br>an integer value which is the unique id - used by the status bar implementation to identify a status - bar entry. This value is currently only used by internal - OpenOffice.org status bar controller implementations.</li> - </ul> - */ - interface com::sun::star::lang::XInitialization; - - /** used to notify an implementation that it needs to add its listener or - remove and add them again. - - <p> - A status bar controller instance is ready for use after this call has - been made the first time. The status bar implementation guarentees that - the controller's item window has been added to the status bar and its - reference is held by it. - </p> - */ - interface com::sun::star::util::XUpdatable; - - //------------------------------------------------------------------------- - /** used to notify changed features and requests for additional user - interface items. - - <p> - Mostly used by a status bar implementation to forward information to - and request services from a status bar controller component. This - interface must be useable after - <member scope="com::sun::star::lang">XInitialitation::initialize</member> - has been called. The behavior of the interface is undefined if the - controller component hasn't been initialized. - </p> - */ - interface com::sun::star::frame::XStatusbarController; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/frame/StatusbarControllerFactory.idl b/offapi/com/sun/star/frame/StatusbarControllerFactory.idl index 8df056bf98b7..46aff8d418f1 100644 --- a/offapi/com/sun/star/frame/StatusbarControllerFactory.idl +++ b/offapi/com/sun/star/frame/StatusbarControllerFactory.idl @@ -19,25 +19,13 @@ * *************************************************************/ - - #ifndef __com_sun_star_frame_StatusbarControllerFactory_idl__ #define __com_sun_star_frame_StatusbarControllerFactory_idl__ -#ifndef __com_sun_star_lang_XMultiComponentFactory_idl__ -#include <com/sun/star/lang/XMultiComponentFactory.idl> -#endif - -#ifndef __com_sun_star_frame_XUIControllerRegistration_idl__ -#include <com/sun/star/frame/XUIControllerRegistration.idl> -#endif - -//============================================================================= +#include <com/sun/star/frame/XUIControllerFactory.idl> module com { module sun { module star { module frame { -//============================================================================= - /** specifies a factory that creates instances of registered status bar controller. @@ -49,39 +37,13 @@ module com { module sun { module star { module frame { @since OOo 2.0 */ - -service StatusbarControllerFactory +service StatusbarControllerFactory : XUIControllerFactory { - /** this interface provides functions to create new instances of a registered - status bar controller. - - <p> - Use <member scope="com.sun.star.lang">XMultiComponentFactory::createInstanceWithArguments()</member> - to create a new status bar controller instance. Use the CommandURL as the - service specifier. - - This call supports the following arguments provided as - <type scope="com::sun::star::beans">PropertyValue</type>: - <ul> - <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type> - instance to which the status bar controller belongs to. This - property must be provided to the status bar controller, otherwise it - cannot dispatch its internal commands.</li> - <li><b>ModuleIdentifier</b><br>optional string that specifies in which module - context the status bar controller should be created.</li> - </ul> - </p> + /** service constructor */ - interface com::sun::star::lang::XMultiComponentFactory; - - /** provides functions to query for, register and deregister a status bar - controller. - */ - interface com::sun::star::frame::XUIControllerRegistration; + create(); }; }; }; }; }; -//============================================================================= - #endif diff --git a/offapi/com/sun/star/frame/ToolbarControllerFactory.idl b/offapi/com/sun/star/frame/ToolbarControllerFactory.idl new file mode 100644 index 000000000000..f24bc0391a8e --- /dev/null +++ b/offapi/com/sun/star/frame/ToolbarControllerFactory.idl @@ -0,0 +1,47 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_frame_ToolbarControllerFactory_idl__ +#define __com_sun_star_frame_ToolbarControllerFactory_idl__ + +#include <com/sun/star/frame/XUIControllerFactory.idl> + +module com { module sun { module star { module frame { + +/** specifies a factory that creates instances of registered toolbar controller. + + <p> + A toolbar controller can be registered for a command URL and a model service name. + </p> + + @since OOo 2.0 +*/ + +service ToolbarControllerFactory : XUIControllerFactory +{ + /** service constructor + */ + create(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/XStatusbarController.idl b/offapi/com/sun/star/frame/XStatusbarController.idl index 232a6841a33e..f2d853c03af0 100644 --- a/offapi/com/sun/star/frame/XStatusbarController.idl +++ b/offapi/com/sun/star/frame/XStatusbarController.idl @@ -19,33 +19,22 @@ * *************************************************************/ - #ifndef __com_sun_star_frame_XStatusbarController_idl__ #define __com_sun_star_frame_XStatusbarController_idl__ -#ifndef __com_sun_star_awt_Point_idl__ -#include <com/sun/star/awt/Point.idl> -#endif - -#ifndef __com_sun_star_awt_MouseEvent_idl__ #include <com/sun/star/awt/MouseEvent.idl> -#endif - -#ifndef __com_sun_star_awt_Rectangle_idl__ +#include <com/sun/star/awt/Point.idl> #include <com/sun/star/awt/Rectangle.idl> -#endif - -#ifndef __com_sun_star_awt_XGraphics_idl__ #include <com/sun/star/awt/XGraphics.idl> -#endif - -//============================================================================= +#include <com/sun/star/frame/XStatusListener.idl> +#include <com/sun/star/lang/XComponent.idl> +#include <com/sun/star/lang/XInitialization.idl> +#include <com/sun/star/util/XUpdatable.idl> module com { module sun { module star { module frame { -//============================================================================= -/** is an abstract service for a component which offers a more complex user interface - to users within a status bar. +/** interface to be implemented by a component offering a more complex user + interface to users within a status bar. <p> A generic status bar field is represented as a simple text field. A status @@ -59,10 +48,69 @@ module com { module sun { module star { module frame { @see com::sun::star::frame::XDispatchProvider @since OOo 2.0 - */ -interface XStatusbarController : ::com::sun::star::uno::XInterface +*/ +interface XStatusbarController { - //============================================================================= + /** used to control the life-time of the component + + Used by a status bar implementation to control the life-time of + a status bar controller. The status bar is the only instance which + is allowed to dispose the component. + */ + interface com::sun::star::lang::XComponent; + + /** used to initialize a component with required arguments. + + <p>A status bar controller is initialized with <b>five</b> additional + arguments provided as a sequence of + <type scope="com::sun::star::beans">PropertyValue</type>:</p> + + <ul> + <li><b>Frame</b><br/>a <type scope="com::sun::star::frame">XFrame</type> + instance to which the status bar controller belongs. + </li> + <li><b>CommandURL</b><br/>a string which specifies the command + associated with the statusbar controller.</br> + The command is used to identify the status bar controller + implementation. + </li> + <li><b>StatusbarItem</b><br/>a <type scope="com::sun::star::ui">XStatusbarItem</type> + instance which represents the status bar item asociated with + this controller. + </li> + <li><b>ParentWindow</b><br/>a <type scope="com::sun::star::awt">Window</type> + instance which represents the parent window (status bar window). + </li> + <li><b>ModuleName</b><br/>a string which specifies the name of the + office module attached to the frame to which this controller + belongs; the value is taken from + <member scope="com::sun::star::frame">XModuleManager::identify()</member>. + </li> + </ul> + */ + interface com::sun::star::lang::XInitialization; + + /** with this interface a component can receive events if a feature has + changed. + + <p>The status bar controller implementation should register itself as a + listener when its <member scope="com::sun::star::util">XUpdatable</member> + interface has been called.</p> + */ + interface com::sun::star::frame::XStatusListener; + + /** used to notify an implementation that it needs to add its listener or + remove and add them again. + + <p> + A status bar controller instance is ready for use after this call has + been made the first time. The status bar implementation guarentees that + the controller's item window has been added to the status bar and its + reference is held by it. + </p> + */ + interface com::sun::star::util::XUpdatable; + /** is called by a status bar if the mouse position is within the controller and a mouse button has been pressed. If the controller has captured the mouse input this function is also called when the mouse position is not @@ -77,7 +125,6 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface */ boolean mouseButtonDown( [in] ::com::sun::star::awt::MouseEvent aMouseEvent ); - //============================================================================= /** is called by a status bar if the mouse position is within the controller and a mouse has been moved. If the controller has captured the mouse input this function is also called when the mouse position is not @@ -92,7 +139,6 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface */ boolean mouseMove( [in] ::com::sun::star::awt::MouseEvent aMouseEvent ); - //============================================================================= /** is called by a status bar if the mouse position is within the controller and a mouse button has been released. If the controller has captured the mouse input this function is also called when the mouse position is not @@ -107,7 +153,6 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface */ boolean mouseButtonUp( [in] ::com::sun::star::awt::MouseEvent aMouseEvent ); - //============================================================================= /** is called by a status bar if a command event is available for a controller. @param aPos @@ -115,6 +160,8 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface @param nCommand describes which command has been invoked. + <br/>See <type scope="com::sun::star::awt">Command</type> for + possible values. @param bMouseEvent <TRUE/> if the command is based on a mouse event, otherwise <FALSE/>. @@ -127,7 +174,6 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface [in] boolean bMouseEvent, [in] any aData ); - //============================================================================= /** is called by a status bar if the controller has to update the visual representation. @@ -139,28 +185,28 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface a <type scope="com::sun::star::awt">Rectangle</type> which determine the output rectangle for all drawing operations - @param nItemID - the unique ID of the control within the status bar. - @param nStyle reserved for future use. */ void paint( [in] ::com::sun::star::awt::XGraphics xGraphics, [in] ::com::sun::star::awt::Rectangle rOutputRectangle, - [in] long nItemId, [in] long nStyle ); - //============================================================================= /** is called by a status bar if the user clicked with mouse into the field of the corresponding control. + + @param aPos + the current mouse position in pixel. */ - void click(); + void click( [in] ::com::sun::star::awt::Point aPos ); - //============================================================================= /** is called by a status bar if the user double-clicked with mouse into the field of the corresponding control. + + @param aPos + the current mouse position in pixel. */ - void doubleClick(); + void doubleClick( [in] ::com::sun::star::awt::Point aPos ); }; }; }; }; }; diff --git a/offapi/com/sun/star/frame/XUIControllerFactory.idl b/offapi/com/sun/star/frame/XUIControllerFactory.idl new file mode 100644 index 000000000000..4e21a0a3d250 --- /dev/null +++ b/offapi/com/sun/star/frame/XUIControllerFactory.idl @@ -0,0 +1,76 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_frame_XUIControllerFactory_idl__ +#define __com_sun_star_frame_XUIControllerFactory_idl__ + +#include <com/sun/star/lang/XMultiComponentFactory.idl> +#include <com/sun/star/frame/XUIControllerRegistration.idl> + +module com { module sun { module star { module frame { + +/** a factory to create User Interface controllers. + + <p> + A user interface controller can be registered for a command URL. A certain user + interface controller will be created when a user interface element contains a + registered command URL. + + @see PopupMenuControllerFactory + @see StatusbarControllerFactory + @see ToolbarControllerFactory + </p> + + @since Apache OpenOffice 4.0 + */ +interface XUIControllerFactory +{ + /** this interface provides functions to create new instances of a registered UI controller. + + <p> + Use <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithArgumentsAndContext()</member> to create + a new UI controller instance. Use the CommandURL as the service specifier. + + This call supports the following arguments provided as <type scope="com::sun::star::beans">PropertyValue</type>: + <ul> + <li> + <b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type> + instance to which the UI controller belongs to. This property must be provided to + the UI controller, otherwise it cannot dispatch its internal commands. + </li> + <li> + <b>ModuleIdentifier</b><br>optional string that specifies in which module context the UI + controller should be created.</br>The module identifier can be retrieved using the + <type>ModuleManager</type>. + </li> + </ul> + </p> + */ + interface com::sun::star::lang::XMultiComponentFactory; + + /** provides functions to query for, register and deregister a popup menu controller. + */ + interface XUIControllerRegistration; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/makefile.mk b/offapi/com/sun/star/frame/makefile.mk index fed9fde1f527..2704265eba9e 100644 --- a/offapi/com/sun/star/frame/makefile.mk +++ b/offapi/com/sun/star/frame/makefile.mk @@ -51,8 +51,8 @@ IDLFILES=\ DispatchProvider.idl\ DispatchRecorder.idl\ DispatchRecorderSupplier.idl\ - DispatchResultState.idl\ DispatchResultEvent.idl\ + DispatchResultState.idl\ DispatchStatement.idl\ DocumentTemplates.idl\ DoubleInitializationException.idl\ @@ -63,8 +63,8 @@ IDLFILES=\ FrameControl.idl\ FrameLoader.idl\ FrameLoaderFactory.idl\ - FramesContainer.idl\ FrameSearchFlag.idl\ + FramesContainer.idl\ IllegalArgumentIOException.idl\ LayoutManager.idl\ LayoutManagerEvents.idl\ @@ -75,14 +75,15 @@ IDLFILES=\ ProtocolHandler.idl\ SessionManager.idl\ Settings.idl\ - SynchronousFrameLoader.idl\ StatusbarController.idl\ StatusbarControllerFactory.idl\ + SynchronousFrameLoader.idl\ Task.idl\ TemplateAccess.idl\ TerminationVetoException.idl\ TitleChangedEvent.idl\ ToolbarController.idl\ + ToolbarControllerFactory.idl \ TransientDocumentsDocumentContentFactory.idl \ UnknownModuleException.idl\ WindowArrange.idl\ @@ -91,9 +92,9 @@ IDLFILES=\ XComponentLoader.idl\ XComponentRegistry.idl\ XConfigManager.idl\ + XControlNotificationListener.idl\ XController.idl\ XController2.idl\ - XControlNotificationListener.idl\ XControllerBorder.idl\ XDesktop.idl\ XDesktopTask.idl\ @@ -113,16 +114,16 @@ IDLFILES=\ XFrameActionListener.idl\ XFrameLoader.idl\ XFrameLoaderQuery.idl\ - XFrames.idl\ XFrameSetModel.idl\ + XFrames.idl\ XFramesSupplier.idl\ XInplaceLayout.idl\ XInterceptorInfo.idl\ XLayoutManager.idl\ XLayoutManagerEventBroadcaster.idl\ XLayoutManagerListener.idl\ - XLoadable.idl\ XLoadEventListener.idl\ + XLoadable.idl\ XMenuBarAcceptor.idl\ XMenuBarMergingAcceptor.idl\ XModel.idl\ @@ -138,8 +139,8 @@ IDLFILES=\ XStatusListener.idl\ XStatusbarController.idl\ XStorable.idl\ - XSubToolbarController.idl\ XStorable2.idl\ + XSubToolbarController.idl\ XSynchronousDispatch.idl\ XSynchronousFrameLoader.idl\ XTask.idl\ @@ -151,10 +152,11 @@ IDLFILES=\ XTitleChangeListener.idl\ XToolbarController.idl\ XTransientDocumentsDocumentContentFactory.idl\ + XUIControllerFactory.idl\ XUIControllerRegistration.idl\ XUntitledNumbers.idl\ XUrlList.idl\ - XWindowArranger.idl + XWindowArranger.idl \ # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/smarttags/XRangeBasedSmartTagRecognizer.idl b/offapi/com/sun/star/smarttags/XRangeBasedSmartTagRecognizer.idl new file mode 100644 index 000000000000..c7671a555cc6 --- /dev/null +++ b/offapi/com/sun/star/smarttags/XRangeBasedSmartTagRecognizer.idl @@ -0,0 +1,101 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + + + +#ifndef __com_sun_star_smarttags_XRangeBasedSmartTagRecognizer_idl__ +#define __com_sun_star_smarttags_XRangeBasedSmartTagRecognizer_idl__ + +#ifndef __com_sun_star_uno_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif + +#ifndef __com_sun_star_lang_Locale_idl__ +#include <com/sun/star/lang/Locale.idl> +#endif + +#ifndef __com_sun_star_smarttags_SmartTagRecognizerMode_idl__ +#include <com/sun/star/smarttags/SmartTagRecognizerMode.idl> +#endif + +#ifndef __com_sun_star_text_XTextMarkup_idl__ +#include <com/sun/star/text/XTextMarkup.idl> +#endif + +#ifndef __com_sun_star_frame_XController_idl__ +#include <com/sun/star/frame/XController.idl> +#endif + +#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> +#endif + +#ifndef __com_sun_star_text_XTextRange_idl__ +#include <com/sun/star/text/XTextRange.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module smarttags { + +//============================================================================= + +/** + provides access to a range based smart tag recognizer. + */ + +interface XRangeBasedSmartTagRecognizer: com::sun::star::lang::XInitialization +{ + + //------------------------------------------------------------------------- + /** recognizes smart tags. + + @param xRange + The text that should be scanned by the recognizer. + + @param eDataType + This value indicates the type of the passed text. + + @param aLocale + Is used to indicate the language of the passed text. + + @param xTextMarkup + This object is used to submit any recognized smart tags + to the calling application. + + @param aApplicationName + A string containing the name of the calling application. + + @param xController + The current controller of the document. + */ + + void recognizeTextRange( [in] com::sun::star::text::XTextRange xRange, + [in] SmartTagRecognizerMode eDataType, + [in] com::sun::star::text::XTextMarkup xTextMarkup, + [in] string aApplicationName, + [in] com::sun::star::frame::XController xController); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/smarttags/XSmartTagAction.idl b/offapi/com/sun/star/smarttags/XSmartTagAction.idl index 6c30320f95d2..799cc3173ec6 100644 --- a/offapi/com/sun/star/smarttags/XSmartTagAction.idl +++ b/offapi/com/sun/star/smarttags/XSmartTagAction.idl @@ -112,7 +112,7 @@ interface XSmartTagAction: com::sun::star::lang::XInitialization @throws com::sun::star::lang::IndexOutOfBoundsException if nSmartTagIndex is greater than SmartTagCount. */ - string getSmartTagName( [in] long nSmartTagIndex ) + string getSmartTagName( [in] long nSmartTagIndex) raises( com::sun::star::lang::IndexOutOfBoundsException ); @@ -135,7 +135,7 @@ interface XSmartTagAction: com::sun::star::lang::XInitialization if nSmartTagIndex is greater than SmartTagCount */ string getSmartTagCaption( [in] long nSmartTagIndex, - [in] ::com::sun::star::lang::Locale aLocale ) + [in] ::com::sun::star::lang::Locale aLocale) raises( com::sun::star::lang::IndexOutOfBoundsException ); @@ -155,7 +155,8 @@ interface XSmartTagAction: com::sun::star::lang::XInitialization type. */ long getActionCount( [in] string aSmartTagName, - [in] com::sun::star::frame::XController xController ); + [in] com::sun::star::frame::XController xController, + [in] com::sun::star::container::XStringKeyMap xProperties); //------------------------------------------------------------------------- /** obtains a unique integer identifier for an action. @@ -245,7 +246,7 @@ interface XSmartTagAction: com::sun::star::lang::XInitialization if the ActionID is not recognized. */ string getActionNameFromID( [in] long nActionID, - [in] com::sun::star::frame::XController xController ) + [in] com::sun::star::frame::XController xController) raises( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/smarttags/XSmartTagRecognizer.idl b/offapi/com/sun/star/smarttags/XSmartTagRecognizer.idl index 31efc4c6edc7..6cf33f97323c 100644 --- a/offapi/com/sun/star/smarttags/XSmartTagRecognizer.idl +++ b/offapi/com/sun/star/smarttags/XSmartTagRecognizer.idl @@ -52,6 +52,11 @@ #include <com/sun/star/lang/IndexOutOfBoundsException.idl> #endif +#ifndef __com_sun_star_text_XTextRange_idl__ +#include <com/sun/star/text/XTextRange.idl> +#endif + + //============================================================================= module com { module sun { module star { module smarttags { @@ -178,7 +183,6 @@ interface XSmartTagRecognizer: com::sun::star::lang::XInitialization [in] com::sun::star::frame::XController xController, [in] com::sun::star::i18n::XBreakIterator xTokenizer ); - //------------------------------------------------------------------------- /** indicates whether there is a property page for a smart tag type. diff --git a/offapi/com/sun/star/smarttags/makefile.mk b/offapi/com/sun/star/smarttags/makefile.mk index 227483ba9b6a..77675f32deb9 100644 --- a/offapi/com/sun/star/smarttags/makefile.mk +++ b/offapi/com/sun/star/smarttags/makefile.mk @@ -37,6 +37,7 @@ IDLFILES=\ SmartTagAction.idl\ SmartTagRecognizer.idl\ SmartTagRecognizerMode.idl\ + XRangeBasedSmartTagRecognizer.idl\ XSmartTagAction.idl\ XSmartTagRecognizer.idl diff --git a/offapi/com/sun/star/system/SimpleMailClientFlags.idl b/offapi/com/sun/star/system/MailClientFlags.idl index 712e3083481d..b606f333e6c6 100644 --- a/offapi/com/sun/star/system/SimpleMailClientFlags.idl +++ b/offapi/com/sun/star/system/MailClientFlags.idl @@ -19,50 +19,40 @@ * *************************************************************/ - - -#ifndef __com_sun_star_system_SimpleMailClientFlags_idl__ -#define __com_sun_star_system_SimpleMailClientFlags_idl__ - +#ifndef __com_sun_star_system_MailClientFlags_idl__ +#define __com_sun_star_system_MailClientFlags_idl__ module com { module sun { module star { module system { -//============================================================================= -/** These constants are used to specify how the SimpleMailClient Service - should behave. +/** These constants are used to specify how the <type>XMailClient</type> + should behave. */ - -published constants SimpleMailClientFlags +constants MailClientFlags { - //--------------------------------------------------------------------- /** Uses the default settings when sending a mail, e.g. launches the current configured system mail client. */ - const long DEFAULTS = 0; + const long DEFAULTS = 0; - //--------------------------------------------------------------------- - /** Does not show the current configured system mail client, but sends + /** Does not show the current configured system mail client GUI, but sends the mail without any further user interaction. - If this flag is specified, a recipient address must have been - specified for the given <type>XSimpleMailMessage</type> + <p>If this flag is specified, a recipient address must have been + specified for the given <type>XMailMessage</type> object given to the method - <member scope="com::sun::star::system">XSimpleMailClient::sendSimpleMailMessage()</member>. - */ - const long NO_USER_INTERFACE = 1; + <member scope="com::sun::star::system">XMailClient::sendMailMessage()</member>.</p> + */ + const long NO_USER_INTERFACE = 1; - //--------------------------------------------------------------------- /** No logon dialog should be displayed to prompt the user for logon information if necessary. - When this flag is specified and the user needs to logon in order - to send a simple mail message via the method - <member scope="com::sun::star::system">XSimpleMailClient::sendSimpleMailMessage()</member>, - an Exception will be thrown. + <p>When this flag is specified and the user needs to logon in order + to send a mail message via the method + <member scope="com::sun::star::system">XMailClient::sendMailMessage()</member>, + an <type scope="com::sun::star::uno">Exception</type> will be thrown.</p> */ - const long NO_LOGON_DIALOG = 2; + const long NO_LOGON_DIALOG = 2; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/system/ProxySettings.idl b/offapi/com/sun/star/system/ProxySettings.idl deleted file mode 100644 index 44a6a69da38b..000000000000 --- a/offapi/com/sun/star/system/ProxySettings.idl +++ /dev/null @@ -1,74 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_ProxySettings_idl__ -#define __com_sun_star_system_ProxySettings_idl__ - -#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 system { - -//============================================================================= - - published interface XProxySettings; - -//============================================================================= -/** Specifies a service for reading the proxy settings from an old office - installation or a central system database. - - @see com::sun::star::system::XProxySettings - - @deprecated -*/ - -published service ProxySettings -{ - //------------------------------------------------------------------------- - /** Provides access to a <type>XProxySettings</type> interface. - */ - interface XProxySettings; - - //------------------------------------------------------------------------- - /** 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/system/SOffice52ProxySettings.idl b/offapi/com/sun/star/system/SOffice52ProxySettings.idl deleted file mode 100644 index 4657796993ea..000000000000 --- a/offapi/com/sun/star/system/SOffice52ProxySettings.idl +++ /dev/null @@ -1,61 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_SOffice52ProxySettings_idl__ -#define __com_sun_star_system_SOffice52ProxySettings_idl__ - -#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_system_ProxySettings_idl__ -#include <com/sun/star/system/ProxySettings.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module system { - -//============================================================================= -/** Specifies a service for reading the proxy settings from an old - StarOffice 5.2 installation. - - @see com::sun::star::system::ProxySettings - - @deprecated -*/ - -published service SOffice52ProxySettings -{ - service ProxySettings; -}; - -//============================================================================= - -}; }; }; }; - -#endif diff --git a/offapi/com/sun/star/system/SimpleCommandMail.idl b/offapi/com/sun/star/system/SimpleCommandMail.idl deleted file mode 100644 index 9dab7c8f3cd1..000000000000 --- a/offapi/com/sun/star/system/SimpleCommandMail.idl +++ /dev/null @@ -1,78 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_SimpleCommandMail_idl__ -#define __com_sun_star_system_SimpleCommandMail_idl__ - -#ifndef __com_sun_star_configuration_ConfigurationProvider_idl__ -#include <com/sun/star/configuration/ConfigurationProvider.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 system { - -//============================================================================= - - published interface XSimpleMailClientSupplier; - -//============================================================================= -/** Specifies a SimpleCommandMail service. Implementations of such a service, do - implement an interface to send mail messages via the current configured - command line mail application. - - @see com::sun::star::system::XSimpleMailClient -*/ - -published service SimpleCommandMail -{ - //------------------------------------------------------------------------- - /** Provides access to a <type>XSimpleMailClientSupplier</type> interface. - */ - interface XSimpleMailClientSupplier; - - //------------------------------------------------------------------------- - /** 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/system/SimpleSystemMail.idl b/offapi/com/sun/star/system/SimpleSystemMail.idl deleted file mode 100644 index 316df1a42968..000000000000 --- a/offapi/com/sun/star/system/SimpleSystemMail.idl +++ /dev/null @@ -1,73 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_SimpleSystemMail_idl__ -#define __com_sun_star_system_SimpleSystemMail_idl__ - -#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 system { - -//============================================================================= - - published interface XSimpleMailClientSupplier; - -//============================================================================= -/** Specifies a SimpleSystemMail service. Implementations of such a service - implement an interface to send mail messages via the currently configured - system mail client. - - @see com::sun::star::system::XSimpleMailClient -*/ - -published service SimpleSystemMail -{ - //------------------------------------------------------------------------- - /** Provides access to a <type>XSimpleMailClientSupplier</type> interface. - */ - interface XSimpleMailClientSupplier; - - //------------------------------------------------------------------------- - /** 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/system/SystemMailProvider.idl b/offapi/com/sun/star/system/SystemMailProvider.idl new file mode 100644 index 000000000000..74fe77a1ca9a --- /dev/null +++ b/offapi/com/sun/star/system/SystemMailProvider.idl @@ -0,0 +1,45 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_system_SystemMailProvider_idl__ +#define __com_sun_star_system_SystemMailProvider_idl__ + +#include <com/sun/star/system/XSystemMailProvider.idl> + +module com { module sun { module star { module system { + +/** A service providing a simple way to send mails using a mail client + available on the system. + + <p>For a more complex way of sending mails using a SMTP serivce, without the + need of a mail client on the system and with no user interaction, use the + <type scope="com::sun::star::mail">MailServiceProvider</type>.</p> +*/ +service SystemMailProvider : XSystemMailProvider +{ + /** service constructor + */ + create(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/system/SystemProxySettings.idl b/offapi/com/sun/star/system/SystemProxySettings.idl deleted file mode 100644 index 5f96e45df6fb..000000000000 --- a/offapi/com/sun/star/system/SystemProxySettings.idl +++ /dev/null @@ -1,59 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_SystemProxySettings_idl__ -#define __com_sun_star_system_SystemProxySettings_idl__ - -#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_system_ProxySettings_idl__ -#include <com/sun/star/system/ProxySettings.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module system { - -//============================================================================= -/** Specifies a service for reading the system proxy settings. Some systems - store this information in a central configuration database. - - @deprecated -*/ - -published service SystemProxySettings -{ - service ProxySettings; -}; - -//============================================================================= - -}; }; }; }; - -#endif diff --git a/offapi/com/sun/star/system/SystemShellExecute.idl b/offapi/com/sun/star/system/SystemShellExecute.idl index 7c32b5a1ab94..ce999a6e697a 100644 --- a/offapi/com/sun/star/system/SystemShellExecute.idl +++ b/offapi/com/sun/star/system/SystemShellExecute.idl @@ -19,54 +19,25 @@ * *************************************************************/ - - #ifndef __com_sun_star_system_SystemShellExecute_idl__ #define __com_sun_star_system_SystemShellExecute_idl__ -#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 - -//============================================================================= +#include <com/sun/star/system/XSystemShellExecute.idl> module com { module sun { module star { module system { -//============================================================================= +published interface XSystemShellExecute; - published interface XSystemShellExecute; - -//============================================================================= /** Specifies a system executer service. Such a service makes it possible to execute an arbitrary system command. - - @see com::sun::star::system::XSystemShellExecute */ - -published service SystemShellExecute +published service SystemShellExecute : XSystemShellExecute { - //------------------------------------------------------------------------- - /** Provides access to a <type>XSystemShellExecute</type> interface. - */ - interface XSystemShellExecute; - - //------------------------------------------------------------------------- - /** Service should always support this interface. - */ - interface com::sun::star::lang::XServiceInfo; - - //------------------------------------------------------------------------- - /** Service should always support this interface. - */ - interface com::sun::star::lang::XTypeProvider; + /** service constructor + */ + create(); }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/system/SystemShellExecuteException.idl b/offapi/com/sun/star/system/SystemShellExecuteException.idl index 4f041ee3fe3b..2dd8fd790b28 100644 --- a/offapi/com/sun/star/system/SystemShellExecuteException.idl +++ b/offapi/com/sun/star/system/SystemShellExecuteException.idl @@ -19,40 +19,28 @@ * *************************************************************/ - - #ifndef __com_sun_star_system_SystemShellExecuteException_idl__ #define __com_sun_star_system_SystemShellExecuteException_idl__ -#ifndef __com_sun_star_uno_Exception_idl__ #include <com/sun/star/uno/Exception.idl> -#endif - -//============================================================================= module com { module sun { module star { module system { -//============================================================================= -/** May be thrown in cases of errors executing a command using the <type>SystemShellExecute</type> service. - <member scope="com::sun::star::uno">Exception::Message</member> may contain a - system error message, but it is not mandatory. - The member PosixError specifies a POSIX conforming error code or -1 for - unknown errors. +/** May be thrown in cases of errors executing a command using the + <type>SystemShellExecute</type> service. + + <p><member scope="com::sun::star::uno">Exception::Message</member> may + contain a system error message, but it is not mandatory.</p> + <p>The member <member>PosixError</member> specifies a POSIX conforming error + code or -1 for unknown errors.</p> */ published exception SystemShellExecuteException: com::sun::star::uno::Exception { - //========================================================================= /** A Posix conforming error code or -1 for unknown errors. */ long PosixError; }; -//============================================================================= - }; }; }; }; -/*============================================================================= - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/system/SystemShellExecuteFlags.idl b/offapi/com/sun/star/system/SystemShellExecuteFlags.idl index 833e6a9bf260..080ef8c161b5 100644 --- a/offapi/com/sun/star/system/SystemShellExecuteFlags.idl +++ b/offapi/com/sun/star/system/SystemShellExecuteFlags.idl @@ -19,34 +19,25 @@ * *************************************************************/ - - #ifndef __com_sun_star_system_SystemShellExecuteFlags_idl__ #define __com_sun_star_system_SystemShellExecuteFlags_idl__ - module com { module sun { module star { module system { -//============================================================================= /** Different settings for the <type>SystemShellExecute</type> service. */ - published constants SystemShellExecuteFlags { - //--------------------------------------------------------------------- /** Uses the default settings for executing commands. */ - const long DEFAULTS = 0; + const long DEFAULTS = 0; - //--------------------------------------------------------------------- /** Prevents the display of system error message boxes if the method <member scope="com::sun::star::system">XSystemShellExecute::execute()</member> fails. */ const long NO_SYSTEM_ERROR_MESSAGE = 1; }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/system/XMailClient.idl b/offapi/com/sun/star/system/XMailClient.idl new file mode 100644 index 000000000000..c6efc97334ca --- /dev/null +++ b/offapi/com/sun/star/system/XMailClient.idl @@ -0,0 +1,80 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_system_XMailClient_idl__ +#define __com_sun_star_system_XMailClient_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/system/XMailMessage.idl> +#include <com/sun/star/system/MailClientFlags.idl> + +module com { module sun { module star { module system { + +/** Specifies an interface for creating and sending email messages + through a mail client. + */ +interface XMailClient +{ + /** Create a mail message object that implements the interface + <type>XMailMessage</type>. + + @returns + An object that implements the <type>XMailMessage</type> interface. + */ + XMailMessage createMailMessage(); + + /** Sends a given mail message object that implements the interface + <type>XMailMessage</type>. + + @param xMailMessage + Specifies a configured mail object to be sent. + + @param aFlag + Specifies different flags that control the send process. + <p>Possible flags are specified in <type>MailClientFlags</type>.</p> + <p>If the flag <const scope="com::sun::star::system">MailClientFlags::NO_USER_INTERFACE</const> + is specified, a recipient address must have been specified for the + given <type>XMailMessage</type>.</p> + + @throws com::sun::star::lang::IllegalArgumentException + <ul> + <li>If invalid or excluding flags have been specified.</li> + <li>The flag <const scope="com::sun::star::system">MailClientFlags::NO_USER_INTERFACE</const> + is specified and no recipient address has been specified for the + given <type>XMailMessage</type> object.</li> + <li>The parameter <type>XMailMessage</type> is <NULL/>.</li> + </ul> + + @throws com::sun::star::uno::Exception + if an error occurs while sending the mail. + <p>The <member scope="com::sun::star::uno">Execption::Message</member> + may contain an error description.</p> + */ + void sendMailMessage( [in] XMailMessage xMailMessage, + [in] long aFlag ) + raises( ::com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::uno::Exception ); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/system/XMailMessage.idl b/offapi/com/sun/star/system/XMailMessage.idl new file mode 100644 index 000000000000..06d86f363695 --- /dev/null +++ b/offapi/com/sun/star/system/XMailMessage.idl @@ -0,0 +1,75 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_system_XMailMessage_idl__ +#define __com_sun_star_system_XMailMessage_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + +module com { module sun { module star { module system { + +/** This interface lets a client set or get the information of a mail message. +*/ +interface XMailMessage +{ + /** The recipient of the mail message. + */ + [attribute] string Recipient; + + /** The email address of the originator of the mail. + */ + [attribute] string Originator; + + /** The subject of the mail message. + */ + [attribute] string Subject; + + /** The body of the mail message. + */ + [attribute] string Body; + + /** A sequence with the email addresses of one or more bcc recipients. + */ + [attribute] sequence< string > BccRecipient; + + /** A sequence with the email addresses of one or more cc recipients. + */ + [attribute] sequence< string > CcRecipient; + + /** A sequence of file URLs specifying the files that should be attached to + the mail. + <p>The file URLs must be conform to + <a href="http://www.w3.org/Addressing/rfc1738.txt" target="_blank">Rfc1738</a>.</p> + + @throws ::com::sun::star::lang::IllegalArgumentException + if at least one of the given file URLs is invalid (doesn't conform to + <a href="http://www.w3.org/Addressing/rfc1738.txt" target="_blank">Rfc1738</a>). + */ + [attribute] sequence< string > Attachement + { + set raises (::com::sun::star::lang::IllegalArgumentException); + }; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/system/XProxySettings.idl b/offapi/com/sun/star/system/XProxySettings.idl deleted file mode 100644 index 76b29d5cf7bc..000000000000 --- a/offapi/com/sun/star/system/XProxySettings.idl +++ /dev/null @@ -1,140 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_XProxySettings_idl__ -#define __com_sun_star_system_XProxySettings_idl__ - -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module system { - -//============================================================================= -/** Enables access to different proxy settings. If particular settings are not - available an empty string will be returned. - - @deprecated -*/ - -published interface XProxySettings: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - /** Access to the Ftp proxy address. - @returns - The address of the ftp proxy server, if any has been specified. - */ - string getFtpProxyAddress( ); - - //------------------------------------------------------------------------- - /** Access to the Ftp proxy port. - @returns - The port of the ftp proxy server, if any has been specified. - */ - string getFtpProxyPort( ); - - //------------------------------------------------------------------------- - /** Access to the Gopher proxy address. - @returns - The address of the gopher proxy server, if any has been specified. - */ - string getGopherProxyAddress( ); - - //------------------------------------------------------------------------- - /** Access to the Gopher proxy port. - @returns - The port of the gopher proxy server, if any has been specified. - */ - string getGopherProxyPort( ); - - //------------------------------------------------------------------------- - /** Access to the Http proxy address. - @returns - The address of the http proxy server, if any has been specified. - */ - string getHttpProxyAddress( ); - - //------------------------------------------------------------------------- - /** Access to the Http proxy port. - @returns - The port of the http proxy server, if any has been specified. - */ - string getHttpProxyPort( ); - - //------------------------------------------------------------------------- - /** Access to the Https proxy address. - @returns - The address of the https proxy server, if any has been specified. - */ - string getHttpsProxyAddress( ); - - //------------------------------------------------------------------------- - /** Access to the Https proxy port. - @returns - The port of the https proxy server, if any has been specified. - */ - string getHttpsProxyPort( ); - - //------------------------------------------------------------------------- - /** Access to the Socks proxy address. - @returns - The address of the socks proxy server, if any has been specified. - */ - string getSocksProxyAddress( ); - - //------------------------------------------------------------------------- - /** Access to the Socks proxy port. - @returns - The port of the socks proxy server, if any has been specified. - */ - string getSocksProxyPort( ); - - //------------------------------------------------------------------------- - /** Access to the Proxy-Bypass address. - @returns - A string of ';' separated addresses for which no proxy server - should be used. - */ - string getProxyBypassAddress( ); - - //------------------------------------------------------------------------- - /** Either a proxy is enabled or not. - @returns - A value of <TRUE/> if a proxy is enabled. - <p>A value of <FALSE/> if a proxy is disabled.</p> - */ - boolean isProxyEnabled( ); -}; - -//============================================================================= - -}; }; }; }; - -#endif - diff --git a/offapi/com/sun/star/system/XSimpleMailClient.idl b/offapi/com/sun/star/system/XSimpleMailClient.idl deleted file mode 100644 index 5515e5ddb7b8..000000000000 --- a/offapi/com/sun/star/system/XSimpleMailClient.idl +++ /dev/null @@ -1,101 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_XSimpleMailClient_idl__ -#define __com_sun_star_system_XSimpleMailClient_idl__ - -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - -#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 - -#ifndef __com_sun_star_system_XSimpleMailMessage_idl__ -#include <com/sun/star/system/XSimpleMailMessage.idl> -#endif - -#ifndef __com_sun_star_system_SimpleMailClientFlags_idl__ -#include <com/sun/star/system/SimpleMailClientFlags.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module system { - -//============================================================================= -/** Specifies an interface for creating and sending email messages. -*/ - -published interface XSimpleMailClient: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - /** Create a simple mail message object that implements the interface - <type>XSimpleMailMessage</type>. - @returns - An object that implements the <type>XSimpleMailMessage</type> interface. - */ - XSimpleMailMessage createSimpleMailMessage( ); - - //------------------------------------------------------------------------- - /** Sends a given simple mail message object that implements the interface - <type>XSimpleMailMessage</type>. - - @param xSimpleMailMessage - Specifies a configured mail object to be sent. - - @param aFlag - Specifies different flags that control the send process - if the flag NO_USER_INTERFACE is specified. A recipient - address must have been specified for the given xMailMessage object. - - @throws com::sun::star::lang::IllegalArgumentException - <ul> - <li>If invalid or excluding flags have been specified.</li> - <li>The flag NO_USER_INTERFACE is specified and no recipient - address has been specified for the given xSimpleMailMessage object.</li> - <li>The parameter xSimpleMailMessage is NULL.</li> - </ul> - - @throws com::sun::star::uno::Exception - if an error occurs while sending the mail. - <p>The Message member of the exception may contain an error description.</p> - - @see com::sun::star::system::XSimpleMailMessage - @see com::sun::star::system::SimpleMailClientFlags - */ - void sendSimpleMailMessage( [in] XSimpleMailMessage xSimpleMailMessage, [in] long aFlag ) - raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception ); -}; - -//============================================================================= - -}; }; }; }; - -#endif - diff --git a/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl b/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl deleted file mode 100644 index 3a3d125ceabd..000000000000 --- a/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl +++ /dev/null @@ -1,73 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_XSimpleMailClientSupplier_idl__ -#define __com_sun_star_system_XSimpleMailClientSupplier_idl__ - -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - -#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 - -#ifndef __com_sun_star_system_XSimpleMailClient_idl__ -#include <com/sun/star/system/XSimpleMailClient.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module system { - -//============================================================================= -/** Implementations of this interface do provide access to a simple mail client - if there is one available - - @see com::sun::star::system::XSimpleMailClient -*/ - -published interface XSimpleMailClientSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - /** Allows a client to query for an object that implements - <type>XSimpleMailClient</type>. - @returns - An interface to a simple mail client if there is one available on the system - or an empty reference else. - - @see com::sun::star::system::XSimpleMailClient - */ - XSimpleMailClient querySimpleMailClient( ); -}; - -//============================================================================= - -}; }; }; }; - -#endif - diff --git a/offapi/com/sun/star/system/XSimpleMailMessage.idl b/offapi/com/sun/star/system/XSimpleMailMessage.idl deleted file mode 100644 index 4ff6ce51129b..000000000000 --- a/offapi/com/sun/star/system/XSimpleMailMessage.idl +++ /dev/null @@ -1,161 +0,0 @@ -/************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - - - -#ifndef __com_sun_star_system_XSimpleMailMessage_idl__ -#define __com_sun_star_system_XSimpleMailMessage_idl__ - -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - -#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 system { - -//============================================================================= -/** This interface lets a client set or get the information of a simple mail - message. -*/ - - -published interface XSimpleMailMessage: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - /** To set the recipient of the simple mail message. - @param aRecipient - The email address of a recipient. The method doesn't check if - the given email address is valid. - */ - void setRecipient( [in] string aRecipient ); - - //------------------------------------------------------------------------- - /** To get the recipient of the simple mail message. - @returns - The specified email address of a recipient - if any has been specified or an empty string. - */ - string getRecipient( ); - - //------------------------------------------------------------------------- - /** To set the cc recipients of a simple mail message. - - @param aCcRecipient - Sets a sequence with the email addresses of one or more cc recipients. - <p>The method does not check if the given addresses are valid. An empty - sequence means there are no cc recipients.</p> - */ - void setCcRecipient( [in] sequence< string > aCcRecipient ); - - //------------------------------------------------------------------------- - /** To get the cc recipients of a simple mail message. - @returns - A sequence with the email addresses of one or more cc recipients. - <p>If no cc recipients have been specified an empty sequence will be returned.</p> - */ - sequence< string > getCcRecipient( ); - - //------------------------------------------------------------------------- - /** To set the bcc recipient of a simple mail message. - @param aBccRecipient - A sequence with the email addresses of one or more bcc recipients. An empty - sequence means there are no bcc recipients.</p> - */ - void setBccRecipient( [in] sequence< string > aBccRecipient ); - - //------------------------------------------------------------------------- - /** To get the bcc recipients of a simple mail message. - @returns - A sequence with the email addresses of one or more bcc recipients. - <p>If no bcc recipients have been specified an empty sequence will be returned.</p> - */ - sequence< string > getBccRecipient( ); - - //------------------------------------------------------------------------- - /** To set the email address of the originator of a simple mail message. - @param aOriginator - Sets the email address of the originator of the mail. - */ - void setOriginator( [in] string aOriginator ); - - //------------------------------------------------------------------------- - /** To get the email address of the originator of a simple mail message. - @returns - The email address of the originator of the mail. - <p>If no originator has been specified an empty string will be returned.</p> - */ - string getOriginator( ); - - //------------------------------------------------------------------------- - /** To set the subject of a simple mail message. - @param aSubject - Sets the subject of the simple mail message. - */ - void setSubject( [in] string aSubject ); - - //------------------------------------------------------------------------- - /** To get the subject of a simple mail message. - @returns - The subject of the simple mail message. - <p>If no subject has been specified an empty string will be returned.</p> - */ - string getSubject( ); - - //------------------------------------------------------------------------- - /** To set an attachment of a simple mail message. - @param aAttachement - Sets a sequence of file URLs specifying the files that should be - attached to the mail. The given file URLs must be conform to - <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. - The method does not check if the specified file or files really exist. - - @throws ::com::sun::star::lang::IllegalArgumentException - if at least one of the given file URLs is invalid (doesn't conform to - <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). - */ - void setAttachement( [in] sequence< string > aAttachement ) - raises( ::com::sun::star::lang::IllegalArgumentException ); - - //------------------------------------------------------------------------- - /** To get the attachment of a simple mail message. - @returns - A sequence of file URLs specifying the files that should be attached to - the mail or an empty sequence if no attachments have been specified. - The returned file URLs are conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. - */ - sequence< string > getAttachement( ); -}; - -//============================================================================= - -}; }; }; }; - -#endif - diff --git a/offapi/com/sun/star/system/XSystemMailProvider.idl b/offapi/com/sun/star/system/XSystemMailProvider.idl new file mode 100644 index 000000000000..70a2b689ba8a --- /dev/null +++ b/offapi/com/sun/star/system/XSystemMailProvider.idl @@ -0,0 +1,46 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_system_XSystemMailProvider_idl__ +#define __com_sun_star_system_XSystemMailProvider_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/system/XMailClient.idl> + +module com { module sun { module star { module system { + +/** Provides access to a mail client, if there is one available on the system. +*/ +interface XSystemMailProvider +{ + /** Allows a client to query for an object that implements + <type>XMailClient</type>. + + @returns + An interface to a mail client if there is one available + on the system, or an empty reference otherwise. + */ + XMailClient queryMailClient( ); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/system/XSystemShellExecute.idl b/offapi/com/sun/star/system/XSystemShellExecute.idl index ba356b37674e..abb9a344ff18 100644 --- a/offapi/com/sun/star/system/XSystemShellExecute.idl +++ b/offapi/com/sun/star/system/XSystemShellExecute.idl @@ -19,72 +19,51 @@ * *************************************************************/ - - #ifndef __com_sun_star_system_XSystemShellExecute_idl__ #define __com_sun_star_system_XSystemShellExecute_idl__ -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - -#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 - -#ifndef __com_sun_star_system_SystemShellExecuteException_idl__ #include <com/sun/star/system/SystemShellExecuteException.idl> -#endif - -//============================================================================= module com { module sun { module star { module system { -//============================================================================= /** Specifies an interface for executing a system command. */ - - -published interface XSystemShellExecute: com::sun::star::uno::XInterface +published interface XSystemShellExecute { - //------------------------------------------------------------------------- /** Executes an abitrary system command. - @param aCommand - Specifies the command to execute. This may be an executable file or a - document which is registered with an application on a specific platform, - so that the platform knows what application to launch for that document. - If the command specifies a path to an executable, etc, this has to be - a system specific path. + @param aCommand + Specifies the command to execute. + <p>This may be an executable file or a document which is registered with + an application on a specific platform, so that the platform knows what + application to launch for that document.</p> + <p>If the command specifies a path to an executable, etc, this has to be + a system specific path.</p> - @param aParameter - Specifies a list of space separated parameters. The method does not - validate the given parameters, but only passes it as a parameter to the - specified command. + @param aParameter + Specifies a list of space separated parameters. + <p>The method does not validate the given parameters, but only passes it + as a parameter to the specified command.</p> - @param nFlags - Specifies different flags to control the execution of this method, for example, - avoid showing system error messages, in case of failures, etc. + @param nFlags + A combination of <type>SystemShellExecuteFlags</type> specifying different + flags to control the execution of this method. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException when the specified flags are wrong or exclude each other. -. - @throws com::sun::star::sys::SystemExecuteException - in the case of errors when trying to executed the specified command. - @see com::sun::star::system::SystemShellExecuteFlags + @throws com::sun::star::sys::SystemExecuteException + in the case of errors when trying to executed the specified command. */ - void execute( [in] string aCommand, [in] string aParameter, [in] long nFlags ) - raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::system::SystemShellExecuteException ); + void execute( [in] string sCommand, + [in] string sParameter, + [in] long nFlags ) + raises( ::com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::system::SystemShellExecuteException ); }; -//============================================================================= - }; }; }; }; #endif - diff --git a/offapi/com/sun/star/system/makefile.mk b/offapi/com/sun/star/system/makefile.mk index d0c152f580d6..8d0f9bc1f4c6 100644 --- a/offapi/com/sun/star/system/makefile.mk +++ b/offapi/com/sun/star/system/makefile.mk @@ -34,21 +34,15 @@ PACKAGE=com$/sun$/star$/system # ------------------------------------------------------------------------ IDLFILES=\ + MailClientFlags.idl\ + SystemMailProvider.idl\ SystemShellExecute.idl\ SystemShellExecuteException.idl\ SystemShellExecuteFlags.idl\ + XMailClient.idl\ + XMailMessage.idl\ + XSystemMailProvider.idl\ XSystemShellExecute.idl\ - SimpleMailClientFlags.idl\ - XSimpleMailMessage.idl\ - XSimpleMailMessage2.idl\ - XSimpleMailClient.idl\ - XSimpleMailClientSupplier.idl\ - SimpleCommandMail.idl \ - SimpleSystemMail.idl\ - ProxySettings.idl\ - SOffice52ProxySettings.idl\ - SystemProxySettings.idl\ - XProxySettings.idl # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/text/AutoTextGroup.idl b/offapi/com/sun/star/text/AutoTextGroup.idl index 0c5fee5b164c..dcb16709b8ed 100644 --- a/offapi/com/sun/star/text/AutoTextGroup.idl +++ b/offapi/com/sun/star/text/AutoTextGroup.idl @@ -23,45 +23,34 @@ #ifndef __com_sun_star_text_AutoTextGroup_idl__ #define __com_sun_star_text_AutoTextGroup_idl__ -#ifndef __com_sun_star_text_XAutoTextGroup_idl__ #include <com/sun/star/text/XAutoTextGroup.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ #include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_container_XNamed_idl__ #include <com/sun/star/container/XNamed.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module text { -//============================================================================= +module com { module sun { module star { module text { -// DocMerge from xml: service com::sun::star::text::AutoTextGroup -/** provides access to text blocks in a group.@see com::sun::star::text::AutoTextContainer +/** provides access to text blocks in a group. + @see com::sun::star::text::AutoTextContainer */ published service AutoTextGroup { - // DocMerge: empty anyway interface com::sun::star::text::XAutoTextGroup; - // DocMerge: empty anyway interface com::sun::star::container::XIndexAccess; - - // DocMerge from xml: service com::sun::star::text::AutoTextGroup: interface com::sun::star::container::XNamed /** provides access to the name of the group. - */ + */ interface com::sun::star::container::XNamed; -}; + /** The path to the file containing the <type>AutoTextEntry</type>'s in this group + */ + [property, readonly] string FilePath; -//============================================================================= + /** The title of this <type>AutoTextGroup</type> + */ + [property] string Title; + +}; }; }; }; }; diff --git a/offapi/com/sun/star/text/ViewSettings.idl b/offapi/com/sun/star/text/ViewSettings.idl index 7059a33449a7..9f242fcc6aa7 100644 --- a/offapi/com/sun/star/text/ViewSettings.idl +++ b/offapi/com/sun/star/text/ViewSettings.idl @@ -23,244 +23,156 @@ #ifndef __com_sun_star_text_ViewSettings_idl__ #define __com_sun_star_text_ViewSettings_idl__ -#ifndef __com_sun_star_beans_XPropertySet_idl__ #include <com/sun/star/beans/XPropertySet.idl> -#endif -#ifndef __com_sun_star_view_DocumentZoomType_idl__ #include <com/sun/star/view/DocumentZoomType.idl> -#endif -#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> -#endif -//============================================================================= - - module com { module sun { module star { module text { - -//============================================================================= +module com { module sun { module star { module text { // DocMerge from xml: service com::sun::star::text::ViewSettings /** provides access to the settings of the controller of a text document. */ published service ViewSettings { - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowAnnotations /** If this property is <TRUE/>, annotations (notes) are visible. */ [property] boolean ShowAnnotations; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowBreaks /** If this property is <TRUE/>, paragraph line breaks are visible. */ [property] boolean ShowBreaks; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFieldCommandsShowDrawings /** If this property is <TRUE/>, shapes are visible. */ [property] boolean ShowDrawings; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFieldCommands /** If this property is <TRUE/>, text fields are shown with their commands; otherwise the content is visible. */ [property] boolean ShowFieldCommands; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFootnoteBackground /** If this property is <TRUE/>, footnotes symbols are displayed with gray background. */ [property] boolean ShowFootnoteBackground; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowGraphics /** If this property is <TRUE/>, graphic objects are visible. */ [property] boolean ShowGraphics; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowHiddenParagraphs /** If this property is <TRUE/>, hidden paragraghs are displayed. */ [property] boolean ShowHiddenParagraphs; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowHiddenText /** If this property is <TRUE/>, hidden text is displayed. */ [property] boolean ShowHiddenText; - //------------------------------------------------------------------------- - - /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible. - */ - [property] boolean ShowRulers; - - //------------------------------------------------------------------------- + /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible. + */ + [property] boolean ShowRulers; - /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>, - the horizontal ruler is displayed. + /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>, + the horizontal ruler is displayed. */ [property] boolean ShowHoriRuler; - //------------------------------------------------------------------------- - - /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>, - the horizontal scroll bar is displayed. + /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>, + the horizontal scroll bar is displayed. */ [property] boolean ShowHoriScrollBar; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowIndexMarkBackground /** If this property is <TRUE/>, index marks are displayed with gray background. */ [property] boolean ShowIndexMarkBackground; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowParaBreaks /** If this property is <TRUE/>, paragraph breaks are visible. */ [property] boolean ShowParaBreaks; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowProtectedSpaces /** If this property is <TRUE/>, protected spaces (hard spaces) are displayed with gray background. */ [property] boolean ShowProtectedSpaces; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowSoftHyphens /** If this property is <TRUE/>, soft hyphens are displayed with gray background. */ [property] boolean ShowSoftHyphens; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowSpaces /** If this property is <TRUE/>, spaces are displayed with dots. */ [property] boolean ShowSpaces; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTableBoundaries /** If this property is <TRUE/>, table boundaries are displayed. */ [property] boolean ShowTableBoundaries; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTables /** If this property is <TRUE/>, tables are visible. */ [property] boolean ShowTables; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTabstops /** If this property is <TRUE/>, tab stops are visible. */ [property] boolean ShowTabstops; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTextBoundaries /** If this property is <TRUE/>, text boundaries are displayed. */ [property] boolean ShowTextBoundaries; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTextFieldBackground /** If this property is <TRUE/>, text fields are displayed with gray background. */ [property] boolean ShowTextFieldBackground; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowVertRuler /** If this property is <TRUE/>, the vertical ruler is displayed. */ [property] boolean ShowVertRuler; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowVertScrollBar /** If this property is <TRUE/>, the vertical scroll bar is displayed. */ [property] boolean ShowVertScrollBar; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::SmoothScrolling /** If this property is <TRUE/>, smooth scrolling is active. */ [property] boolean SmoothScrolling; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::text::ViewSettings::SolidMarkHandles /** If this property is <TRUE/>, handles of drawing objects are visible. */ [property] boolean SolidMarkHandles; - //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the vertical ruler is aligned to the right side of the view and the vertical scrollbar is on the left. */ [property] boolean IsVertRulerRightAligned; - //------------------------------------------------------------------------- /** If this property is <TRUE/> the document will be displayed as if it were a HTML document. */ [property] boolean ShowOnlineLayout; - //------------------------------------------------------------------------- /** This property defines the zoom type for the document. @see com::sun::star::view::DocumentZoomType */ [property] short ZoomType; - //------------------------------------------------------------------------- /** Defines the zoom value to use. Valid only if the ZoomType is set to <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>. */ [property] short ZoomValue; - //------------------------------------------------------------------------- + /** If this property is <TRUE/> hyperlinks in the document are executed (loaded) on mouse click. Otherwise they are handled like normal text. */ [optional, property] boolean IsExecuteHyperlinks; - //------------------------------------------------------------------------- /** Specifies whether to display the grid or not @since OOo 2.0 */ [optional, property] boolean IsRasterVisible; - //------------------------------------------------------------------------- /** Specifies whether to move frames, drawing elements, and form functions only between grid points. @@ -268,7 +180,6 @@ published service ViewSettings */ [optional, property] boolean IsSnapToRaster; - //------------------------------------------------------------------------- /** Specifies the number of intervals between grid points on the X-axis. <p>The value must be greater or equal to 0, and the application @@ -280,7 +191,6 @@ published service ViewSettings */ [optional, property] long RasterSubdivisionX; - //------------------------------------------------------------------------- /** Specifies the number of intervals between grid points on the Y-axis. <p>The value must be greater or equal to 0, and the application @@ -292,7 +202,6 @@ published service ViewSettings */ [optional, property] long RasterSubdivisionY; - //------------------------------------------------------------------------- /** Defines the unit of measure for the spacing between grid points on the X-axis. @@ -305,7 +214,6 @@ published service ViewSettings */ [optional, property] long RasterResolutionX; - //------------------------------------------------------------------------- /** Defines the unit of measure for the spacing between grid points on the Y-axis. @@ -318,13 +226,12 @@ published service ViewSettings */ [optional, property] long RasterResolutionY; - //------------------------------------------------------------------------- /** If this property is <TRUE/>, hidden characters are displayed @since OOo 3.0 */ [optional, property] boolean ShowHiddenCharacters; - //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the settings of nonprinting characters are applied. <p>This option controls the use of the settings ShowHiddenCharacters, @@ -333,7 +240,7 @@ published service ViewSettings @since OOo 3.0 */ [optional, property] boolean ShowNonprintingCharacters; - //------------------------------------------------------------------------- + /** metric unit of the horizontal ruler <p>Uses values <type scope="com::sun::star::awt">FieldUnit</type></p> @@ -341,7 +248,7 @@ published service ViewSettings @since OOo 3.1 */ [optional, property] long HorizontalRulerMetric; - //------------------------------------------------------------------------- + /** metric unit of the vertical ruler <p>Uses values from <type scope="com::sun::star::awt">FieldUnit</type></p> @@ -349,16 +256,21 @@ published service ViewSettings @since OOo 3.1 */ [optional, property] long VerticalRulerMetric; - //------------------------------------------------------------------------- + /** If this property is <TRUE/>, tips for document content are shown, typically in a help balloon when the mouse is over the content. - @since Apache OpenOffice 3.5 + @since Apache OpenOffice 4.0 */ [optional, property] boolean ShowContentTips; -}; -//============================================================================= + /** If this property is <TRUE/>, and the scroll bar is shown, a tool tip + is displayed while scrolling. + + @since Apache OpenOffice 4.0 + */ + [optional, property] boolean ShowScrollBarTips; +}; }; }; }; }; diff --git a/offapi/com/sun/star/text/XAutoTextContainer.idl b/offapi/com/sun/star/text/XAutoTextContainer.idl index da34ee4e2bde..6ff07740991a 100644 --- a/offapi/com/sun/star/text/XAutoTextContainer.idl +++ b/offapi/com/sun/star/text/XAutoTextContainer.idl @@ -19,85 +19,68 @@ * *************************************************************/ - #ifndef __com_sun_star_text_XAutoTextContainer_idl__ #define __com_sun_star_text_XAutoTextContainer_idl__ -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - -#ifndef __com_sun_star_text_XAutoTextGroup_idl__ -#include <com/sun/star/text/XAutoTextGroup.idl> -#endif - -#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ -#include <com/sun/star/lang/IllegalArgumentException.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 text { +#include <com/sun/star/container/XNameAccess.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/text/XAutoTextGroup.idl> -//============================================================================= +module com { module sun { module star { module text { -// DocMerge from xml: interface com::sun::star::text::XAutoTextContainer /** handles blocks of <type>AutoTextEntry</type>. - - - - - - - - @example <pre> - AutoTextPath=d:\office\autotext;f:\user\autotext - - groupname: "standard*0" - -&amp;gt; the group file is located n the path d:\office\autotext - groupname: "all*1" - -&amp;gt; the group file is located in the path f:\user\autotext\ - </pre> - - <p>If the path extension is not specified, then the first directory - is used. For automatic text expansion, the name of an actual group is - set to search first in this group. - - </p>@see AutoTextContainer - */ + @see AutoTextContainer +*/ published interface XAutoTextContainer: com::sun::star::container::XNameAccess { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::text::XAutoTextContainer::insertNewByName /** creates a new AutoText group. - */ + + @param aGroupName the name of the <type>AutoTextContainer</type> + + <p>The name must follow the pattern <code>groupname*pathid</code>, where:</p> + + <ul> + <li><code>groupname</code> should contain only alphanumeric characters + (A-Za-z0-9), underscore (_) or space (0x20)</li> + <li>an asterisk (*) delimiter separates the group name from the path + identifier</li> + <li><code>pathid</code> is a number (0 or 1) identifying the directory + where the AutoText file is stored. Paths are stored in the Office + configuration and accessed through + <member scope="com::sun::star::util">PathSettings::AutoText</member>. + <ul> + <li>0 indicates the path of the <b>Office Basis</b> layer</li> + <li>1 indicates the path of the <b>user</b> directory</li> + </ul> + </li> + </ul> + If only <code>groupname</code> is specified, the path defaults to 0, the + <b>Office Basis</b> layer.</br>Note that in some systems the user may lack of + write access to the Office Basis directory. + + @example + + <ul> + <li><code>standard*0</code></br>the "standard" AutoTextGroup in the Office Basis layer</li> + <li><code>template</code></br>the "template" AutoTextGroup in the Office Basis layer</li> + <li><code>mytexts*1</code></br>the "mytexts" AutoTextGroup in the user directory</li> + </ul> + + */ com::sun::star::text::XAutoTextGroup insertNewByName( [in] string aGroupName ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::text::XAutoTextContainer::removeByName /** deletes the specified AutoText group. - */ + @param aGroupName see the documentation for <member>XAutoTextContainer::insertNewByName()</member> + */ void removeByName( [in] string aGroupName ) raises( com::sun::star::container::NoSuchElementException ); }; -//============================================================================= - }; }; }; }; - #endif diff --git a/offapi/com/sun/star/awt/XThrobber.idl b/offapi/com/sun/star/text/XMarkingAccess.idl index 243de03f61c9..cb9b539816ee 100644 --- a/offapi/com/sun/star/awt/XThrobber.idl +++ b/offapi/com/sun/star/text/XMarkingAccess.idl @@ -20,31 +20,24 @@ *************************************************************/ -#ifndef __com_sun_star_awt_XThrobber_idl__ -#define __com_sun_star_awt_XThrobber_idl__ +#ifndef __com_sun_star_text_XMarkingAccess_idl__ +#define __com_sun_star_text_XMarkingAccess_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.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 { + module com { module sun { module star { module text { //============================================================================= -/** - @deprecated - You should use <type>XAnimation</type>, <type>AnimatedImagesControl</type> and <type>SpinningProgressControlModel</type>. +/** extends a text range by method to modify its position. */ -published interface XThrobber: com::sun::star::uno::XInterface +interface XMarkingAccess { - void start(); - void stop(); + void invalidateMarkings([in] long nType); }; //============================================================================= diff --git a/offapi/com/sun/star/text/XTextMarkup.idl b/offapi/com/sun/star/text/XTextMarkup.idl index d051ad764ae0..041ee6841bb3 100644 --- a/offapi/com/sun/star/text/XTextMarkup.idl +++ b/offapi/com/sun/star/text/XTextMarkup.idl @@ -32,6 +32,11 @@ #include <com/sun/star/text/TextMarkupType.idl> #endif +#ifndef __com_sun_star_text_XTextRange_idl__ +#include <com/sun/star/text/XTextRange.idl> +#endif + + //============================================================================= module com { module sun { module star { module text { @@ -74,11 +79,17 @@ interface XTextMarkup @param xMarkupInfoContainer contains additional information about the markup. */ - void commitTextMarkup( [in] long nType, + void commitStringMarkup( [in] long nType, [in] string aIdentifier, [in] long nStart, [in] long nLength, [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer ); + + void commitTextRangeMarkup( [in] long nType, + [in] string aIdentifier, + [in] com::sun::star::text::XTextRange xRange, + [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer ); + }; }; }; }; }; diff --git a/offapi/com/sun/star/text/makefile.mk b/offapi/com/sun/star/text/makefile.mk index adf2e89c8955..82be3aa9ddc3 100644 --- a/offapi/com/sun/star/text/makefile.mk +++ b/offapi/com/sun/star/text/makefile.mk @@ -234,6 +234,7 @@ IDLFILES=\ XTextColumns.idl\ XTextContent.idl\ XTextCursor.idl\ + XMarkingAccess.idl\ XTextCopy.idl\ XTextDocument.idl\ XTextEmbeddedObject.idl\ diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index dddf8338949c..1e0171056fa3 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -19,8 +19,6 @@ * *************************************************************/ - - #ifndef __com_sun_star_ucb_Content_idl__ #define __com_sun_star_ucb_Content_idl__ @@ -35,18 +33,15 @@ #include <com/sun/star/ucb/XContentCreator.idl> #include <com/sun/star/container/XChild.idl> -//============================================================================= - module com { module sun { module star { module ucb { -//============================================================================= /** A <type>Content</type> is a service that provides access to data of a content provided by an implementation of the service <type>ContentProvider</type>. */ published service Content { - //------------------------------------------------------------------------- + /** provides access to the identitity and the type of the content and allows the registration of listeners for <type>ContentEvent</type>s. @@ -54,7 +49,7 @@ published service Content */ interface com::sun::star::ucb::XContent; - //------------------------------------------------------------------------- + /** must be implemented to make it possible to resolve cyclic object references. @@ -73,7 +68,7 @@ published service Content */ interface com::sun::star::lang::XComponent; - //------------------------------------------------------------------------- + /** enables the caller to let the content execute commands. <p>It is strongly recommended that any implementation supports the @@ -85,527 +80,813 @@ published service Content commands and properties. A content may define additional commands and properties. </p> - <p>This interface is required. </p> - - <pre> - ======================================================================= - Commands: - ======================================================================= - - [return type] - [command name] - [parameter type and name] - - ----------------------------------------------------------------------- - Mandatory commands: - ----------------------------------------------------------------------- - - // This command obtains an interface which allows to query - // information on commands supported by a content. - <type>XCommandInfo</type> - getCommandInfo - void - - // This command obtains an interface which allows to query - // information on properties supported by a content. - <type scope="com::sun::star::beans">XPropertySetInfo</type> - getPropertySetInfo - void - - // This command obtains property values from the content. - // Note: The execution will not be aborted, if there are properties - // requested, that are unknown to the content! The returned - // row object must contain a NULL value in the corresponding - // column instead. - <type scope="com::sun::star::sdbc">XRow</type> - getPropertyValues - sequence< <type scope="com::sun::star::beans">Property</type> > aProps - - // This command sets property values of the content. - // Note that setPropertyValues does not throw an exception in the case - // that one or more of the requested property values cannot be set! The - // implementation should set as much property values as possible. This - // command returns a sequence< any > which has exactly the same number - // of elements like the number of properties to set. Every sequence - // element contains the status for a property. The first sequence - // elements corresponds to the first element in the sequence of - // <type scope="com::sun::star::beans">PropertyValue</type> passed as - // command argument and so on. The exceptions will never be passed to - // an Interaction Handler. - // - // An any containing: - // - // - No value indicates, that the property value was set successfully. - // - <type scope="com::sun::star::beans">UnknownPropertyException</type> - // indicates, that the property is not known to the content - // implementation. - // - <type scope="com::sun::star::beans">IllegalTypeException</type> - // indicates, that the data type of the property value is not - // acceptable. - // - <type scope="com::sun::star::lang">IllegalAccessException</type> - // indicates, that the property is constant - // (<member scope="com::sun::star::beans">PropertyAttribute::READONLY</member> - // is set). - // - <type scope="com::sun::star::lang">IllegalArgumentException</type> - // indicates, that the property value is not acceptable. For instance, - // setting an empty title may be illegal. - // - Any other execption derived from <type scope="com::sun::star::uno">Exception</type> - // indicates, that the value was not set successfully. For example, - // this can be a <type>InteractiveAugmentedIOException</type> - // transporting the error code <member>IOErrorCode::ACCESS_DENIED</member>. - // - // If the value to set is equal to the current value, no exception must - // be added to the returned sequence - sequence< any > - setPropertyValues - sequence< <type scope="com::sun::star::beans">PropertyValue</type> > aValues - - ----------------------------------------------------------------------- - Optional commands: - ----------------------------------------------------------------------- - - // For folder objects, this command will return an implementation - // of service <type>DynamicResultSet</type>. - // - // The <type>OpenCommandArgument2</type> members must be filled as follows: - // - // Mode : ALL or FOLDERS or DOCUMENTS. The implementation - // of the open command MUST support all these modes! - // Priority : can be set, but implementation may ignore the value - // Sink : empty( ignored ) - // Properties : The properties for that the result set shall - // contain the property values. The order of the - // sequence is the same as the order of result set - // columns. First element of sequence will be row - // number one, second will be row number two, ... - // SortingInfo : contains sort criteria, if result set shall - // be sorted, otherwise it can be left empty. - // - // The exceution must be aborted by the implementation of this command - // (by throwing a <type>CommandAbortedException</type>), if an - // unsupported mode is requested. - <type>XDynamicResultSet</type> - <B>open</B> - <type>OpenCommandArgument2</type> aOpenCommandArg - - // For non-folder objects, the <type>OpenCommandArgument2</type> struct - // will be prefilled with a data sink object, which will be filled - // with the content data. - // - // The <type>OpenCommandArgument2</type> members must be filled as follows: - // - // Mode : DOCUMENT or DOCUMENT_SHARE_DENY_NONE or - // DOCUMENT_SHARE_DENY_WRITE. Support for DOCUMENT - // is mandatory, all others are optional. - // Priority : can be set, but implementation may ignore the value - // Sink : a sink, where the implementation can put the - // document data into. - // Properties : empty ( ignored ) - // SortingInfo : empty ( ignored ) - // - // The exceution must be aborted by the implementation of this command - // (by throwing a <type>CommandAbortedException</type>), if an - // unsupported mode is requested. - void - <B>open</B> - <type>OpenCommandArgument2</type> aOpenCommandArg - - // This command triggers an update operation on a content. For example, - // when "updating" a POP3-Inbox, the content for that box will get - // and store all new objects on the appropriate server. The inserted - // contents will be notified by calling - // <member>XContentEventListener::contentEvent</member>. - void - <B>update</B> - <type>OpenCommandArgument2</type> aOpenCommandArg - - // This command triggers a synchronization operation between locally - // cached data and remote server's data. For example, when - // "synchronizing" a POP3-Inbox the content for that box will get and - // store all new objects and destroy all cached data for objects no - // longer existing on the server. The inserted/deleted contents will - // be notified by calling - // <member>XContent::contentEvent</member>. - void - <B>synchronize</B> - <type>OpenCommandArgument2</type> aOpenCommandArg - - // This command closes an object. - void - <B>close</B> - void - - // This command deletes an object. If <TRUE/> is passed as parameter, - // the object will be destroyed physically. Otherwise it will be put - // into trash can, if such a service is available and the object to - // be deleted supports the command "undelete". - // On successful completion of this command, the deleted content - // must propagate its deletion by notifying a <type>ContentEvent</type> - // - <member>ContentAction::DELETED</member>. Additionally, the contents - // parent must notify a <type>ContentEvent</type> - // - <member>ContentAction::REMOVED</member> - void - <B>delete</B> - boolean bDeletePhysically - - // This command restores an object previously deleted into trash. It - // must be supported by objects which claim to be undeletable, but - // should never be called directly. - void - <B>undelete</B> - void - - // (1) This command inserts a new content. It commits the process of - // creating a new content via executing the command "createNewContent" - // and initializing it via setting properties, afterwards. - // The command is not called on the content which created the new - // content, because the new object already knows where it is to be - // inserted (i.e. Calling createNewContent with the content type for a - // message on a News Group creates a content which internally belongs - // to the Outbox. Calling "insert" on that message will result in - // posting the article to the appropriate News Group). Not calling - // "insert" for the new content, i.e. because the user cancels writing - // a new message, simply discards the new object. No extra call to - // "delete" is necessary. - // On successful completion of this command, the parent of the inserted - // content must propagate the change by notifying a - // <type>ContentEvent</type> - <member>ContentAction::INSERTED</member>. - // - // (2) Additionally this command can be called at any time to overwrite - // the data of an existing content. - void - <B>insert</B> - <type>InsertCommandArgument</type> aInsertCommandArg - - // This command searches for subcontents of a content matching the - // given search criteria. The command will return an implemenation - // of service <type>DynamicResultSet</type>. - <type>XDynamicResultSet</type> - <B>search</B> - <type>SearchCommandArgument</type> aSearchCommandArg - - // <b>Important note:</b> A client that wants to transfer data should - // not execute this command, but it should execute the command - // "globalTransfer" at the <type>UniversalContentBroker</type>. - // This command is able to transfer all kind of content - // supported by that UCB. - // - // This command transfers (copies/moves) an object from one location - // to another. It must be executed at the folder content representing - // the destination of the transfer operation. Note that the - // implementation need not(!) be able to handle any type of contents. - // Generally, there are good chances that a transfer of a content will - // succeed, if source and target folder have the same URL scheme. - // But there is no guaranty for that. For instance, moving a message - // from a folder on IMAP server A to a folder on IMAP server B may - // fail, because the transfer command can't be implemented efficiently - // for this scenario, because it is not directly supported by the IMAP - // protocol. On the other hand, moving a message from one folder to - // another folder on the same IMAP server should work, because it can - // be implemeted efficiently. If an implementation is not able to - // handle a given source URL, it should indicate this by issuing a - // <type>InteractiveBadTransferURLException</type> interaction request. - // Source and target folder may be the same when doing a move operation. - // - // Transfers without the transfer command can be done as follows: - // - // 1) Create a new content at the target folder - // --> targetContent = target.execute( "createNewContent", type ) - // 2) Transfer data from source to target content - // --> props = sourceContent.execute( "getPropertyValues", ... ) - // --> dataStream = sourceContent.execute( "open", ... ) - // --> targetContent.execute( "setPropertyValues", props ) - // 3) Insert ( commit ) the new content - // --> targetContent.execute( "insert", dataStream ) - // 4) For move operations only: destroy the source content - // sourceContent.execute( "delete", ... ) - // - // This mechanism should work for all transfer operations, but generally - // it's less efficient than the transfer command. - void - <B>transfer</B> - <type>TransferInfo</type> aTransferInfo - - // This command obtains an exlusive write lock for the resource. The - // lock is active until command "unlock" is executed or the OOo - // session that obtained the lock ends or until the lock is released by - // a third party (e.g. a system administrator). - void - <B>lock</B> - void - Exceptions: <type>InteractiveLockingLockedException</type> - <type>InteractiveLockingLockExpiredException</type> - - // This command removes a lock obtained by executing the command "lock" - // from the resource. - void - <B>unlock</B> - void - Exceptions: <type>InteractiveLockingNotLockedException</type> - <type>InteractiveLockingLockExpiredException</type> - - // Note that <type>InteractiveLockingLockExpiredException</type> might - // be raised by any command that requires a previously obtained lock. - - // This command creates a new non-persistent content of a given type. - // - // <p>Creation of a new (persistent) content: - // <ol> - // <li>creatabletypes = obtain "CreatableContentsInfo" property<br> - // from creator - // <li>choose a suitable type from creatabletypes - // <li>newObject = execute command "createNewContent(type)" at<br> - // creator - // <li>initialize the new object (i.e. newObject.Property1 = ...) - // <li>execute command "insert" at new content. This command - // commits the data and makes the new content persistent. - // </ol> - // - // This command must be supported by every Content that supports the - // property "CreatableContentsInfo" if the returned property value - // contains a non-empty sequence of creatable types. - // - // Note: This command is part of the replacement for the deprecated - // interface <type>XContentCreator</type>. - <type>XContent</type> > - <B>createNewContent</B> - <type>ContentInfo<type> contentinfo - - ======================================================================= - Properties: - ======================================================================= - - ----------------------------------------------------------------------- - Mandatory properties: - ----------------------------------------------------------------------- - - // contains a unique(!) type string for the content ( i.e. - // "application/vnd.sun.star.hierarchy-link" ). This property is always - // read-only. It does not contain the media type ( MIME types ) of the - // content. Media types may be provided through the optional property - // "MediaType". - // The value of this property should match the information on creatable - // contents given by UCB contents that implement the property - // "CreatableContentsInfo". - string ContentType - - // indicates, whether a content can contain other contents. - boolean IsFolder - - // indicates, whether a content is a document. This means, the - // content can dump itself into a data sink. - boolean IsDocument - - // contains the title of an object (e.g. the subject of a message). - string Title; - - ----------------------------------------------------------------------- - Optional properties: - ----------------------------------------------------------------------- - - // contains the interval for automatic updates of an object. - // It is specified in seconds. - long AutoUpdateInterval - - // contains the maximum number of network connections - // allowed for one (internet) protocol at a time. (e.g. The HTTP - // cache can be configured to use a maximum for the number of - // connections used for browsing.) - short ConnectionLimit - - // contains the current connection mode for the object. - // (see <type>ConnectionMode</type>) - short ConnectionMode - - // contains the date and time the object was created. - <type scope"com::sun::star::util">DateTime</type> DateCreated - - // contains the date and time the object was last modified. - <type scope"com::sun::star::util">DateTime</type> DateModified - - // contains the count of documents of a folder. - long DocumentCount; - - // contains the count of marked documents within a folder. - long DocumentCountMarked - - // contains a sequence of documemt header fields (i.e. header - // fields of a MIME-message, or the document info of an - // office document ). For some standard header fields there - // are predefined separate properties, like "MessageTo". - sequence< <type>DocumentHeaderField</type> > DocumentHeader - - // contains information about the way a folder stores the - // contents of (remote) documents. - <type>DocumentStoreMode</type> DocumentStoreMode - - // contains the count of subfolders of a folder. - long FolderCount - - // contains the free space left on a storage device. It is - // specified in bytes. - hyper FreeSpace - - // indicates whether a content has subcontents, which are documents. - boolean HasDocuments - - // indicates whether a content has subcontents, which are folders. - boolean HasFolders - - // indicates whether a content is "marked". - boolean IsMarked - - // indicates whether a content has been "read". - boolean IsRead; - - // indicates whether a content is read-only. - boolean IsReadOnly - - // indicates whether a content is subscribed. - boolean IsSubscribed - - // indicates whether the feature to store contents depending on - // their age is active. - boolean IsTimeLimitedStore; - - // indicates whether (sub)contents shall be automatically updated - // everytime a (folder) content is opened. This property may be - // used to control whether a folder content should read data only - // from local cache when it is opened, or whether it should connect - // to a server to obtain latest data. - boolean UpdateOnOpen - - // contains the keywords of a document (e.g. the value - // of the "keywords" header field of a news article). - string Keywords - - // contains the media type ( MIME type ) of a content. It is highly - // recommended to support this property if the content's implementation - // can obtain the media type natively from its data source ( i.e. - // HTTP servers provide media types for all their documents ). - string MediaType - - // contains the BCC (blind carbon copy) receiver(s) of a message. - string MessageBCC - - // contains the CC (carbon copy) receiver(s) of a message. - string MessageCC - - // contains (the address of) the sender of a message. - string MessageFrom - - // contains the ID of a message. - string MessageId - - // contains the "In-Reply-To" field of a message. - string MessageInReplyTo - - // contains the "Reply-To" field of a message. - string MessageReplyTo - - // contains the recipient(s) of a message. - string MessageTo - - // contains the name(s) of the newsgroup(s) into which a message - // was posted. - string NewsGroups - - // contains a password (e.g. needed to access a POP3-Server). - string Password - - // contains a priority (i.e. of a message). - <type>Priority</type> Priority - - // contains the "References" field of a news article. - string References - - // contains the rules set for a content. - <type>RuleSet</type> Rules - - // contains the count of seen/read subcontents of a folder content. - long SeenCount - - // contains the base directory to use on a server. (e.g. Setting - // the server base of an FTP-Account to "/pub/incoming" - // will result in showing contents from that directory and not from - // server's root directory) - string ServerBase - - // contains a server name (e.g. The name of the server to use for - // a POP3-Account). - string ServerName - - // contains a numeric server port. - short ServerPort - - // contains the size (usually in bytes) of an object. - hyper Size - - // contains a size limit for an object. (e.g. One may specify the - // maximum size of the HTTP-Cache) - hyper SizeLimit - - // contains the count of subscribed contents of a folder. - long SubscribedCount - - // contains the policy to use when synchronizing two objects. - <type>SynchronizePolicy</type> SynchronizePolicy - - // contains information about the target frame to use when displaying - // an object. - - <p>The value is a string containing three tokens, separated by ";" - (A semicolon):<br/> - <dl> - <dt>1st token - </dt><dd>Behavior on "select" ( single click ) - </dd><dt>2nd token - </dt><dd>Behavior on "open" ( double click ) - </dd><dt>3rd token - </dt><dd>Behavior on "open in new task" ( double click + CTRL key ) - </dd></dl> - </p> - <p> Each token may contain the following values:<br/> - <dl> - <dt>"_beamer" - </dt><dd>Show in "Beamer" - </dd><dt>"_top" - </dt><dd>Show in current frame (replaces old) - </dd><dt>"_blank" - </dt><dd>Show in new task - </dd></dl> - </p> - string TargetFrames - - // for contents that are links to other contents, contains the URL of - // the target content - string TargetURL - - // contains the value to use if the property "IsTimeLimitedStore" is set. - short TimeLimitStore; - - // contains a user name. (e.g. the user name needed to access a - // POP3-Account) - string UserName - - // describes a verification policy. - <type>VerificationMode</type> VerificationMode - - // contains the types of Contents a Content object can create via - // command "createNewContent". - // - // If the property value can be a non-empty sequence, the Content must - // also support command "createNewContent". - // - // Note: This property is part of the replacement for the deprecated - // interface <type>XContentCreator</type>. - sequence <type>ContentInfo</type> CreatableContentsInfo - - </pre> + <p>This interface is required.</p> + + <h3>Commands</h3> + <h4>Mandatory commands</h4> + + <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> + <thead> + <tr> + <th>Command Name</th> + <th>Return Type</th> + <th>Parameters</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>getCommandInfo</td> + <td><type>XCommandInfo</type></td> + <td>void</td> + <td>This command obtains an interface which allows to query + information on commands supported by a content. + </td> + </tr> + <tr> + <td>getPropertySetInfo</td> + <td><type scope="com::sun::star::beans">XPropertySetInfo</type></td> + <td>void</td> + <td>This command obtains an interface which allows to query + information on properties supported by a content. + </td> + </tr> + <tr> + <td>getPropertyValues</td> + <td><type scope="com::sun::star::sdbc">XRow</type></td> + <td>sequence< <type scope="com::sun::star::beans">Property</type> > aProps</td> + <td>This command obtains property values from the content. + <blockquote> + <b>Note</b>: The execution will not be aborted, if there + are properties requested, that are unknown to the + content. The returned row object must contain a NULL + value in the corresponding column instead. + </blockquote> + </td> + </tr> + <tr> + <td>setPropertyValues</td> + <td>sequence< any ></td> + <td>sequence< <type scope="com::sun::star::beans">PropertyValue</type> > aValues</td> + <td>This command sets property values of the content. + <p>Note that setPropertyValues does not throw an exception in the case + that one or more of the requested property values cannot be set. + The implementation should set as much property values as possible.</p> + + <p>This command returns a sequence< any > which has exactly the same number + of elements like the number of properties to set. Every sequence + element contains the status for a property. The first sequence + elements corresponds to the first element in the sequence of + <type scope="com::sun::star::beans">PropertyValue</type>s passed as + command argument, and so on. The exceptions will never be passed to + an <type scope="com::sun::star::task">InteractionHandler</type>.</p> + + <p>Every element in the returned sequence is an any containing:</p> + <ul> + <li>No value indicates, that the property value was set successfully.</li> + <li><type scope="com::sun::star::beans">UnknownPropertyException</type> + indicates, that the property is not known to the content + implementation.</li> + <li><type scope="com::sun::star::beans">IllegalTypeException</type> + indicates, that the data type of the property value is not + acceptable.</li> + <li><type scope="com::sun::star::lang">IllegalAccessException</type> + indicates, that the property is constant + (<member scope="com::sun::star::beans">PropertyAttribute::READONLY</member> + is set).</li> + <li><type scope="com::sun::star::lang">IllegalArgumentException</type> + indicates, that the property value is not acceptable. For instance, + setting an empty title may be illegal.</li> + <li>Any other execption derived from <type scope="com::sun::star::uno">Exception</type> + indicates, that the value was not set successfully. For example, + this can be a <type>InteractiveAugmentedIOException</type> + transporting the error code <member>IOErrorCode::ACCESS_DENIED</member>.</li> + </ul> + + <p>If the value to set is equal to the current value, no exception must + be added to the returned sequence</p> + </td> + </tr> + </tbody> + </table> + + <h4>Optional commands</h4> + <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> + <thead> + <tr> + <th>Command Name</th> + <th>Return Type</th> + <th>Parameters</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>open</td> + <td><type>XDynamicResultSet</type></td> + <td><type>OpenCommandArgument2</type> aOpenCommandArg</td> + <td> + For <b>folder</b> objects, this command will return an + implementation of service <type>DynamicResultSet</type>. + <p>The <type>OpenCommandArgument2</type> members must be + filled as follows:</p> + <ul> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Mode</member>: + <const scope="com::sun::star::ucb">OpenMode::ALL</const> or + <const scope="com::sun::star::ucb">OpenMode::FOLDERS</const> or + <const scope="com::sun::star::ucb">OpenMode::DOCUMENTS</const>. + The implementation of the open command MUST support all these modes! + </li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Priority</member>: + can be set, but implementation may ignore the value + </li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Sink</member>: + empty( ignored ) + </li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Properties</member>: + The properties for which the result set shall + contain the property values. The order of the + sequence is the same as the order of result set + columns. First element of sequence will be row + number one, second will be row number two, ... + </li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument2::SortingInfo</member>: + contains sort criteria, if result set shall + be sorted, otherwise it can be left empty. + </li> + </ul> + The exceution must be aborted by the implementation of this command + (by throwing a <type>CommandAbortedException</type>), if an + unsupported mode is requested. + </td> + </tr> + <tr> + <td>open</td> + <td>void</td> + <td><type>OpenCommandArgument2</type> aOpenCommandArg</td> + <td>For non-folder objects, the <type>OpenCommandArgument2</type> + struct will be prefilled with a data sink object, which + will be filled with the content data. + <p>The <type>OpenCommandArgument2</type> members must be + filled as follows:</p> + <ul> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Mode</member>: + <const scope="com::sun::star::ucb">OpenMode::DOCUMENT</const> or + <const scope="com::sun::star::ucb">OpenMode::DOCUMENT_SHARE_DENY_NONE</const> or + <const scope="com::sun::star::ucb">OpenMode::DOCUMENT_SHARE_DENY_WRITE</const>. + Support for DOCUMENT is mandatory, all others are optional. + </li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Priority</member>: + can be set, but implementation may ignore the value + </li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Sink</member>: + a sink, where the implementation can put the document data into. + </li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument::Properties</member>: empty ( ignored )</li> + <li><member scope="com::sun::star::ucb">OpenCommandArgument2::SortingInfo</member>: empty ( ignored )</li> + </ul> + <p>The exceution must be aborted by the implementation of this command + (by throwing a <type>CommandAbortedException</type>), if an + unsupported mode is requested.</p> + </td> + </tr> + <tr> + <td>createNewContent</td> + <td><type>XContent</type></td> + <td><type>ContentInfo</type> contentinfo</td> + <td> + This command creates a new <b>non-persistent</b> content of a given type. + <p>This command must be supported by every <type>Content</type> + that supports the property "CreatableContentsInfo", if the returned + property value contains a non-empty sequence of creatable types. + <blockquote> + Note: This command is part of the replacement for the deprecated + interface <type>XContentCreator</type>. + </blockquote> + <p>Creation of a new <b>persistent</b> content: + <ol> + <li>creatabletypes = obtain "CreatableContentsInfo" property from creator</li> + <li>choose a suitable type from creatabletypes</li> + <li>newObject = execute command "createNewContent(type)" at creator</li> + <li>initialize the new object (i.e. newObject.Property1 = ...)</li> + <li>execute command "insert" at new content. This command + commits the data and makes the new content persistent.</li> + </ol> + </td> + </tr> + <tr> + <td>insert</td> + <td>void</td> + <td><type>InsertCommandArgument</type> aInsertCommandArg</td> + <td> + <ol> + <li> + This command inserts a <b>new content</b>. It commits the process of + creating a new content via executing the command "createNewContent" + and initializing it via setting properties, afterwards.</br> + The command is not called on the content which created the new + content, because the new object already knows where it is to be + inserted (i.e. Calling createNewContent with the content type for a + message on a News Group creates a content which internally belongs + to the Outbox. Calling "insert" on that message will result in + posting the article to the appropriate News Group). Not calling + "insert" for the new content, i.e. because the user cancels writing + a new message, simply discards the new object. No extra call to + "delete" is necessary.</br> + On successful completion of this command, the parent of the inserted + content must propagate the change by notifying a + <type>ContentEvent</type> - <member>ContentAction::INSERTED</member>. + </li> + <li> + Additionally this command can be called at any time to overwrite + the data of an <b>existing content</b>. + </li> + </ol> + </td> + </tr> + <tr> + <td>update</td> + <td>void</td> + <td><type>OpenCommandArgument2</type> aOpenCommandArg</td> + <td>This command triggers an update operation on a content. + For example, when "updating" a POP3-Inbox, the content + for that box will get and store all new objects on the + appropriate server. The inserted contents will be + notified by calling + <member>XContentEventListener::contentEvent</member>. + </td> + </tr> + <tr> + <td>synchronize</td> + <td>void</td> + <td><type>OpenCommandArgument2</type> aOpenCommandArg</td> + <td> + This command triggers a synchronization operation between locally + cached data and remote server's data. For example, when + "synchronizing" a POP3-Inbox the content for that box will get and + store all new objects and destroy all cached data for objects no + longer existing on the server. The inserted/deleted contents will + be notified by calling + <member>XContent::contentEvent</member>. + </td> + </tr> + <tr> + <td>close</td> + <td>void</td> + <td>void</td> + <td>This command closes an object.</td> + </tr> + <tr> + <td>delete</td> + <td>void</td> + <td>boolean bDeletePhysically</td> + <td> + This command deletes an object. If <TRUE/> is passed as parameter, + the object will be destroyed physically. Otherwise it will be put + into trash can, if such a service is available and the object to + be deleted supports the command "undelete". + On successful completion of this command, the deleted content + must propagate its deletion by notifying a <type>ContentEvent</type> + - <member>ContentAction::DELETED</member>. Additionally, the contents + parent must notify a <type>ContentEvent</type> + - <member>ContentAction::REMOVED</member> + </td> + </tr> + <tr> + <td>undelete</td> + <td>void</td> + <td>void</td> + <td> + This command restores an object previously deleted into trash. It + must be supported by objects which claim to be undeletable, but + should never be called directly. + </td> + </tr> + <tr> + <td>search</td> + <td><type>XDynamicResultSet</type></td> + <td><type>SearchCommandArgument</type> aSearchCommandArg</td> + <td> + This command searches for subcontents of a content matching the + given search criteria. The command will return an implemenation + of service <type>DynamicResultSet</type>. + </td> + </tr> + <tr> + <td>transfer</td> + <td>void</td> + <td><type>TransferInfo</type> aTransferInfo</td> + <td> + <blockquote> + <b>Important note:</b> A client that wants to transfer data should + not execute this command, but it should execute the command + "globalTransfer" at the <type>UniversalContentBroker</type>. + This command is able to transfer all kind of content + supported by that UCB. + </blockquote> + This command transfers (copies/moves) an object from one location + to another. It must be executed at the folder content representing + the <b>destination</b> of the transfer operation.</br> + Note that the implementation need not be able to handle + any type of contents.</br> + Generally, there are good chances that a transfer of a content will + succeed, if source and target folder have the same URL scheme. + But there is no guaranty for that.</br> + For instance, moving a message from a folder on IMAP server A + to a folder on IMAP server B may fail, because the transfer + command can't be implemented efficiently for this scenario, + because it is not directly supported by the IMAP protocol. + On the other hand, moving a message from one folder to + another folder on the same IMAP server should work, because it can + be implemeted efficiently.</br> + If an implementation is not able to handle a given source URL, + it should indicate this by issuing a + <type>InteractiveBadTransferURLException</type> interaction request.</br> + Source and target folder may be the same when doing a move operation. + </br> + Transfers without the transfer command can be done as follows: + <ol> + <li>Create a new content at the target folder</br> + <code>targetContent = target.execute( "createNewContent", type )</code> + </li> + <li>Transfer data from source to target content</br> + <code>props = sourceContent.execute( "getPropertyValues", ... )</code> + <code>dataStream = sourceContent.execute( "open", ... )</code> + <code>targetContent.execute( "setPropertyValues", props )</code> + </li> + <li>Insert ( commit ) the new content</br> + <code>targetContent.execute( "insert", dataStream )</code> + </li> + <li>For move operations only: destroy the source content</br> + <code>sourceContent.execute( "delete", ... )</code> + </li> + </ol> + <p>This mechanism should work for all transfer operations, but generally + it's less efficient than the transfer command.</p> + </td> + </tr> + <tr> + <td>lock</td> + <td>void</td> + <td>void</td> + <td> + This command obtains an exlusive write lock for the resource. The + lock is active until command "unlock" is executed, or the OOo + session that obtained the lock ends, or until the lock is released by + a third party (e.g. a system administrator).</br> + Exceptions: + <ul> + <li><type>InteractiveLockingLockedException</type></li> + <li><type>InteractiveLockingLockExpiredException</type></li> + </ul> + </td> + </tr> + <tr> + <td>unlock</td> + <td>void</td> + <td>void</td> + <td> + This command removes a lock obtained by executing the command "lock" + from the resource.</br> + <p>Exceptions: + <ul> + <li><type>InteractiveLockingLockedException</type></li> + <li><type>InteractiveLockingLockExpiredException</type></li> + </ul> + </p> + <p>Note that <type>InteractiveLockingLockExpiredException</type> might + be raised by any command that requires a previously obtained lock. + </p> + </td> + </tr> + <tr> + <td>addProperty</td> + <td>void</td> + <td><type>PropertyCommandArgument</type> aCmdArg</td> + <td> + Adds a new properties to the content. + <p> + <member>PropertyCommandArgument::Property</member> + contains information about the property to be added. + <member>PropertyCommandArgument::DefaultValue</member> + may contain the default value for the property. Its type must + match the one specified in <member scope="com::sun::star::beans">Property::Type</member>. + </p> + <p>Note that the dynamic properties must be kept persistent. The + service <type>Store</type> (UCB persistence service) may be used to + implement this.</p> + <p><b>Important:</b> The implementation must at least support + adding properties of the following basic data types:</p> + <p> + <ul> + <li>boolean + <li>char + <li>byte + <li>string + <li>short + <li>long + <li>hyper + <li>float + <li>double + </ul> + </p> + <p> + Raises a <type scope="com::sun::star::beans">PropertyExistException</type> + if a property with the same name already exists; + <type scope="com::sun::star::beans">IllegalTypeException</type> + if the property has an unsupported type; + <type scope="com::sun::star::lang">IllegalArgumentException</type> + if the Name of the property is empty.</p> + <blockquote> + Note: This command replaces the deprecated interface method + <member scope="com::sun::star::beans">XPropertyContainer::addProperty</member>. + </blockquote> + </td> + </tr> + <tr> + <td>removeProperty</td> + <td>void</td> + <td>string PropertyName</td> + <td>Removes the properties from the content. + <p>Raises a <type scope="com::sun::star::beans">UnknownPropertyException</type> + if the property does not exist; + <type scope="com::sun::star::beans">NotRemoveableException</type> + if the property is not removable.</p> + <blockquote> + Note: This command replaces the deprecated interface method + <member scope="com::sun::star::beans">XPropertyContainer::removeProperty</member>. + </blockquote> + </td> + </tr> + </tbody> + </table> + + <h3>Properties</h3> + <h4>Mandatory properties</h4> + + <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> + <thead> + <tr> + <th>Name</th> + <th>Type</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>ContentType</td> + <td>string</td> + <td> + contains a unique type string for the content + ( i.e. "application/vnd.sun.star.hierarchy-link" ). + <p>This property is always read-only.</p> + <p>The ContentType should not be confused with the MIME + media type ( MIME types ) of the content. Media types + may be provided through the optional property "MediaType".</p> + <p>The value of this property should match the information on creatable + contents given by UCB contents that implement the property + "CreatableContentsInfo".</p> + </td> + </tr> + <tr> + <td>IsFolder</td> + <td>boolean</td> + <td>indicates, whether a content can contain other contents.</td> + </tr> + <tr> + <td>IsDocument</td> + <td>boolean</td> + <td>indicates, whether a content is a document. This means, + the content can dump itself into a data sink. + </td> + </tr> + <tr> + <td>Title</td> + <td>string</td> + <td>contains the title of an object (e.g. the subject of a message).</td> + </tr> + </tbody> + </table> + + <h4>Optional properties</h4> + + <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc"> + <thead> + <tr> + <th>Name</th> + <th>Type</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>AutoUpdateInterval</td> + <td>long</td> + <td>contains the interval for automatic updates of an object. + It is specified in seconds. + </td> + </tr> + <tr> + <td>ConnectionLimit</td> + <td>short</td> + <td>contains the maximum number of network connections + allowed for one (internet) protocol at a time. (e.g. The HTTP + cache can be configured to use a maximum for the number of + connections used for browsing.) + </td> + </tr> + <tr> + <td>ConnectionMode</td> + <td>short</td> + <td>contains the current connection mode for the object. + (see <type>ConnectionMode</type>) + </td> + </tr> + <tr> + <td>CreatableContentsInfo</td> + <td>sequence <type>ContentInfo</type></td> + <td> + contains the types of Contents a Content object can create via + command "createNewContent". + <p>If the property value can be a non-empty sequence, the + Content must also support command "createNewContent".</p> + <blockquote> + Note: This property is part of the replacement for the deprecated + interface <type>XContentCreator</type>. + </blockquote> + </td> + </tr> + <tr> + <td>DateCreated</td> + <td><type scope"com::sun::star::util">DateTime</type></td> + <td>contains the date and time the object was created.</td> + </tr> + <tr> + <td>DateModified</td> + <td><type scope"com::sun::star::util">DateTime</type></td> + <td>contains the date and time the object was last modified.</td> + </tr> + <tr> + <td>DocumentCount</td> + <td>long</td> + <td>contains the count of documents of a folder.</td> + </tr> + <tr> + <td>DocumentCountMarked</td> + <td>long</td> + <td>contains the count of marked documents within a folder.</td> + </tr> + <tr> + <td>DocumentHeader</td> + <td>sequence< <type>DocumentHeaderField</type> > </td> + <td>contains a sequence of documemt header fields (i.e. header + fields of a MIME-message, or the document info of an + office document ). For some standard header fields there + are predefined separate properties, like "MessageTo". + </td> + </tr> + <tr> + <td>DocumentStoreMode</td> + <td><type>DocumentStoreMode</type></td> + <td>contains information about the way a folder stores the + contents of (remote) documents. + </td> + </tr> + <tr> + <td>FolderCount</td> + <td>long</td> + <td>contains the count of subfolders of a folder.</td> + </tr> + <tr> + <td>FreeSpace</td> + <td>hyper</td> + <td>contains the free space left on a storage device. It is + specified in bytes.</td> + </tr> + <tr> + <td>HasDocuments</td> + <td>boolean</td> + <td>indicates whether a content has subcontents, which are documents.</td> + </tr> + <tr> + <td>HasFolders</td> + <td>boolean</td> + <td>indicates whether a content has subcontents, which are folders.</td> + </tr> + <tr> + <td>IsMarked</td> + <td>boolean</td> + <td>indicates whether a content is "marked".</td> + </tr> + <tr> + <td>IsRead</td> + <td>boolean</td> + <td>indicates whether a content has been "read".</td> + </tr> + <tr> + <td>IsReadOnly</td> + <td>boolean</td> + <td>indicates whether a content is read-only.</td> + </tr> + <tr> + <td>IsSubscribed</td> + <td>boolean</td> + <td>indicates whether a content is subscribed.</td> + </tr> + <tr> + <td>IsTimeLimitedStore</td> + <td>boolean</td> + <td>indicates whether the feature to store contents + depending on their age is active.</td> + </tr> + <tr> + <td>UpdateOnOpen</td> + <td>boolean</td> + <td>indicates whether (sub)contents shall be automatically updated + everytime a (folder) content is opened.</br>This property may be + used to control whether a folder content should read data only + from local cache when it is opened, or whether it should connect + to a server to obtain latest data.</td> + </tr> + <tr> + <td>Keywords</td> + <td>string</td> + <td>contains the keywords of a document (e.g. the value + of the "keywords" header field of a news article).</td> + </tr> + <tr> + <td>MediaType</td> + <td>string</td> + <td>contains the media type ( MIME type ) of a content. It is highly + recommended to support this property if the content's implementation + can obtain the media type natively from its data source ( i.e. + HTTP servers provide media types for all their documents ). + </td> + </tr> + <tr> + <td>MessageBCC</td> + <td>string</td> + <td>contains the BCC (blind carbon copy) receiver(s) of a message.</td> + </tr> + <tr> + <td>MessageCC</td> + <td>string</td> + <td>contains the CC (carbon copy) receiver(s) of a message.</td> + </tr> + <tr> + <td>MessageFrom</td> + <td>string</td> + <td>contains (the address of) the sender of a message.</td> + </tr> + <tr> + <td>MessageId</td> + <td>string</td> + <td>contains the ID of a message.</td> + </tr> + <tr> + <td>MessageInReplyTo</td> + <td>string</td> + <td>contains the "In-Reply-To" field of a message.</td> + </tr> + <tr> + <td>MessageReplyTo</td> + <td>string</td> + <td>contains the "Reply-To" field of a message.</td> + </tr> + <tr> + <td>MessageTo</td> + <td>string</td> + <td>contains the recipient(s) of a message.</td> + </tr> + <tr> + <td>NewsGroups</td> + <td>string</td> + <td>contains the name(s) of the newsgroup(s) into which a message was posted.</td> + </tr> + <tr> + <td>Password</td> + <td>string</td> + <td>contains a password (e.g. needed to access a POP3-Server).</td> + </tr> + <tr> + <td>Priority</td> + <td><type>Priority</type></td> + <td>contains a priority (i.e. of a message).</td> + </tr> + <tr> + <td>References</td> + <td>string</td> + <td>contains the "References" field of a news article.</td> + </tr> + <tr> + <td>Rules</td> + <td><type>RuleSet</type></td> + <td>contains the rules set for a content.</td> + </tr> + <tr> + <td>SeenCount</td> + <td>long</td> + <td>contains the count of seen/read subcontents of a folder content.</td> + </tr> + <tr> + <td>ServerBase</td> + <td>string</td> + <td>contains the base directory to use on a server. (e.g. Setting + the server base of an FTP-Account to "/pub/incoming" + will result in showing contents from that directory and not from + server's root directory) + </td> + </tr> + <tr> + <td>ServerName</td> + <td>string</td> + <td>contains a server name (e.g. The name of the server to use for + a POP3-Account). + </td> + </tr> + <tr> + <td>ServerPort</td> + <td>short</td> + <td>contains a numeric server port.</td> + </tr> + <tr> + <td>Size</td> + <td>hyper</td> + <td>contains the size (usually in bytes) of an object.</td> + </tr> + <tr> + <td>SizeLimit</td> + <td>hyper</td> + <td>contains a size limit for an object. (e.g. One may specify the + maximum size of the HTTP-Cache) + </td> + </tr> + <tr> + <td>SubscribedCount</td> + <td>long</td> + <td>contains the count of subscribed contents of a folder.</td> + </tr> + <tr> + <td>SynchronizePolicy</td> + <td><type>SynchronizePolicy</type></td> + <td>contains the policy to use when synchronizing two objects.</td> + </tr> + <tr> + <td>TargetFrames</td> + <td>string</td> + <td>contains information about the target frame to use when displaying + an object. + <p>The value is a string containing three tokens, separated by ";" + (A semicolon):<br/> + <dl> + <dt>1st token</dt> + <dd>Behavior on "select" ( single click )</dd> + <dt>2nd token</dt> + <dd>Behavior on "open" ( double click )</dd> + <dt>3rd token</dt> + <dd>Behavior on "open in new task" ( double click + CTRL key )</dd> + </dl> + </p> + <p> Each token may contain the following values:<br/> + <dl> + <dt>"_beamer"</dt> + <dd>Show in "Beamer"</dd> + <dt>"_top"</dt> + <dd>Show in current frame (replaces old)</dd> + <dt>"_blank"</dt> + <dd>Show in new task</dd> + </dl> + </p> + </td> + </tr> + <tr> + <td>TargetURL</td> + <td>string</td> + <td>for contents that are links to other contents, contains the URL of + the target content</td> + </tr> + <tr> + <td>TimeLimitStore</td> + <td>short</td> + <td>contains the value to use if the property "IsTimeLimitedStore" is set.</td> + </tr> + <tr> + <td>UserName</td> + <td>string</td> + <td>contains a user name. (e.g. the user name needed to access a + POP3-Account)</td> + </tr> + <tr> + <td>VerificationMode</td> + <td><type>VerificationMode</type> </td> + <td>describes a verification policy.</td> + </tr> + </tbody> + </table> */ interface com::sun::star::ucb::XCommandProcessor; - //------------------------------------------------------------------------- + /** is an enhanced version of <type>XCommandProcessor</type> that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid @@ -617,7 +898,7 @@ published service Content */ [optional] interface com::sun::star::ucb::XCommandProcessor2; - //------------------------------------------------------------------------- + /** notifies changes of property values to listeners registered for those properties. @@ -625,7 +906,7 @@ published service Content */ interface com::sun::star::beans::XPropertiesChangeNotifier; - //------------------------------------------------------------------------- + /** can be used to add new properties to the content and to remove properties from the content dynamically. @@ -639,25 +920,33 @@ published service Content types: <p> - <ul> - <li>boolean - <li>char - <li>byte - <li>string - <li>short - <li>long - <li>hyper - <li>float - <li>double - </ul> + <ul> + <li>boolean + <li>char + <li>byte + <li>string + <li>short + <li>long + <li>hyper + <li>float + <li>double + </ul> + </p> <p>If a property with an unsupported type shall be added a <type scope="com::sun::star::beans">IllegalTypeException</type> must be raised. + + @deprecated + <p>This interface is <b>deprecated</b>, because a + <type>ContentProvider</type> might need a + <type>XCommandEnvironment</type> to perform the tasks of adding and + removing properties. New implementations should implement the + respective commands "addProperty" and "removeProperty" instead. */ interface com::sun::star::beans::XPropertyContainer; - //------------------------------------------------------------------------- + /** can be used to notify properties removed from or added to the content's property set. @@ -668,7 +957,7 @@ published service Content */ [optional] interface com::sun::star::beans::XPropertySetInfoChangeNotifier; - //------------------------------------------------------------------------- + /** can be used to notify commands removed from or added to the content's command set. @@ -681,7 +970,7 @@ published service Content */ [optional] interface com::sun::star::ucb::XCommandInfoChangeNotifier; - //------------------------------------------------------------------------- + /** creates new contents (i.e. creates a new folder in another folder somewhere in the local file system). @@ -698,7 +987,7 @@ published service Content */ [optional] interface com::sun::star::ucb::XContentCreator; - //------------------------------------------------------------------------- + /** provides access to the parent content of this content. <p>The object returned by the implementation of the method @@ -712,9 +1001,6 @@ published service Content [optional] interface com::sun::star::container::XChild; }; -//============================================================================= - }; }; }; }; #endif - diff --git a/offapi/com/sun/star/ucb/PropertyCommandArgument.idl b/offapi/com/sun/star/ucb/PropertyCommandArgument.idl new file mode 100644 index 000000000000..a2e28179b2b3 --- /dev/null +++ b/offapi/com/sun/star/ucb/PropertyCommandArgument.idl @@ -0,0 +1,47 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_ucb_PropertyCommandArgument_idl__ +#define __com_sun_star_ucb_PropertyCommandArgument_idl__ + +#include <com/sun/star/beans/Property.idl> + +module com { module sun { module star { module ucb { + +/** The argument for the "addProperty" command. + + @see XCommandProcessor + @since Apache OpenOffice 4.0 +*/ +struct PropertyCommandArgument +{ + /** The property that the command has to add. + */ + com::sun::star::beans::Property Property; + + /** The default value of the property. + */ + any DefaultValue; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ucb/WebDAVHTTPMethod.idl b/offapi/com/sun/star/ucb/WebDAVHTTPMethod.idl new file mode 100644 index 000000000000..876a4ff01120 --- /dev/null +++ b/offapi/com/sun/star/ucb/WebDAVHTTPMethod.idl @@ -0,0 +1,118 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_ucb_WebDAVHTTPMethod_idl__ +#define __com_sun_star_ucb_WebDAVHTTPMethod_idl__ + +module com { module sun { module star { module ucb { + + +/** Standard WebDAV/HTTP methods. + + @since Apache OpenOffice 4.0 +*/ +enum WebDAVHTTPMethod +{ + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.3">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + GET, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.4">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + HEAD, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.5">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + POST, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.6">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + PUT, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.7">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + DELETE, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.8">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + TRACE, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.2">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + OPTIONS, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc2616#section-9.9">RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1</a> + */ + CONNECT, + + /** HTTP request method as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc5789">RFC 5789: PATCH Method for HTTP</a> + */ + PATCH, + + /** WebDAV methods as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc4918#section-9.1">HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)</a> + */ + PROPFIND, + + /** WebDAV methods as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc4918#section-9.2">HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)</a> + */ + PROPPATCH, + + /** WebDAV methods as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc4918#section-9.3">HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)</a> + */ + MKCOL, + + /** WebDAV methods as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc4918#section-9.8">HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)</a> + */ + COPY, + + /** WebDAV methods as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc4918#section-9.9">HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)</a> + */ + MOVE, + + /** WebDAV methods as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc4918#section-9.10">HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)</a> + */ + LOCK, + + /** WebDAV methods as defined in + <a target="_blank" href="http://tools.ietf.org/html/rfc4918#section-9.11">HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)</a> + */ + UNLOCK + +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl b/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl index a5da409359ac..23fcda9d47ac 100644 --- a/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl +++ b/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl @@ -19,32 +19,20 @@ * *************************************************************/ - #ifndef __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__ #define __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif -#ifndef __com_sun_star_beans_NamedValue_idl__ -#include <com/sun/star/beans/NamedValue.idl> -#endif - -//============================================================================= +#include <com/sun/star/ucb/XCommandEnvironment.idl> +#include <com/sun/star/ucb/WebDAVHTTPMethod.idl> +#include <com/sun/star/beans/StringPair.idl> module com { module sun { module star { module ucb { -//============================================================================= /** A command environment that can be used to deal with WebDAV/HTTP specific commands. - - <p>Supply an implementation of this interface together with an - <type>XCommandEnvironment</type> implementation, when executing a command - using <type>XCommandProcessor</type>. */ -published interface XWebDAVCommandEnvironment : com::sun::star::uno::XInterface +interface XWebDAVCommandEnvironment : XCommandEnvironment { - //------------------------------------------------------------------------- /** This method gets called while assembling an WebDAV/HTTP request. The returned headername-headervalue pairs will be appended to the list of request headers before the request is dispatched. @@ -53,20 +41,18 @@ published interface XWebDAVCommandEnvironment : com::sun::star::uno::XInterface The request URI. @param aMethod - The WebDAV/HTTP method ("GET","PUT","MKCOL",...). + The WebDAV/HTTP method ("GET","PUT","MKCOL",...) as defined in + <type>WebDAVHTTPMethod</type>. @return A sequence of header name, header value pairs. The header names must be the plain names and contain no trailing ":". - The header value must be an Any containing a string. */ - sequence<com::sun::star::beans::NamedValue> getUserRequestHeaders( - [in] string aURI, - [in] string aMethod); + sequence<com::sun::star::beans::StringPair> getUserRequestHeaders( + [in] string aURI, + [in] WebDAVHTTPMethod eMethod); }; -//============================================================================= - }; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/makefile.mk b/offapi/com/sun/star/ucb/makefile.mk index 2522b637ecd0..26c67d2a6722 100644 --- a/offapi/com/sun/star/ucb/makefile.mk +++ b/offapi/com/sun/star/ucb/makefile.mk @@ -37,7 +37,7 @@ IDLFILES=\ AlreadyInitializedException.idl\ AnyCompareFactory.idl\ AuthenticationRequest.idl\ - URLAuthenticationRequest.idl\ + CHAOSProgressStart.idl\ CachedContentResultSet.idl\ CachedContentResultSetFactory.idl\ CachedContentResultSetStub.idl\ @@ -46,7 +46,6 @@ IDLFILES=\ CachedDynamicResultSetFactory.idl\ CachedDynamicResultSetStub.idl\ CachedDynamicResultSetStubFactory.idl\ - CHAOSProgressStart.idl\ CertificateValidationRequest.idl\ Command.idl\ CommandAbortedException.idl\ @@ -83,6 +82,8 @@ IDLFILES=\ Error.idl\ ExpandContentProvider.idl\ ExportStreamInfo.idl\ + FTPContent.idl\ + FTPContentProvider.idl\ FetchError.idl\ FetchResult.idl\ FileContent.idl\ @@ -91,10 +92,8 @@ IDLFILES=\ FolderList.idl\ FolderListCommand.idl\ FolderListEntry.idl\ - FTPContent.idl\ - FTPContentProvider.idl\ - GlobalTransferCommandArgument.idl\ GIOContentProvider.idl\ + GlobalTransferCommandArgument.idl\ GnomeVFSContentProvider.idl\ GnomeVFSDocumentContent.idl\ GnomeVFSFolderContent.idl\ @@ -108,6 +107,7 @@ IDLFILES=\ HierarchyFolderContent.idl\ HierarchyLinkContent.idl\ HierarchyRootFolderContent.idl\ + IOErrorCode.idl\ IllegalIdentifierException.idl\ InsertCommandArgument.idl\ InteractiveAppException.idl\ @@ -117,8 +117,8 @@ IDLFILES=\ InteractiveFileIOException.idl\ InteractiveIOException.idl\ InteractiveLockingException.idl\ - InteractiveLockingLockedException.idl\ InteractiveLockingLockExpiredException.idl\ + InteractiveLockingLockedException.idl\ InteractiveLockingNotLockedException.idl\ InteractiveNetworkConnectException.idl\ InteractiveNetworkException.idl\ @@ -128,12 +128,11 @@ IDLFILES=\ InteractiveNetworkResolveNameException.idl\ InteractiveNetworkWriteException.idl\ InteractiveWrongMediumException.idl\ - IOErrorCode.idl\ Link.idl\ ListAction.idl\ ListActionType.idl\ - ListenerAlreadySetException.idl\ ListEvent.idl\ + ListenerAlreadySetException.idl\ Lock.idl\ LockDepth.idl\ LockEntry.idl\ @@ -159,6 +158,7 @@ IDLFILES=\ PostCommandArgument2.idl\ Priority.idl\ PropertiesManager.idl\ + PropertyCommandArgument.idl\ PropertySetRegistry.idl\ PropertyValueInfo.idl\ PropertyValueState.idl\ @@ -191,10 +191,11 @@ IDLFILES=\ TransferInfo.idl\ TransferResult.idl\ TransientDocumentsContentProvider.idl\ - TransientDocumentsRootContent.idl\ TransientDocumentsDocumentContent.idl\ TransientDocumentsFolderContent.idl\ + TransientDocumentsRootContent.idl\ TransientDocumentsStreamContent.idl\ + URLAuthenticationRequest.idl\ UniversalContentBroker.idl\ UnsupportedCommandException.idl\ UnsupportedDataSinkException.idl\ @@ -204,6 +205,7 @@ IDLFILES=\ WebDAVContentProvider.idl\ WebDAVDocumentContent.idl\ WebDAVFolderContent.idl\ + WebDAVHTTPMethod.idl \ WelcomeDynamicResultSetStruct.idl\ XAnyCompare.idl\ XAnyCompareFactory.idl\ @@ -262,7 +264,7 @@ IDLFILES=\ XSimpleFileAccess3.idl\ XSortedDynamicResultSetFactory.idl\ XSourceInitialization.idl\ - XWebDAVCommandEnvironment.idl + XWebDAVCommandEnvironment.idl \ # ------------------------------------------------------------------ diff --git a/offapi/com/sun/star/ui/ContextChangeEventMultiplexer.idl b/offapi/com/sun/star/ui/ContextChangeEventMultiplexer.idl new file mode 100644 index 000000000000..e695184c391f --- /dev/null +++ b/offapi/com/sun/star/ui/ContextChangeEventMultiplexer.idl @@ -0,0 +1,40 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + + +#ifndef __com_sun_star_ui_ContextChangeEventMultiplexer_idl__ +#define __com_sun_star_ui_ContextChangeEventMultiplexer_idl__ + +#ifndef __com_sun_star_ui_XContextChangeEventMultiplexer_idl__ +#include <com/sun/star/ui/XContextChangeEventMultiplexer.idl> +#endif + +module com { module sun { module star { module ui { + +/** Multiplex events for context changes. + + A typical listener for context changes is the sidebar. +*/ +singleton ContextChangeEventMultiplexer : com::sun::star::ui::XContextChangeEventMultiplexer; + +}; }; }; }; // com.sun.star.ui + +#endif diff --git a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl b/offapi/com/sun/star/ui/ContextChangeEventObject.idl index c0a562435582..7ab6bddd0b5e 100644 --- a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl +++ b/offapi/com/sun/star/ui/ContextChangeEventObject.idl @@ -20,33 +20,34 @@ *************************************************************/ -#ifndef __com_sun_star_awt_UnoControlThrobberModel_idl__ -#define __com_sun_star_awt_UnoControlThrobberModel_idl__ - -#ifndef __com_sun_star_awt_UnoControlModel_idl__ -#include <com/sun/star/awt/UnoControlModel.idl> -#endif +#ifndef __com_sun_star_ui_ContextChangeEventObject_idl__ +#define __com_sun_star_ui_ContextChangeEventObject_idl__ -//============================================================================= +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif - module com { module sun { module star { module awt { +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif -//============================================================================= -/** - @since OOo 2.2 - @deprecated - You should use <type>SpinningProgressControlModel</type>. - */ +module com { module sun { module star { module ui { -published service UnoControlThrobberModel +struct ContextChangeEventObject : com::sun::star::lang::EventObject { - service com::sun::star::awt::UnoControlModel; -}; + /** Return the name of the application. + */ + string ApplicationName; -//============================================================================= + /** Return the application specific context name. + */ + string ContextName; +}; }; }; }; }; +//============================================================================= + #endif diff --git a/offapi/com/sun/star/ui/LayoutSize.idl b/offapi/com/sun/star/ui/LayoutSize.idl new file mode 100644 index 000000000000..065a7d00c2f4 --- /dev/null +++ b/offapi/com/sun/star/ui/LayoutSize.idl @@ -0,0 +1,50 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_ui_LayoutSize_idl__ +#define __com_sun_star_ui_LayoutSize_idl__ + +module com { module sun { module star { module ui { + +/** Size used for layouting windows. + It specifies a range of valid values and a preferred value. + The values must not violate the relation 0 <= Minimum <= Preferred <= Maximum. + + @param Minimum + Zero or positive. The value itself is included in the valid + range. + @param Maximum + A value larger than or equal to Minimum. + The special value -1 means that there is no upper bound. Every value larger than or + equal to Minimum is valid. + @param Preferred + The preferred size inside the valid range. +*/ +struct LayoutSize +{ + long Minimum; + long Maximum; + long Preferred; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/XContextChangeEventListener.idl b/offapi/com/sun/star/ui/XContextChangeEventListener.idl new file mode 100644 index 000000000000..000e3deec82a --- /dev/null +++ b/offapi/com/sun/star/ui/XContextChangeEventListener.idl @@ -0,0 +1,47 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_ui_XContextChangeEventListener_idl__ +#define __com_sun_star_ui_XContextChangeEventListener_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + +#ifndef __com_sun_star_ui_ContextChangeEventObject_idl__ +#include <com/sun/star/ui/ContextChangeEventObject.idl> +#endif + +module com { module sun { module star { module ui { + +interface XContextChangeEventListener : ::com::sun::star::lang::XEventListener +{ + [oneway] void notifyContextChangeEvent ( + [in] com::sun::star::ui::ContextChangeEventObject event); +} ; + +} ; } ; } ; } ; + +#endif diff --git a/offapi/com/sun/star/ui/XContextChangeEventMultiplexer.idl b/offapi/com/sun/star/ui/XContextChangeEventMultiplexer.idl new file mode 100644 index 000000000000..e9e7238d1e7d --- /dev/null +++ b/offapi/com/sun/star/ui/XContextChangeEventMultiplexer.idl @@ -0,0 +1,131 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + + + +#ifndef __com_sun_star_ui_XContextChangeEventMultiplexer_idl__ +#define __com_sun_star_ui_XContextChangeEventMultiplexer_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_ui_XContextChangeEventListener_idl__ +#include <com/sun/star/ui/XContextChangeEventListener.idl> +#endif + +#ifndef __com_sun_star_ui_ContextChangeEventObject_idl__ +#include <com/sun/star/ui/ContextChangeEventObject.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 { + +/** Provide a central access point for a group of events. + + Listeners can be added with a simple restriction on the event source. + They are only called for events that originate at the specified source. + + Event providers can broadcast an event to all interested listeners. + + The XEventMultiplexer interface is typically implemented as a singleton +*/ +interface XContextChangeEventMultiplexer : ::com::sun::star::uno::XInterface +{ + /** Add an event listener that is called only when events are broadcast for the specified + event focus. + + @param xListener + An empty reference results in an InvalidArgumentException. + + One listener may be added more than once for different + event foci. Adding a listener a second time for the same + event focus results in an InvalidArgumentException. + + @param xEventFocus + An empty reference is a valid value. In this case the + registered listener will be called for every event + broadcast, regardless of its event focus. + + The event focus may or may not be the source of the event. + + A typical example for an event focus is the XController of + a view. Using an XController restricts events passed to + a listener to events that belong to one view. + + @throws com::sun::star::lang::IllegalArgumentException + + */ + void addContextChangeEventListener ( + [in] com::sun::star::ui::XContextChangeEventListener xListener, + [in] com::sun::star::uno::XInterface xEventFocus) + raises (com::sun::star::lang::IllegalArgumentException); + + /** Remove an event listener for the specified event focus. + + When the same listener was added for other event foci then + these associations remain unmodified. + + @param xListener + An empty reference results in an InvalidArgumentException. + + When the listener is not registered for the given event + focus then an InvalidArgumentException is thrown. + + @param xEventFocus + The listener is only removed for this event focus. + An empty reference is a valid value. + + @throws com::sun::star::lang::IllegalArgumentException + */ + void removeContextChangeEventListener ( + [in] com::sun::star::ui::XContextChangeEventListener xListener, + [in] com::sun::star::uno::XInterface xEventFocus) + raises (com::sun::star::lang::IllegalArgumentException); + + /** Remove an event listener for all event foci. + + @param xListener + An empty reference results in an InvalidArgumentException. + + It is not an error when the listener is not registered for any event focus. + + @throws com::sun::star::lang::IllegalArgumentException + */ + void removeAllContextChangeEventListeners ( + [in] com::sun::star::ui::XContextChangeEventListener xListener) + raises (com::sun::star::lang::IllegalArgumentException); + + + /** Call all event listeners that where added for the specified event focus. + */ + [oneway] void broadcastContextChangeEvent ( + [in] com::sun::star::ui::ContextChangeEventObject aEvent, + [in] com::sun::star::uno::XInterface xEventFocus); +} ; + +} ; } ; } ; } ; + +#endif diff --git a/offapi/com/sun/star/awt/XSimpleAnimation.idl b/offapi/com/sun/star/ui/XContextChangeListener.idl index 747848d2d37b..f7741133a0a3 100644 --- a/offapi/com/sun/star/awt/XSimpleAnimation.idl +++ b/offapi/com/sun/star/ui/XContextChangeListener.idl @@ -20,36 +20,32 @@ *************************************************************/ -#ifndef __com_sun_star_awt_XSimpleAnimation_idl__ -#define __com_sun_star_awt_XSimpleAnimation_idl__ + +#ifndef __com_sun_star_util_XEventListener_idl__ +#define __com_sun_star_util_XEventListener_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> #endif -#ifndef com_sun_star_graphic_XGraphic_idl -#include <com/sun/star/graphic/XGraphic.idl> +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> #endif -//============================================================================= - - module com { module sun { module star { module awt { +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif -//============================================================================= +module com { module sun { module star { module util { -/** - @deprecated - You should use <type>XAnimation</type>, <type>AnimatedImagesControl</type>, and <type>AnimatedImagesControlModel</type>. - */ -published interface XSimpleAnimation: com::sun::star::uno::XInterface +/** Generic event listener. +*/ +interface XEventListener : ::com::sun::star::lang::XEventListener { - void start(); - void stop(); - void setImageList( [in] sequence < com::sun::star::graphic::XGraphic > ImageList ); -}; - -//============================================================================= + [oneway] void notifyEvent ( + [in] com::sun::star::lang::EventObject event); +} ; -}; }; }; }; +} ; } ; } ; } ; #endif diff --git a/offapi/com/sun/star/ui/XSidebar.idl b/offapi/com/sun/star/ui/XSidebar.idl new file mode 100644 index 000000000000..e0992591687b --- /dev/null +++ b/offapi/com/sun/star/ui/XSidebar.idl @@ -0,0 +1,46 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + + + +#ifndef __com_sun_star_ui_XSidebar_idl__ +#define __com_sun_star_ui_XSidebar_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +module com { module sun { module star { module ui { + +/** Interface of the sidebar that allows its elements like panels to eg request layouts. +*/ +interface XSidebar +{ + /** Request layout of the sidebar. + Call this method when one of the panels wants to change its size due to + late initilization or different content after a context change. + */ + void requestLayout (); +} ; + +} ; } ; } ; } ; + +#endif diff --git a/offapi/com/sun/star/ui/XSidebarPanel.idl b/offapi/com/sun/star/ui/XSidebarPanel.idl new file mode 100644 index 000000000000..837dcf9dc73a --- /dev/null +++ b/offapi/com/sun/star/ui/XSidebarPanel.idl @@ -0,0 +1,64 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + + + +#ifndef __com_sun_star_ui_XSidebarPanel_idl__ +#define __com_sun_star_ui_XSidebarPanel_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_rendering_XCanvas_idl__ +#include <com/sun/star/rendering/XCanvas.idl> +#endif + +#ifndef __com_sun_star_awt_Point_idl__ +#include <com/sun/star/awt/Point.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_ui_LayoutSize_idl__ +#include <com/sun/star/ui/LayoutSize.idl> +#endif + +module com { module sun { module star { module ui { + +/** Optional interface of sidebar panels. +*/ +interface XSidebarPanel +{ + /** For a given width of the container the layouter asks every ui element for its + optimal height. + + The height to which a ui element is set may differ from the returned value. + + The height is set via the XWindow interface. + */ + LayoutSize getHeightForWidth ( [in] long nWidth); +} ; + +} ; } ; } ; } ; + +#endif diff --git a/offapi/com/sun/star/ui/XStatusbarItem.idl b/offapi/com/sun/star/ui/XStatusbarItem.idl new file mode 100644 index 000000000000..49e71e235f43 --- /dev/null +++ b/offapi/com/sun/star/ui/XStatusbarItem.idl @@ -0,0 +1,115 @@ +/************************************************************** + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + *************************************************************/ + +#ifndef __com_sun_star_ui_XStatusbarItem_idl__ +#define __com_sun_star_ui_XStatusbarItem_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/awt/Rectangle.idl> + +module com { module sun { module star { module ui { + +/** Represents an item in a status bar + + @see <type scope="com::sun::star::frame">XStatusbarController</type> + + @since Apache OpenOffice 4.0 +*/ +interface XStatusbarItem +{ + /** the command of the status bar item + */ + [attribute, readonly] string Command; + + /** the unique ID of the control within the status bar + */ + [attribute, readonly] unsigned short ItemId; + + /** the width of the status bar item + */ + [attribute, readonly] unsigned long Width; + + /** the style of the status bar item + + <p>The following values apply for a status bar item:</p> + <ul> + <li>Alignment + <ul> + <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_LEFT</member></li> + <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_CENTER</member></li> + <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_RIGHT</member></li> + </ul> + </li> + <li>Drawing + <ul> + <li><member scope="com::sun::star::ui">ItemStyle::DRAW_OUT3D</member></li> + <li><member scope="com::sun::star::ui">ItemStyle::DRAW_IN3D</member></li> + <li><member scope="com::sun::star::ui">ItemStyle::DRAW_FLAT</member></li> + </ul> + </li> + <li><member scope="com::sun::star::ui">ItemStyle::AUTO_SIZE</member></li> + <li><member scope="com::sun::star::ui">ItemStyle::OWNER_DRAW</member></li> + </ul> + + @see <type scope="com::sun::star::ui">ItemStyle</type> + */ + [attribute, readonly] unsigned short Style; + + /** the offset between this status bar item and the following + */ + [attribute, readonly] long Offset; + + /** the rectangle on the status bar device onto which the item is drawn + + @see <member scope="com::sun::star::frame">XStatusbarController::paint()</member> + */ + [attribute, readonly] com::sun::star::awt::Rectangle ItemRect; + + /** the text of status bar item + */ + [attribute] string Text; + + /** the help text of the status bar item when extended help tips are on + */ + [attribute] string HelpText; + + /** the help text of the status bar item when help tips are on + */ + [attribute] string QuickHelpText; + + /** the accesible name of the status bar item + */ + [attribute] string AccessibleName; + + /** whether the item is visible or not + */ + [attribute] boolean Visible; + + /** forces repainting the item onto the status bar device + + @see <member scope="com::sun::star::frame">XStatusbarController::paint()</member> + */ + void repaint(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/ui/makefile.mk b/offapi/com/sun/star/ui/makefile.mk index 8f2088991b95..5e7a5f7feb6b 100644 --- a/offapi/com/sun/star/ui/makefile.mk +++ b/offapi/com/sun/star/ui/makefile.mk @@ -40,6 +40,8 @@ IDLFILES=\ ActionTriggerSeparatorType.idl \ ConfigurableUIElement.idl \ ConfigurationEvent.idl \ + ContextChangeEventMultiplexer.idl \ + ContextChangeEventObject.idl \ ContextMenuExecuteEvent.idl \ ContextMenuInterceptorAction.idl \ DockingArea.idl \ @@ -48,6 +50,7 @@ IDLFILES=\ ItemDescriptor.idl \ ItemStyle.idl \ ItemType.idl \ + LayoutSize.idl \ ModuleUICategoryDescription.idl \ ModuleUICommandDescription.idl \ ModuleUIConfigurationManager.idl \ @@ -66,10 +69,15 @@ IDLFILES=\ XAcceleratorConfiguration.idl \ XContextMenuInterception.idl \ XContextMenuInterceptor.idl \ + XContextChangeEventListener.idl \ + XContextChangeEventMultiplexer.idl \ XDockingAreaAcceptor.idl \ XImageManager.idl \ XModuleUIConfigurationManager.idl \ XModuleUIConfigurationManagerSupplier.idl \ + XSidebar.idl \ + XSidebarPanel.idl \ + XStatusbarItem.idl \ XUIConfiguration.idl \ XUIConfigurationListener.idl \ XUIConfigurationManager.idl \ diff --git a/offapi/com/sun/star/system/XSimpleMailMessage2.idl b/offapi/com/sun/star/util/EventMultiplexer.idl index 4560488a1804..80cf505999d0 100755..100644 --- a/offapi/com/sun/star/system/XSimpleMailMessage2.idl +++ b/offapi/com/sun/star/util/EventMultiplexer.idl @@ -20,23 +20,21 @@ *************************************************************/ +#ifndef __com_sun_star_util_EventMultiplexer_idl__ +#define __com_sun_star_util_EventMultiplexer_idl__ -#ifndef __com_sun_star_system_XSimpleMailMessage2_idl__ -#define __com_sun_star_system_XSimpleMailMessage2_idl__ - -#include <com/sun/star/system/XSimpleMailMessage.idl> - -module com { module sun { module star { module system { +#ifndef __com_sun_star_util_XEventMultiplexer_idl__ +#include <com/sun/star/util/XEventMultiplexer.idl> +#endif -/** This interface extends <type>XSimpleMailMessage</type>. +module com { module sun { module star { module util { - @since Apache OpenOffice 3.5 +/** Multiplex generic events. */ -interface XSimpleMailMessage2: XSimpleMailMessage +service EventMultiplexer : com::sun::star::util::XEventMultiplexer { - [attribute] string Body; }; -}; }; }; }; +}; }; }; }; // com.sun.star.util #endif diff --git a/offapi/type_reference/typelibrary_history.txt b/offapi/type_reference/typelibrary_history.txt index 1b47f11b3841..a42bf6c505ca 100644 --- a/offapi/type_reference/typelibrary_history.txt +++ b/offapi/type_reference/typelibrary_history.txt @@ -189,3 +189,22 @@ 06/11/2012 (JSC): TaskID=119944 Update reference type library to 3.4 version + +06/12/2012 (arielch): TaskID=121442 + Extend css::awt::XGraphics for StatusbarController implementation + +19/12/2012 (arielch): TaskID=121513 + Remove deprecated AWT Throbber API + +19/12/2012 (arielch): TaskID=121514 + Remove deprecated AWT UnoControlSimpleAnimation API + +23/03/2013 (arielch): TaskID=121944 + css::ucb::XWebDAVCommandEnvironment should be derived from css::ucb::XCommandEnvironment + +23/03/2013 (arielch): TaskID=121945 + css::ucb::XWebDAVCommandEnvironment::getUserRequestHeaders() should return a + sequence of css::beans::StringPair + +23/03/2013 (arielch): TaskID=121946 + css::ucb::XWebDAVCommandEnvironment: use enums to identify WebDAV/HTTP methods diff --git a/offapi/type_reference/types.rdb b/offapi/type_reference/types.rdb Binary files differindex c9264fe7b57c..a6edadfb0ab5 100644 --- a/offapi/type_reference/types.rdb +++ b/offapi/type_reference/types.rdb |