CWS-TOOLING: integrate CWS unoawt

offapi/com/sun/star/awt/ItemListEvent.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __offapi_com_sun_star_awt_ListItemEvent_idl__
+#define __offapi_com_sun_star_awt_ListItemEvent_idl__
+
+#include <com/sun/star/lang/EventObject.idl>
+#include <com/sun/star/beans/Optional.idl>
+
+//==================================================================================================================
+
+module com { module sun { module star { module awt {
+
+//==================================================================================================================
+
+/** is the event broadcasted by a <type>XListItems</type> implementation for changes
+    in its item list.
+ */
+struct ItemListEvent : ::com::sun::star::lang::EventObject
+{
+    /** specifies the position of the item which is affected by the event
+
+        <p>In case the event is not related to a single item, but to the complete list, the value of this
+        member is undefined.</p>
+    */
+    long    ItemPosition;
+
+    /** the text of the item.
+
+        <p>If the event being notified did not touch the text of an item, this member is empty. For instance, upon
+        invocation of <member>XItemList::setItemImage</member>, only <code>ItemImageURL</code> will be set, and
+        <code>ItemText</code> will be empty.</p>
+    */
+    ::com::sun::star::beans::Optional< string >
+            ItemText;
+
+    /** the URL of the image of the item
+
+        <p>If the event being notified did not touch the image of an item, this member is empty. For instance, upon
+        invocation of <member>XItemList::setItemText</member>, only <code>ItemText</code> will be set, and
+        <code>ItemImageURL</code> will be empty.</p>
+    */
+    ::com::sun::star::beans::Optional< string >
+            ItemImageURL;
+};
+
+//==================================================================================================================
+
+}; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/awt/UnoControlListBoxModel.idl

@@ -39,6 +39,8 @@
 #include <com/sun/star/util/Color.idl>
 #endif
 
+#include <com/sun/star/awt/XItemList.idl>
+
 
 //=============================================================================
 
@@ -208,6 +210,11 @@ published service UnoControlListBoxModel
         this is possible.</p>
     */
     [optional, property] short MouseWheelBehavior;
+
+    /** allows mmanipulating the list of items in the list box more fine-grained than the
+        <member>StringItemList</member> property.
+    */
+    [optional] interface XItemList;
 };
 
 //=============================================================================

offapi/com/sun/star/awt/XItemListListener.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __offapi_com_sun_star_awt_XItemListListener_idl__
+#define __offapi_com_sun_star_awt_XItemListListener_idl__
+
+#include <com/sun/star/lang/XEventListener.idl>
+#include <com/sun/star/awt/ItemListEvent.idl>
+
+//==================================================================================================================
+
+module com { module sun { module star { module awt {
+
+//==================================================================================================================
+
+/** describes a listener for changes in a item list
+    @see XListItems
+ */
+interface XItemListListener : ::com::sun::star::lang::XEventListener
+{
+    /** is called when an item is inserted into the list
+    */
+    void    listItemInserted(
+                [in] ItemListEvent Event
+            );
+
+    /** is called when an item is removed from the list
+    */
+    void    listItemRemoved(
+                [in] ItemListEvent Event
+            );
+
+    /** is called when an item in the list is modified, i.e. its text or image changed
+    */
+    void    listItemModified(
+                [in] ItemListEvent Event
+            );
+    /** is called when the list has been completely cleared, i.e. after an invocation of
+        <member>XItemList::removeAllItems</member>
+    */
+    void    allItemsRemoved(
+                [in] ::com::sun::star::lang::EventObject Event
+            );
+
+    /** is called when the changes to the item list which occured are too complex to be notified
+        in single events.
+
+        <p>Consumers of this event should discard their cached information about the current item list,
+        and completely refresh it from the <type>XItemList</type>'s current state.</p>
+    */
+    void    itemListChanged(
+                [in] ::com::sun::star::lang::EventObject Event
+            );
+};
+
+//==================================================================================================================
+
+}; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/awt/makefile.mk

@@ -328,7 +328,10 @@ IDLFILES=\
     MenuLogo.idl \
     XMenuExtended2.idl \
     XMenuBarExtended.idl \
-    XPopupMenuExtended.idl
+    XPopupMenuExtended.idl \
+    XItemList.idl \
+    XItemListListener.idl \
+    ItemListEvent.idl
 
 # ------------------------------------------------------------------
 

offapi/com/sun/star/awt/tree/XTreeControl.idl

@@ -219,6 +219,17 @@ interface XTreeControl
     */
     XTreeNode getClosestNodeForLocation( [in] long x, [in] long y );
 
+    /** returns the rectangle occupied by the visual representation of the given node
+
+        @param Node
+            the node whose geometry should be obtained
+        @throws ::com::sun::star::lang::IllegalArgumentException
+            if the given node is <NULL/>, or does not belong to the tree's data model
+    */
+    ::com::sun::star::awt::Rectangle
+        getNodeRect( [in] XTreeNode Node )
+            raises( ::com::sun::star::lang::IllegalArgumentException );
+
     // ------------
     // tree editing
     // ------------

offapi/com/sun/star/ui/dialogs/Wizard.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_ui_dialogs_Wizard_idl__
+#define __com_sun_star_ui_dialogs_Wizard_idl__
+
+#include <com/sun/star/ui/dialogs/XWizard.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+//==================================================================================================================
+
+module com { module sun { module star { module ui { module dialogs {
+
+interface XWizardController;
+
+//==================================================================================================================
+
+/** provides a framework for implementing a wizard dialog.
+ */
+service Wizard : XWizard
+{
+    /** creates a wizard with a single execution path
+        @param PageIds
+            the IDs of the pages which constitute the execution path. IDs must be in ascending order.
+    */
+    createSinglePathWizard(
+        [in] sequence< short > PageIds,
+        [in] XWizardController Controller
+    )
+    raises  (   ::com::sun::star::lang::IllegalArgumentException
+            );
+
+    /** creates a wizard with a multiple possible execution paths
+
+        @param PageIds
+            the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order.
+    */
+    createMultiplePathsWizard(
+        [in] sequence< sequence< short > > PageIds,
+        [in] XWizardController Controller
+    )
+    raises  (   ::com::sun::star::lang::IllegalArgumentException
+            );
+};
+
+//==================================================================================================================
+
+}; }; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/ui/dialogs/WizardButton.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_ui_dialogs_WizardButton_idl__
+#define __com_sun_star_ui_dialogs_WizardButton_idl__
+
+//==================================================================================================================
+
+module com { module sun { module star { module ui { module dialogs {
+
+//==================================================================================================================
+
+/** denotes the buttons found in a <type>Wizard</type>
+ */
+constants WizardButton
+{
+    /// denotes none of the buttons in the wizard
+    const short NONE = 0;
+    /// denotes the button used to travel forward through the wizard
+    const short NEXT = 1;
+    /// denotes the button used to travel backward through the wizard
+    const short PREVIOUS = 2;
+    /// denotes the button used to finish the wizard
+    const short FINISH = 3;
+    /// denotes the button used to cancel the wizard
+    const short CANCEL = 4;
+    /// denotes the button used to request help
+    const short HELP = 5;
+};
+
+//==================================================================================================================
+
+}; }; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/ui/dialogs/WizardTravelType.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_ui_dialogs_WizardTravelType_idl__
+#define __com_sun_star_ui_dialogs_WizardTravelType_idl__
+
+//==================================================================================================================
+
+module com { module sun { module star { module ui { module dialogs {
+
+//==================================================================================================================
+
+/** denotes ways to leave a <type>Wizard</type>'s page
+ */
+constants WizardTravelType
+{
+    /// indicates the wizard page is left due to forward traveling through the wizard
+    const short FORWARD = 1;
+    /// indicates the wizard page is left due to backward traveling through the wizard
+    const short BACKWARD = 2;
+    /// indicates the wizard page is left since the wizard is about to be finished
+    const short FINISH = 3;
+};
+
+//==================================================================================================================
+
+}; }; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/ui/dialogs/XWizardController.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_ui_dialogs_XWizardController_idl__
+#define __com_sun_star_ui_dialogs_XWizardController_idl__
+
+#include <com/sun/star/ui/dialogs/XWizardPage.idl>
+
+//==================================================================================================================
+
+module com { module sun { module star { module ui { module dialogs {
+
+//==================================================================================================================
+
+/** is the interface of a client-provided controller of a custom <type>Wizard</type>.
+ */
+interface XWizardController
+{
+    /** creates a page
+
+        <p>Wizard pages are created on demand, when the respective page is reached during traveling through the
+        wizard. Effectively, this means the method is called at most once for each possible page ID.</p>
+
+        @param ParentWindow
+            the parent window to use for the page window
+        @param PageId
+            the ID of the page.
+        @return
+            the requested page.
+    */
+    XWizardPage createPage( [in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId );
+
+    /** provides the title of a page given by ID
+
+        <p>The page titles are displayed in the wizard's roadmap.</p>
+    */
+    string  getPageTitle( [in] short PageId );
+
+    boolean canAdvance();
+
+    /** called when a new page in the wizard is being activated
+    */
+    void    onActivatePage( [in] short PageId );
+
+    /** called when a page in the wizard is being deactivated
+    */
+    void    onDeactivatePage( [in] short PageId );
+
+    /** called when the wizard is about to be finished.
+
+        <p>This method allows the controller to do any final checks, and ultimatively veto finishing the wizard.</p>
+    */
+    boolean confirmFinish();
+};
+
+//==================================================================================================================
+
+}; }; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/ui/dialogs/XWizardPage.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_ui_dialogs_XWizardPage_idl__
+#define __com_sun_star_ui_dialogs_XWizardPage_idl__
+
+#include <com/sun/star/awt/XWindow.idl>
+
+//==================================================================================================================
+
+module com { module sun { module star { module ui { module dialogs {
+
+//==================================================================================================================
+
+/** is a single page of a <type>Wizard</type>
+ */
+interface XWizardPage : ::com::sun::star::lang::XComponent
+{
+    /** provides read-only access to the window of the page
+    */
+    [attribute, readonly]   ::com::sun::star::awt::XWindow  Window;
+
+    /** denotes the ID of the page.
+
+        <p>Within a wizard, no two pages are allowed to have the same ID.</p>
+    */
+    [attribute, readonly]   short PageId;
+
+    /** called when the page is activated
+    */
+    void    activatePage();
+
+    /** is called when the page is about to be left
+
+        <p>An implementation can veto the leave by returning <FALSE/> here. Usually, the decision about this
+        depends on the current state of the page.</p>
+
+        @param Reason
+            is one of the <type>WizardTravelType</type> contants denoting the reason why the page should be
+            committed.
+    */
+    boolean commitPage( [in] short Reason );
+
+    /** determines whether it is allowed to travel to a later page in the wizard
+
+        <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually,
+        you return <FALSE/> here if and only if not all necessary input on the page has been provided by the user,
+        or the provided input is not valid.</p>
+
+        <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity
+        than a disabled <code>Next</code> button in the wizard, then move your checks to the <member>commitPage</member>
+        method.</p>
+    */
+    boolean canAdvance();
+};
+
+//==================================================================================================================
+
+}; }; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/ui/dialogs/makefile.mk

@@ -64,7 +64,13 @@ IDLFILES=\
         XControlInformation.idl \
         XAsynchronousExecutableDialog.idl \
         XDialogClosedListener.idl \
-        DialogClosedEvent.idl
+        DialogClosedEvent.idl \
+    XWizard.idl \
+    XWizardController.idl \
+    Wizard.idl \
+    XWizardPage.idl \
+    WizardButton.idl \
+    WizardTravelType.idl
 
 # ------------------------------------------------------------------
 

offapi/com/sun/star/util/InvalidStateException.idl

+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_util_InvalidStateException_idl__
+#define __com_sun_star_util_InvalidStateException_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+
+//==================================================================================================================
+
+module com { module sun { module star { module util {
+
+//==================================================================================================================
+
+/** is thrown when an object's state does not allow to call requested functionality.
+ */
+exception InvalidStateException : com::sun::star::uno::Exception
+{
+};
+
+//==================================================================================================================
+
+}; }; }; };
+
+//==================================================================================================================
+
+#endif

offapi/com/sun/star/util/makefile.mk

@@ -53,6 +53,7 @@ IDLFILES=\
     ElementChange.idl \
     Endianness.idl \
     FileIOException.idl\
+    InvalidStateException.idl\
     Language.idl\
     NumberFormat.idl\
     NumberFormatProperties.idl\