diff options
Diffstat (limited to 'offapi/com/sun/star/frame')
133 files changed, 904 insertions, 904 deletions
diff --git a/offapi/com/sun/star/frame/BorderWidths.idl b/offapi/com/sun/star/frame/BorderWidths.idl index db3d4484a69f..b9469c3cb0bf 100644 --- a/offapi/com/sun/star/frame/BorderWidths.idl +++ b/offapi/com/sun/star/frame/BorderWidths.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,16 +24,16 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_BorderWidths_idl__ -#define __com_sun_star_frame_BorderWidths_idl__ - - +#ifndef __com_sun_star_frame_BorderWidths_idl__ +#define __com_sun_star_frame_BorderWidths_idl__ + + //============================================================================ - - module com { module sun { module star { module frame { - + + module com { module sun { module star { module frame { + //============================================================================ - + /** specifies a border area by offsets from each side. */ struct BorderWidths @@ -41,7 +41,7 @@ struct BorderWidths //------------------------------------------------------------------------ /** specifies the offset from left border. */ - long Left; + long Left; //------------------------------------------------------------------------ /** specifies the offset from top border. @@ -56,13 +56,13 @@ struct BorderWidths //------------------------------------------------------------------------ /** specifies the offset from bottom border. */ - long Bottom; - -}; + long Bottom; +}; + //============================================================================ - -}; }; }; }; - -#endif + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/CommandGroup.idl b/offapi/com/sun/star/frame/CommandGroup.idl index d8058379922e..36454d07665f 100644 --- a/offapi/com/sun/star/frame/CommandGroup.idl +++ b/offapi/com/sun/star/frame/CommandGroup.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,132 +41,132 @@ module com { module sun { module star { module frame { */ published constants CommandGroup { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies interal commands. */ const short INTERNAL = 0; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies application based commands. */ const short APPLICATION = 1; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies view specific commands. */ const short VIEW = 2; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies document specific commands. */ const short DOCUMENT = 3; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies edit specific commands. */ const short EDIT = 4; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands used by the built-in Basic. */ const short MACRO = 5; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands to change options. */ const short OPTIONS = 6; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies math specific commands. */ const short MATH = 7; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies navigate commands. */ const short NAVIGATOR = 8; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies insert commands. */ const short INSERT = 9; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to formats. */ const short FORMAT = 10; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to templates. */ const short TEMPLATE = 11; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies text specific commands. */ const short TEXT = 12; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies frame specific commands. */ const short FRAME = 13; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to graphical data. */ const short GRAPHIC = 14; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to tables. */ const short TABLE = 15; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to bullets and numbering. */ const short ENUMERATION = 16; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to data. */ const short DATA = 17; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies special commands. */ const short SPECIAL = 18; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to images. */ const short IMAGE = 19; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies chart specific commands. */ const short CHART = 20; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies explorer specific commands. */ const short EXPLORER = 21; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to connectors. */ const short CONNECTOR = 22; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to modifications. */ const short MODIFY = 23; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to drawing. */ const short DRAWING = 24; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies commands that are related to controls. */ const short CONTROLS = 25; diff --git a/offapi/com/sun/star/frame/Components.idl b/offapi/com/sun/star/frame/Components.idl index 705ad4364d73..0445553e192b 100644 --- a/offapi/com/sun/star/frame/Components.idl +++ b/offapi/com/sun/star/frame/Components.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/ContentHandler.idl b/offapi/com/sun/star/frame/ContentHandler.idl index ad30ccab2108..3be56a65f1c0 100644 --- a/offapi/com/sun/star/frame/ContentHandler.idl +++ b/offapi/com/sun/star/frame/ContentHandler.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/ContentHandlerFactory.idl b/offapi/com/sun/star/frame/ContentHandlerFactory.idl index 7fb08ba7aa13..a3c1776bf345 100644 --- a/offapi/com/sun/star/frame/ContentHandlerFactory.idl +++ b/offapi/com/sun/star/frame/ContentHandlerFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/ControlCommand.idl b/offapi/com/sun/star/frame/ControlCommand.idl index 9be9a6948349..345659f1e2af 100644 --- a/offapi/com/sun/star/frame/ControlCommand.idl +++ b/offapi/com/sun/star/frame/ControlCommand.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,44 +24,44 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_ControlCommand_idl__ -#define __com_sun_star_frame_ControlCommand_idl__ - - +#ifndef __com_sun_star_frame_ControlCommand_idl__ +#define __com_sun_star_frame_ControlCommand_idl__ + + #ifndef __com_sun_star_beans_NamedValue_idl__ #include <com/sun/star/beans/NamedValue.idl> #endif - -//============================================================================= - + +//============================================================================= + module com { module sun { module star { module frame { - -//============================================================================= - + +//============================================================================= + /** describes a command which can be send to a generic toolbar control. - + @since OOo 2.0.3 */ struct ControlCommand { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** specifies the command which should be processed by the toolbar control. */ string Command; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** specifies a sequence of named values which are used as argument for the command. The number and type of arguments depend on the the command and control. */ - sequence< com::sun::star::beans::NamedValue > Arguments; -}; - -//============================================================================= - + sequence< com::sun::star::beans::NamedValue > Arguments; +}; + +//============================================================================= + }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/frame/ControlEvent.idl b/offapi/com/sun/star/frame/ControlEvent.idl index 7cde5fc5ee54..2a701bf6edb8 100644 --- a/offapi/com/sun/star/frame/ControlEvent.idl +++ b/offapi/com/sun/star/frame/ControlEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,51 +24,51 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_ControlEvent_idl__ -#define __com_sun_star_frame_ControlEvent_idl__ +#ifndef __com_sun_star_frame_ControlEvent_idl__ +#define __com_sun_star_frame_ControlEvent_idl__ #ifndef __com_sun_star_util_URL_idl__ #include <com/sun/star/util/URL.idl> #endif - + #ifndef __com_sun_star_beans_NamedValue_idl__ #include <com/sun/star/beans/NamedValue.idl> #endif - -//============================================================================= - + +//============================================================================= + module com { module sun { module star { module frame { - -//============================================================================= - -/** describes a control event send by extended user interface + +//============================================================================= + +/** describes a control event send by extended user interface controls. - + @since OOo 2.0.3 */ struct ControlEvent { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** fully parsed URL describing the control that sends this notification. */ ::com::sun::star::util::URL aURL; - + /** specifies the event which has occured. */ string Event; - - //------------------------------------------------------------------------- - - /** specifies a sequence of named values which are used as + + //------------------------------------------------------------------------- + + /** specifies a sequence of named values which are used as additional values for the event. The number and types of named values depent on the event. */ - sequence< com::sun::star::beans::NamedValue > aInformation; -}; - -//============================================================================= - + sequence< com::sun::star::beans::NamedValue > aInformation; +}; + +//============================================================================= + }; }; }; }; - + #endif diff --git a/offapi/com/sun/star/frame/Controller.idl b/offapi/com/sun/star/frame/Controller.idl index 5371d3c331e0..8e8c4c2dd39d 100644 --- a/offapi/com/sun/star/frame/Controller.idl +++ b/offapi/com/sun/star/frame/Controller.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/Desktop.idl b/offapi/com/sun/star/frame/Desktop.idl index f7a92ca25df0..99f10105c2eb 100644 --- a/offapi/com/sun/star/frame/Desktop.idl +++ b/offapi/com/sun/star/frame/Desktop.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DesktopTask.idl b/offapi/com/sun/star/frame/DesktopTask.idl index 3640f57c332f..07d57142d97f 100644 --- a/offapi/com/sun/star/frame/DesktopTask.idl +++ b/offapi/com/sun/star/frame/DesktopTask.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DesktopTasks.idl b/offapi/com/sun/star/frame/DesktopTasks.idl index afb479209b3d..8a32609991cc 100644 --- a/offapi/com/sun/star/frame/DesktopTasks.idl +++ b/offapi/com/sun/star/frame/DesktopTasks.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchDescriptor.idl b/offapi/com/sun/star/frame/DispatchDescriptor.idl index f3b3867695f3..a4ce7fabfcb6 100644 --- a/offapi/com/sun/star/frame/DispatchDescriptor.idl +++ b/offapi/com/sun/star/frame/DispatchDescriptor.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchHelper.idl b/offapi/com/sun/star/frame/DispatchHelper.idl index 088a113d1fc0..02950a036cf6 100644 --- a/offapi/com/sun/star/frame/DispatchHelper.idl +++ b/offapi/com/sun/star/frame/DispatchHelper.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchInformation.idl b/offapi/com/sun/star/frame/DispatchInformation.idl index 49789f003b8a..d6ce8e0110c9 100644 --- a/offapi/com/sun/star/frame/DispatchInformation.idl +++ b/offapi/com/sun/star/frame/DispatchInformation.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -49,10 +49,10 @@ published struct DispatchInformation /** command URL of a supported command. */ string Command; - + //------------------------------------------------------------------------- /** group identifier to which the supported command belong. - + <p> @see CommandGroup </p> diff --git a/offapi/com/sun/star/frame/DispatchProvider.idl b/offapi/com/sun/star/frame/DispatchProvider.idl index 0eb061d54971..316b4fbba50a 100644 --- a/offapi/com/sun/star/frame/DispatchProvider.idl +++ b/offapi/com/sun/star/frame/DispatchProvider.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchRecorder.idl b/offapi/com/sun/star/frame/DispatchRecorder.idl index 276d332e45a4..ddc22cd694ed 100644 --- a/offapi/com/sun/star/frame/DispatchRecorder.idl +++ b/offapi/com/sun/star/frame/DispatchRecorder.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl b/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl index 7dec99011b17..f94444b5e210 100644 --- a/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl +++ b/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchResultEvent.idl b/offapi/com/sun/star/frame/DispatchResultEvent.idl index c295f517b446..a2d4c43b30a9 100644 --- a/offapi/com/sun/star/frame/DispatchResultEvent.idl +++ b/offapi/com/sun/star/frame/DispatchResultEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchResultState.idl b/offapi/com/sun/star/frame/DispatchResultState.idl index aac075795045..95e1fb5db1b8 100644 --- a/offapi/com/sun/star/frame/DispatchResultState.idl +++ b/offapi/com/sun/star/frame/DispatchResultState.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DispatchStatement.idl b/offapi/com/sun/star/frame/DispatchStatement.idl index c1965b0db838..662a5102460c 100644 --- a/offapi/com/sun/star/frame/DispatchStatement.idl +++ b/offapi/com/sun/star/frame/DispatchStatement.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DocumentTemplates.idl b/offapi/com/sun/star/frame/DocumentTemplates.idl index b3c44ffe83ad..3b7a14052d47 100644 --- a/offapi/com/sun/star/frame/DocumentTemplates.idl +++ b/offapi/com/sun/star/frame/DocumentTemplates.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/DoubleInitializationException.idl b/offapi/com/sun/star/frame/DoubleInitializationException.idl index f1121156a2cc..414e6155f672 100644 --- a/offapi/com/sun/star/frame/DoubleInitializationException.idl +++ b/offapi/com/sun/star/frame/DoubleInitializationException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,31 +24,31 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_TerminationVetoException_idl__ -#define __com_sun_star_frame_TerminationVetoException_idl__ - -#ifndef __com_sun_star_uno_Exception_idl__ -#include <com/sun/star/uno/Exception.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module frame { - -//============================================================================= - +#ifndef __com_sun_star_frame_TerminationVetoException_idl__ +#define __com_sun_star_frame_TerminationVetoException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + // DocMerge from xml: exception com::sun::star::frame::DoubleInitializationException /** This exception can be thrown in case an object is initialized second time. @since OOo 1.1.2 */ published exception DoubleInitializationException: com::sun::star::uno::Exception -{ -}; - -//============================================================================= - -}; }; }; }; - -#endif +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl index c812424e42ac..8105257cdb66 100644 --- a/offapi/com/sun/star/frame/FeatureStateEvent.idl +++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/Frame.idl b/offapi/com/sun/star/frame/Frame.idl index 2111775c9948..ddb880ea6c28 100644 --- a/offapi/com/sun/star/frame/Frame.idl +++ b/offapi/com/sun/star/frame/Frame.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -89,7 +89,7 @@ published service Frame @see <type scope="com::sun::star::xml">UserDefinedAttributesSupplier</type> */ [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; - + //------------------------------------------------------------------------- /** allows the component to be loaded and accessed within the frame; it is the main connection to the @@ -126,11 +126,11 @@ published service Frame //------------------------------------------------------------------------- /** provides information about supported commands - + @since OOo 2.0.0 */ [optional] interface XDispatchInformationProvider; - + //------------------------------------------------------------------------- /** supports interception mechanism for dispatched URLs @@ -192,9 +192,9 @@ published service Frame @since OOo 1.1.2 */ [optional, property] XDispatchRecorderSupplier RecorderSupplier; - + //------------------------------------------------------------------------- - /** provides access to the <type>LayoutManager</type> of the frame. + /** provides access to the <type>LayoutManager</type> of the frame. */ [optional, property] com::sun::star::uno::XInterface LayoutManager; }; diff --git a/offapi/com/sun/star/frame/FrameAction.idl b/offapi/com/sun/star/frame/FrameAction.idl index e3249900095e..de2cfb18eecf 100644 --- a/offapi/com/sun/star/frame/FrameAction.idl +++ b/offapi/com/sun/star/frame/FrameAction.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/FrameActionEvent.idl b/offapi/com/sun/star/frame/FrameActionEvent.idl index 563cf5ffe064..40f6d4002eea 100644 --- a/offapi/com/sun/star/frame/FrameActionEvent.idl +++ b/offapi/com/sun/star/frame/FrameActionEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/FrameControl.idl b/offapi/com/sun/star/frame/FrameControl.idl index d05819970559..d9872181a15a 100644 --- a/offapi/com/sun/star/frame/FrameControl.idl +++ b/offapi/com/sun/star/frame/FrameControl.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/FrameLoader.idl b/offapi/com/sun/star/frame/FrameLoader.idl index 3ba240608dbf..8308f239a451 100644 --- a/offapi/com/sun/star/frame/FrameLoader.idl +++ b/offapi/com/sun/star/frame/FrameLoader.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -65,7 +65,7 @@ published service FrameLoader interface XFrameLoader; //------------------------------------------------------------------------- - /** support initialization of loader with its own configuration! + /** support initialization of loader with its own configuration! <p> Concrete implementations should use it to get her own configuration data @@ -82,9 +82,9 @@ published service FrameLoader The internal name is a part of his configuration and will be passed by the <type>FrameLoaderFactory</type> after creation if optional interface <type scope="com::sun::star::lang">XInitialization</type> - is supported. Value of function <member scope="com::sun::star::container">XNamed::getName()</member> + is supported. Value of function <member scope="com::sun::star::container">XNamed::getName()</member> can be used on service <type>FrameLoaderFactory</type> to get further informations about this loader. - Setting of this name by calling <member scope="com::sun::star::container">XNamed::setName()</member> + Setting of this name by calling <member scope="com::sun::star::container">XNamed::setName()</member> must be forwarded to same factory service. He should decide, if it's allowed or not. The reason: prevent code against name ambigities. </p> diff --git a/offapi/com/sun/star/frame/FrameLoaderFactory.idl b/offapi/com/sun/star/frame/FrameLoaderFactory.idl index 1866f286d2cf..0203c8179ae2 100644 --- a/offapi/com/sun/star/frame/FrameLoaderFactory.idl +++ b/offapi/com/sun/star/frame/FrameLoaderFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -75,7 +75,7 @@ published service FrameLoaderFactory /** provides access to the whole frame loader configuration <p>This interface supports an access to the internal configuration of all accessible loader objects. - The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member> + The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member> is a property sequence packed in an any. </p> <table border=1> <tr> diff --git a/offapi/com/sun/star/frame/FrameSearchFlag.idl b/offapi/com/sun/star/frame/FrameSearchFlag.idl index ac3acee82f7e..4fb0ea97ab77 100644 --- a/offapi/com/sun/star/frame/FrameSearchFlag.idl +++ b/offapi/com/sun/star/frame/FrameSearchFlag.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/FramesContainer.idl b/offapi/com/sun/star/frame/FramesContainer.idl index 450da0ac0538..1d1d1972996f 100644 --- a/offapi/com/sun/star/frame/FramesContainer.idl +++ b/offapi/com/sun/star/frame/FramesContainer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl b/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl index 23c98809acbd..3af26c857eb3 100644 --- a/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl +++ b/offapi/com/sun/star/frame/GlobalEventBroadcaster.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/IllegalArgumentIOException.idl b/offapi/com/sun/star/frame/IllegalArgumentIOException.idl index 2154daac70fe..c82fcf5054d2 100644 --- a/offapi/com/sun/star/frame/IllegalArgumentIOException.idl +++ b/offapi/com/sun/star/frame/IllegalArgumentIOException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,31 +24,31 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_TerminationVetoException_idl__ -#define __com_sun_star_frame_TerminationVetoException_idl__ - -#ifndef __com_sun_star_io_IOException_idl__ -#include <com/sun/star/io/IOException.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module frame { - -//============================================================================= - +#ifndef __com_sun_star_frame_TerminationVetoException_idl__ +#define __com_sun_star_frame_TerminationVetoException_idl__ + +#ifndef __com_sun_star_io_IOException_idl__ +#include <com/sun/star/io/IOException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module frame { + +//============================================================================= + // DocMerge from xml: exception com::sun::star::frame::IllegalArgumentIOException /** This exception can be thrown in case arguments are wrong. @since OOo 1.1.2 */ published exception IllegalArgumentIOException: com::sun::star::io::IOException -{ -}; - -//============================================================================= - -}; }; }; }; - -#endif +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/LayoutManager.idl b/offapi/com/sun/star/frame/LayoutManager.idl index 7a2f25f39d20..2465b0fb364b 100644 --- a/offapi/com/sun/star/frame/LayoutManager.idl +++ b/offapi/com/sun/star/frame/LayoutManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -56,20 +56,20 @@ #include <com/sun/star/frame/XLayoutManagerEventBroadcaster.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= /** controls the layout of user interface elements which are part of a frame. <p> - Layout management is the process of determining the size and position of - user interface elements. By default, each <type>Frame</type> has a layout - manager -- it performs layout management for the user interface elements - within the frame. User interface elements can provide size and alignment - hints to layout managers, but layout managers have the final decision on - the size and position of those user interface elements. + Layout management is the process of determining the size and position of + user interface elements. By default, each <type>Frame</type> has a layout + manager -- it performs layout management for the user interface elements + within the frame. User interface elements can provide size and alignment + hints to layout managers, but layout managers have the final decision on + the size and position of those user interface elements. </p> @since OOo 2.0.0 @@ -77,14 +77,14 @@ service LayoutManager { - /** central interface to query for, create, destroy and manipulate user + /** central interface to query for, create, destroy and manipulate user interface elements which are bound to a frame. @see ::com::sun::star::frame::XLayoutManager; */ interface ::com::sun::star::frame::XLayoutManager; - - /** notification interface to receive status information about the state + + /** notification interface to receive status information about the state of the connected frame. <p> @@ -97,7 +97,7 @@ service LayoutManager */ interface ::com::sun::star::frame::XFrameActionListener; - /** notification interface to receive change messages of user interface + /** notification interface to receive change messages of user interface elements which are part of the layout manager. <p> @@ -119,11 +119,11 @@ service LayoutManager */ [optional] interface ::com::sun::star::frame::XLayoutManagerEventBroadcaster; - /** interface to support settings a menu bar for inplace editing of + /** interface to support settings a menu bar for inplace editing of components inside OpenOffice.org. @deprecated - */ + */ [optional] interface ::com::sun::star::frame::XInplaceLayout; }; diff --git a/offapi/com/sun/star/frame/LayoutManagerEvents.idl b/offapi/com/sun/star/frame/LayoutManagerEvents.idl index 8a7bafcf9880..7809d4afce8e 100644 --- a/offapi/com/sun/star/frame/LayoutManagerEvents.idl +++ b/offapi/com/sun/star/frame/LayoutManagerEvents.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -105,7 +105,7 @@ constants LayoutManagerEvents */ const short MERGEDMENUBAR = 5; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies that a certain user interface element has been made visible @@ -116,7 +116,7 @@ constants LayoutManagerEvents */ const short UIELEMENT_VISIBLE = 6; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** specifies that a certain user interface element has been made invisible diff --git a/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl index d4f934c39f44..31f0d859bc6a 100644 --- a/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl +++ b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/ModuleManager.idl b/offapi/com/sun/star/frame/ModuleManager.idl index 4b8c1cb8723a..4513478d7ff9 100644 --- a/offapi/com/sun/star/frame/ModuleManager.idl +++ b/offapi/com/sun/star/frame/ModuleManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -42,7 +42,7 @@ module com { module sun { module star { module frame { //=============================================== /** can be used to identify office modules. - + <p> Further it provides read access to the configuration of office modules. @@ -60,14 +60,14 @@ service ModuleManager //------------------------------------------- /** provides read access to the configuration of office modules. - + <p> Every module is referenced by an unique service name (which is used inside configuration as set node name too) and is further represented by a sequence of elements of type <type scope="com::sun::star::beans">PropertyValue</type>. A list of properties can be getted from the configuration template - org.openoffice.Setup/Factory. + org.openoffice.Setup/Factory. </p> */ interface ::com::sun::star::container::XNameAccess; diff --git a/offapi/com/sun/star/frame/PopupMenuController.idl b/offapi/com/sun/star/frame/PopupMenuController.idl index 0d24f19e6cd5..ce9ebfa9a5d6 100644 --- a/offapi/com/sun/star/frame/PopupMenuController.idl +++ b/offapi/com/sun/star/frame/PopupMenuController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,11 +36,11 @@ #include <com/sun/star/lang/XInitialization.idl> #endif -#ifndef __com_sun_star_frame_XStatusListener_idl__ +#ifndef __com_sun_star_frame_XStatusListener_idl__ #include <com/sun/star/frame/XStatusListener.idl> #endif -#ifndef __com_sun_star_frame_XDispatchProvider_idl__ +#ifndef __com_sun_star_frame_XDispatchProvider_idl__ #include <com/sun/star/frame/XDispatchProvider.idl> #endif @@ -49,19 +49,19 @@ #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= /** provides access to a popup menu controller. - + <p> - A popup menu controller is used to make special functions available to + A popup menu controller is used to make special functions available to users, which depend on runtime or context specific conditions.<br/> - A typical example for a popup menu controller can be a recent file list - implementation which provides a list of latest files that a user has + A typical example for a popup menu controller can be a recent file list + implementation which provides a list of latest files that a user has worked on. This list gets changes consistently during a work session. </p> @@ -75,26 +75,26 @@ service PopupMenuController implementation. <p> - A popup menu controller implementation gets initialized with a + A popup menu controller implementation gets initialized with a <type scope="com::sun::star::awt">XPopupMenu</type> object. This assures that a popup menu controller can be implemented with any UNO based language. </p> */ interface com::sun::star::frame::XPopupMenuController; - + //------------------------------------------------------------------------- - /** provides functions to initialize a popup menu controller with - specific data which are needed. - + /** provides functions to initialize a popup menu controller with + specific data which are needed. + <p> - This interface should not directly used. A factory service is responsible to + This interface should not directly used. A factory service is responsible to initialize every controller correctly.<br/> A popup menu controller needs at least two additional 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> + <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type> instance to which the popup menu controller belongs to.</li> <li><b>CommandURL</b><br>specifies which popup menu controller should be created.</li> </ul> @@ -108,8 +108,8 @@ service PopupMenuController /** used to brief the popup menu controller with new status information. <p> - A popup menu controller makes special functions available to users which - normally depend on the state of other data. This interface is used to + A popup menu controller makes special functions available to users which + normally depend on the state of other data. This interface is used to send this data to a controller implementation. </p> */ @@ -127,7 +127,7 @@ service PopupMenuController Popup menu controller functions must be specified using the following the dispatch URL scheme: "vnd.sun.star.popup:" opaque_part [ "?" query ]. </p> - + @since OOo 2.2 */ [optional] interface com::sun::star::frame::XDispatchProvider; @@ -140,7 +140,7 @@ service PopupMenuController life-time. For correct life-time handling a popup menu controller should support this interface. </p> - + @since OOo 2.2 */ [optional] interface com::sun::star::lang::XComponent; @@ -148,6 +148,6 @@ service PopupMenuController }; }; }; }; -//============================================================================= +//============================================================================= #endif diff --git a/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl b/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl index b0d6d71bb1bd..675b09f7e80d 100644 --- a/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl +++ b/offapi/com/sun/star/frame/PopupMenuControllerFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,17 +36,17 @@ #include <com/sun/star/frame/XUIControllerRegistration.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= /** specifies a factory that creates instances of registered popup menu controller. <p> - A popup menu controller can be registered for a command URL and a model service name. - A menu bar or context menu will automatically create a popup menu controller if + A popup menu controller can be registered for a command URL and a model service name. + A menu bar or context menu will automatically create a popup menu controller if it contains a registered command URL. </p> @@ -56,17 +56,17 @@ module com { module sun { module star { module frame { service PopupMenuControllerFactory { /** 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> + <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 + <li><b>ModuleIdentifier</b><br>optional string that specifies in which module context the popup menu controller should be created.</li> </ul> </p> @@ -80,6 +80,6 @@ service PopupMenuControllerFactory }; }; }; }; -//============================================================================= +//============================================================================= #endif diff --git a/offapi/com/sun/star/frame/ProtocolHandler.idl b/offapi/com/sun/star/frame/ProtocolHandler.idl index f1a6e9dbc6fc..f8fc95abf81c 100644 --- a/offapi/com/sun/star/frame/ProtocolHandler.idl +++ b/offapi/com/sun/star/frame/ProtocolHandler.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/SessionManager.idl b/offapi/com/sun/star/frame/SessionManager.idl index 56c59705fd36..bf29963d8b50 100644 --- a/offapi/com/sun/star/frame/SessionManager.idl +++ b/offapi/com/sun/star/frame/SessionManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -76,9 +76,9 @@ service SessionManager the session manager's signals as well as requests to the session manager. */ interface XSessionManagerClient; - + }; - + }; }; }; }; #endif diff --git a/offapi/com/sun/star/frame/Settings.idl b/offapi/com/sun/star/frame/Settings.idl index 81a2a6a857d4..0da1527235db 100644 --- a/offapi/com/sun/star/frame/Settings.idl +++ b/offapi/com/sun/star/frame/Settings.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/StatusbarController.idl b/offapi/com/sun/star/frame/StatusbarController.idl index 861c4364e1f0..6754d1443217 100644 --- a/offapi/com/sun/star/frame/StatusbarController.idl +++ b/offapi/com/sun/star/frame/StatusbarController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -48,16 +48,16 @@ module com { module sun { module star { module frame { //============================================================================= -/** is an abstract service for a component which offers a more complex user +/** is an abstract service for a component which offers a more complex user interface to users within a status bar. <p> - A generic status bar function is represented as a text field which - provides status information to the user. A status bar controller can be - added to a status bar and provides information or functions with a more + A generic status bar function is represented as a text field which + provides status information to the user. A status bar controller can be + added to a status bar and provides information or functions with a more sophisticated user interface.<br/> - A typical example for a status bar controller is the zoom level chooser - within the statusbar. It provides an option to change the zoom level of + A typical example for a status bar controller is the zoom level chooser + within the statusbar. It provides an option to change the zoom level of an application. <p> @@ -70,12 +70,12 @@ service StatusbarController { //------------------------------------------------------------------------- - /** with this interface a component can receive events if a feature has + /** 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> + 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> */ @@ -83,52 +83,52 @@ service StatusbarController /** used to initialize a component with required arguments. - <b>A status bar controller needs at least three additional 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 + <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 + <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 + 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 + 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 + <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 + /** 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 + 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 + /** 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 + 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> */ diff --git a/offapi/com/sun/star/frame/StatusbarControllerFactory.idl b/offapi/com/sun/star/frame/StatusbarControllerFactory.idl index 01d26117f1c1..fcffafa55a90 100644 --- a/offapi/com/sun/star/frame/StatusbarControllerFactory.idl +++ b/offapi/com/sun/star/frame/StatusbarControllerFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,18 +36,18 @@ #include <com/sun/star/frame/XUIControllerRegistration.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= -/** specifies a factory that creates instances of registered status bar +/** specifies a factory that creates instances of registered status bar controller. <p> - A status bar controller can be registered for a command URL and a model - service name. A status bar will automatically create a status bar controller + A status bar controller can be registered for a command URL and a model + service name. A status bar will automatically create a status bar controller if it contains a registered command URL. </p> @@ -56,29 +56,29 @@ module com { module sun { module star { module frame { service StatusbarControllerFactory { - /** this interface provides functions to create new instances of a registered + /** 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 + 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 + + 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 + <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 + <li><b>ModuleIdentifier</b><br>optional string that specifies in which module context the status bar controller should be created.</li> </ul> </p> */ interface com::sun::star::lang::XMultiComponentFactory; - /** provides functions to query for, register and deregister a status bar + /** provides functions to query for, register and deregister a status bar controller. */ interface com::sun::star::frame::XUIControllerRegistration; @@ -86,6 +86,6 @@ service StatusbarControllerFactory }; }; }; }; -//============================================================================= +//============================================================================= #endif diff --git a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl index b6c954c8fff8..15da61b46bf5 100644 --- a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -65,7 +65,7 @@ published service SynchronousFrameLoader interface XSynchronousFrameLoader; //------------------------------------------------------------------------- - /** support initialization of loader with its own configuration! + /** support initialization of loader with its own configuration! <p> Concrete implementations should use it to get her own configuration data diff --git a/offapi/com/sun/star/frame/Task.idl b/offapi/com/sun/star/frame/Task.idl index 76e7bef933a9..630d56cde4f9 100644 --- a/offapi/com/sun/star/frame/Task.idl +++ b/offapi/com/sun/star/frame/Task.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/TemplateAccess.idl b/offapi/com/sun/star/frame/TemplateAccess.idl index 049529a930c3..1bced8264dca 100644 --- a/offapi/com/sun/star/frame/TemplateAccess.idl +++ b/offapi/com/sun/star/frame/TemplateAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/TerminationVetoException.idl b/offapi/com/sun/star/frame/TerminationVetoException.idl index aa114abd98c4..39a4a3ba0dad 100644 --- a/offapi/com/sun/star/frame/TerminationVetoException.idl +++ b/offapi/com/sun/star/frame/TerminationVetoException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/TitleChangedEvent.idl b/offapi/com/sun/star/frame/TitleChangedEvent.idl index f93ef7ccc564..a67daddeb1df 100644 --- a/offapi/com/sun/star/frame/TitleChangedEvent.idl +++ b/offapi/com/sun/star/frame/TitleChangedEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/ToolbarController.idl b/offapi/com/sun/star/frame/ToolbarController.idl index 674b35af4e6c..b79fe669d5f2 100644 --- a/offapi/com/sun/star/frame/ToolbarController.idl +++ b/offapi/com/sun/star/frame/ToolbarController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -53,15 +53,15 @@ module com { module sun { module star { module frame { //============================================================================= -/** is an abstract service for a component which offers a more complex user +/** is an abstract service for a component which offers a more complex user interface to users within a toolbar. <p> - A generic toolbar function is represented as a button which has a state - (enabled,disabled and selected, not selected). A toolbar controller can - be added to a toolbar and provide information or functions within a more - sophisticated user interface.<br/> A typical example for toolbar controller - is the font chooser within the toolbar. It provides all available fonts in + A generic toolbar function is represented as a button which has a state + (enabled,disabled and selected, not selected). A toolbar controller can + be added to a toolbar and provide information or functions within a more + sophisticated user interface.<br/> A typical example for toolbar controller + is the font chooser within the toolbar. It provides all available fonts in a dropdown box and shows the current chosen font. <p> @@ -73,12 +73,12 @@ service ToolbarController { //------------------------------------------------------------------------- - /** with this interface a component can receive events if a feature has + /** with this interface a component can receive events if a feature has changed. <p> - The toolbar controller implementation should register itself as a - listener when its <member scope="com::sun::star::util">XUpdatable</member> + The toolbar controller implementation should register itself as a + listener when its <member scope="com::sun::star::util">XUpdatable</member> interface has been called. </p> */ @@ -86,53 +86,53 @@ service ToolbarController /** used to initialize a component with required arguments. - A toolbar controller needs at least three additional arguments + A toolbar 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> + <li><b>Frame</b><br>a <type scope="com::sun::star::frame">XFrame</type> instance to which the toolbar controller belongs.</li> - <li><b>CommandURL</b><br>a string which specifies the command a + <li><b>CommandURL</b><br>a string which specifies the command a toolbar controller is bound.</li> - <li><b>ServiceManager</b><br>a + <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> </ul> */ interface com::sun::star::lang::XInitialization; - /** used to notify an implementation that it needs to add its listener or remove + /** used to notify an implementation that it needs to add its listener or remove and add them again. <p> - A toolbar controller instance is ready for use after this call has been made - the first time. The toolbar implementation guarentees that the controller's + A toolbar controller instance is ready for use after this call has been made + the first time. The toolbar implementation guarentees that the controller's item window has been added to the toolbar 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 + /** used to notify changed features and requests for additional user interface items. <p> Mostly used by a toolbar implementation to forward information to and request - services from a toolbar 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 + services from a toolbar 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::XToolbarController; //------------------------------------------------------------------------- - /** used to notify and retrieve information that are specific for sub-toolbar + /** used to notify and retrieve information that are specific for sub-toolbar controllers. <p> Used by implementations that want to provide the toolbar button/sub- - toolbar function feature. A controller supporting this interface exchanges - the function of its own toolbar button, that opened the sub-toolbar, with + toolbar function feature. A controller supporting this interface exchanges + the function of its own toolbar button, that opened the sub-toolbar, with the one that has been selected on the sub-toolbar. </p> */ diff --git a/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl b/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl index 326981516522..2dfb26d38d7c 100644 --- a/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl +++ b/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/UnknownModuleException.idl b/offapi/com/sun/star/frame/UnknownModuleException.idl index c1c9aad21d8a..39f47ef7bd1c 100644 --- a/offapi/com/sun/star/frame/UnknownModuleException.idl +++ b/offapi/com/sun/star/frame/UnknownModuleException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,7 +40,7 @@ module com { module sun { module star { module frame { * module could not be classified or does not have * a valid configuration. - @since OOo 2.0.0 + @since OOo 2.0.0 */ exception UnknownModuleException : ::com::sun::star::uno::Exception { diff --git a/offapi/com/sun/star/frame/WindowArrange.idl b/offapi/com/sun/star/frame/WindowArrange.idl index e16d0a01fb7f..0ee7a3dd41df 100644 --- a/offapi/com/sun/star/frame/WindowArrange.idl +++ b/offapi/com/sun/star/frame/WindowArrange.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XBorderResizeListener.idl b/offapi/com/sun/star/frame/XBorderResizeListener.idl index c6c96dc9c7fc..0b0eb8161222 100644 --- a/offapi/com/sun/star/frame/XBorderResizeListener.idl +++ b/offapi/com/sun/star/frame/XBorderResizeListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl b/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl index e6ee4b618519..92e664d04ae5 100644 --- a/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl +++ b/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XComponentLoader.idl b/offapi/com/sun/star/frame/XComponentLoader.idl index 37589454b260..e987cd51038a 100644 --- a/offapi/com/sun/star/frame/XComponentLoader.idl +++ b/offapi/com/sun/star/frame/XComponentLoader.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XComponentRegistry.idl b/offapi/com/sun/star/frame/XComponentRegistry.idl index 9a9f32541b7b..8389798d55fc 100644 --- a/offapi/com/sun/star/frame/XComponentRegistry.idl +++ b/offapi/com/sun/star/frame/XComponentRegistry.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XConfigManager.idl b/offapi/com/sun/star/frame/XConfigManager.idl index d46cf5696478..28362ad3c6f7 100644 --- a/offapi/com/sun/star/frame/XConfigManager.idl +++ b/offapi/com/sun/star/frame/XConfigManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XControlNotificationListener.idl b/offapi/com/sun/star/frame/XControlNotificationListener.idl index 1ebc134cc76f..5584f36a2749 100644 --- a/offapi/com/sun/star/frame/XControlNotificationListener.idl +++ b/offapi/com/sun/star/frame/XControlNotificationListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,27 +24,27 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_XControlNotificationListener_idl__ -#define __com_sun_star_frame_XControlNotificationListener_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> +#ifndef __com_sun_star_frame_XControlNotificationListener_idl__ +#define __com_sun_star_frame_XControlNotificationListener_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> #endif #ifndef __com_sun_star_frame_ControlEvent_idl__ #include <com/sun/star/frame/ControlEvent.idl> #endif - -//============================================================================= - -module com { module sun { module star { module frame { - -//============================================================================= - -/** Must be implemented by dispatch objects which want to get + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= + +/** Must be implemented by dispatch objects which want to get notifications about control events. - - @since OOo 2.0.3 + + @since OOo 2.0.3 */ interface XControlNotificationListener : com::sun::star::uno::XInterface { @@ -54,12 +54,12 @@ interface XControlNotificationListener : com::sun::star::uno::XInterface @param Event contains the event informantion */ - void controlEvent( [in] ControlEvent Event ); - -}; - -//============================================================================= + void controlEvent( [in] ControlEvent Event ); -}; }; }; }; - -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl index 50d58246fb1a..1815d7b378ae 100644 --- a/offapi/com/sun/star/frame/XController.idl +++ b/offapi/com/sun/star/frame/XController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XController2.idl b/offapi/com/sun/star/frame/XController2.idl index 2c0157d99309..695d9fb11ddc 100644 --- a/offapi/com/sun/star/frame/XController2.idl +++ b/offapi/com/sun/star/frame/XController2.idl @@ -1,6 +1,6 @@ /************************************************************************* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -44,7 +44,7 @@ module com { module sun { module star { module frame { interface XController2 : XController { /** denotes the "root window" of the controller. - + <p>If the controller is plugged into a frame, this window acts as the frame's <code>ComponentWindow</code>.</p> diff --git a/offapi/com/sun/star/frame/XControllerBorder.idl b/offapi/com/sun/star/frame/XControllerBorder.idl index 9f8659ee8da9..617f45ca7951 100644 --- a/offapi/com/sun/star/frame/XControllerBorder.idl +++ b/offapi/com/sun/star/frame/XControllerBorder.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl index 18f531703da5..d633a0ba86ec 100644 --- a/offapi/com/sun/star/frame/XDesktop.idl +++ b/offapi/com/sun/star/frame/XDesktop.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDesktopTask.idl b/offapi/com/sun/star/frame/XDesktopTask.idl index 7a1c3cdbc436..23a891a13618 100644 --- a/offapi/com/sun/star/frame/XDesktopTask.idl +++ b/offapi/com/sun/star/frame/XDesktopTask.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl index bad1f6525079..26e8f9436469 100644 --- a/offapi/com/sun/star/frame/XDispatch.idl +++ b/offapi/com/sun/star/frame/XDispatch.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDispatchHelper.idl b/offapi/com/sun/star/frame/XDispatchHelper.idl index 7d58677c19b7..5bb7cce1b125 100644 --- a/offapi/com/sun/star/frame/XDispatchHelper.idl +++ b/offapi/com/sun/star/frame/XDispatchHelper.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDispatchInformationProvider.idl b/offapi/com/sun/star/frame/XDispatchInformationProvider.idl index 3bf6886ba17b..f3c722ff61f1 100644 --- a/offapi/com/sun/star/frame/XDispatchInformationProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchInformationProvider.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -48,9 +48,9 @@ module com { module sun { module star { module frame { <p> This interface can be used to retrieve additional information about - supported commands. This interface is normally used by configuration - implementations to retrieve all supported commands. - A dispatch information provider is normally supported by a + supported commands. This interface is normally used by configuration + implementations to retrieve all supported commands. + A dispatch information provider is normally supported by a <type>Frame</type> service. </p> @@ -71,12 +71,12 @@ published interface XDispatchInformationProvider: com::sun::star::uno::XInterfac sequence < short > getSupportedCommandGroups(); //------------------------------------------------------------------------- - /** returns additional information about supported commands of a + /** returns additional information about supported commands of a given command group. - + @param CommandGroup specifies a command group. - + @returns name and group name of every command supported. A group ID which is not supported returns an empty <type scope="com::sun::star::uno">Sequence</type>. diff --git a/offapi/com/sun/star/frame/XDispatchProvider.idl b/offapi/com/sun/star/frame/XDispatchProvider.idl index 8197d272a119..38ef9cf5f9b9 100644 --- a/offapi/com/sun/star/frame/XDispatchProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchProvider.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl index 769a4acce3ac..4669f2bc6613 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl index 3b1ee2c16f71..3739ec2fa732 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDispatchRecorder.idl b/offapi/com/sun/star/frame/XDispatchRecorder.idl index ed980d89f91d..a621f2c4b198 100644 --- a/offapi/com/sun/star/frame/XDispatchRecorder.idl +++ b/offapi/com/sun/star/frame/XDispatchRecorder.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -79,12 +79,12 @@ published interface XDispatchRecorder: com::sun::star::uno::XInterface <p> Must be called in pairs with <member>XDispatchRecorder::startRecording()</member>. </p> - + @attention The recorder uses this method to control the lifetime of its internal used macro buffer. It will be cleared here. So the macro must be fetched before endRecording() is called. - - @see getRecordedMacro() + + @see getRecordedMacro() */ void endRecording(); diff --git a/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl b/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl index c63e34dec1e9..410a6908677c 100644 --- a/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl +++ b/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDispatchResultListener.idl b/offapi/com/sun/star/frame/XDispatchResultListener.idl index 409bd4e0206e..10587ad14895 100644 --- a/offapi/com/sun/star/frame/XDispatchResultListener.idl +++ b/offapi/com/sun/star/frame/XDispatchResultListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XDocumentTemplates.idl b/offapi/com/sun/star/frame/XDocumentTemplates.idl index bc41386ea1fd..eec3042e52b1 100644 --- a/offapi/com/sun/star/frame/XDocumentTemplates.idl +++ b/offapi/com/sun/star/frame/XDocumentTemplates.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl index b51feda6d406..a0ca005440ed 100644 --- a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl +++ b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XFilterDetect.idl b/offapi/com/sun/star/frame/XFilterDetect.idl index 5add9f5e34e9..e55f527fa724 100644 --- a/offapi/com/sun/star/frame/XFilterDetect.idl +++ b/offapi/com/sun/star/frame/XFilterDetect.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl index e74a15446d1e..d432ec3f017d 100644 --- a/offapi/com/sun/star/frame/XFrame.idl +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -68,7 +68,7 @@ published interface XFrame: com::sun::star::lang::XComponent </p> <p>This frame will take over ownership of the window refered from - <var>xWindow</var>. Thus, the previous owner is not allowed to + <var>xWindow</var>. Thus, the previous owner is not allowed to dispose this window anymore. </p> @param xWindow diff --git a/offapi/com/sun/star/frame/XFrameActionListener.idl b/offapi/com/sun/star/frame/XFrameActionListener.idl index 52f87f960113..dfef212e2727 100644 --- a/offapi/com/sun/star/frame/XFrameActionListener.idl +++ b/offapi/com/sun/star/frame/XFrameActionListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XFrameLoader.idl b/offapi/com/sun/star/frame/XFrameLoader.idl index 4e830af1dc4e..40e5f9e0c807 100644 --- a/offapi/com/sun/star/frame/XFrameLoader.idl +++ b/offapi/com/sun/star/frame/XFrameLoader.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl index 370386cc73e3..c6f0c538fdc6 100644 --- a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl +++ b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XFrameSetModel.idl b/offapi/com/sun/star/frame/XFrameSetModel.idl index d5baf6f86466..8635c31af122 100644 --- a/offapi/com/sun/star/frame/XFrameSetModel.idl +++ b/offapi/com/sun/star/frame/XFrameSetModel.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XFrames.idl b/offapi/com/sun/star/frame/XFrames.idl index 42a7b0eb35e8..0c65c3fa4700 100644 --- a/offapi/com/sun/star/frame/XFrames.idl +++ b/offapi/com/sun/star/frame/XFrames.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XFramesSupplier.idl b/offapi/com/sun/star/frame/XFramesSupplier.idl index 6674693e8fe2..1a0bc8709835 100644 --- a/offapi/com/sun/star/frame/XFramesSupplier.idl +++ b/offapi/com/sun/star/frame/XFramesSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -73,7 +73,7 @@ published interface XFramesSupplier: XFrame XFrame getActiveFrame(); //------------------------------------------------------------------------- - /** is called on activation of a direct sub-frame. + /** is called on activation of a direct sub-frame. <p> This method is only allowed to be called by a sub-frame according to diff --git a/offapi/com/sun/star/frame/XInplaceLayout.idl b/offapi/com/sun/star/frame/XInplaceLayout.idl index 71344418bda3..ba923da41cc9 100644 --- a/offapi/com/sun/star/frame/XInplaceLayout.idl +++ b/offapi/com/sun/star/frame/XInplaceLayout.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,32 +32,32 @@ #include <com/sun/star/uno/XInterface.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= -/** special interface to support inplace editing of components inside +/** special interface to support inplace editing of components inside OpenOffice.org. @deprecated @since OOo 2.0.0 */ - + interface XInplaceLayout : com::sun::star::uno::XInterface { /** sets an inplace menu to the container window of the attached frame. - + @param InplaceMenuBarPointer must be a VCL menu bar pointer which is accessible within the layout manager process. */ void setInplaceMenuBar( [in] hyper InplaceMenuBarPointer ); - + /** removes an inplace menu and sets back a previously created menu bar if one - has been set before. + has been set before. */ void resetInplaceMenuBar(); }; diff --git a/offapi/com/sun/star/frame/XInterceptorInfo.idl b/offapi/com/sun/star/frame/XInterceptorInfo.idl index de135a517171..6282fd281e6a 100644 --- a/offapi/com/sun/star/frame/XInterceptorInfo.idl +++ b/offapi/com/sun/star/frame/XInterceptorInfo.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XLayoutManager.idl b/offapi/com/sun/star/frame/XLayoutManager.idl index 5699fe00687b..f280d8606c06 100644 --- a/offapi/com/sun/star/frame/XLayoutManager.idl +++ b/offapi/com/sun/star/frame/XLayoutManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -60,34 +60,34 @@ #include <com/sun/star/ui/XDockingAreaAcceptor.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= -/** central interface to query for, create, destroy and manipulate user +/** central interface to query for, create, destroy and manipulate user interface elements which are bound to a layout manager. <p> - Every user interface element which is controlled by a layout manager has + Every user interface element which is controlled by a layout manager has a unique identifier called resource URL. - - A resourcce URL must meet the following syntax: - "private:resource/$type/$name". It is only allowed to use ascii characters + + A resourcce URL must meet the following syntax: + "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. Currently the following user interface element types are defined: <ul> - <li><b>menubar</b>A configurable user interface element representing + <li><b>menubar</b>A configurable user interface element representing a menu bar.</li> - <li><b>popupmenu</b>A configurable user interface element representing + <li><b>popupmenu</b>A configurable user interface element representing a popup menu.</li> - <li><b>toolbar</b>A configurable user interface element a tool + <li><b>toolbar</b>A configurable user interface element a tool bar.</li> - <li><b>statusbar</b>A configurable user interfave element representing + <li><b>statusbar</b>A configurable user interfave element representing a status bar.</li> - <li><b>floater</b>A basic user interface element representing a + <li><b>floater</b>A basic user interface element representing a floating window.</li> </ul> @@ -97,28 +97,28 @@ module com { module sun { module star { module frame { @since OOo 2.0.0 */ - + interface XLayoutManager : com::sun::star::uno::XInterface { - /** attaches a <type scope="com::sun::star::frame">XFrame</type> to a layout manager. - + /** attaches a <type scope="com::sun::star::frame">XFrame</type> to a layout manager. + @param Frame specifies the frame that should be attached to the layout manager - + <p> - A layout manager needs a <type scope="com::sun::star::frame">XFrame</type> to be + A layout manager needs a <type scope="com::sun::star::frame">XFrame</type> to be able to work. Without a it no user interface elements can be created. </p> */ void attachFrame( [in] com::sun::star::frame::XFrame Frame ); - - /** resets the layout manager and remove all of its internal user interface + + /** resets the layout manager and remove all of its internal user interface elements. <p> This call should be handled with care as all user interface elements will - be destroyed and the layout manager is reseted to a state after a - <member>attachFrame</member> has been made. That means an attached frame + be destroyed and the layout manager is reseted to a state after a + <member>attachFrame</member> has been made. That means an attached frame which has been set by <member>attachFrame</member> is not released. The layout manager itself calls reset after a component has been attached or reattached to a frame. @@ -127,9 +127,9 @@ interface XLayoutManager : com::sun::star::uno::XInterface void reset(); /** provides the current docking area size of the layout manager. - + @return - The <type scope="com::sun::star::awt">Rectangle</type> contains pixel values. The + The <type scope="com::sun::star::awt">Rectangle</type> contains pixel values. The members of <type scope="com::sun::star::awt">Rectangle</type> are filled as following: <ul> <li>X = docking area on left side (in pixel)</li> @@ -140,12 +140,12 @@ interface XLayoutManager : com::sun::star::uno::XInterface */ com::sun::star::awt::Rectangle getCurrentDockingArea(); - /** retrieves the current docking area acceptor that controls the border space of the frame's + /** retrieves the current docking area acceptor that controls the border space of the frame's container window. @return current docking area acceptor which controls the border space of frame's container window. - + <p> A docking area acceptor retrieved by this method is owned by the layout manager. It is not allowed to dispose this object, it will be destroyed on reference count! @@ -157,7 +157,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface @param xDockingAreaAcceptor a docking area acceptor which controls the border space of frame's container window. - + <p> A docking area acceptor decides if the layout manager can use requested border space for docking windows. If the acceptor denies the requested space the layout manager automatically @@ -167,41 +167,41 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> */ void setDockingAreaAcceptor( [in] com::sun::star::ui::XDockingAreaAcceptor xDockingAreaAcceptor ); - + /** creates a new user interface element. @param ResourceURL - specifies which user interface element should be created. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be created. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. */ void createElement( [in] string ResourceURL ); - - /** destroys a user interface element. - + + /** destroys a user interface element. + @param ResourceURL - specifies which user interface element should be destroyed. A resourcce URL must meet + specifies which user interface element should be destroyed. A resourcce URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. */ void destroyElement( [in] string ResourceURL ); - + /** request to make a user interface element visible if it is not in hidden state. @param ResourceURL - specifies which user interface element should be made visible. A resourcce URL must - meet the following syntax: "private:resource/$type/$name". It is only allowed to use - ascii characters for type and + specifies which user interface element should be made visible. A resourcce URL must + meet the following syntax: "private:resource/$type/$name". It is only allowed to use + ascii characters for type and name. - + @return - returns <TRUE/> if the user interface element could be made visible, otherwise + returns <TRUE/> if the user interface element could be made visible, otherwise <FALSE/> will be returned. <p> - If a user interface element should forced to the visible state - <member>XLayoutManager::showElement</member> should be used. This function can be - used for context dependent elements which should respect a the current visibility + If a user interface element should forced to the visible state + <member>XLayoutManager::showElement</member> should be used. This function can be + used for context dependent elements which should respect a the current visibility state. </p> */ @@ -210,17 +210,17 @@ interface XLayoutManager : com::sun::star::uno::XInterface /** retrieves a user interface element which has been created before. @param ResourceURL - specifies which user interface element should be retrieved. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be retrieved. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + <p> - The layout manager instance is owner of the returned user interface element. That means that the life time of + The layout manager instance is owner of the returned user interface element. That means that the life time of the user interface element is controlled by the layout manager. It can be disposed at every time! </p> */ com::sun::star::ui::XUIElement getElement( [in] string ResourceURL ); - + /** retrieves all user interface elements which are currently instanciated. @return @@ -228,7 +228,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface interface. <p> - The layout manager instance is owner of the returned user interface elements. That means that the life time of + The layout manager instance is owner of the returned user interface elements. That means that the life time of the user interface elements is controlled by the layout manager. They can be disposed at every time! </p> */ @@ -237,32 +237,32 @@ interface XLayoutManager : com::sun::star::uno::XInterface /** shows a user interface element. @param ResourceURL - specifies which user interface element should be shown. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be shown. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return returns <TRUE/> if the user interface element has been shown, otherwise <FALSE/> will be returned. */ boolean showElement( [in] string ResourceURL ); - + /** hides a user interface element. @param ResourceURL - specifies which user interface element should be hidden. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be hidden. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return returns <TRUE/> if the user interface element has been hidden, otherwise <FALSE/> will be returned. */ boolean hideElement( [in] string ResourceURL ); - + /** docks a window based user interface element to a specified docking area. @param ResourceURL - specifies which user interface element should be docked. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be docked. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. @param DockingArea @@ -270,44 +270,44 @@ interface XLayoutManager : com::sun::star::uno::XInterface @param Pos specifies the position inside the docking area. - + @return returns <TRUE/> if the user interface element has been docked, otherwise <FALSE/> will be returned. @see com::sun::star::ui::DockingArea */ boolean dockWindow( [in] string ResourceURL, [in] com::sun::star::ui::DockingArea DockingArea, [in] com::sun::star::awt::Point Pos ); - + /** docks all windows which are member of the provided user interface element type. @param nElementType specifies which user interface element type should be docked. @return - returns <TRUE/> if all user interface elements of the requested type could be + returns <TRUE/> if all user interface elements of the requested type could be docked, otherwise <FALSE/> will be returned. @see com::sun::star::ui::UIElementType */ boolean dockAllWindows( [in] short nElementType ); - + /** forces a window based user interface element to float. @param ResourceURL - specifies which user interface element should be float. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be float. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. @return returns <TRUE/> if the user interface element has been docked, otherwise <FALSE/> will be returned. */ boolean floatWindow( [in] string ResourceURL ); - + /** locks a window based user interface element if it's in a docked state. @param ResourceURL - specifies which user interface element should be locked. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be locked. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. @return @@ -318,12 +318,12 @@ interface XLayoutManager : com::sun::star::uno::XInterface /** unlocks a window based user interface element if it's in a docked state. @param ResourceURL - specifies which user interface element should be unlocked. A resourcce URL must - meet the following syntax: "private:resource/$type/$name". It is only allowed + specifies which user interface element should be unlocked. A resourcce URL must + meet the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. @return - returns <TRUE/> if the user interface element has been unlocked, otherwise + returns <TRUE/> if the user interface element has been unlocked, otherwise <FALSE/> will be returned. */ boolean unlockWindow( [in] string ResourceURL ); @@ -331,8 +331,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface /** sets a new size for a window based user interface element. @param ResourceURL - specifies which user interface element should be resized. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be resized. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. @param Size @@ -344,12 +344,12 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> */ void setElementSize( [in] string ResourceURL, [in] com::sun::star::awt::Size Size ); - + /** sets a new position for a window based user interface element. @param ResourceURL - specifies which user interface element should be moved. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be moved. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. @param Pos @@ -361,12 +361,12 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> */ void setElementPos( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos ); - + /** sets a new position and size for a window based user interface element. @param ResourceURL - specifies which user interface element should be moved and resized. A resourcce URL must meet the following - syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies which user interface element should be moved and resized. A resourcce URL must meet the following + syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. @param Pos @@ -376,111 +376,111 @@ interface XLayoutManager : com::sun::star::uno::XInterface specifies the new position in pixel. <p> - It is up to the layout manager to decide if the user interface element can be moved and resized. The new position and size can + It is up to the layout manager to decide if the user interface element can be moved and resized. The new position and size can be retrieved by calling <member>getElementPos</member> and <member>getElementSize</member>. </p> */ void setElementPosSize( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos, [in] com::sun::star::awt::Size Size ); - + /** retrieves the current visibility state of a window based user interface element. @param ResourceURL - specifies for which user interface element the visibility state should be retrieved. A resource URL must meet - the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies for which user interface element the visibility state should be retrieved. A resource URL must meet + the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return <TRUE/> if the user interface element is visible, otherwise <FALSE/>. */ boolean isElementVisible( [in] string ResourceURL ); - + /** retrieves the current floating state of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the floating state should be retrieved. A resource URL must meet - the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies for which user interface element the floating state should be retrieved. A resource URL must meet + the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return <TRUE/> if the user interface element is floating, otherwise <FALSE/>. */ boolean isElementFloating( [in] string ResourceURL ); - + /** retrieves the current docking state of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the docking state should be retrieved. A resource URL must meet - the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies for which user interface element the docking state should be retrieved. A resource URL must meet + the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return <TRUE/> if the user interface element is docked, otherwise <FALSE/>. */ boolean isElementDocked( [in] string ResourceURL ); - + /** retrieves the current lock state of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the lock state should be retrieved. A resource URL must meet - the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies for which user interface element the lock state should be retrieved. A resource URL must meet + the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return <TRUE/> if the user interface element is locked, otherwise <FALSE/>. */ boolean isElementLocked( [in] string ResourceURL ); /** retrieves the current size of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the current size should be retrieved. A resource URL must meet - the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies for which user interface element the current size should be retrieved. A resource URL must meet + the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return the size in pixel of the user interface element. A non-window based user interface element provides a zero size. */ com::sun::star::awt::Size getElementSize( [in] string ResourceURL ); - + /** retrieves the current pixel position of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the current position should be retrieved. A resource URL must meet - the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and + specifies for which user interface element the current position should be retrieved. A resource URL must meet + the following syntax: "private:resource/$type/$name". It is only allowed to use ascii characters for type and name. - + @return the size in pixel of the user interface element. A non-window based user interface element provides a zero size. */ com::sun::star::awt::Point getElementPos( [in] string ResourceURL ); - + /** prohibit all layout updates until unlock is called again. <p> - This call can be used to speed up the creation process of serveral user interface elements. Otherwise the layout manager + This call can be used to speed up the creation process of serveral user interface elements. Otherwise the layout manager would calculate the layout for every creation. </p> */ void lock(); - + /** permit layout updates again. - + <p> This function should be called to permit layout updates. The layout manager starts to calculate the new layout after this call. </p> */ void unlock(); - + /** forces a complete new layouting of all user interface elements. */ void doLayout(); - /** sets the layout manager to invisible state and hides all user interface elements. + /** sets the layout manager to invisible state and hides all user interface elements. <p> - A layout manager can be set to invisible state to force it to hide all of its - user interface elements. If another component wants to use the window for its + A layout manager can be set to invisible state to force it to hide all of its + user interface elements. If another component wants to use the window for its own user interface elements it can use this function. This function is normally used to implement inplace editing. </p> @@ -494,8 +494,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface /** retrieves the visibility state of a layout manager. <p> - A layout manager can be set to invisible state to force it to hide all of its - user interface elements. If another component wants to use the window for its + A layout manager can be set to invisible state to force it to hide all of its + user interface elements. If another component wants to use the window for its own user interface elements it can use this function. This function is normally used to implement inplace editing. </p> diff --git a/offapi/com/sun/star/frame/XLayoutManagerEventBroadcaster.idl b/offapi/com/sun/star/frame/XLayoutManagerEventBroadcaster.idl index b79827dd4b3e..53d179139159 100644 --- a/offapi/com/sun/star/frame/XLayoutManagerEventBroadcaster.idl +++ b/offapi/com/sun/star/frame/XLayoutManagerEventBroadcaster.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -53,11 +53,11 @@ interface XLayoutManagerEventBroadcaster : com::sun::star::uno::XInterface */ void addLayoutManagerEventListener( [in] XLayoutManagerListener aLayoutManagerListener ); - /** removes a layout manager event listener from the object's listener + /** removes a layout manager event listener from the object's listener list. @param aLayoutManagerListener - a listener that don't want to receive events regarding user + a listener that don't want to receive events regarding user interface elements that are controlled by a layout manager. */ void removeLayoutManagerEventListener( [in] XLayoutManagerListener aLayoutManagerListener ); diff --git a/offapi/com/sun/star/frame/XLayoutManagerListener.idl b/offapi/com/sun/star/frame/XLayoutManagerListener.idl index 593ba510c08c..dbdc68ed6ce1 100644 --- a/offapi/com/sun/star/frame/XLayoutManagerListener.idl +++ b/offapi/com/sun/star/frame/XLayoutManagerListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -27,9 +27,9 @@ #ifndef __com_sun_star_frame_XLayoutManagerListener_idl__ #define __com_sun_star_frame_XLayoutManagerListener_idl__ -#ifndef __com_sun_star_lang_XEventListener_idl__ -#include <com/sun/star/lang/XEventListener.idl> -#endif +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif //============================================================================= @@ -38,25 +38,25 @@ module com { module sun { module star { module frame { //============================================================================= /** makes it possible to receive events from a layout manager. - <p>Events are provided <strong>only</strong> for notification - purposes only. All operations are handled interally by the - layout manager component, so that GUI layout works properly - regardless of whether a component registers such a listener + <p>Events are provided <strong>only</strong> for notification + purposes only. All operations are handled interally by the + layout manager component, so that GUI layout works properly + regardless of whether a component registers such a listener or not.</p> @see ::com::sun::star::frame::LayoutManager @see ::com::sun::star::frame::LayoutManagerEvents - + @since OOo 2.0.0 */ -interface XLayoutManagerListener : com::sun::star::lang::XEventListener +interface XLayoutManagerListener : com::sun::star::lang::XEventListener { //============================================================================= /** is invoked when a layout manager has made a certain operation. @param aSource reference to the layout manager which invoked the event. - + @param eLayoutEvent identifies the layout event that has occured. diff --git a/offapi/com/sun/star/frame/XLoadEventListener.idl b/offapi/com/sun/star/frame/XLoadEventListener.idl index c682114f9234..c7963d43c712 100644 --- a/offapi/com/sun/star/frame/XLoadEventListener.idl +++ b/offapi/com/sun/star/frame/XLoadEventListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XLoadable.idl b/offapi/com/sun/star/frame/XLoadable.idl index 073ca9a55f34..e8ab52fc7b5f 100644 --- a/offapi/com/sun/star/frame/XLoadable.idl +++ b/offapi/com/sun/star/frame/XLoadable.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XMenuBarAcceptor.idl b/offapi/com/sun/star/frame/XMenuBarAcceptor.idl index 7eec81bb5308..51320a28fdf5 100644 --- a/offapi/com/sun/star/frame/XMenuBarAcceptor.idl +++ b/offapi/com/sun/star/frame/XMenuBarAcceptor.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,11 +36,11 @@ #include <com/sun/star/awt/XMenuBar.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= /** provides function to update a menu bar for inplace editing. @@ -52,10 +52,10 @@ module com { module sun { module star { module frame { interface XMenuBarAcceptor : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** update menu bar according to the current frame mode. This is used in - inplace editing mode where we have to merge our own menu into the + /** update menu bar according to the current frame mode. This is used in + inplace editing mode where we have to merge our own menu into the container applications menu. - + @param xMenuBar the menu bar that should be merged with current one. */ diff --git a/offapi/com/sun/star/frame/XMenuBarMergingAcceptor.idl b/offapi/com/sun/star/frame/XMenuBarMergingAcceptor.idl index b7c6a1b13c19..5ae56391a944 100644 --- a/offapi/com/sun/star/frame/XMenuBarMergingAcceptor.idl +++ b/offapi/com/sun/star/frame/XMenuBarMergingAcceptor.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,11 +36,11 @@ #include <com/sun/star/frame/XDispatchProvider.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= /** provides functions to set and remove a merged menu bar for inplace editing. @@ -56,19 +56,19 @@ interface XMenuBarMergingAcceptor : com::sun::star::uno::XInterface specifies the merged menu bar. <p> - This function is normally used to provide inplace editing where - functions from two application parts, container application and - embedded object, are available to the user simultaneously. A menu - bar which is set by this method has a higher priority than others - created by <type scope="com::sun::star::frame">XLayoutManager</type> + This function is normally used to provide inplace editing where + functions from two application parts, container application and + embedded object, are available to the user simultaneously. A menu + bar which is set by this method has a higher priority than others + created by <type scope="com::sun::star::frame">XLayoutManager</type> interface. Settings of a merged menu bar cannot be retrieved. </p> - + @see com::sun::star::ui::UIElementSettings @see com::sun::star::frame::XDispatchProvider @see com::sun::star::frame::XLayoutManager */ - boolean setMergedMenuBar( + boolean setMergedMenuBar( [in] ::com::sun::star::container::XIndexAccess xMergedMenuBar ); /** removes a previously set merged menu bar and sets a previously created diff --git a/offapi/com/sun/star/frame/XModel.idl b/offapi/com/sun/star/frame/XModel.idl index 7ae603a38df9..ce6bc3443646 100644 --- a/offapi/com/sun/star/frame/XModel.idl +++ b/offapi/com/sun/star/frame/XModel.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XModel2.idl b/offapi/com/sun/star/frame/XModel2.idl index 0b18ff02be1f..8993cc7a9a76 100644 --- a/offapi/com/sun/star/frame/XModel2.idl +++ b/offapi/com/sun/star/frame/XModel2.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -39,12 +39,12 @@ //============================================================================= /** extends interface XModel. - + The foloowing functions are added: - + - enumeration of all currently connected controller objects. (not getCurrentController() only, which depends on focus) - + - establish new view controller factory methods, which will make it possible to create new views for this model. */ @@ -96,25 +96,25 @@ interface XModel2 : com::sun::star::frame::XModel <p>Effectively, this method is equivalent to calling <member>createView</member> with the <code>ViewName</code> being <code>"Default"</code>.</p> - + @param Frame used to place the new created view there - + @return the new view controller instance - + @throws ::com::sun::star::lang::IllegalArgumentException if one of the given parameter was wrong - + @throws ::com::sun::star::uno::Exception if creation of a new view failed by other reasons */ com::sun::star::frame::XController2 createDefaultViewController( [in] com::sun::star::frame::XFrame Frame ) raises (com::sun::star::lang::IllegalArgumentException, com::sun::star::uno::Exception ); - + //------------------------------------------------------------------------- /** creates a new view instance classified by the specified name and arguments. - + <p>The newly created controller must not be connected with the document and the frame. That is, you should neither call <member>XFrame::setComponent</member>, nor <member>XController::attachFrame</member>, nor <member>XController::attachModel</member>, @@ -123,18 +123,18 @@ interface XModel2 : com::sun::star::frame::XModel @param ViewName classified name of instance - + @param Arguments arguments used for creation - + @param Frame used to place the new created view there - + @return the new view controller instance - + @throws ::com::sun::star::lang::IllegalArgumentException if one of the given parameter was wrong - + @throws ::com::sun::star::uno::Exception if creation of a new view failed by other reasons */ diff --git a/offapi/com/sun/star/frame/XModule.idl b/offapi/com/sun/star/frame/XModule.idl index c302892d5df5..b6ad30a0a5fe 100644 --- a/offapi/com/sun/star/frame/XModule.idl +++ b/offapi/com/sun/star/frame/XModule.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -57,7 +57,7 @@ module com { module sun { module star { module frame { </p> @see XModuleManager - + @since OOo 2.3.0 */ interface XModule : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/frame/XModuleManager.idl b/offapi/com/sun/star/frame/XModuleManager.idl index 7c8527c84d73..066ff40d2cca 100644 --- a/offapi/com/sun/star/frame/XModuleManager.idl +++ b/offapi/com/sun/star/frame/XModuleManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -46,7 +46,7 @@ module com { module sun { module star { module frame { //=============================================== /** can be used to identify office modules. - + @since OOo 2.0.0 */ interface XModuleManager : com::sun::star::uno::XInterface @@ -54,17 +54,17 @@ interface XModuleManager : com::sun::star::uno::XInterface //------------------------------------------- /** @short identifies the given module. - + @descr This identifier can then be used at the service <type>ModuleManager</type> to get more information about this module. - + For identification the interface <type scope="com::sun::star::lang">XServiceInfo</type> is requested on the given module. Because all module service registrations must be unique this value can be queried and checked against the configuration. Since OOo 2.3.0 also the optional interface <type>XModule</type> will be used. If its exists it will be preferred. - + @param Module Possible objects for this parameter can be the following one: <ul> @@ -84,7 +84,7 @@ interface XModuleManager : com::sun::star::uno::XInterface identification directly. </li> </ul> - + @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> if the parameter Module is: <ul> @@ -93,12 +93,12 @@ interface XModuleManager : com::sun::star::uno::XInterface XFrame, XControllerm, XModel</li> <li>or does not provide the needed interface XServiceInfo.</li> </ul> - + @throws <type>UnknownModuleException</type> if the given module could not be identified. Note: If the module represent a XFrame instance with does not contain a document, this exception is thrown too! - + @return An identifier for the given module. Note: This value is valie everytimes. Error will be transported by thrown exceptions! @@ -106,8 +106,8 @@ interface XModuleManager : com::sun::star::uno::XInterface string identify( [in] ::com::sun::star::uno::XInterface Module ) raises(::com::sun::star::lang::IllegalArgumentException, UnknownModuleException ); - - + + }; }; }; }; }; diff --git a/offapi/com/sun/star/frame/XNotifyingDispatch.idl b/offapi/com/sun/star/frame/XNotifyingDispatch.idl index 2d1a9bbc203d..882dfa822c6c 100644 --- a/offapi/com/sun/star/frame/XNotifyingDispatch.idl +++ b/offapi/com/sun/star/frame/XNotifyingDispatch.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XPopupMenuController.idl b/offapi/com/sun/star/frame/XPopupMenuController.idl index ffc7db109f4a..b06d2a2b34b3 100644 --- a/offapi/com/sun/star/frame/XPopupMenuController.idl +++ b/offapi/com/sun/star/frame/XPopupMenuController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,22 +32,22 @@ #include <com/sun/star/awt/XPopupMenu.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= /** provides data to a popup menu controller implementation to fill and update a popup menu dynamically. - + <p> - A popup menu controller gets a <type scope="com::sun::star::awt">XPopupMenu</type> - from its parent menu implementation. The controller has to fill this popup - menu with a set of menu items and/or sub menus. The parent menu implementation + A popup menu controller gets a <type scope="com::sun::star::awt">XPopupMenu</type> + from its parent menu implementation. The controller has to fill this popup + menu with a set of menu items and/or sub menus. The parent menu implementation briefs the controller whenever the popup menu gets activated by a user. </p> - + @since OOo 2.0.0 */ interface XPopupMenuController : com::sun::star::uno::XInterface @@ -62,12 +62,12 @@ interface XPopupMenuController : com::sun::star::uno::XInterface void setPopupMenu( [in] com::sun::star::awt::XPopupMenu PopupMenu ); /** briefs the popup menu controller to update the contents of the provided - popup menu to reflect the current state. - - <p>A controller should <b>never</b> update the popup menu structure on its - own to prevent performance problems. A better way would be that a controller - registers itself as status listener to for a command URL and immediately - deregister after that. Therefor status updates will not be send regularly + popup menu to reflect the current state. + + <p>A controller should <b>never</b> update the popup menu structure on its + own to prevent performance problems. A better way would be that a controller + registers itself as status listener to for a command URL and immediately + deregister after that. Therefor status updates will not be send regularly for a non visible popup menu. </p> */ @@ -76,6 +76,6 @@ interface XPopupMenuController : com::sun::star::uno::XInterface }; }; }; }; -//============================================================================= +//============================================================================= #endif diff --git a/offapi/com/sun/star/frame/XRecordableDispatch.idl b/offapi/com/sun/star/frame/XRecordableDispatch.idl index 189dfb04ab5a..8ece65792443 100644 --- a/offapi/com/sun/star/frame/XRecordableDispatch.idl +++ b/offapi/com/sun/star/frame/XRecordableDispatch.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XSessionManagerClient.idl b/offapi/com/sun/star/frame/XSessionManagerClient.idl index 8d1f51d4632a..1fe891935395 100644 --- a/offapi/com/sun/star/frame/XSessionManagerClient.idl +++ b/offapi/com/sun/star/frame/XSessionManagerClient.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -44,7 +44,7 @@ module com { module sun { module star { module frame { { /** addSessionManagerListener registers a listener for session management events - + @param xListener listener for session management events @@ -54,7 +54,7 @@ module com { module sun { module star { module frame { [oneway] void addSessionManagerListener( [in] XSessionManagerListener xListener ); /** removeSessionManagerListener deregisters a listener for session events - + @param xListener listener to be removed diff --git a/offapi/com/sun/star/frame/XSessionManagerListener.idl b/offapi/com/sun/star/frame/XSessionManagerListener.idl index 2ee33c160240..7159b38b2c9d 100644 --- a/offapi/com/sun/star/frame/XSessionManagerListener.idl +++ b/offapi/com/sun/star/frame/XSessionManagerListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,16 +40,16 @@ module com { module sun { module star { module frame { /** doSave gets called when a save event was issued by the session manager the listener should do what is necessary to restore the current state of the application - + <p>If the listener desires to interact with the user it must first issue a user interaction request and only do so if interaction was granted</p> - + <p>When the save request is processed (with or without user interaction) the listener must call <member>XSessionManagerClient::saveDone()</member> on the session manager client service object.</p> - + @param bShutdown <TRUE/> if a shutdown is in progress, <FALSE/> if just a save point was requested @@ -57,13 +57,13 @@ module com { module sun { module star { module frame { @param bCancelable <TRUE/> if a shutdown in progress can be canceled by the listener, <FALSE/> else - + <p>the listener may choose to ignore the <member>saveDone</member> event in case no real shutdown is in progress. He still has to call <member>XSessionManagerClient::saveDone()</member> in that case.</p> - + @see XSessionManagerClient @see XSessionManagerClient::saveDone() */ @@ -95,7 +95,7 @@ module com { module sun { module star { module frame { /** returns true, if a session was restored */ boolean doRestore(); - }; + }; }; }; }; }; diff --git a/offapi/com/sun/star/frame/XSessionManagerListener2.idl b/offapi/com/sun/star/frame/XSessionManagerListener2.idl index 233b7614ad2e..8db874ded149 100644 --- a/offapi/com/sun/star/frame/XSessionManagerListener2.idl +++ b/offapi/com/sun/star/frame/XSessionManagerListener2.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,7 +45,7 @@ module com { module sun { module star { module frame { further UI will usually be impossible and must be avoided. */ [oneway] void doQuit(); - }; + }; }; }; }; }; diff --git a/offapi/com/sun/star/frame/XStatusListener.idl b/offapi/com/sun/star/frame/XStatusListener.idl index 250e22c2141d..7bb3bd22e592 100644 --- a/offapi/com/sun/star/frame/XStatusListener.idl +++ b/offapi/com/sun/star/frame/XStatusListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XStatusbarController.idl b/offapi/com/sun/star/frame/XStatusbarController.idl index d9e035ad03bc..466372817527 100644 --- a/offapi/com/sun/star/frame/XStatusbarController.idl +++ b/offapi/com/sun/star/frame/XStatusbarController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -52,68 +52,68 @@ module com { module sun { module star { module frame { to users within a status bar. <p> - A generic status bar field is represented as a simple text field. A status - bar controller can be added to a Statusbar and provide information or + A generic status bar field is represented as a simple text field. A status + bar controller can be added to a Statusbar and provide information or functions with a more sophisticated user interface.<br/> - A typical example for status bar controller is a zoom chooser. It shows - the current zoom and provides general zoom levels on a popup menu + A typical example for status bar controller is a zoom chooser. It shows + the current zoom and provides general zoom levels on a popup menu that can be activated by a mouse action for context menus. <p> @see com::sun::star::frame::XDispatchProvider - + @since OOo 2.0.0 */ interface XStatusbarController : ::com::sun::star::uno::XInterface { //============================================================================= - /** 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 + /** 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 within the controller. - + @param aMouseEvent current information about the mouse pointer. @return - return <TRUE/> if the event should not be processed and <FALSE/> + return <TRUE/> if the event should not be processed and <FALSE/> if the event should be processed by the status bar. */ 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 + /** 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 within the controller. - + @param aMouseEvent current information about the mouse pointer. @return - return <TRUE/> if the event should not be processed and <FALSE/> + return <TRUE/> if the event should not be processed and <FALSE/> if the event should be processed by the status bar. */ 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 + /** 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 within the controller. - + @param aMouseEvent current information about the mouse pointer. @return - return <TRUE/> if the event should not be processed and <FALSE/> + return <TRUE/> if the event should not be processed and <FALSE/> if the event should be processed by the status bar. */ 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 the current mouse position in pixel. @@ -130,11 +130,11 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface [in] long nCommand, [in] boolean bMouseEvent, [in] any aData ); - + //============================================================================= /** is called by a status bar if the controller has to update the visual representation. - + @param xGraphics a reference to a <type scope="com::sun::star::awt">XGraphics</type> which has to be used to update the visual representation. @@ -153,19 +153,19 @@ interface XStatusbarController : ::com::sun::star::uno::XInterface [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 + /** is called by a status bar if the user clicked with mouse into the field of the corresponding control. */ void click(); //============================================================================= - /** is called by a status bar if the user double-clicked with mouse + /** is called by a status bar if the user double-clicked with mouse into the field of the corresponding control. */ void doubleClick(); -}; +}; }; }; }; }; diff --git a/offapi/com/sun/star/frame/XStorable.idl b/offapi/com/sun/star/frame/XStorable.idl index 6c54b5b84c1c..be9a3b2fc775 100644 --- a/offapi/com/sun/star/frame/XStorable.idl +++ b/offapi/com/sun/star/frame/XStorable.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XStorable2.idl b/offapi/com/sun/star/frame/XStorable2.idl index d33f49da8b8b..05beeca35156 100644 --- a/offapi/com/sun/star/frame/XStorable2.idl +++ b/offapi/com/sun/star/frame/XStorable2.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -64,7 +64,7 @@ published interface XStorable2: XStorable This method allows to specify some additional parametes for storing process. </p> - + @param lArguments optional parameters for saving, can take values from subset of <type scope="com::sun::star::document">MediaDescriptor</type> diff --git a/offapi/com/sun/star/frame/XSubToolbarController.idl b/offapi/com/sun/star/frame/XSubToolbarController.idl index e0de8b9b8e2f..413674c81553 100644 --- a/offapi/com/sun/star/frame/XSubToolbarController.idl +++ b/offapi/com/sun/star/frame/XSubToolbarController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,19 +40,19 @@ <p> This interface is normally used to implement the toolbar button/sub- - toolbar function feature. It exchanges the function of the toolbar - button, that opened the sub-toolbar, with the one that has been selected + toolbar function feature. It exchanges the function of the toolbar + button, that opened the sub-toolbar, with the one that has been selected on the sub-toolbar. </p> - + @see com::sun::star::frame::ToolbarController - + @since OOo 2.0.0 */ interface XSubToolbarController : com::sun::star::uno::XInterface { //============================================================================= - /** if the controller features a sub-toolbar. + /** if the controller features a sub-toolbar. @return <TRUE/> if the controller offers a sub toolbar, otherwise <FALSE/>. @@ -68,13 +68,13 @@ interface XSubToolbarController : com::sun::star::uno::XInterface /** provides the resource URL of the sub-toolbar this controller opens. @return - name of the sub-toolbar this controller offers. A empty string + name of the sub-toolbar this controller offers. A empty string will be interpreted as if this controller offers no sub-toolbar. */ string getSubToolbarName(); //============================================================================= - /** gets called to notify a controller that a sub-toolbar function has been + /** gets called to notify a controller that a sub-toolbar function has been selected. @param aCommand @@ -89,7 +89,7 @@ interface XSubToolbarController : com::sun::star::uno::XInterface <p> Only the controller instance is able to set the correct image for the - current function. A toolbar implementation will ask sub-toolbar + current function. A toolbar implementation will ask sub-toolbar controllers to update their image whenever it has to update the images of all its buttons. </p> diff --git a/offapi/com/sun/star/frame/XSynchronousDispatch.idl b/offapi/com/sun/star/frame/XSynchronousDispatch.idl index b016e42932a3..90fe07159ef7 100644 --- a/offapi/com/sun/star/frame/XSynchronousDispatch.idl +++ b/offapi/com/sun/star/frame/XSynchronousDispatch.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl index 6a39bbfeaf98..71043497ab68 100644 --- a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XTask.idl b/offapi/com/sun/star/frame/XTask.idl index f0a59b25bcb0..88c75626db09 100644 --- a/offapi/com/sun/star/frame/XTask.idl +++ b/offapi/com/sun/star/frame/XTask.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XTasksSupplier.idl b/offapi/com/sun/star/frame/XTasksSupplier.idl index deb1b3cbb757..7fca1dcf7e7c 100644 --- a/offapi/com/sun/star/frame/XTasksSupplier.idl +++ b/offapi/com/sun/star/frame/XTasksSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XTerminateListener.idl b/offapi/com/sun/star/frame/XTerminateListener.idl index 937e3523817b..073faf6e88bc 100644 --- a/offapi/com/sun/star/frame/XTerminateListener.idl +++ b/offapi/com/sun/star/frame/XTerminateListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XTerminateListener2.idl b/offapi/com/sun/star/frame/XTerminateListener2.idl index e4b000bc2f0a..8a2b1f3164da 100644 --- a/offapi/com/sun/star/frame/XTerminateListener2.idl +++ b/offapi/com/sun/star/frame/XTerminateListener2.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XTitle.idl b/offapi/com/sun/star/frame/XTitle.idl index 0ce06aecb8f0..eb2b10198edb 100644 --- a/offapi/com/sun/star/frame/XTitle.idl +++ b/offapi/com/sun/star/frame/XTitle.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl b/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl index 3bc851f4a557..a2228df939a1 100644 --- a/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl +++ b/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XTitleChangeListener.idl b/offapi/com/sun/star/frame/XTitleChangeListener.idl index 8d1c4c1d8019..9f510ba8b486 100644 --- a/offapi/com/sun/star/frame/XTitleChangeListener.idl +++ b/offapi/com/sun/star/frame/XTitleChangeListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XToolbarController.idl b/offapi/com/sun/star/frame/XToolbarController.idl index 1ca2c8fa9278..cd0c7f20dbfd 100644 --- a/offapi/com/sun/star/frame/XToolbarController.idl +++ b/offapi/com/sun/star/frame/XToolbarController.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -44,8 +44,8 @@ to users within a toolbar. <p> - A generic toolbar function is represented as a button which has a state - (enabled,disabled and selected, not selected). A toolbar controller can be added to a + A generic toolbar function is represented as a button which has a state + (enabled,disabled and selected, not selected). A toolbar controller can be added to a toolbar and provide information or functions with a more sophisticated user interface.<br/> A typical example for toolbar controller is a font chooser on a toolbar. It provides all available fonts in a dropdown box and shows the current chosen font. @@ -60,7 +60,7 @@ interface XToolbarController : com::sun::star::uno::XInterface //============================================================================= /** provides a function to execute the command which is bound to the toolbar controller. - @param + @param a combination of <type scope="com::sun::star::awt">KeyModifier</type> value that represent the current state of the modifier keys. @@ -85,7 +85,7 @@ interface XToolbarController : com::sun::star::uno::XInterface /** requests to create a popup window for additional functions. @return - a <type scope="com::sun::star::awt">XWindow</type> which provides additional functions + a <type scope="com::sun::star::awt">XWindow</type> which provides additional functions to the user. The reference must be empty if component does not want to provide a separate window. */ @@ -97,9 +97,9 @@ interface XToolbarController : com::sun::star::uno::XInterface @param Parent a <type scope="com::sun::star::awt">XWindow</type> which must be used as a parent for the requested item window. - + @return - a <type scope="com::sun::star::awt">XWindow</type> which can be added to a toolbar. + a <type scope="com::sun::star::awt">XWindow</type> which can be added to a toolbar. The reference must be empty if a component does not want to provide an item window. */ com::sun::star::awt::XWindow createItemWindow( [in] com::sun::star::awt::XWindow Parent ); diff --git a/offapi/com/sun/star/frame/XToolbarControllerListener.idl b/offapi/com/sun/star/frame/XToolbarControllerListener.idl index 6450d8ef910e..5e1e5b3a8b85 100644 --- a/offapi/com/sun/star/frame/XToolbarControllerListener.idl +++ b/offapi/com/sun/star/frame/XToolbarControllerListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -35,7 +35,7 @@ /** is used to notify a toolbar controller about events @see com::sun::star::frame::ToolbarController - + @since OOo 2.0.0 */ interface XToolbarControllerListener : com::sun::star::uno::XInterface @@ -50,7 +50,7 @@ interface XToolbarControllerListener : com::sun::star::uno::XInterface a string which identifies the function that has been selected. <p> - This notification is normally used to implement the toolbar button/sub-toolbar + This notification is normally used to implement the toolbar button/sub-toolbar function feature. It exchanges the function of the toolbar button, that opened the sub-toolbar, with the one that has been selected on the sub-toolbar. </p> diff --git a/offapi/com/sun/star/frame/XTransientDocumentsDocumentContentFactory.idl b/offapi/com/sun/star/frame/XTransientDocumentsDocumentContentFactory.idl index ec3259b4ad06..318576465688 100644 --- a/offapi/com/sun/star/frame/XTransientDocumentsDocumentContentFactory.idl +++ b/offapi/com/sun/star/frame/XTransientDocumentsDocumentContentFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XUIControllerRegistration.idl b/offapi/com/sun/star/frame/XUIControllerRegistration.idl index 3fcc74e4c320..2bd8e96e2687 100644 --- a/offapi/com/sun/star/frame/XUIControllerRegistration.idl +++ b/offapi/com/sun/star/frame/XUIControllerRegistration.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -32,22 +32,22 @@ #include <com/sun/star/uno/XInterface.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= /** is used to query, register and unregister user interface controller. <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 + 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 </p> - + @since OOo 2.0 */ @@ -69,9 +69,9 @@ published interface XUIControllerRegistration : com::sun::star::uno::XInterface */ boolean hasController( [in] string aCommandURL, [in] string aModelName ); - /** function to create an association between a user interface controller implementation + /** function to create an association between a user interface controller implementation and a command URL and optional module. - + @param aCommandURL a command URL which specifies an action which shoudl be associated with a user interface controller. @@ -85,10 +85,10 @@ published interface XUIControllerRegistration : com::sun::star::uno::XInterface with the OpenOffice service manager. */ void registerController( [in] string aCommandURL, [in] string aModelName, [in] string aControllerImplementationName ); - - /** function to remove a previously defined association between a user interface controller + + /** function to remove a previously defined association between a user interface controller implementation and a command URL and optional module. - + @param aCommandURL a command URL which specifies an action which shoudl be associated with a user interface controller. @@ -102,6 +102,6 @@ published interface XUIControllerRegistration : com::sun::star::uno::XInterface }; }; }; }; -//============================================================================= +//============================================================================= #endif diff --git a/offapi/com/sun/star/frame/XUntitledNumbers.idl b/offapi/com/sun/star/frame/XUntitledNumbers.idl index e2864d709c2f..c2da9cfc1c48 100644 --- a/offapi/com/sun/star/frame/XUntitledNumbers.idl +++ b/offapi/com/sun/star/frame/XUntitledNumbers.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,7 +43,7 @@ constants UntitledNumbersConst { const long INVALID_NUMBER = 0; }; - + //============================================================================= /** knows all currently used and all free numbers for using with untitled but counted objects. @@ -72,13 +72,13 @@ interface XUntitledNumbers : com::sun::star::uno::XInterface If the reqistered component does not use such leased number any longer it has to be released so it can be used for new components. - + Note: calling this method with an unknown (but normaly valid number) has to be ignored. No exceptions - no errors. - + @param nNumber specify number for release. - + @throws [IllegalArgumentException] if the given number is the special value 0. */ @@ -88,24 +88,24 @@ interface XUntitledNumbers : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** does the same then releaseNumber () but it searches the corresponding number for the specified component and deregister it. - + @param xComponent the component for deregistration. - + @throws [IllegalArgumentException] if an invalid object reference was provided to this method. */ void releaseNumberForComponent ( [in] com::sun::star::uno::XInterface xComponent ) raises (com::sun::star::lang::IllegalArgumentException); - + //------------------------------------------------------------------------- /** returns the localized string value to be used for untitles objects in combination with the leased number. - + Note: Such string already contains leading spaces/tabs etcpp. ! The only thing which an outside code has todo then ... adding a leased number to the string. - + @return the localized string for untitled components. */ string getUntitledPrefix (); diff --git a/offapi/com/sun/star/frame/XUrlList.idl b/offapi/com/sun/star/frame/XUrlList.idl index d4005ded9cd2..7b40fa359092 100644 --- a/offapi/com/sun/star/frame/XUrlList.idl +++ b/offapi/com/sun/star/frame/XUrlList.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/XWindowArranger.idl b/offapi/com/sun/star/frame/XWindowArranger.idl index ed5044b9d5aa..f4375cbc8d31 100644 --- a/offapi/com/sun/star/frame/XWindowArranger.idl +++ b/offapi/com/sun/star/frame/XWindowArranger.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/frame/status/ClipboardFormats.idl b/offapi/com/sun/star/frame/status/ClipboardFormats.idl index 2cc39db0696f..d8f7d1f14a6b 100644 --- a/offapi/com/sun/star/frame/status/ClipboardFormats.idl +++ b/offapi/com/sun/star/frame/status/ClipboardFormats.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,40 +24,40 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_ClipboardFormats_idl__ -#define __com_sun_star_frame_status_ClipboardFormats_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_ClipboardFormats_idl__ +#define __com_sun_star_frame_status_ClipboardFormats_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** contains a list of format ID's and names which are part of the system clipboard. - + @since OOo 2.0 */ struct ClipboardFormats { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** specifies a sequence of format IDs which are contained in the system clipboard. */ sequence< hyper > Identifiers; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** specifies a sequence of format names which are contained in the system clipboard. */ sequence< string > Names; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/FontHeight.idl b/offapi/com/sun/star/frame/status/FontHeight.idl index 3cefd4aab7f9..7a610018ce45 100644 --- a/offapi/com/sun/star/frame/status/FontHeight.idl +++ b/offapi/com/sun/star/frame/status/FontHeight.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,47 +24,47 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_FontHeight_idl__ -#define __com_sun_star_frame_status_FontHeight_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_FontHeight_idl__ +#define __com_sun_star_frame_status_FontHeight_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** describes the characteristics of a font. - + <p>For example, this can be used to select a font.</p> - + @since OOo 2.0 */ struct FontHeight { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** specifies the current height of the font. */ - float Height; - - //------------------------------------------------------------------------- - + float Height; + + //------------------------------------------------------------------------- + /** specifies the height of the font in the measure of the destination. */ - short Prop; - - //------------------------------------------------------------------------- - + short Prop; + + //------------------------------------------------------------------------- + /** specifies the width of the font in the measure of the destination. */ - float Diff; -}; - -//============================================================================= - + float Diff; +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/ItemState.idl b/offapi/com/sun/star/frame/status/ItemState.idl index d1ade5b4589e..2e752375a7c6 100644 --- a/offapi/com/sun/star/frame/status/ItemState.idl +++ b/offapi/com/sun/star/frame/status/ItemState.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,20 +24,20 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_ItemState_idl__ -#define __com_sun_star_frame_status_ItemState_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_ItemState_idl__ +#define __com_sun_star_frame_status_ItemState_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** these constants describe a state of a <type>ItemStatus</type>. @see ItemStatus - + @since OOo 2.0 */ constants ItemState @@ -59,9 +59,9 @@ constants ItemState //------------------------------------------------------------------------- /** specifies that the property is currently in a don't care state. - + <p> - This is normally used if a selection provides more than one state + This is normally used if a selection provides more than one state for a property at the same time. </p> */ @@ -76,10 +76,10 @@ constants ItemState /** specifies that the property is currently in a set state. */ const short set = 64; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/ItemStatus.idl b/offapi/com/sun/star/frame/status/ItemStatus.idl index ef49aca6a527..f6e1a1afa42e 100644 --- a/offapi/com/sun/star/frame/status/ItemStatus.idl +++ b/offapi/com/sun/star/frame/status/ItemStatus.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,39 +24,39 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_ItemState_idl__ -#define __com_sun_star_frame_status_ItemState_idl__ - -//============================================================================= - +#ifndef __com_sun_star_frame_status_ItemState_idl__ +#define __com_sun_star_frame_status_ItemState_idl__ + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** describes a state of a property. - + @since OOo 2.0 */ struct ItemStatus { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** numerical value which describes the current state of an item. @see <type>ItemState</type> */ short State; - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** optional data which can be used by an implementation to send additional information. The content is dependent on the specific implementation. */ any aStateData; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/LeftRightMargin.idl b/offapi/com/sun/star/frame/status/LeftRightMargin.idl index 2112168f9286..44af045153c0 100644 --- a/offapi/com/sun/star/frame/status/LeftRightMargin.idl +++ b/offapi/com/sun/star/frame/status/LeftRightMargin.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,35 +24,35 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_LeftRightMargin_idl__ -#define __com_sun_star_frame_status_LeftRightMargin_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_LeftRightMargin_idl__ +#define __com_sun_star_frame_status_LeftRightMargin_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** specifies a left and right margin. - + @since OOo 2.0 */ struct LeftRightMargin { /** specifies a left side margin in 1/100th mm. */ - long Left; - - //------------------------------------------------------------------------- - + long Left; + + //------------------------------------------------------------------------- + /** specifies a right side margin in 1/100th mm. */ - long Right; -}; - -//============================================================================= - + long Right; +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/Template.idl b/offapi/com/sun/star/frame/status/Template.idl index 1377efabd5c7..4165bc0aff5c 100644 --- a/offapi/com/sun/star/frame/status/Template.idl +++ b/offapi/com/sun/star/frame/status/Template.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,37 +24,37 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_Template_idl__ -#define __com_sun_star_frame_status_Template_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_Template_idl__ +#define __com_sun_star_frame_status_Template_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** contains an association between a style name and a value. - + @since OOo 2.0 */ struct Template { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** specifies a style name. */ string StyleName; - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** specifies a value that is bound to the style name. */ long Value; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/UpperLowerMargin.idl b/offapi/com/sun/star/frame/status/UpperLowerMargin.idl index b1a05a94fab7..6c9e4501c926 100644 --- a/offapi/com/sun/star/frame/status/UpperLowerMargin.idl +++ b/offapi/com/sun/star/frame/status/UpperLowerMargin.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,18 +24,18 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_UpperLowerMargin_idl__ -#define __com_sun_star_frame_status_UpperLowerMargin_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_UpperLowerMargin_idl__ +#define __com_sun_star_frame_status_UpperLowerMargin_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** specifies an upper and lower margin. - + @since OOo 2.0 */ struct UpperLowerMargin @@ -43,16 +43,16 @@ struct UpperLowerMargin /** specifies a upper margin in 1/100th mm. */ long Upper; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** specifies a lower margin in 1/100th mm. */ long Lower; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/UpperLowerMarginScale.idl b/offapi/com/sun/star/frame/status/UpperLowerMarginScale.idl index ae5e04e6bca8..0e7f611a1dfe 100644 --- a/offapi/com/sun/star/frame/status/UpperLowerMarginScale.idl +++ b/offapi/com/sun/star/frame/status/UpperLowerMarginScale.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,18 +24,18 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_UpperLowerMarginScale_idl__ -#define __com_sun_star_frame_status_UpperLowerMarginScale_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_UpperLowerMarginScale_idl__ +#define __com_sun_star_frame_status_UpperLowerMarginScale_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** specifies an upper and lower margin. - + @since OOo 2.0 */ struct UpperLowerMarginScale @@ -43,28 +43,28 @@ struct UpperLowerMarginScale /** specifies a upper margin in 1/100th mm. */ long Upper; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** specifies a lower margin in 1/100th mm. */ long Lower; - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** specifies a scale value for the upper margin. */ short ScaleUpper; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** specifies a scale value for the lower margin. */ short ScaleLower; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/Verb.idl b/offapi/com/sun/star/frame/status/Verb.idl index caeaf6525f24..edc1d0f47392 100644 --- a/offapi/com/sun/star/frame/status/Verb.idl +++ b/offapi/com/sun/star/frame/status/Verb.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,49 +24,49 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_Verb_idl__ -#define __com_sun_star_frame_status_Verb_idl__ - - -//============================================================================= - +#ifndef __com_sun_star_frame_status_Verb_idl__ +#define __com_sun_star_frame_status_Verb_idl__ + + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** describes a command that can be send to an OLE object - + <p>For example, this can be used to select a font.</p> @since OOo 2.0 */ struct Verb { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** specifies the Id of the command. */ long VerbId; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** specifies the name of the command. The name is localized. */ string VerbName; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** specifies if the command should be visible in a menu. */ boolean VerbIsOnMenu; - + /** specifies if the command is available for a constant object. */ boolean VerbIsConst; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/frame/status/Visibility.idl b/offapi/com/sun/star/frame/status/Visibility.idl index a061a89265d5..7fedffe3a11d 100644 --- a/offapi/com/sun/star/frame/status/Visibility.idl +++ b/offapi/com/sun/star/frame/status/Visibility.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,30 +24,30 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_frame_status_Visibility_idl__ -#define __com_sun_star_frame_status_Visiblilty_idl__ - -//============================================================================= - +#ifndef __com_sun_star_frame_status_Visibility_idl__ +#define __com_sun_star_frame_status_Visiblilty_idl__ + +//============================================================================= + module com { module sun { module star { module frame { module status { - -//============================================================================= - + +//============================================================================= + /** describes the visibility state of a property. @since OOo 2.0 */ struct Visibility { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** <TRUE/> if the property is visible otherwise <FALSE/>. */ boolean bVisible; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif |