From 9cdd338cf868480fecc95c2296ed57033bf90958 Mon Sep 17 00:00:00 2001 From: Mihaela Kedikova Date: Thu, 12 Aug 2010 17:36:53 +0200 Subject: tabcontrol: new source code for tabcontrol added --- offapi/prj/build.lst | 3 ++- offapi/prj/d.lst | 2 ++ offapi/util/makefile.mk | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/prj/build.lst b/offapi/prj/build.lst index a0be2398f429..8679d924a6c7 100644 --- a/offapi/prj/build.lst +++ b/offapi/prj/build.lst @@ -8,6 +8,7 @@ oa offapi\com\sun\star\accessibility nmake - all oa_accessibility oa_awt N oa offapi\com\sun\star\awt nmake - all oa_awt NULL oa offapi\com\sun\star\awt\tree nmake - all oa_awttree NULL oa offapi\com\sun\star\awt\grid nmake - all oa_awtgrid NULL +oa offapi\com\sun\star\awt\tab nmake - all oa_awttab NULL oa offapi\com\sun\star\chart nmake - all oa_chart NULL oa offapi\com\sun\star\chart2 nmake - all oa_chart2 NULL oa offapi\com\sun\star\chart2\data nmake - all oa_chart2_data NULL @@ -105,4 +106,4 @@ oa offapi\com\sun\star\rendering nmake - all oa_rendering oa_geometry NU oa offapi\com\sun\star\rdf nmake - all oa_rdf oa_datatransfer oa_text NULL oa offapi\com\sun\star\office nmake - all oa_office oa_text NULL oa offapi\drafts\com\sun\star\form nmake - all oa_drafts_form NULL -oa offapi\util nmake - all oa_util oa_auth oa_awt oa_awttree oa_awtgrid oa_chart oa_chart2 oa_chart2_data oa_config oa_configbootstrap oa_configbackend oa_configbackend_xml oa_datatrans_clip oa_datatrans_dnd oa_datatransfer oa_docu oa_draw oa_draw_framework oa_embed oa_fcomp oa_finsp oa_fcontr oa_fieldmaster oa_form oa_xforms oa_formula oa_frame oa_i18n oa_inst oa_ldap oa_ling2 oa_logging oa_mail oa_media oa_mozilla oa_packages oa_manifest oa_zippackage oa_plug oa_pres oa_animations oa_putil oa_resrc oa_sax oa_xml_input oa_scan oa_sdb oa_sdbtools oa_sdbapp oa_sdbc oa_sdbcx oa_setup oa_sheet oa_style oa_svg oa_sync oa_sync2 oa_system oa_table oa_task oa_text oa_textfield oa_docinfo oa_ucb oa_view oa_xml oa_xml_dom oa_xml_xpath oa_xml_views oa_xml_events oa_image oa_xsd oa_inspection oa_ui oa_ui_dialogs oa_accessibility oa_form_binding oa_form_validation oa_form_submission oa_fruntime oa_geometry oa_rendering oa_sfprovider oa_sfbrowse oa_drafts_form oa_deployment oa_deploymenttest oa_deployment_ui oa_frame_status oa_gallery oa_graphic oa_security oa_crypto_sax oa_crypto oa_csax oa_wrapper oa_script oa_smarttags oa_report oa_reportins oa_reportmeta oa_rdf oa_oooimprovement oa_office oa_prestextfield oa_starme NULL +oa offapi\util nmake - all oa_util oa_auth oa_awt oa_awttree oa_awtgrid oa_awttab oa_chart oa_chart2 oa_chart2_data oa_config oa_configbootstrap oa_configbackend oa_configbackend_xml oa_datatrans_clip oa_datatrans_dnd oa_datatransfer oa_docu oa_draw oa_draw_framework oa_embed oa_fcomp oa_finsp oa_fcontr oa_fieldmaster oa_form oa_xforms oa_formula oa_frame oa_i18n oa_inst oa_ldap oa_ling2 oa_logging oa_mail oa_media oa_mozilla oa_packages oa_manifest oa_zippackage oa_plug oa_pres oa_animations oa_putil oa_resrc oa_sax oa_xml_input oa_scan oa_sdb oa_sdbtools oa_sdbapp oa_sdbc oa_sdbcx oa_setup oa_sheet oa_style oa_svg oa_sync oa_sync2 oa_system oa_table oa_task oa_text oa_textfield oa_docinfo oa_ucb oa_view oa_xml oa_xml_dom oa_xml_xpath oa_xml_views oa_xml_events oa_image oa_xsd oa_inspection oa_ui oa_ui_dialogs oa_accessibility oa_form_binding oa_form_validation oa_form_submission oa_fruntime oa_geometry oa_rendering oa_sfprovider oa_sfbrowse oa_drafts_form oa_deployment oa_deploymenttest oa_deployment_ui oa_frame_status oa_gallery oa_graphic oa_security oa_crypto_sax oa_crypto oa_csax oa_wrapper oa_script oa_smarttags oa_report oa_reportins oa_reportmeta oa_rdf oa_oooimprovement oa_office oa_prestextfield oa_starme NULL diff --git a/offapi/prj/d.lst b/offapi/prj/d.lst index 9532cd773c6f..d87a435f25c6 100644 --- a/offapi/prj/d.lst +++ b/offapi/prj/d.lst @@ -13,6 +13,7 @@ mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\auth mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\awt mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\awt\tree mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\awt\grid +mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\awt\tab mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\chart mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\chart2 mkdir: %COMMON_DEST%\idl%_EXT%\com\sun\star\chart2\data @@ -129,6 +130,7 @@ mkdir: %COMMON_DEST%\idl%_EXT%\drafts\com\sun\star\form ..\com\sun\star\awt\*.idl %COMMON_DEST%\idl%_EXT%\com\sun\star\awt ..\com\sun\star\awt\tree\*.idl %COMMON_DEST%\idl%_EXT%\com\sun\star\awt\tree ..\com\sun\star\awt\grid\*.idl %COMMON_DEST%\idl%_EXT%\com\sun\star\awt\grid +..\com\sun\star\awt\tab\*.idl %COMMON_DEST%\idl%_EXT%\com\sun\star\awt\tab ..\com\sun\star\chart\*.idl %COMMON_DEST%\idl%_EXT%\com\sun\star\chart ..\com\sun\star\chart2\*.idl %COMMON_DEST%\idl%_EXT%\com\sun\star\chart2 ..\com\sun\star\chart2\data\*.idl %COMMON_DEST%\idl%_EXT%\com\sun\star\chart2\data diff --git a/offapi/util/makefile.mk b/offapi/util/makefile.mk index 0ed4feba57b6..3f684372676b 100644 --- a/offapi/util/makefile.mk +++ b/offapi/util/makefile.mk @@ -42,6 +42,7 @@ UNOIDLDBFILES= \ $(UCR)$/cssawt.db \ $(UCR)$/cssawttree.db \ $(UCR)$/cssawtgrid.db \ + $(UCR)$/cssawttab.db \ $(UCR)$/csschart.db \ $(UCR)$/csschart2.db \ $(UCR)$/csschart2data.db \ -- cgit From fde9364cfeaa83d757e982108a3cb8f8b589055b Mon Sep 17 00:00:00 2001 From: Mihaela Kedikova Date: Thu, 12 Aug 2010 17:44:19 +0200 Subject: tabcontrol: new source code for tabcontrol added --- .../com/sun/star/awt/tab/TabPageActivatedEvent.idl | 56 +++++++++++ offapi/com/sun/star/awt/tab/UnoControlTabPage.idl | 56 +++++++++++ .../star/awt/tab/UnoControlTabPageContainer.idl | 55 +++++++++++ .../awt/tab/UnoControlTabPageContainerModel.idl | 55 +++++++++++ .../sun/star/awt/tab/UnoControlTabPageModel.idl | 51 ++++++++++ offapi/com/sun/star/awt/tab/XTabPage.idl | 52 ++++++++++ offapi/com/sun/star/awt/tab/XTabPageContainer.idl | 110 +++++++++++++++++++++ .../sun/star/awt/tab/XTabPageContainerListener.idl | 57 +++++++++++ .../sun/star/awt/tab/XTabPageContainerModel.idl | 53 ++++++++++ offapi/com/sun/star/awt/tab/XTabPageModel.idl | 88 +++++++++++++++++ offapi/com/sun/star/awt/tab/makefile.mk | 54 ++++++++++ 11 files changed, 687 insertions(+) create mode 100644 offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl create mode 100644 offapi/com/sun/star/awt/tab/UnoControlTabPage.idl create mode 100644 offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl create mode 100644 offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl create mode 100644 offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl create mode 100644 offapi/com/sun/star/awt/tab/XTabPage.idl create mode 100644 offapi/com/sun/star/awt/tab/XTabPageContainer.idl create mode 100644 offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl create mode 100644 offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl create mode 100644 offapi/com/sun/star/awt/tab/XTabPageModel.idl create mode 100644 offapi/com/sun/star/awt/tab/makefile.mk (limited to 'offapi') diff --git a/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl b/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl new file mode 100644 index 000000000000..b52575537d6f --- /dev/null +++ b/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl @@ -0,0 +1,56 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_TabPageActivationEvent_idl__ +#define __com_sun_star_awt_tab_TabPageActivationEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include +#endif + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** An event used by a XTabPageContainer to notify changes in tab page activation. + + @since OOo 3.3.0 + */ +struct TabPageActivatedEvent: com::sun::star::lang::EventObject +{ + /** Contains the ID of the tab page + */ + short TabPageID; + +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPage.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPage.idl new file mode 100644 index 000000000000..87add4c73c91 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPage.idl @@ -0,0 +1,56 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_UnoControlTabPage_idl__ +#define __com_sun_star_awt_tab_UnoControlTabPage_idl__ + +#include +#include + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** specifies a TabPage control. + + @since OOo 3.3.0 +*/ + +service UnoControlTabPage +{ + service com::sun::star::awt::UnoControlContainer; + + interface XTabPage; + +}; + +//============================================================================= + + }; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl new file mode 100644 index 000000000000..2ac4beff9b31 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_UnoControlTabPageContainer_idl__ +#define __com_sun_star_awt_tab_UnoControlTabPageContainer_idl__ + +#include +#include + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** specifies a TabPageContainer control. + + @since OOo 3.3.0 + */ +service UnoControlTabPageContainer +{ + service com::sun::star::awt::UnoControl; + + interface com::sun::star::awt::tab::XTabPageContainer; + +}; + +//============================================================================= + + }; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl new file mode 100644 index 000000000000..9f90e7c90454 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_UnoControlTabPageContainerModel_idl__ +#define __com_sun_star_awt_tab_UnoControlTabPageContainerModel_idl__ + +#include +#include + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** specifies a model for a UnoControlTabPageContainer control. + + @since OOo 3.3.0 + */ +service UnoControlTabPageContainerModel +{ + service com::sun::star::awt::UnoControlModel; + + interface com::sun::star::awt::tab::XTabPageContainerModel; + +}; + +//============================================================================= + + }; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl new file mode 100644 index 000000000000..78570956de92 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_UnoControlTabPageModel_idl__ +#define __com_sun_star_awt_tab_UnoControlTabPageModel_idl__ + +#include + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** specifies the standard model of a XTabPageModel. + */ +service UnoControlTabPageModel : XTabPageModel +{ + /** Creates a new XTabPageModel with a given ID. + */ + create([in] short tabPageID); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/XTabPage.idl b/offapi/com/sun/star/awt/tab/XTabPage.idl new file mode 100644 index 000000000000..a76d85c5f7f7 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/XTabPage.idl @@ -0,0 +1,52 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_XTabPage_idl__ +#define __com_sun_star_awt_tab_XTabPage_idl__ + +#include +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** An interface to a control that displays a tab page. + + @see UnoControlTabPage + + @since OOo 3.3.0 + */ +interface XTabPage +{ + +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl new file mode 100644 index 000000000000..606d5e23ac28 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl @@ -0,0 +1,110 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_XTabPageContainer_idl__ +#define __com_sun_star_awt_tab_XTabPageContainer_idl__ + +#include +#include +#include +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** An interface to a control that displays tab pages. + + @see UnoControlTabPageContainer + + @since OOo 3.3.0 + */ +interface XTabPageContainer: XControlContainer +{ + /** Returns the number of tab pages. + @returns + the number of tab pages. + */ + long getTabPageCount(); + + //------------------------------------------------------------------------- + + /** Checks whether a tab page is activated. + @param + the tab page to be checked. + @returns + if tab page is activated, else . + */ + boolean isTabPageActive([in] short tabPageIndex); + + //------------------------------------------------------------------------- + + /** Returns tab page for the given index. + @param + tabPageIndex - index of the tab page in the IndexContainer. + @returns + tab page which has tabPageIndex. + */ + XTabPage getTabPage([in] short tabPageIndex); + + //------------------------------------------------------------------------- + + /** Returns tab page for the given ID. + @param + tabPageID - ID of the tab page. + @returns + tab page which has tabPageID. + */ + XTabPage getTabPageByID([in] short tabPageID); + + //------------------------------------------------------------------------- + + /** Adds a listener for the TabPageActivedEvent posted after + the tab page was activated. + @param listener + the listener to add. + */ + [oneway] void addTabPageListener( [in] XTabPageContainerListener listener); + + //------------------------------------------------------------------------- + + /** Removes a listener previously added with addTabPageListener(). + @param listener + the listener to remove. + */ + [oneway] void removeTabPageListener( [in] XTabPageContainerListener listener); + + //------------------------------------------------------------------------- + /** Specifies the ID of the current active tab page. + */ + [attribute] short ActiveTabPageID; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl b/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl new file mode 100644 index 000000000000..5e256c3b999d --- /dev/null +++ b/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_XTabPageContainerListener_idl__ +#define __com_sun_star_awt_tab_XTabPageContainerListener_idl__ + +#include +#include + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** An instance of this interface is used by the XTabPageContainer to + get notifications about changes in activation of tab pages. + + @since OOo 3.3.0 + */ +interface XTabPageContainerListener: com::sun::star::lang::XEventListener +{ + //------------------------------------------------------------------------- + /** Invoked after a tab page was activated. + */ + [oneway] void tabPageActivated( [in] TabPageActivatedEvent tabPageActivatedEvent); + +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl b/offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl new file mode 100644 index 000000000000..ac9ff468af89 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl @@ -0,0 +1,53 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_XTabPageContainerModel_idl__ +#define __com_sun_star_awt_tab_XTabPageContainerModel_idl__ + +#include +#include + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** specifies an interface for a UnoControlTabPageContainerModel. + + @since OOo 3.3.0 + */ +interface XTabPageContainerModel +{ + interface com::sun::star::container::XIndexContainer; + interface com::sun::star::container::XContainer; +}; + +//============================================================================= + + }; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/XTabPageModel.idl b/offapi/com/sun/star/awt/tab/XTabPageModel.idl new file mode 100644 index 000000000000..501fa0b52e80 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/XTabPageModel.idl @@ -0,0 +1,88 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_tab_XTabPageModel_idl__ +#define __com_sun_star_awt_tab_XTabPageModel_idl__ + +#include +#include +#include +#include +#include + +//============================================================================= + +module com { module sun { module star { module awt { module tab { + +//============================================================================= + +/** specifies an XTabPageModel interface. + + @since OOo 3.3.0 +*/ + +interface XTabPageModel +{ + //interface com::sun::star::lang::XMultiServiceFactory; + + //interface com::sun::star::container::XNameContainer; + + //interface com::sun::star::container::XContainer; + + /**ID for tab page. + */ + [attribute, readonly] short TabPageID; + //------------------------------------------------------------------------- + + /** determines whether a tab page is enabled or disabled. + */ + [attribute] boolean Enabled; + + //------------------------------------------------------------------------- + + /** specifies the text that is displayed in the tab bar of the tab page. + */ + [attribute] string Title; + + //------------------------------------------------------------------------- + + /** specifies a URL that references a graphic that should be displayed in the tab bar. + */ + [attribute] string ImageURL; + + //------------------------------------------------------------------------- + + /** specifies a tooltip text that should be displayed in the tab bar. + */ + [attribute] string Tooltip; +}; + + +//============================================================================= + + }; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/tab/makefile.mk b/offapi/com/sun/star/awt/tab/makefile.mk new file mode 100644 index 000000000000..39d1e66f7643 --- /dev/null +++ b/offapi/com/sun/star/awt/tab/makefile.mk @@ -0,0 +1,54 @@ +#************************************************************************* +# +# 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 +# +# for a copy of the LGPLv3 License. +# +#************************************************************************* + +PRJ=..$/..$/..$/..$/.. + +PRJNAME=api + +TARGET=cssawttab +PACKAGE=com$/sun$/star$/awt$/tab + +# --- Settings ----------------------------------------------------- + +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ +IDLFILES=\ + TabPageActivatedEvent.idl\ + XTabPageContainerListener.idl\ + XTabPageModel.idl\ + XTabPage.idl\ + XTabPageContainerModel.idl\ + XTabPageContainer.idl\ + UnoControlTabPage.idl\ + UnoControlTabPageModel.idl\ + UnoControlTabPageContainer.idl\ + UnoControlTabPageContainerModel.idl +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk -- cgit From 7c139e98343eb73c24fd9874ddba1ee1ab449b16 Mon Sep 17 00:00:00 2001 From: "Ocke Janssen [oj]" Date: Fri, 27 Aug 2010 12:13:59 +0200 Subject: tabcontrol: #i113362# impl tabcontrol in awt --- .../sun/star/awt/UnoControlDialogModelProvider.idl | 55 ++++++++++++++++++++++ offapi/com/sun/star/awt/makefile.mk | 1 + .../sun/star/awt/tab/UnoControlTabPageModel.idl | 5 ++ offapi/com/sun/star/awt/tab/XTabPageContainer.idl | 3 +- 4 files changed, 62 insertions(+), 2 deletions(-) create mode 100644 offapi/com/sun/star/awt/UnoControlDialogModelProvider.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/awt/UnoControlDialogModelProvider.idl b/offapi/com/sun/star/awt/UnoControlDialogModelProvider.idl new file mode 100644 index 000000000000..a91065f72d66 --- /dev/null +++ b/offapi/com/sun/star/awt/UnoControlDialogModelProvider.idl @@ -0,0 +1,55 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_awt_UnoControlDialogModelProvider_idl__ +#define __com_sun_star_awt_UnoControlDialogModelProvider_idl__ + +#include +#include +#include + +//============================================================================= + +module com { module sun { module star { module awt { + +//============================================================================= + +/** specifies a service to load a dialog model and allows to access the control models inside + + @since OOo 3.3.0 + */ +service UnoControlDialogModelProvider : com::sun::star::container::XNameContainer +{ + /** Creates a new dialog model + */ + create([in] string URL)raises ( com::sun::star::lang::IllegalArgumentException ); +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/awt/makefile.mk b/offapi/com/sun/star/awt/makefile.mk index 55734fd75ca6..f5a73d458e1a 100644 --- a/offapi/com/sun/star/awt/makefile.mk +++ b/offapi/com/sun/star/awt/makefile.mk @@ -161,6 +161,7 @@ IDLFILES=\ UnoControlDialog.idl\ UnoControlDialogElement.idl\ UnoControlDialogModel.idl\ + UnoControlDialogModelProvider.idl\ UnoControlEdit.idl\ UnoControlEditModel.idl\ UnoControlFileControl.idl\ diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl index 78570956de92..0f74e21865db 100644 --- a/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl @@ -36,12 +36,17 @@ module com { module sun { module star { module awt { module tab { //============================================================================= /** specifies the standard model of a XTabPageModel. + @since OOo 3.3.0 */ service UnoControlTabPageModel : XTabPageModel { /** Creates a new XTabPageModel with a given ID. */ create([in] short tabPageID); + + /** Creates a new XTabPageModel with a given ID and a url which is used to load teh tab page model. + */ + load([in] short tabPageID,[in] string url); }; //============================================================================= diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl index 606d5e23ac28..65964337c43f 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl @@ -29,7 +29,6 @@ #include #include -#include //============================================================================= module com { module sun { module star { module awt { module tab { @@ -42,7 +41,7 @@ module com { module sun { module star { module awt { module tab { @since OOo 3.3.0 */ -interface XTabPageContainer: XControlContainer +interface XTabPageContainer { /** Returns the number of tab pages. @returns -- cgit From f878701a60eb29ba4900bb6f71b7c57388248930 Mon Sep 17 00:00:00 2001 From: "Ocke Janssen [oj]" Date: Thu, 2 Sep 2010 14:32:02 +0200 Subject: tabcontrol: fix some compile errors --- offapi/com/sun/star/awt/tab/XTabPageModel.idl | 1 - 1 file changed, 1 deletion(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/awt/tab/XTabPageModel.idl b/offapi/com/sun/star/awt/tab/XTabPageModel.idl index 501fa0b52e80..d9e688a79415 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageModel.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageModel.idl @@ -31,7 +31,6 @@ #include #include #include -#include //============================================================================= -- cgit From ee2c47597d26e7d6d95575ea5783c756c1e05c68 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Wed, 6 Oct 2010 14:21:47 +0200 Subject: dba34b: #i112779# new 'animated images' UNO control, superseding the (X)SimpleAnimation and Throbber controls --- offapi/com/sun/star/awt/AnimatedImagesControl.idl | 58 +++++++ .../sun/star/awt/AnimatedImagesControlModel.idl | 57 +++++++ offapi/com/sun/star/awt/SpinEvent.idl | 0 .../sun/star/awt/SpinningProgressControlModel.idl | 54 +++++++ .../com/sun/star/awt/UnoControlSimpleAnimation.idl | 9 +- .../star/awt/UnoControlSimpleAnimationModel.idl | 26 +-- offapi/com/sun/star/awt/UnoControlSpinButton.idl | 0 .../com/sun/star/awt/UnoControlSpinButtonModel.idl | 0 offapi/com/sun/star/awt/UnoControlThrobber.idl | 9 +- .../com/sun/star/awt/UnoControlThrobberModel.idl | 10 +- offapi/com/sun/star/awt/XAnimatedImages.idl | 176 +++++++++++++++++++++ offapi/com/sun/star/awt/XAnimation.idl | 63 ++++++++ offapi/com/sun/star/awt/XSimpleAnimation.idl | 19 +-- offapi/com/sun/star/awt/XSpinField.idl | 0 offapi/com/sun/star/awt/XSpinListener.idl | 0 offapi/com/sun/star/awt/XSpinValue.idl | 0 offapi/com/sun/star/awt/XThrobber.idl | 13 +- offapi/com/sun/star/awt/makefile.mk | 7 +- 18 files changed, 432 insertions(+), 69 deletions(-) create mode 100755 offapi/com/sun/star/awt/AnimatedImagesControl.idl create mode 100755 offapi/com/sun/star/awt/AnimatedImagesControlModel.idl mode change 100644 => 100755 offapi/com/sun/star/awt/SpinEvent.idl create mode 100755 offapi/com/sun/star/awt/SpinningProgressControlModel.idl mode change 100644 => 100755 offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl mode change 100644 => 100755 offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl mode change 100644 => 100755 offapi/com/sun/star/awt/UnoControlSpinButton.idl mode change 100644 => 100755 offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl create mode 100755 offapi/com/sun/star/awt/XAnimatedImages.idl create mode 100755 offapi/com/sun/star/awt/XAnimation.idl mode change 100644 => 100755 offapi/com/sun/star/awt/XSimpleAnimation.idl mode change 100644 => 100755 offapi/com/sun/star/awt/XSpinField.idl mode change 100644 => 100755 offapi/com/sun/star/awt/XSpinListener.idl mode change 100644 => 100755 offapi/com/sun/star/awt/XSpinValue.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/awt/AnimatedImagesControl.idl b/offapi/com/sun/star/awt/AnimatedImagesControl.idl new file mode 100755 index 000000000000..90f8b3a356e8 --- /dev/null +++ b/offapi/com/sun/star/awt/AnimatedImagesControl.idl @@ -0,0 +1,58 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_awt_AnimatedImagesControl_idl__ +#define __com_sun_star_awt_AnimatedImagesControl_idl__ + +#include + +//====================================================================================================================== + +module com { module sun { module star { module awt { + +interface XAnimation; + +//====================================================================================================================== + +/** is the default control used for an AnimatedImagesControlModel, displayed a series of + images. + + @since OOo 3.4 + */ +service AnimatedImagesControl +{ + service com::sun::star::awt::UnoControl; + + interface XAnimation; +}; + +//====================================================================================================================== + +}; }; }; }; + +//====================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/AnimatedImagesControlModel.idl b/offapi/com/sun/star/awt/AnimatedImagesControlModel.idl new file mode 100755 index 000000000000..2bc1260775c9 --- /dev/null +++ b/offapi/com/sun/star/awt/AnimatedImagesControlModel.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_awt_AnimatedImagesControlModel_idl__ +#define __com_sun_star_awt_AnimatedImagesControlModel_idl__ + +#include + +//====================================================================================================================== + +module com { module sun { module star { module awt { + +interface XAnimatedImages; + +//====================================================================================================================== + +/** describes the model for a control displaying a series of images + + @since OOo 3.4 + */ +service AnimatedImagesControlModel +{ + service com::sun::star::awt::UnoControlModel; + + interface XAnimatedImages; +}; + +//====================================================================================================================== + +}; }; }; }; + +//====================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/SpinEvent.idl b/offapi/com/sun/star/awt/SpinEvent.idl old mode 100644 new mode 100755 diff --git a/offapi/com/sun/star/awt/SpinningProgressControlModel.idl b/offapi/com/sun/star/awt/SpinningProgressControlModel.idl new file mode 100755 index 000000000000..a75417d41cc3 --- /dev/null +++ b/offapi/com/sun/star/awt/SpinningProgressControlModel.idl @@ -0,0 +1,54 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_awt_SpinningProgressControlModel_idl__ +#define __com_sun_star_awt_SpinningProgressControlModel_idl__ + +#include + +//====================================================================================================================== + +module com { module sun { module star { module awt { + +//====================================================================================================================== + +/** is a specialization of the AnimatedImagesControlModel which provides standard image sets + for displaying a non-procentual progress. + +

Three image sets are provided, of size 16x16, 32x32, and 64x64 pixels.

+ */ +service SpinningProgressControlModel +{ + service AnimatedImagesControlModel; +}; + +//====================================================================================================================== + +}; }; }; }; + +//====================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl b/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl old mode 100644 new mode 100755 index cf45f0aea0f0..b00ec8740521 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl +++ b/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl @@ -42,17 +42,14 @@ //============================================================================= -/** specifies a simple animation control. - -

The model of an UnoControlSimpleAnimation control must support - the UnoControlSimpleAnimationModel service.

- +/** @since OOo 2.2 + @deprecated + You should use AnimatedImagesControl. */ published service UnoControlSimpleAnimation { service com::sun::star::awt::UnoControl; - interface com::sun::star::awt::XSimpleAnimation; }; diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl b/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl old mode 100644 new mode 100755 index ca301483263f..1f96099fee63 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl +++ b/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl @@ -38,36 +38,16 @@ //============================================================================= -/** specifies the standard model of an UnoControlSimpleAnimation. - -

The simple animation control displays a sequence of images.

- -

- - @see UnoControlScrollBarModel +/** @since OOo 2.2 + @deprecated + You should use AnimatedImagesControlModel. */ published service UnoControlSimpleAnimationModel { service com::sun::star::awt::UnoControlModel; - - //------------------------------------------------------------------------- - - /** specifies the time in milliseconds between two animation steps. - - 
This is the minimum time, the actual value might be longer due to
-        system load. The default value will be 100 ms.
- */ [property] long StepTime; - - //------------------------------------------------------------------------- - - /** specifies whether the animation will restart again after displaying the last - image. - -

The default is FALSE.

- */ [property] boolean AutoRepeat; }; diff --git a/offapi/com/sun/star/awt/UnoControlSpinButton.idl b/offapi/com/sun/star/awt/UnoControlSpinButton.idl old mode 100644 new mode 100755 diff --git a/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl b/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl old mode 100644 new mode 100755 diff --git a/offapi/com/sun/star/awt/UnoControlThrobber.idl b/offapi/com/sun/star/awt/UnoControlThrobber.idl index f5194075019a..85b5d8b850f7 100644 --- a/offapi/com/sun/star/awt/UnoControlThrobber.idl +++ b/offapi/com/sun/star/awt/UnoControlThrobber.idl @@ -42,17 +42,14 @@ //============================================================================= -/** specifies a simple animation control. - -

The model of an UnoControlThrobber control must support - the UnoControlThrobberModel service.

- +/** @since OOo 2.2 + @deprecatd + You should use AnimatedImagesControl. */ published service UnoControlThrobber { service com::sun::star::awt::UnoControl; - interface com::sun::star::awt::XThrobber; }; diff --git a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl b/offapi/com/sun/star/awt/UnoControlThrobberModel.idl index f2eacad5b76b..060ff105c119 100644 --- a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl +++ b/offapi/com/sun/star/awt/UnoControlThrobberModel.idl @@ -38,14 +38,10 @@ //============================================================================= -/** specifies the standard model of an UnoControlThrobber. - -

The simple animation control displays a sequence of images.

- -

- - @see UnoControlScrollBarModel +/** @since OOo 2.2 + @deprecatd + You should use SpinningAnimationControlModel. */ published service UnoControlThrobberModel diff --git a/offapi/com/sun/star/awt/XAnimatedImages.idl b/offapi/com/sun/star/awt/XAnimatedImages.idl new file mode 100755 index 000000000000..a03d08c965f1 --- /dev/null +++ b/offapi/com/sun/star/awt/XAnimatedImages.idl @@ -0,0 +1,176 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_awt_XAnimatedImages_idl__ +#define __com_sun_star_awt_XAnimatedImages_idl__ + +#include +#include +#include +#include + +//====================================================================================================================== + +module com { module sun { module star { module awt { + +//====================================================================================================================== + +/** allows administrating a set of images, to be displayed as animated seres. + +

Components implementing this interface maintain a variable number of image sets. Components displaying + those images will choose the best-fitting image set depending on the available space, and possibly other + restrictions.

+ + @since OOo 3.4 + */ +interface XAnimatedImages +{ + /** specifies the time in milliseconds between two animation steps. + +

This is the minimum time, the actual value might be longer due to + system load. The default value will be 100 ms.

+ */ + [attribute] long StepTime; + + /** specifies whether the animation should start over with the first image of the image series when the last image + has been played. + +

The default value for this attribute is .

+ */ + [attribute] boolean AutoRepeat; + + /** controls the way the images are scaled up or down, when the available space is larger or smaller + than what is needed for them. + +

Allowed values are those from the ImageScaleMode constants group.

+ */ + [attribute] short ScaleMode + { + set raises (::com::sun::star::lang::IllegalArgumentException); + }; + + /** returns the number of images sets maintained by the component. + */ + long + getImageSetCount(); + + /** returns the URLs of the image set with the given index + + @param i_index + the index of the set those image URLs are to be retrieved. Must be greater than or equal to 0, + and smaller than the value returned by getImageSetCount. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if the i_index is not a valid index. + */ + sequence< string > + getImageSet + ( + [in] long i_index + ) + raises + ( + ::com::sun::star::lang::IndexOutOfBoundsException + ); + + /** sets the URLs of the image set with the given index + + @param i_index + the index at which a new image set should be inserted. Must be greater than or equal to 0, + and smaller than or equal to the value returned by getImageSetCount. + @param i_imageURLs + the URLs for the images for the given set. Will be resolved using a GraphicProvider. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if the i_index is not a valid index. + */ + void + insertImageSet + ( + [in] long i_index, + [in] sequence< string > i_imageURLs + ) + raises + ( + ::com::sun::star::lang::IndexOutOfBoundsException + ); + + /** replaces the image set given by index with a new one + + @param i_index + the index of the set those image URLs are to be replaced. Must be greater than or equal to 0, + and smaller than the value returned by getImageSetCount. + + @param i_imageURLs + the URLs for the images for the given set. Will be resolved using a GraphicProvider. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if the i_index is not a valid index. + */ + void + replaceImageSet + ( + [in] long i_index, + [in] sequence< string > i_imageURLs + ) + raises + ( + ::com::sun::star::lang::IndexOutOfBoundsException + ); + + + /** removes the image set with the given index + + @param i_index + the index of the set to remove. Must be greater than or equal to 0, + and smaller than the value returned by getImageSetCount. + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if the i_index is not a valid index. + */ + void + removeImageSet + ( + [in] long i_index + ) + raises + ( + ::com::sun::star::lang::IndexOutOfBoundsException + ); + + + /** allows other components to observer the insertion, removal, and replacement of image sets + */ + interface ::com::sun::star::container::XContainer; +}; + +//====================================================================================================================== + +}; }; }; }; + +//====================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/XAnimation.idl b/offapi/com/sun/star/awt/XAnimation.idl new file mode 100755 index 000000000000..e1e8f6023a7d --- /dev/null +++ b/offapi/com/sun/star/awt/XAnimation.idl @@ -0,0 +1,63 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_awt_XAnimation_idl__ +#define __com_sun_star_awt_XAnimation_idl__ + +#include + +//====================================================================================================================== + +module com { module sun { module star { module awt { + +//====================================================================================================================== + +/** allows controlling an animation. + + @since OOo 3.4 + */ +interface XAnimation +{ + /** starts the animation + */ + void startAnimation(); + + /** stops the animation + */ + void stopAnimation(); + + /** determines whether the animation is currently running + */ + boolean isAnimationRunning(); +}; + +//====================================================================================================================== + +}; }; }; }; + +//====================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/awt/XSimpleAnimation.idl b/offapi/com/sun/star/awt/XSimpleAnimation.idl old mode 100644 new mode 100755 index 1cfd758590b9..bff9eeeb5a90 --- a/offapi/com/sun/star/awt/XSimpleAnimation.idl +++ b/offapi/com/sun/star/awt/XSimpleAnimation.idl @@ -41,28 +41,15 @@ //============================================================================= -/** Controls the animation control. +/** + @deprecated + You should use XAnimation, AnimatedImagesControl, and AnimatedImagesControlModel. */ published interface XSimpleAnimation: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - /** starts the animation of the control. - */ void start(); - - //------------------------------------------------------------------------- - - /** stops the animation of the control. - */ void stop(); - - //------------------------------------------------------------------------- - - /** The list of images to be displayed. - */ void setImageList( [in] sequence < com::sun::star::graphic::XGraphic > ImageList ); - }; //============================================================================= diff --git a/offapi/com/sun/star/awt/XSpinField.idl b/offapi/com/sun/star/awt/XSpinField.idl old mode 100644 new mode 100755 diff --git a/offapi/com/sun/star/awt/XSpinListener.idl b/offapi/com/sun/star/awt/XSpinListener.idl old mode 100644 new mode 100755 diff --git a/offapi/com/sun/star/awt/XSpinValue.idl b/offapi/com/sun/star/awt/XSpinValue.idl old mode 100644 new mode 100755 diff --git a/offapi/com/sun/star/awt/XThrobber.idl b/offapi/com/sun/star/awt/XThrobber.idl index 0a4ac133524a..04dc6887cbe9 100644 --- a/offapi/com/sun/star/awt/XThrobber.idl +++ b/offapi/com/sun/star/awt/XThrobber.idl @@ -41,20 +41,13 @@ //============================================================================= -/** Controls the animation control. +/** + @deprecatd + You should use XAnimation, AnimatedImagesControl, and AnimatedImagesControlModel. */ published interface XThrobber: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - /** starts the animation of the control. - */ void start(); - - //------------------------------------------------------------------------- - - /** stops the animation of the control. - */ void stop(); }; diff --git a/offapi/com/sun/star/awt/makefile.mk b/offapi/com/sun/star/awt/makefile.mk index a6357703500c..b6cf34046ae9 100644 --- a/offapi/com/sun/star/awt/makefile.mk +++ b/offapi/com/sun/star/awt/makefile.mk @@ -334,7 +334,12 @@ IDLFILES=\ XPopupMenuExtended.idl \ XItemList.idl \ XItemListListener.idl \ - ItemListEvent.idl + ItemListEvent.idl \ + AnimatedImagesControl.idl \ + AnimatedImagesControlModel.idl \ + XAnimatedImages.idl \ + XAnimation.idl \ + SpinningProgressControlModel.idl # ------------------------------------------------------------------ -- cgit From 0658bb205ab9da692e1f73199e92ca40003e27af Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Thu, 14 Oct 2010 16:40:29 +0200 Subject: undoapi: initial version of an UNO Undo API, implemented empty for SFX-based documents --- offapi/com/sun/star/document/XUndoAction.idl | 59 ++++++++ offapi/com/sun/star/document/XUndoManager.idl | 161 +++++++++++++++++++++ .../com/sun/star/document/XUndoManagerSupplier.idl | 53 +++++++ offapi/com/sun/star/document/makefile.mk | 5 +- 4 files changed, 277 insertions(+), 1 deletion(-) create mode 100755 offapi/com/sun/star/document/XUndoAction.idl create mode 100755 offapi/com/sun/star/document/XUndoManager.idl create mode 100755 offapi/com/sun/star/document/XUndoManagerSupplier.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoAction.idl b/offapi/com/sun/star/document/XUndoAction.idl new file mode 100755 index 000000000000..e844f527fceb --- /dev/null +++ b/offapi/com/sun/star/document/XUndoAction.idl @@ -0,0 +1,59 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_XUndoAction_idl__ +#define __com_sun_star_document_XUndoAction_idl__ + +//================================================================================================================== + +module com { module sun { module star { module document { + +//================================================================================================================== + +/** represents a single (undoable) action on a document + */ +interface XUndoAction +{ + /** reverts the action represented by the instance + */ + void undo(); + + /** repeats the action represented by the instance, after it had previously been reverted. + */ + void redo(); + + /** is the human-readable, localized description of the action. + */ + [attribute, readonly] string Title; +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl new file mode 100755 index 000000000000..9ad65e4f4e82 --- /dev/null +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -0,0 +1,161 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_XUndoManager_idl__ +#define __com_sun_star_document_XUndoManager_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module document { + +interface XUndoAction; + +//================================================================================================================== + +/** provides access to the undo/redo stacks of the document + */ +interface XUndoManager +{ + /** enters a new undo context. + +

A new undo action will be added to the undo stack, with the title given as i_title. As long + as the context is not left, every undo action added to the stack will be treated as sub action. This means + it will not be directly accessible at the undo manager, not appear in any user interface, and cannot be + separately undone or re-done.

+ +

Each call to enterUndoContext must be paired by a call to leaveUndoContext, + otherwise, the document's undo stack is left in an inconsistent state.

+ +

Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext and + enterHiddenUndoContext multiple times without calling leaveUndoContext inbetween.

+ + @see leaveUndoContext + */ + void enterUndoContext( + [in] string i_title + ); + + /** enters a new undo context, creating a hidden Undo action. + +

A hidden Undo action does not, in any visible way, contribute to the Undo stack. This means + that +

  • Calling undo when the top-element is a hidden Undo action will transparently + undo this action, and also undo the new top element of the stack.
    • +
  • Calling redo when the top-element is a hidden action will transparently + redo this action, and also redo the new top element of the stack.
    • +
  • In any user interface presenting the current Undo or Redo actions to the user, a hidden + action will not be listed.

    +
+ +

A new undo action will be added to the undo stack. As long as the context is not left, every undo action + added to the stack will be treated as sub action. This means it will not be directly accessible at the undo + manager, not appear in any user interface, and cannot be separately undone or re-done.

+ +

Each call to enterHiddenUndoContext must be paired by a call to leaveUndoContext, + otherwise, the document's undo stack is left in an inconsistent state.

+ +

Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext and + enterHiddenUndoContext multiple times without calling leaveUndoContext inbetween.

+ + @throws ::com::sun::star::util::InvalidStateException + if the Undo stack is currently empty, in which case it is impossible to push a hidden Undo action onto + it. + + @see emterUndoContext + @see leaveUndoContext + */ + void enterHiddenUndoContext() + raises( ::com::sun::star::util::InvalidStateException ); + + /** leaves the undo context previously opened via enterUndoContext respectively + enterHiddenUndoContext. + + @throws ::com::sun::star::util::InvalidStateException + if no undo context is currently open. + + @see enterUndoContext + @see enterHiddenUndoContext + */ + void leaveUndoContext() + raises( ::com::sun::star::util::InvalidStateException ); + + /** adds the given undo action to the undo stack. + +

The redo stack is cleared when a new action is pushed onto the undo stack.

+ +

The undo manager takes ownership of any actions pushed onto the undo stack. This means that if the + action is finally removed from the undo manager's control (e.g. by calling clear resp. + clearRedo), it will be disposed, as long as it supports the XComponent + interface.

+ */ + void addUndoAction( + [in] XUndoAction i_action + ); + + /** reverts the most recent action on the document. + +

Effectively, invoking this method will +

  • close any undo contexts which are currently open

    +
  • invoke XUndoAction::undo on the top-most action of the undo stack
    • +
  • move this undo action from the undo stack to the redo stack
    • +

+ +

If one or more undo contexts are currently open, those will be implicit + + @see redo + */ + void undo(); + + /** replays the action on the document which has most recently been undone + +

Effectively, invoking this method will +

  • close any undo contexts which are currently open

    +
  • invoke XUndoAction::redo on the top-most action of the redo stack
    • +
  • move this action from the redo stack to the undo stack
    • +

+ + @see undo + */ + void redo(); + + /** clears the undo and the redo stack. + */ + void clear(); + + /** clears the redo stack. + */ + void clearRedo(); +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/XUndoManagerSupplier.idl b/offapi/com/sun/star/document/XUndoManagerSupplier.idl new file mode 100755 index 000000000000..14b345e44126 --- /dev/null +++ b/offapi/com/sun/star/document/XUndoManagerSupplier.idl @@ -0,0 +1,53 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_XUndoManagerSupplier_idl__ +#define __com_sun_star_document_XUndoManagerSupplier_idl__ + +//================================================================================================================== + +module com { module sun { module star { module document { + +interface XUndoManager; + +//================================================================================================================== + +/** provides access to an XUndoManager. + */ +interface XUndoManagerSupplier +{ + /** returns the Undo manager associated with the component. + */ + XUndoManager getUndoManager(); +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/makefile.mk b/offapi/com/sun/star/document/makefile.mk index 48394a65008c..f705df150929 100644 --- a/offapi/com/sun/star/document/makefile.mk +++ b/offapi/com/sun/star/document/makefile.mk @@ -114,7 +114,10 @@ IDLFILES=\ XDocumentRevisionListPersistence.idl\ DocumentRevisionListPersistence.idl \ XDocumentLanguages.idl \ - XCodeNameQuery.idl + XCodeNameQuery.idl \ + XUndoAction.idl \ + XUndoManager.idl \ + XUndoManagerSupplier.idl # ------------------------------------------------------------------ -- cgit From 7ef064a0825daadc6b810d782db83ed6028bb8e2 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Thu, 14 Oct 2010 16:40:30 +0200 Subject: undoapi: some flesh on the initial skeleton --- offapi/com/sun/star/document/XUndoManager.idl | 7 ++++++- offapi/com/sun/star/document/XUndoManagerSupplier.idl | 2 ++ 2 files changed, 8 insertions(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 9ad65e4f4e82..d69b211f2f90 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -28,6 +28,7 @@ #define __com_sun_star_document_XUndoManager_idl__ #include +#include //================================================================================================================== @@ -112,10 +113,14 @@ interface XUndoManager action is finally removed from the undo manager's control (e.g. by calling clear resp. clearRedo), it will be disposed, as long as it supports the XComponent interface.

+ + @throws ::com::sun::star::lang::IllegalArgumentException + if the given undo action is . */ void addUndoAction( [in] XUndoAction i_action - ); + ) + raises( ::com::sun::star::lang::IllegalArgumentException ); /** reverts the most recent action on the document. diff --git a/offapi/com/sun/star/document/XUndoManagerSupplier.idl b/offapi/com/sun/star/document/XUndoManagerSupplier.idl index 14b345e44126..88a082259413 100755 --- a/offapi/com/sun/star/document/XUndoManagerSupplier.idl +++ b/offapi/com/sun/star/document/XUndoManagerSupplier.idl @@ -27,6 +27,8 @@ #ifndef __com_sun_star_document_XUndoManagerSupplier_idl__ #define __com_sun_star_document_XUndoManagerSupplier_idl__ +#include + //================================================================================================================== module com { module sun { module star { module document { -- cgit From fd589fba71d4010d6f00f063da22f98622b6d020 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Thu, 14 Oct 2010 16:40:32 +0200 Subject: undoapi: first sketch of the listener API - not sure this will survive 'til the final version --- offapi/com/sun/star/document/UndoManagerEvent.idl | 63 ++++++++++++ offapi/com/sun/star/document/XUndoManager.idl | 24 ++++- .../com/sun/star/document/XUndoManagerListener.idl | 107 +++++++++++++++++++++ offapi/com/sun/star/document/makefile.mk | 4 +- 4 files changed, 195 insertions(+), 3 deletions(-) create mode 100755 offapi/com/sun/star/document/UndoManagerEvent.idl create mode 100755 offapi/com/sun/star/document/XUndoManagerListener.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/document/UndoManagerEvent.idl b/offapi/com/sun/star/document/UndoManagerEvent.idl new file mode 100755 index 000000000000..a95c0707ba33 --- /dev/null +++ b/offapi/com/sun/star/document/UndoManagerEvent.idl @@ -0,0 +1,63 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_UndoManagerEvent_idl__ +#define __com_sun_star_document_UndoManagerEvent_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module document { + +//================================================================================================================== + +/** is an event sent by an XUndoManager implementation when the Undo/Redo stacks of the manager are + modified. + @see XUndoManager + @see XUndoManagerListener + @see XUndoAction + */ +struct UndoManagerEvent : ::com::sun::star::lang::EventObject +{ + /** the title of the Undo action which is described by the event + @see XUndoAction::Title + */ + string UndoActionTitle; + + /** denotes the number of Undo contexts which are open, and not yet closed, at the time the event is fired. + @see XUndoManager::enterUndoContext + */ + long UndoContextDepth; +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index d69b211f2f90..b937aa538e7a 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -29,12 +29,14 @@ #include #include +#include //================================================================================================================== module com { module sun { module star { module document { interface XUndoAction; +interface XUndoManagerListener; //================================================================================================================== @@ -133,8 +135,11 @@ interface XUndoManager

If one or more undo contexts are currently open, those will be implicit @see redo + @throws ::com::sun::star::lang::WrappedTargetException + if the invocation of XUndoAction::undo raises an exception other than a RuntimeException */ - void undo(); + void undo() + raises( ::com::sun::star::lang::WrappedTargetException ); /** replays the action on the document which has most recently been undone @@ -145,8 +150,11 @@ interface XUndoManager

@see undo + @throws ::com::sun::star::lang::WrappedTargetException + if the invocation of XUndoAction::redo raises an exception other than a RuntimeException */ - void redo(); + void redo() + raises( ::com::sun::star::lang::WrappedTargetException ); /** clears the undo and the redo stack. */ @@ -155,6 +163,18 @@ interface XUndoManager /** clears the redo stack. */ void clearRedo(); + + /** adds a listener to be notified of changes in the Undo/Redo stacks. + */ + void addUndoManagerListener( + [in] XUndoManagerListener i_listener + ); + + /** removes a previously added listener + */ + void removeUndoManagerListener( + [in] XUndoManagerListener i_listener + ); }; //================================================================================================================== diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl new file mode 100755 index 000000000000..281b3911f65c --- /dev/null +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -0,0 +1,107 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_XUndoManagerListener_idl__ +#define __com_sun_star_document_XUndoManagerListener_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module document { + +//================================================================================================================== + +/** implemented by components which want to be notified of changes in the Undo/Redo stacks of an Undo manager. + + @see XUndoManager + */ +interface XUndoManagerListener +{ + /** is called when an Undo action is added to the Undo stack. + +

Note that the action must not necessarily be the new top element of the stack: In case there's an + open Undo context, UndoManagerEvent::UndoContextDepth will be greater 0, + and the newly added action will be subordinate of the context action.

+ */ + void undoActionAdded( [in] UndoManagerEvent i_event ); + + /** is called when the top-most action of the Undo stack has been undone. + */ + void actionUndone( [in] UndoManagerEvent i_event ); + + /** is called when the top-most action of the Redo stack has been redone. + */ + void actionRedone( [in] UndoManagerEvent i_event ); + + /** is called when both the Undo and the Redo stack have been cleared from all Undo actions. + @see XUndoManager::clear + */ + void allActionsCleared( [in] ::com::sun::star::lang::EventObject i_event ); + + /** is called when the the Redo stack has been cleared. + @see XUndoManager::clearRedo + */ + void redoActionsCleared( [in] ::com::sun::star::lang::EventObject i_event ); + + /** is called when a new Undo context has been entered. + +

UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and + UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the + one just entered.

+ + @see XUndoManager::enterUndoContext + */ + void enteredUndoContext( [in] UndoManagerEvent i_event ); + + /** is called when a new hidden Undo context has been entered. + +

UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and + UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the + one just entered.

+ + @see XUndoManager::enterUndoContext + */ + void enteredHiddenUndoContext( [in] UndoManagerEvent i_event ); + + /** is called when a new Undo context has been entered. + +

UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and + UndoManagerEvent::UndoContextDepth the number of open Undo contexts, exluding the + one just left.

+ + @see XUndoManager::leaveUndoContext + */ + void leftUndoContext( [in] UndoManagerEvent i_event ); +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/makefile.mk b/offapi/com/sun/star/document/makefile.mk index f705df150929..3a426123f1bf 100644 --- a/offapi/com/sun/star/document/makefile.mk +++ b/offapi/com/sun/star/document/makefile.mk @@ -117,7 +117,9 @@ IDLFILES=\ XCodeNameQuery.idl \ XUndoAction.idl \ XUndoManager.idl \ - XUndoManagerSupplier.idl + XUndoManagerListener.idl \ + XUndoManagerSupplier.idl \ + UndoManagerEvent.idl # ------------------------------------------------------------------ -- cgit From 69702668ba9b6d2f1c3243b1fd67da74a1808c8c Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Fri, 15 Oct 2010 13:30:09 +0200 Subject: undoapi: explicitly include XInterface.idl - sometimes (not always - strange enough) the IDL compiler complains --- offapi/com/sun/star/document/XUndoAction.idl | 2 ++ 1 file changed, 2 insertions(+) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoAction.idl b/offapi/com/sun/star/document/XUndoAction.idl index e844f527fceb..8449a24b9ca7 100755 --- a/offapi/com/sun/star/document/XUndoAction.idl +++ b/offapi/com/sun/star/document/XUndoAction.idl @@ -27,6 +27,8 @@ #ifndef __com_sun_star_document_XUndoAction_idl__ #define __com_sun_star_document_XUndoAction_idl__ +#include + //================================================================================================================== module com { module sun { module star { module document { -- cgit From 52831664bf32c86d9691712817a799fd33ae729e Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Fri, 15 Oct 2010 23:39:04 +0200 Subject: undoapi: deprecated those two (unused) exceptions --- offapi/com/sun/star/util/DiskFullException.idl | 2 +- offapi/com/sun/star/util/FileIOException.idl | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/util/DiskFullException.idl b/offapi/com/sun/star/util/DiskFullException.idl index 385a5d1f590a..43eda08302a2 100644 --- a/offapi/com/sun/star/util/DiskFullException.idl +++ b/offapi/com/sun/star/util/DiskFullException.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module util { //============================================================================= -/** is thrown when a disk full error occurs. +/** @deprecated */ published exception DiskFullException: com::sun::star::util::FileIOException { diff --git a/offapi/com/sun/star/util/FileIOException.idl b/offapi/com/sun/star/util/FileIOException.idl index 2b1d2ae31400..804c18094704 100644 --- a/offapi/com/sun/star/util/FileIOException.idl +++ b/offapi/com/sun/star/util/FileIOException.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module util { //============================================================================= -/** thrown when file I/O error occurs. +/** @deprecated */ published exception FileIOException: com::sun::star::uno::Exception { @@ -48,3 +48,4 @@ published exception FileIOException: com::sun::star::uno::Exception }; }; }; }; #endif + -- cgit From 460b79696a0111b89bc4ac9c41a0b37fdb621f16 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Fri, 15 Oct 2010 23:39:05 +0200 Subject: undoapi: API and Impl tweaks --- offapi/com/sun/star/document/XUndoManager.idl | 10 ++++++++-- offapi/com/sun/star/document/XUndoManagerListener.idl | 3 ++- 2 files changed, 10 insertions(+), 3 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index b937aa538e7a..2fbecdc6e3de 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -135,11 +135,14 @@ interface XUndoManager

If one or more undo contexts are currently open, those will be implicit @see redo + @throws ::com::sun::star::util::InvalidStateException + when the Undo stack is currently empty @throws ::com::sun::star::lang::WrappedTargetException if the invocation of XUndoAction::undo raises an exception other than a RuntimeException */ void undo() - raises( ::com::sun::star::lang::WrappedTargetException ); + raises( ::com::sun::star::util::InvalidStateException, + ::com::sun::star::lang::WrappedTargetException ); /** replays the action on the document which has most recently been undone @@ -150,11 +153,14 @@ interface XUndoManager

@see undo + @throws ::com::sun::star::util::InvalidStateException + when the Redo stack is currently empty @throws ::com::sun::star::lang::WrappedTargetException if the invocation of XUndoAction::redo raises an exception other than a RuntimeException */ void redo() - raises( ::com::sun::star::lang::WrappedTargetException ); + raises( ::com::sun::star::util::InvalidStateException, + ::com::sun::star::lang::WrappedTargetException ); /** clears the undo and the redo stack. */ diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index 281b3911f65c..30373739c997 100755 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -28,6 +28,7 @@ #define __com_sun_star_document_XUndoManagerListener_idl__ #include +#include //================================================================================================================== @@ -39,7 +40,7 @@ module com { module sun { module star { module document { @see XUndoManager */ -interface XUndoManagerListener +interface XUndoManagerListener : ::com::sun::star::lang::XEventListener { /** is called when an Undo action is added to the Undo stack. -- cgit From a3963e83ea99eb1c7ee7f6b7bcadadd17961eb7c Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 19 Oct 2010 22:23:16 +0200 Subject: undoapi: added isUndo/RedoPossible / getCurrent/AllUndo/RedoTitle(s) to XUndoManager --- offapi/com/sun/star/document/XUndoManager.idl | 37 +++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 2fbecdc6e3de..1885068bf92c 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -162,6 +162,43 @@ interface XUndoManager raises( ::com::sun::star::util::InvalidStateException, ::com::sun::star::lang::WrappedTargetException ); + /** determines whether the Undo stack is currently non-empty. + */ + boolean isUndoPossible(); + + /** determines whether the Redo stack is currently non-empty. + */ + boolean isRedoPossible(); + + /** returns the title of the top-most action on the Undo stack + @throws ::com::sun::star::util::InvalidStateException + when the Undo stack is currently empty + @see XUndoAction::Title + */ + string getCurrentUndoActionTitle() + raises( ::com::sun::star::util::InvalidStateException ); + + /** returns the title of the top-most action on the Redo stack + + @throws ::com::sun::star::util::InvalidStateException + when the Redo stack is currently empty + @see XUndoAction::Title + */ + string getCurrentRedoActionTitle() + raises( ::com::sun::star::util::InvalidStateException ); + + /** returns the titles of all actions currently on the Undo stack, from top to bottom + @see XUndoAction::Title + */ + sequence< string > + getAllUndoActionTitles(); + + /** returns the titles of all actions currently on the Redo stack, from top to bottom + @see XUndoAction::Title + */ + sequence< string > + getAllRedoActionTitles(); + /** clears the undo and the redo stack. */ void clear(); -- cgit From 55c84d659987dce9e75b5bffdba8dfd34912bbdc Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Thu, 21 Oct 2010 12:12:16 +0200 Subject: undoapi: specified (and implemented and tested) what should happen when you leave an Undo context which does not have any elements --- offapi/com/sun/star/document/XUndoManager.idl | 5 +++++ offapi/com/sun/star/document/XUndoManagerListener.idl | 12 +++++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 1885068bf92c..4abfbc891140 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -98,6 +98,11 @@ interface XUndoManager /** leaves the undo context previously opened via enterUndoContext respectively enterHiddenUndoContext. +

If no Undo action has been added since the context has been opened, the context is not only left, + but silently removed, and does not contribute to the Undo stack at all. In this case, possible + listeners will be notified via XUndoManagerListener::cancelledUndoContext, + instead of XUndoManagerListener::leftUndoContext.

+ @throws ::com::sun::star::util::InvalidStateException if no undo context is currently open. diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index 30373739c997..460fd3dcefd1 100755 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -88,7 +88,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener */ void enteredHiddenUndoContext( [in] UndoManagerEvent i_event ); - /** is called when a new Undo context has been entered. + /** is called when an Undo context has been left.

UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and UndoManagerEvent::UndoContextDepth the number of open Undo contexts, exluding the @@ -97,6 +97,16 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener @see XUndoManager::leaveUndoContext */ void leftUndoContext( [in] UndoManagerEvent i_event ); + + /** is called when an Undo context has been left, but no actions have been added within this context. + +

In such a case, the context which has just been left will not contribute to the Undo stack, but instead + be silently removed.

+ + @see XUndoManager::leaveUndoContext + @see leftUndoContext + */ + void cancelledUndoContext( [in] UndoManagerEvent i_event ); }; //================================================================================================================== -- cgit From c15d04604ad25cfd9bc55a5034660542dca76b90 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Fri, 22 Oct 2010 15:00:38 +0200 Subject: undoapi: spelling --- offapi/com/sun/star/util/XBroadcaster.idl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/util/XBroadcaster.idl b/offapi/com/sun/star/util/XBroadcaster.idl index feb09fe6124f..a622fcef7b98 100644 --- a/offapi/com/sun/star/util/XBroadcaster.idl +++ b/offapi/com/sun/star/util/XBroadcaster.idl @@ -50,7 +50,7 @@ interface XBroadcaster: com::sun::star::uno::XInterface XBroadcaster::unlockBroadcasts() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, no broadcasts are - send to registered listeners. + sent to registered listeners.

*/ [oneway] void lockBroadcasts(); @@ -64,10 +64,10 @@ interface XBroadcaster: com::sun::star::uno::XInterface XBroadcaster::unlockBroadcasts() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, no broadcasts are - send to registered listeners. + sent to registered listeners.

-

Pending broadcasts will be send immediately after the last +

Pending broadcasts will be sent immediately after the last call to XBroadcaster::lockBroadcast() is matched by a call to XBroadcaster::unlockBroadcasts(). An implementation can decide to broadcast all pending notification in -- cgit From 9ede458a168649ca20cf5558c2b618a94e40ecf9 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Fri, 22 Oct 2010 15:33:15 +0200 Subject: undoapi: added locking support to the XUndoManager --- offapi/com/sun/star/document/XUndoManager.idl | 91 +++++++++++++++++++++++++-- 1 file changed, 85 insertions(+), 6 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 4abfbc891140..c30049fc520d 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -40,7 +40,36 @@ interface XUndoManagerListener; //================================================================================================================== -/** provides access to the undo/redo stacks of the document +/** provides access to the undo/redo stacks of a document + +

Undo

+

Changes to a document usually result in recording of information how to undo those changes, if desired. A so-called + Undo action records the information how to undo a single change. Undo actions are maintained in a stack, so that + the changes they represent can be undo in the reverse order they have originally been applied.

+ +

Redo

+

Additionally, the Undo manager manages a Redo stack: Actions which are undone are moved from the Undo to the Redo + stack, so it is possible to re-apply the changes to the document.

+ +

Undo contexts

+

For collecting multiple changes in a single Undo action, so-called Undo contexts are provided. When an Undo + context is entered, all subsequently added Undo actions are not pushed onto the Undo stack directly, but considered + a sub action of the Undo context. Once the Undo context is left, a single Undo action is pushed onto the Undo stack, + which comprises all those single Undo actions.
+ Undo contexts can be arbitrarily nested.

+ +

Hidden Undo actions

+

Hidden Undo actions are those which in no observable way contribute to the Undo stack. That is, + any method retrieving information about the stack will behave as if the Undo action does not exist. Nonetheless, + calling undo respectively redo will include those actions.
+ Hidden Undo actions can be created by calling enterHiddenUndoContext, following by + leaveUndoContext.

+ + +

Locking

+

An Undo manager can be locked and unlocked, using the lock and unlock methods. + When it is locked, then every attempt to add an Undo action, or to enter or leave an Undo context, will be silently + ignored.

*/ interface XUndoManager { @@ -48,7 +77,7 @@ interface XUndoManager

A new undo action will be added to the undo stack, with the title given as i_title. As long as the context is not left, every undo action added to the stack will be treated as sub action. This means - it will not be directly accessible at the undo manager, not appear in any user interface, and cannot be + it will not be directly accessible at the Undo manager, not appear in any user interface, and cannot be separately undone or re-done.

Each call to enterUndoContext must be paired by a call to leaveUndoContext, @@ -57,6 +86,8 @@ interface XUndoManager

Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext and enterHiddenUndoContext multiple times without calling leaveUndoContext inbetween.

+

The redo stack is cleared when a new Undo context is entered.

+ @see leaveUndoContext */ void enterUndoContext( @@ -85,6 +116,8 @@ interface XUndoManager

Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext and enterHiddenUndoContext multiple times without calling leaveUndoContext inbetween.

+

The redo stack is cleared when a new hidden Undo context is entered.

+ @throws ::com::sun::star::util::InvalidStateException if the Undo stack is currently empty, in which case it is impossible to push a hidden Undo action onto it. @@ -116,11 +149,14 @@ interface XUndoManager

The redo stack is cleared when a new action is pushed onto the undo stack.

-

The undo manager takes ownership of any actions pushed onto the undo stack. This means that if the - action is finally removed from the undo manager's control (e.g. by calling clear resp. +

The Undo manager takes ownership of any actions pushed onto the undo stack. This means that if the + action is finally removed from the Undo manager's control (e.g. by calling clear resp. clearRedo), it will be disposed, as long as it supports the XComponent interface.

+

If the Undo manager is locked at the moment the method is called, the call will be ignored, and the Undo action + will immediately be disposed, if applicable.

+ @throws ::com::sun::star::lang::IllegalArgumentException if the given undo action is . */ @@ -139,11 +175,13 @@ interface XUndoManager

If one or more undo contexts are currently open, those will be implicit - @see redo @throws ::com::sun::star::util::InvalidStateException when the Undo stack is currently empty + @throws ::com::sun::star::lang::WrappedTargetException if the invocation of XUndoAction::undo raises an exception other than a RuntimeException + + @see redo */ void undo() raises( ::com::sun::star::util::InvalidStateException, @@ -157,11 +195,13 @@ interface XUndoManager

  • move this action from the redo stack to the undo stack

    • - @see undo @throws ::com::sun::star::util::InvalidStateException when the Redo stack is currently empty + @throws ::com::sun::star::lang::WrappedTargetException if the invocation of XUndoAction::redo raises an exception other than a RuntimeException + + @see undo */ void redo() raises( ::com::sun::star::util::InvalidStateException, @@ -176,8 +216,10 @@ interface XUndoManager boolean isRedoPossible(); /** returns the title of the top-most action on the Undo stack + @throws ::com::sun::star::util::InvalidStateException when the Undo stack is currently empty + @see XUndoAction::Title */ string getCurrentUndoActionTitle() @@ -199,19 +241,56 @@ interface XUndoManager getAllUndoActionTitles(); /** returns the titles of all actions currently on the Redo stack, from top to bottom + @see XUndoAction::Title */ sequence< string > getAllRedoActionTitles(); /** clears the undo and the redo stack. + +

    All actions will be removed from both the Undo and the Redo stack. Actions which implement the + XComponent interface will be disposed.

    */ void clear(); /** clears the redo stack. + +

    All actions will be removed from the Redo stack. Actions which implement the XComponent + interface will be disposed.

    */ void clearRedo(); + /** locks the Undo manager + +

    lock and unlock calls can be nested. However, they must be in + pairs. As long as there has been one more call to lock than to unlock, the + Undo manager is considered locked.

    + + @see unlock + @see isLocked + */ + void lock(); + + /** unlocks the Undo manager + + @throws ::com::sun::star::util::InvalidStateException + if the Undo manager is not currently locked. + + @see lock + @see isLocked + */ + void unlock() + raises ( ::com::sun::star::util::InvalidStateException + ); + + /** determines whether the Undo manager is currently locked. + + @see lock + @see unlock + */ + boolean isLocked(); + /** adds a listener to be notified of changes in the Undo/Redo stacks. */ void addUndoManagerListener( -- cgit From c90d7a8bc8525741ea7b3bbd2bf6e3ca34d0f011 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Mon, 25 Oct 2010 11:48:17 +0200 Subject: undoapi: defined, implemented, and tested the exception handling for XUndoAction/Manager::Undo --- offapi/com/sun/star/document/XUndoManagerListener.idl | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index 460fd3dcefd1..c018b9474506 100755 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -47,23 +47,31 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener

    Note that the action must not necessarily be the new top element of the stack: In case there's an open Undo context, UndoManagerEvent::UndoContextDepth will be greater 0, and the newly added action will be subordinate of the context action.

    + + @see XUndoManager::addUndoAction */ void undoActionAdded( [in] UndoManagerEvent i_event ); /** is called when the top-most action of the Undo stack has been undone. + + @see XUndoManager::undo */ void actionUndone( [in] UndoManagerEvent i_event ); /** is called when the top-most action of the Redo stack has been redone. + + @see XUndoManager::redo */ void actionRedone( [in] UndoManagerEvent i_event ); /** is called when both the Undo and the Redo stack have been cleared from all Undo actions. + @see XUndoManager::clear */ void allActionsCleared( [in] ::com::sun::star::lang::EventObject i_event ); /** is called when the the Redo stack has been cleared. + @see XUndoManager::clearRedo */ void redoActionsCleared( [in] ::com::sun::star::lang::EventObject i_event ); @@ -95,6 +103,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener one just left.

    @see XUndoManager::leaveUndoContext + @see cancelledUndoContext */ void leftUndoContext( [in] UndoManagerEvent i_event ); -- cgit From 57c21148af2d385ce8b40207b33f0518f4a38378 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Mon, 25 Oct 2010 12:48:42 +0200 Subject: undoapi: implementation/tests for hidden Undo contexts --- offapi/com/sun/star/document/XUndoManagerListener.idl | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index c018b9474506..4917bd83d645 100755 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -103,10 +103,22 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener one just left.

    @see XUndoManager::leaveUndoContext + @see leftHiddenUndocontext @see cancelledUndoContext */ void leftUndoContext( [in] UndoManagerEvent i_event ); + /** is calledn when a hidden Undo context has been left. + +

    UndoManagerEvent::UndoActionTitle is empty, as hidden Undo contexts don't have + a title.

    + + @see XUndoManager::leaveHiddenUndoContext + @see leftUndoContext + @see cancelledUndoContext + */ + void leftHiddenUndoContext( [in] UndoManagerEvent i_event ); + /** is called when an Undo context has been left, but no actions have been added within this context.

    In such a case, the context which has just been left will not contribute to the Undo stack, but instead @@ -114,6 +126,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener @see XUndoManager::leaveUndoContext @see leftUndoContext + @see leftHiddenUndocontext */ void cancelledUndoContext( [in] UndoManagerEvent i_event ); }; -- cgit From b28ad987327d89ec393168d68d044be0405081c3 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Mon, 25 Oct 2010 13:53:25 +0200 Subject: undoapi: renamings, API docs --- offapi/com/sun/star/document/UndoManagerEvent.idl | 2 +- offapi/com/sun/star/document/XUndoManager.idl | 44 +++++++++++----------- .../com/sun/star/document/XUndoManagerListener.idl | 28 +++++++------- 3 files changed, 36 insertions(+), 38 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/UndoManagerEvent.idl b/offapi/com/sun/star/document/UndoManagerEvent.idl index a95c0707ba33..e587669e4fbd 100755 --- a/offapi/com/sun/star/document/UndoManagerEvent.idl +++ b/offapi/com/sun/star/document/UndoManagerEvent.idl @@ -43,7 +43,7 @@ module com { module sun { module star { module document { */ struct UndoManagerEvent : ::com::sun::star::lang::EventObject { - /** the title of the Undo action which is described by the event + /** the title of the undo action which is described by the event @see XUndoAction::Title */ string UndoActionTitle; diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index c30049fc520d..1c8b29083f94 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -44,7 +44,7 @@ interface XUndoManagerListener;

    Undo

    Changes to a document usually result in recording of information how to undo those changes, if desired. A so-called - Undo action records the information how to undo a single change. Undo actions are maintained in a stack, so that + undo action records the information how to undo a single change. Undo actions are maintained in a stack, so that the changes they represent can be undo in the reverse order they have originally been applied.

    Redo

    @@ -52,15 +52,15 @@ interface XUndoManagerListener; stack, so it is possible to re-apply the changes to the document.

    Undo contexts

    -

    For collecting multiple changes in a single Undo action, so-called Undo contexts are provided. When an Undo - context is entered, all subsequently added Undo actions are not pushed onto the Undo stack directly, but considered - a sub action of the Undo context. Once the Undo context is left, a single Undo action is pushed onto the Undo stack, +

    For collecting multiple changes in a single undo action, so-called Undo contexts are provided. When an Undo + context is entered, all subsequently added Undo actions are not pushed onto the undo stack directly, but considered + a sub action of the Undo context. Once the Undo context is left, a single undo action is pushed onto the undo stack, which comprises all those single Undo actions.
    Undo contexts can be arbitrarily nested.

    Hidden Undo actions

    -

    Hidden Undo actions are those which in no observable way contribute to the Undo stack. That is, - any method retrieving information about the stack will behave as if the Undo action does not exist. Nonetheless, +

    Hidden Undo actions are those which in no observable way contribute to the undo stack. That is, + any method retrieving information about the stack will behave as if the undo action does not exist. Nonetheless, calling undo respectively redo will include those actions.
    Hidden Undo actions can be created by calling enterHiddenUndoContext, following by leaveUndoContext.

    @@ -68,7 +68,7 @@ interface XUndoManagerListener;

    Locking

    An Undo manager can be locked and unlocked, using the lock and unlock methods. - When it is locked, then every attempt to add an Undo action, or to enter or leave an Undo context, will be silently + When it is locked, then every attempt to add an undo action, or to enter or leave an Undo context, will be silently ignored.

    */ interface XUndoManager @@ -94,11 +94,11 @@ interface XUndoManager [in] string i_title ); - /** enters a new undo context, creating a hidden Undo action. + /** enters a new undo context, creating a hidden undo action. -

    A hidden Undo action does not, in any visible way, contribute to the Undo stack. This means +

    A hidden undo action does not, in any visible way, contribute to the undo stack. This means that -

    • Calling undo when the top-element is a hidden Undo action will transparently +
      • Calling undo when the top-element is a hidden undo action will transparently undo this action, and also undo the new top element of the stack.
      • Calling redo when the top-element is a hidden action will transparently redo this action, and also redo the new top element of the stack.
        • @@ -119,7 +119,7 @@ interface XUndoManager

        The redo stack is cleared when a new hidden Undo context is entered.

        @throws ::com::sun::star::util::InvalidStateException - if the Undo stack is currently empty, in which case it is impossible to push a hidden Undo action onto + if the undo stack is currently empty, in which case it is impossible to push a hidden undo action onto it. @see emterUndoContext @@ -131,10 +131,10 @@ interface XUndoManager /** leaves the undo context previously opened via enterUndoContext respectively enterHiddenUndoContext. -

        If no Undo action has been added since the context has been opened, the context is not only left, - but silently removed, and does not contribute to the Undo stack at all. In this case, possible - listeners will be notified via XUndoManagerListener::cancelledUndoContext, - instead of XUndoManagerListener::leftUndoContext.

        +

        If no undo action has been added since the context has been opened, the context is not only left, + but silently removed, and does not contribute to the undo stack at all. In this case, possible + listeners will be notified via XUndoManagerListener::cancelledContext, + instead of XUndoManagerListener::leftContext.

        @throws ::com::sun::star::util::InvalidStateException if no undo context is currently open. @@ -154,7 +154,7 @@ interface XUndoManager clearRedo), it will be disposed, as long as it supports the XComponent interface.

        -

        If the Undo manager is locked at the moment the method is called, the call will be ignored, and the Undo action +

        If the Undo manager is locked at the moment the method is called, the call will be ignored, and the undo action will immediately be disposed, if applicable.

        @throws ::com::sun::star::lang::IllegalArgumentException @@ -173,10 +173,8 @@ interface XUndoManager
      • move this undo action from the undo stack to the redo stack

      -

      If one or more undo contexts are currently open, those will be implicit - @throws ::com::sun::star::util::InvalidStateException - when the Undo stack is currently empty + when the undo stack is currently empty @throws ::com::sun::star::lang::WrappedTargetException if the invocation of XUndoAction::undo raises an exception other than a RuntimeException @@ -207,7 +205,7 @@ interface XUndoManager raises( ::com::sun::star::util::InvalidStateException, ::com::sun::star::lang::WrappedTargetException ); - /** determines whether the Undo stack is currently non-empty. + /** determines whether the undo stack is currently non-empty. */ boolean isUndoPossible(); @@ -215,10 +213,10 @@ interface XUndoManager */ boolean isRedoPossible(); - /** returns the title of the top-most action on the Undo stack + /** returns the title of the top-most action on the undo stack @throws ::com::sun::star::util::InvalidStateException - when the Undo stack is currently empty + when the undo stack is currently empty @see XUndoAction::Title */ @@ -234,7 +232,7 @@ interface XUndoManager string getCurrentRedoActionTitle() raises( ::com::sun::star::util::InvalidStateException ); - /** returns the titles of all actions currently on the Undo stack, from top to bottom + /** returns the titles of all actions currently on the undo stack, from top to bottom @see XUndoAction::Title */ sequence< string > diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index 4917bd83d645..e08846035087 100755 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -42,7 +42,7 @@ module com { module sun { module star { module document { */ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener { - /** is called when an Undo action is added to the Undo stack. + /** is called when an undo action is added to the undo stack.

      Note that the action must not necessarily be the new top element of the stack: In case there's an open Undo context, UndoManagerEvent::UndoContextDepth will be greater 0, @@ -52,13 +52,13 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener */ void undoActionAdded( [in] UndoManagerEvent i_event ); - /** is called when the top-most action of the Undo stack has been undone. + /** is called when the top-most action of the undo stack has been undone. @see XUndoManager::undo */ void actionUndone( [in] UndoManagerEvent i_event ); - /** is called when the top-most action of the Redo stack has been redone. + /** is called when the top-most action of the Redo stack has been re-applied. @see XUndoManager::redo */ @@ -84,7 +84,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener @see XUndoManager::enterUndoContext */ - void enteredUndoContext( [in] UndoManagerEvent i_event ); + void enteredContext( [in] UndoManagerEvent i_event ); /** is called when a new hidden Undo context has been entered. @@ -94,7 +94,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener @see XUndoManager::enterUndoContext */ - void enteredHiddenUndoContext( [in] UndoManagerEvent i_event ); + void enteredHiddenContext( [in] UndoManagerEvent i_event ); /** is called when an Undo context has been left. @@ -104,9 +104,9 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener @see XUndoManager::leaveUndoContext @see leftHiddenUndocontext - @see cancelledUndoContext + @see cancelledContext */ - void leftUndoContext( [in] UndoManagerEvent i_event ); + void leftContext( [in] UndoManagerEvent i_event ); /** is calledn when a hidden Undo context has been left. @@ -114,21 +114,21 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener a title.

      @see XUndoManager::leaveHiddenUndoContext - @see leftUndoContext - @see cancelledUndoContext + @see leftContext + @see cancelledContext */ - void leftHiddenUndoContext( [in] UndoManagerEvent i_event ); + void leftHiddenContext( [in] UndoManagerEvent i_event ); /** is called when an Undo context has been left, but no actions have been added within this context. -

      In such a case, the context which has just been left will not contribute to the Undo stack, but instead +

      In such a case, the context which has just been left will not contribute to the undo stack, but instead be silently removed.

      @see XUndoManager::leaveUndoContext - @see leftUndoContext - @see leftHiddenUndocontext + @see leftContext + @see leftHiddenContext */ - void cancelledUndoContext( [in] UndoManagerEvent i_event ); + void cancelledContext( [in] UndoManagerEvent i_event ); }; //================================================================================================================== -- cgit From d4be10b3fab2ec80f137d1d86cd9dddd41506015 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Wed, 27 Oct 2010 12:23:48 +0200 Subject: undoapi: detailed the error handling --- .../sun/star/document/EmptyUndoStackException.idl | 51 +++++++++++ .../com/sun/star/document/NotLockedException.idl | 50 +++++++++++ .../document/UndoContextNotClosedException.idl | 51 +++++++++++ .../com/sun/star/document/UndoFailedException.idl | 56 +++++++++++++ offapi/com/sun/star/document/XUndoAction.idl | 19 ++++- offapi/com/sun/star/document/XUndoManager.idl | 98 ++++++++++++++++------ .../com/sun/star/document/XUndoManagerListener.idl | 4 + offapi/com/sun/star/document/makefile.mk | 6 +- 8 files changed, 305 insertions(+), 30 deletions(-) create mode 100755 offapi/com/sun/star/document/EmptyUndoStackException.idl create mode 100755 offapi/com/sun/star/document/NotLockedException.idl create mode 100755 offapi/com/sun/star/document/UndoContextNotClosedException.idl create mode 100755 offapi/com/sun/star/document/UndoFailedException.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/document/EmptyUndoStackException.idl b/offapi/com/sun/star/document/EmptyUndoStackException.idl new file mode 100755 index 000000000000..e003d6af71b9 --- /dev/null +++ b/offapi/com/sun/star/document/EmptyUndoStackException.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_EmptyUndoStackException_idl__ +#define __com_sun_star_document_EmptyUndoStackException_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module document { + +//================================================================================================================== + +/** is raised when an operation is attemption at an XUndoManager which requires a non-empty stack + of undo actions, and this requirement is not fullfilled. + */ +exception EmptyUndoStackException : ::com::sun::star::util::InvalidStateException +{ +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/NotLockedException.idl b/offapi/com/sun/star/document/NotLockedException.idl new file mode 100755 index 000000000000..d739a6f52033 --- /dev/null +++ b/offapi/com/sun/star/document/NotLockedException.idl @@ -0,0 +1,50 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_NotLockedException_idl__ +#define __com_sun_star_document_NotLockedException_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module document { + +//================================================================================================================== + +/** is raised when attempt is made to unlock a lockable component which actually is not locked. + */ +exception NotLockedException : ::com::sun::star::util::InvalidStateException +{ +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/UndoContextNotClosedException.idl b/offapi/com/sun/star/document/UndoContextNotClosedException.idl new file mode 100755 index 000000000000..4f7d746bad1a --- /dev/null +++ b/offapi/com/sun/star/document/UndoContextNotClosedException.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_UndoContextNotClosedException_idl__ +#define __com_sun_star_document_UndoContextNotClosedException_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module document { + +//================================================================================================================== + +/** is thrown when an operation is attempted at an XUndoManager which requires all undo + contexts to be closed, but this requirement is not fullfilled. + */ +exception UndoContextNotClosedException : ::com::sun::star::util::InvalidStateException +{ +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/UndoFailedException.idl b/offapi/com/sun/star/document/UndoFailedException.idl new file mode 100755 index 000000000000..4489ac5a0e0d --- /dev/null +++ b/offapi/com/sun/star/document/UndoFailedException.idl @@ -0,0 +1,56 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_document_UndoFailedException_idl__ +#define __com_sun_star_document_UndoFailedException_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module document { + +//================================================================================================================== + +/** thrown when reverting to re-applying an undoable action fails. + + @see XUndoAction::undo + @see XUndoManager::undo + */ +exception UndoFailedException : ::com::sun::star::uno::Exception +{ + /** describes the reason why the operation failed. Usually, this member will carry an exception. + */ + any Reason; +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/document/XUndoAction.idl b/offapi/com/sun/star/document/XUndoAction.idl index 8449a24b9ca7..b47550a3f52f 100755 --- a/offapi/com/sun/star/document/XUndoAction.idl +++ b/offapi/com/sun/star/document/XUndoAction.idl @@ -28,6 +28,7 @@ #define __com_sun_star_document_XUndoAction_idl__ #include +#include //================================================================================================================== @@ -40,12 +41,26 @@ module com { module sun { module star { module document { interface XUndoAction { /** reverts the action represented by the instance + + @throws UndoFailedException + if reverting the action failed. In this case, the caller should assume that this is a permanent failure, + and take appropriate action, such as discarding the XUndoAction instance, and any possibly + depending instances. */ - void undo(); + void undo() + raises ( ::com::sun::star::document::UndoFailedException + ); /** repeats the action represented by the instance, after it had previously been reverted. + + @throws UndoFailedException + if repeating the action failed. In this case, the caller should assume that this is a permanent failure, + and take appropriate action, such as discarding the XUndoAction instance, and any possibly + depending instances. */ - void redo(); + void redo() + raises ( ::com::sun::star::document::UndoFailedException + ); /** is the human-readable, localized description of the action. */ diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 1c8b29083f94..890bf9b4b3c6 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -27,6 +27,10 @@ #ifndef __com_sun_star_document_XUndoManager_idl__ #define __com_sun_star_document_XUndoManager_idl__ +#include +#include +#include +#include #include #include #include @@ -118,7 +122,7 @@ interface XUndoManager

      The redo stack is cleared when a new hidden Undo context is entered.

      - @throws ::com::sun::star::util::InvalidStateException + @throws EmptyUndoStackException if the undo stack is currently empty, in which case it is impossible to push a hidden undo action onto it. @@ -126,7 +130,7 @@ interface XUndoManager @see leaveUndoContext */ void enterHiddenUndoContext() - raises( ::com::sun::star::util::InvalidStateException ); + raises( EmptyUndoStackException ); /** leaves the undo context previously opened via enterUndoContext respectively enterHiddenUndoContext. @@ -168,69 +172,86 @@ interface XUndoManager /** reverts the most recent action on the document.

      Effectively, invoking this method will -

      • close any undo contexts which are currently open

        -
      • invoke XUndoAction::undo on the top-most action of the undo stack
        • +
        • invoke XUndoAction::undo on the top-most action of the undo stack
        • move this undo action from the undo stack to the redo stack

        - @throws ::com::sun::star::util::InvalidStateException - when the undo stack is currently empty + @throws EmptyUndoStackException + if the undo stack is currently empty + + @throws UndoContextNotClosedException + if there currently is an open undo context - @throws ::com::sun::star::lang::WrappedTargetException - if the invocation of XUndoAction::undo raises an exception other than a RuntimeException + @throws UndoFailedException + if the invocation of XUndoAction::undo raised this exception. In this case, the undo stack + of the undo manager will have been cleared. @see redo + @see enterUndoContext */ void undo() - raises( ::com::sun::star::util::InvalidStateException, - ::com::sun::star::lang::WrappedTargetException ); + raises( ::com::sun::star::document::EmptyUndoStackException, + ::com::sun::star::document::UndoContextNotClosedException, + ::com::sun::star::document::UndoFailedException ); /** replays the action on the document which has most recently been undone

        Effectively, invoking this method will -

        • close any undo contexts which are currently open

          -
        • invoke XUndoAction::redo on the top-most action of the redo stack
          • +
          • invoke XUndoAction::redo on the top-most action of the redo stack
          • move this action from the redo stack to the undo stack

          - @throws ::com::sun::star::util::InvalidStateException + @throws EmptyUndoStackException when the Redo stack is currently empty - @throws ::com::sun::star::lang::WrappedTargetException - if the invocation of XUndoAction::redo raises an exception other than a RuntimeException + @throws UndoContextNotClosedException + if there currently is an open undo context + + @throws UndoFailedException + if the invocation of XUndoAction::redo raised this exception. In this case, the redo stack + of the undo manager will have been cleared. @see undo */ void redo() - raises( ::com::sun::star::util::InvalidStateException, - ::com::sun::star::lang::WrappedTargetException ); + raises( ::com::sun::star::document::EmptyUndoStackException, + ::com::sun::star::document::UndoContextNotClosedException, + ::com::sun::star::document::UndoFailedException ); - /** determines whether the undo stack is currently non-empty. + /** determines whether undo can reasonably be expected to succeed. + + @return + if and only if the undo stack is currently, empty, or there is an open and not-yet-closed + undo context. */ boolean isUndoPossible(); - /** determines whether the Redo stack is currently non-empty. + /** determines whether redo can reasonably be expected to succeed. + + @return + if and only if the redo stack is currently, empty, or there is an open and not-yet-closed + undo context. */ boolean isRedoPossible(); /** returns the title of the top-most action on the undo stack - @throws ::com::sun::star::util::InvalidStateException + @throws EmptyUndoStackException when the undo stack is currently empty @see XUndoAction::Title */ string getCurrentUndoActionTitle() - raises( ::com::sun::star::util::InvalidStateException ); + raises( ::com::sun::star::document::EmptyUndoStackException ); /** returns the title of the top-most action on the Redo stack - @throws ::com::sun::star::util::InvalidStateException + @throws EmptyUndoStackException when the Redo stack is currently empty @see XUndoAction::Title */ string getCurrentRedoActionTitle() - raises( ::com::sun::star::util::InvalidStateException ); + raises( ::com::sun::star::document::EmptyUndoStackException ); /** returns the titles of all actions currently on the undo stack, from top to bottom @see XUndoAction::Title @@ -249,15 +270,38 @@ interface XUndoManager

          All actions will be removed from both the Undo and the Redo stack. Actions which implement the XComponent interface will be disposed.

          + + @throws UndoContextNotClosedException + if the method is invoked while an undo context is still open */ - void clear(); + void clear() + raises( ::com::sun::star::document::UndoContextNotClosedException ); /** clears the redo stack.

          All actions will be removed from the Redo stack. Actions which implement the XComponent interface will be disposed.

          + + @throws UndoContextNotClosedException + if the method is invoked while an undo context is still open */ - void clearRedo(); + void clearRedo() + raises( ::com::sun::star::document::UndoContextNotClosedException ); + + /** resets the Undo manager + +

          In particular, this method will +

          • close all open undo contexts
            • +
          • clear the undo stack
            • +
          • clear the redo stack
            • +

          + +

          Note that possible listeners will not get notifications for the single parts of the reset, i.e. there + will be no single XUndoManagerListener::allActionsCleared, + XUndoManagerListener::leftContext, etc., notifications. Instead, listeners will be + notified of the reset by calling their XUndoManagerListener::resetAll method.

          + */ + void reset(); /** locks the Undo manager @@ -272,14 +316,14 @@ interface XUndoManager /** unlocks the Undo manager - @throws ::com::sun::star::util::InvalidStateException + @throws ::com::sun::star::document::NotLockedException if the Undo manager is not currently locked. @see lock @see isLocked */ void unlock() - raises ( ::com::sun::star::util::InvalidStateException + raises ( ::com::sun::star::document::NotLockedException ); /** determines whether the Undo manager is currently locked. diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index e08846035087..64c8c49db501 100755 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -76,6 +76,10 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener */ void redoActionsCleared( [in] ::com::sun::star::lang::EventObject i_event ); + /** called when the complete undo manager has been reset + */ + void resetAll( [in] ::com::sun::star::lang::EventObject i_event ); + /** is called when a new Undo context has been entered.

          UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and diff --git a/offapi/com/sun/star/document/makefile.mk b/offapi/com/sun/star/document/makefile.mk index 3a426123f1bf..ebef44407a94 100644 --- a/offapi/com/sun/star/document/makefile.mk +++ b/offapi/com/sun/star/document/makefile.mk @@ -119,7 +119,11 @@ IDLFILES=\ XUndoManager.idl \ XUndoManagerListener.idl \ XUndoManagerSupplier.idl \ - UndoManagerEvent.idl + UndoManagerEvent.idl \ + NotLockedException.idl \ + EmptyUndoStackException.idl \ + UndoContextNotClosedException.idl \ + UndoFailedException.idl \ # ------------------------------------------------------------------ -- cgit From b8ae0aaaf14f91ba8d0a7a70516b3da143c1ab57 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Wed, 27 Oct 2010 12:23:53 +0200 Subject: undoapi: outsourced locking functionality into a dedicated interface --- .../com/sun/star/document/NotLockedException.idl | 50 -------------- offapi/com/sun/star/document/XUndoManager.idl | 42 +++--------- offapi/com/sun/star/document/makefile.mk | 1 - offapi/com/sun/star/util/NotLockedException.idl | 50 ++++++++++++++ offapi/com/sun/star/util/XLockable.idl | 79 ++++++++++++++++++++++ offapi/com/sun/star/util/makefile.mk | 2 + 6 files changed, 139 insertions(+), 85 deletions(-) delete mode 100755 offapi/com/sun/star/document/NotLockedException.idl create mode 100755 offapi/com/sun/star/util/NotLockedException.idl create mode 100755 offapi/com/sun/star/util/XLockable.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/document/NotLockedException.idl b/offapi/com/sun/star/document/NotLockedException.idl deleted file mode 100755 index d739a6f52033..000000000000 --- a/offapi/com/sun/star/document/NotLockedException.idl +++ /dev/null @@ -1,50 +0,0 @@ -/************************************************************************* - * 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 - * - * for a copy of the LGPLv3 License. - * - ************************************************************************/ - -#ifndef __com_sun_star_document_NotLockedException_idl__ -#define __com_sun_star_document_NotLockedException_idl__ - -#include - -//================================================================================================================== - -module com { module sun { module star { module document { - -//================================================================================================================== - -/** is raised when attempt is made to unlock a lockable component which actually is not locked. - */ -exception NotLockedException : ::com::sun::star::util::InvalidStateException -{ -}; - -//================================================================================================================== - -}; }; }; }; - -//================================================================================================================== - -#endif diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 890bf9b4b3c6..d1fe4b2b65a0 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -28,10 +28,10 @@ #define __com_sun_star_document_XUndoManager_idl__ #include -#include #include #include #include +#include #include #include @@ -71,12 +71,16 @@ interface XUndoManagerListener;

          Locking

          -

          An Undo manager can be locked and unlocked, using the lock and unlock methods. - When it is locked, then every attempt to add an undo action, or to enter or leave an Undo context, will be silently - ignored.

          +

          An Undo manager can be locked and unlocked, using the XLockable::lock and + XLockable::unlock methods. When it is locked, then every attempt to add an undo action, or to + enter or leave an Undo context, will be silently ignored.

          */ interface XUndoManager { + /** allows locking the undo manager. + */ + interface ::com::sun::star::util::XLockable; + /** enters a new undo context.

          A new undo action will be added to the undo stack, with the title given as i_title. As long @@ -303,36 +307,6 @@ interface XUndoManager */ void reset(); - /** locks the Undo manager - -

          lock and unlock calls can be nested. However, they must be in - pairs. As long as there has been one more call to lock than to unlock, the - Undo manager is considered locked.

          - - @see unlock - @see isLocked - */ - void lock(); - - /** unlocks the Undo manager - - @throws ::com::sun::star::document::NotLockedException - if the Undo manager is not currently locked. - - @see lock - @see isLocked - */ - void unlock() - raises ( ::com::sun::star::document::NotLockedException - ); - - /** determines whether the Undo manager is currently locked. - - @see lock - @see unlock - */ - boolean isLocked(); - /** adds a listener to be notified of changes in the Undo/Redo stacks. */ void addUndoManagerListener( diff --git a/offapi/com/sun/star/document/makefile.mk b/offapi/com/sun/star/document/makefile.mk index ebef44407a94..1521e6b9513c 100644 --- a/offapi/com/sun/star/document/makefile.mk +++ b/offapi/com/sun/star/document/makefile.mk @@ -120,7 +120,6 @@ IDLFILES=\ XUndoManagerListener.idl \ XUndoManagerSupplier.idl \ UndoManagerEvent.idl \ - NotLockedException.idl \ EmptyUndoStackException.idl \ UndoContextNotClosedException.idl \ UndoFailedException.idl \ diff --git a/offapi/com/sun/star/util/NotLockedException.idl b/offapi/com/sun/star/util/NotLockedException.idl new file mode 100755 index 000000000000..b0917e0bdca6 --- /dev/null +++ b/offapi/com/sun/star/util/NotLockedException.idl @@ -0,0 +1,50 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_util_NotLockedException_idl__ +#define __com_sun_star_util_NotLockedException_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module util { + +//================================================================================================================== + +/** is raised when attempt is made to unlock a lockable component which actually is not locked. + */ +exception NotLockedException : ::com::sun::star::util::InvalidStateException +{ +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/util/XLockable.idl b/offapi/com/sun/star/util/XLockable.idl new file mode 100755 index 000000000000..e3da8025a034 --- /dev/null +++ b/offapi/com/sun/star/util/XLockable.idl @@ -0,0 +1,79 @@ +/************************************************************************* + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_util_XLockable_idl__ +#define __com_sun_star_util_XLockable_idl__ + +#include + +//================================================================================================================== + +module com { module sun { module star { module util { + +//================================================================================================================== + +/** allows locking a component + +

          lock and unlock calls can be nested. However, they must be in + pairs. As long as there has been one more call to lock than to unlock, the + component is considered locked, which is reflected by isLocked returning .

          + */ +interface XLockable +{ + /** locks the component + + @see unlock + @see isLocked + */ + void lock(); + + /** unlocks the component + + @throws NotLockedException + if the component is not currently locked. + + @see lock + @see isLocked + */ + void unlock() + raises ( NotLockedException + ); + + /** determines whether the component is currently locked. + + @see lock + @see unlock + */ + boolean isLocked(); +}; + +//================================================================================================================== + +}; }; }; }; + +//================================================================================================================== + +#endif diff --git a/offapi/com/sun/star/util/makefile.mk b/offapi/com/sun/star/util/makefile.mk index aa0374296ddb..87dc2d078037 100644 --- a/offapi/com/sun/star/util/makefile.mk +++ b/offapi/com/sun/star/util/makefile.mk @@ -145,6 +145,8 @@ IDLFILES=\ UriAbbreviation.idl\ XJobManager.idl\ JobManager.idl\ + XLockable.idl\ + NotLockedException.idl\ # ------------------------------------------------------------------ -- cgit From caeafe3596ab5ba76fe3cdcfb2e84fb4108752ee Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 2 Nov 2010 13:19:49 +0100 Subject: undoapi: allow retrieving the count/comments of Undo/Redo actions both on the current and the top level --- offapi/com/sun/star/document/XUndoManager.idl | 6 +++--- offapi/com/sun/star/document/XUndoManagerListener.idl | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index d1fe4b2b65a0..9d8b3e11974f 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -130,7 +130,7 @@ interface XUndoManager if the undo stack is currently empty, in which case it is impossible to push a hidden undo action onto it. - @see emterUndoContext + @see enterUndoContext @see leaveUndoContext */ void enterHiddenUndoContext() @@ -225,7 +225,7 @@ interface XUndoManager /** determines whether undo can reasonably be expected to succeed. @return - if and only if the undo stack is currently, empty, or there is an open and not-yet-closed + if and only if the undo stack is currently empty, or there is an open and not-yet-closed undo context. */ boolean isUndoPossible(); @@ -233,7 +233,7 @@ interface XUndoManager /** determines whether redo can reasonably be expected to succeed. @return - if and only if the redo stack is currently, empty, or there is an open and not-yet-closed + if and only if the redo stack is currently empty, or there is an open and not-yet-closed undo context. */ boolean isRedoPossible(); diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index 64c8c49db501..783e8e7014d8 100755 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -126,7 +126,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener /** is called when an Undo context has been left, but no actions have been added within this context.

          In such a case, the context which has just been left will not contribute to the undo stack, but instead - be silently removed.

          + be silently removed. Consequently, the UndoManagerEvent::UndoActionTitle is empty.

          @see XUndoManager::leaveUndoContext @see leftContext -- cgit From cfd5f04fbc428abbc99fb0036d93725c95dd5e76 Mon Sep 17 00:00:00 2001 From: Mihaela Kedikova Date: Tue, 2 Nov 2010 16:08:50 +0100 Subject: tabcontrol: changes regarding version and services --- offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl | 2 +- offapi/com/sun/star/awt/tab/UnoControlTabPage.idl | 2 +- offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl | 2 +- offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl | 2 +- offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl | 2 +- offapi/com/sun/star/awt/tab/XTabPage.idl | 2 +- offapi/com/sun/star/awt/tab/XTabPageContainer.idl | 2 +- offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl | 2 +- offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl | 2 +- offapi/com/sun/star/awt/tab/XTabPageModel.idl | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl b/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl index b52575537d6f..ef678395fe06 100644 --- a/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl +++ b/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module awt { module tab { /** An event used by a XTabPageContainer to notify changes in tab page activation. - @since OOo 3.3.0 + @since OOo 3.4 */ struct TabPageActivatedEvent: com::sun::star::lang::EventObject { diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPage.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPage.idl index 87add4c73c91..6244b18e0c77 100644 --- a/offapi/com/sun/star/awt/tab/UnoControlTabPage.idl +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPage.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module awt { module tab { /** specifies a TabPage control. - @since OOo 3.3.0 + @since OOo 3.4 */ service UnoControlTabPage diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl index 2ac4beff9b31..488ce4b5354a 100644 --- a/offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainer.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module awt { module tab { /** specifies a TabPageContainer control. - @since OOo 3.3.0 + @since OOo 3.4 */ service UnoControlTabPageContainer { diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl index 9f90e7c90454..b97b7881b416 100644 --- a/offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPageContainerModel.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module awt { module tab { /** specifies a model for a UnoControlTabPageContainer control. - @since OOo 3.3.0 + @since OOo 3.4 */ service UnoControlTabPageContainerModel { diff --git a/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl b/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl index 0f74e21865db..3508e33260c7 100644 --- a/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl +++ b/offapi/com/sun/star/awt/tab/UnoControlTabPageModel.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module awt { module tab { //============================================================================= /** specifies the standard model of a XTabPageModel. - @since OOo 3.3.0 + @since OOo 3.4 */ service UnoControlTabPageModel : XTabPageModel { diff --git a/offapi/com/sun/star/awt/tab/XTabPage.idl b/offapi/com/sun/star/awt/tab/XTabPage.idl index a76d85c5f7f7..616820071f5b 100644 --- a/offapi/com/sun/star/awt/tab/XTabPage.idl +++ b/offapi/com/sun/star/awt/tab/XTabPage.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module awt { module tab { @see UnoControlTabPage - @since OOo 3.3.0 + @since OOo 3.4 */ interface XTabPage { diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl index 65964337c43f..e62cf4c365c1 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module awt { module tab { @see UnoControlTabPageContainer - @since OOo 3.3.0 + @since OOo 3.4 */ interface XTabPageContainer { diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl b/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl index 5e256c3b999d..f46951231513 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module awt { module tab { /** An instance of this interface is used by the XTabPageContainer to get notifications about changes in activation of tab pages. - @since OOo 3.3.0 + @since OOo 3.4 */ interface XTabPageContainerListener: com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl b/offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl index ac9ff468af89..cc815209a01d 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainerModel.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module awt { module tab { /** specifies an interface for a UnoControlTabPageContainerModel. - @since OOo 3.3.0 + @since OOo 3.4 */ interface XTabPageContainerModel { diff --git a/offapi/com/sun/star/awt/tab/XTabPageModel.idl b/offapi/com/sun/star/awt/tab/XTabPageModel.idl index d9e688a79415..15fae422bb17 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageModel.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageModel.idl @@ -40,7 +40,7 @@ module com { module sun { module star { module awt { module tab { /** specifies an XTabPageModel interface. - @since OOo 3.3.0 + @since OOo 3.4 */ interface XTabPageModel -- cgit From f468ede49f6de848a1d877673fd411dbb330b2a0 Mon Sep 17 00:00:00 2001 From: Mihaela Kedikova Date: Mon, 8 Nov 2010 17:59:39 +0100 Subject: gridcontrol07: bugfixes for gridcontrol --- offapi/com/sun/star/awt/grid/UnoControlGridModel.idl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl index 7eea49624045..b9cf8745d96e 100644 --- a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl +++ b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl @@ -80,7 +80,7 @@ service UnoControlGridModel

          You can implement your own instance of XGridDataModel or use the DefaultGridDataModel. */ - [property] XGridDataModel DataModel; + [property] XGridDataModel GridDataModel; /** Specifies the vertical scrollbar mode.

          The default value is

          -- cgit From 0d112e4aeffecd8890f1938476c4a419d64a6060 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 9 Nov 2010 21:36:50 +0100 Subject: undoapi: step 0.0 of the migration of css.chart2.XUndoManager to css.document.XUndoManager: remove the unused XUndoHelper --- offapi/com/sun/star/chart2/XUndoHelper.idl | 90 ------------------------------ offapi/com/sun/star/chart2/makefile.mk | 1 - 2 files changed, 91 deletions(-) delete mode 100644 offapi/com/sun/star/chart2/XUndoHelper.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/chart2/XUndoHelper.idl b/offapi/com/sun/star/chart2/XUndoHelper.idl deleted file mode 100644 index 6c782564e04f..000000000000 --- a/offapi/com/sun/star/chart2/XUndoHelper.idl +++ /dev/null @@ -1,90 +0,0 @@ -/************************************************************************* - * - * 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 - * - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef com_sun_star_chart2_XUndoHelper_idl -#define com_sun_star_chart2_XUndoHelper_idl - -#include -#include -// #include - -module com -{ -module sun -{ -module star -{ -module chart2 -{ - -/** An interface for storing frame::XModel objects for container undo. - */ -interface XUndoHelper : ::com::sun::star::uno::XInterface -{ - /** call this before you change the xCurrentModel - - @return a clone of the current model that can later be used to - restore the state of a changed model - */ - ::com::sun::star::frame::XModel getModelCloneForUndo( - [in] ::com::sun::star::frame::XModel xModelBeforeChange ); - - /** call this before you change the xCurrentModel. You can pass - parameters to refine the information that is cloned. - - @return a clone of the current model that can later be used to - restore the state of a changed model using the same - arguments in applyModelContentWithArguments. - */ -// ::com::sun::star::frame::XModel getModelCloneForUndoWithArguments( -// [in] ::com::sun::star::frame::XModel xModelBeforeChange, -// [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ); - - /** apply the content of xModelToCopyFrom to the XModel in xModelToChange - */ - void applyModelContent( [inout] ::com::sun::star::frame::XModel xModelToChange, - [in] ::com::sun::star::frame::XModel xModelToCopyFrom ); - - /** apply the content of xModelToCopyFrom to the XModel in - xModelToChange. You can pass parameters to refine the - information that is applied. - -

          Note that xModelToCopyFrom should have been created with - getModelCloneForUndoWithArguments using the same arguments as - are passed here.

          - */ -// void applyModelContentWithArguments( -// [inout] ::com::sun::star::frame::XModel xModelToChange, -// [in] ::com::sun::star::frame::XModel xModelToCopyFrom, -// [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ); -}; - -} ; // chart2 -} ; // com -} ; // sun -} ; // star - -#endif diff --git a/offapi/com/sun/star/chart2/makefile.mk b/offapi/com/sun/star/chart2/makefile.mk index dcce7e71d4d2..2b2e87dbfbad 100644 --- a/offapi/com/sun/star/chart2/makefile.mk +++ b/offapi/com/sun/star/chart2/makefile.mk @@ -103,7 +103,6 @@ IDLFILES= \ XTransformation.idl \ XUndoManager.idl \ XUndoSupplier.idl \ - XUndoHelper.idl # --- Targets ------------------------------------------------------ -- cgit From a358dac4b7da1486051764c0e6c6e32f38193fa3 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 9 Nov 2010 21:36:54 +0100 Subject: undoapi: step 0.1 of the migration of css.chart2.XUndoManager to css.document.XUndoManager: remove the XModel paramter from the XUndoManager methods, they're an implicit attribute of the instance --- offapi/com/sun/star/chart2/XUndoManager.idl | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/chart2/XUndoManager.idl b/offapi/com/sun/star/chart2/XUndoManager.idl index 2d0ca4bd4977..9354fa4f7a54 100644 --- a/offapi/com/sun/star/chart2/XUndoManager.idl +++ b/offapi/com/sun/star/chart2/XUndoManager.idl @@ -28,7 +28,6 @@ #define com_sun_star_chart2_XUndoManager_idl #include -#include #include module com @@ -40,24 +39,23 @@ module star module chart2 { -/** An interface for undo functionality based on passing frame::XModel - objects. +/** An interface for undo functionality based on the model which the undo manager belongs to */ interface XUndoManager : ::com::sun::star::uno::XInterface { - /** call this before you change the xCurrentModel + /** call this before you change the model which the undo manager belongs to */ - void preAction( [in] ::com::sun::star::frame::XModel xModelBeforeChange ); + void preAction(); - /** call this before you change the xCurrentModel. You can pass + /** call this before you change the model which the undo manager belongs to. You can pass parameters to refine the undo action. */ - void preActionWithArguments( [in] ::com::sun::star::frame::XModel xModelBeforeChange, - [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ); + void preActionWithArguments( [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ); /** call this after you successfully did changes to your current model */ void postAction( [in] string aUndoText ); + /** call this if you aborted the current action. */ void cancelAction(); @@ -66,15 +64,15 @@ interface XUndoManager : ::com::sun::star::uno::XInterface state set in preAction. This is useful for cancellation in live-preview dialogs. */ - void cancelActionWithUndo( [inout] ::com::sun::star::frame::XModel xModelToRestore ); + void cancelActionWithUndo(); /** give the current model to be put into the redo-stack */ - void undo( [inout] ::com::sun::star::frame::XModel xCurrentModel ); + void undo(); /** give the current model to be put into the undo-stack */ - void redo( [inout] ::com::sun::star::frame::XModel xCurrentModel ); + void redo(); /** @return if the undo stack is not empty, i.e. a call to undo() will succeed */ -- cgit From 9037b3a4565a3739ca1c7b62fcf27ea8e917c046 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 9 Nov 2010 21:37:01 +0100 Subject: undoapi: step 2.0 of the migration of css.chart2.XUndoManager to css.document.XUndoManager: rename css.chart2.XUndoManager to XDocumentActions. Not sure this class will still exist (in either form) after the refactoring is finished. --- offapi/com/sun/star/chart2/XDocumentActions.idl | 109 ++++++++++++++++++++++++ offapi/com/sun/star/chart2/XUndoManager.idl | 109 ------------------------ offapi/com/sun/star/chart2/XUndoSupplier.idl | 57 ------------- offapi/com/sun/star/chart2/makefile.mk | 3 +- 4 files changed, 110 insertions(+), 168 deletions(-) create mode 100644 offapi/com/sun/star/chart2/XDocumentActions.idl delete mode 100644 offapi/com/sun/star/chart2/XUndoManager.idl delete mode 100644 offapi/com/sun/star/chart2/XUndoSupplier.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/chart2/XDocumentActions.idl b/offapi/com/sun/star/chart2/XDocumentActions.idl new file mode 100644 index 000000000000..c26ee34ee64e --- /dev/null +++ b/offapi/com/sun/star/chart2/XDocumentActions.idl @@ -0,0 +1,109 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef com_sun_star_chart2_XDocumentActions_idl +#define com_sun_star_chart2_XDocumentActions_idl + +#include +#include + +module com +{ +module sun +{ +module star +{ +module chart2 +{ + +/** An interface for undo functionality based on the model which the undo manager belongs to + */ +interface XDocumentActions : ::com::sun::star::uno::XInterface +{ + /** call this before you change the model which the undo manager belongs to + */ + void preAction(); + + /** call this before you change the model which the undo manager belongs to. You can pass + parameters to refine the undo action. + */ + void preActionWithArguments( [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ); + + /** call this after you successfully did changes to your current model + */ + void postAction( [in] string aUndoText ); + + /** call this if you aborted the current action. + */ + void cancelAction(); + + /** same as cancelAction() but restores the given model to the + state set in preAction. This is useful for cancellation in + live-preview dialogs. + */ + void cancelActionWithUndo(); + + /** give the current model to be put into the redo-stack + */ + void undo(); + + /** give the current model to be put into the undo-stack + */ + void redo(); + + /** @return if the undo stack is not empty, i.e. a call to undo() will succeed + */ + boolean undoPossible(); + + /** @return if the redo stack is not empty, i.e. a call to redo() will succeed + */ + boolean redoPossible(); + + /** Retrieves the undo string for the most recent undo step + */ + string getCurrentUndoString(); + + /** Retrieves the redo string for the most recent undo step + */ + string getCurrentRedoString(); + + /** Retrieves the undo strings of all stored undo actions in + chronological order starting with the most recent. + */ + sequence< string > getAllUndoStrings(); + + /** Retrieves the redo strings of all stored undo actions in + chronological order starting with the most recent. + */ + sequence< string > getAllRedoStrings(); +}; + +} ; // chart2 +} ; // com +} ; // sun +} ; // star + +#endif diff --git a/offapi/com/sun/star/chart2/XUndoManager.idl b/offapi/com/sun/star/chart2/XUndoManager.idl deleted file mode 100644 index 9354fa4f7a54..000000000000 --- a/offapi/com/sun/star/chart2/XUndoManager.idl +++ /dev/null @@ -1,109 +0,0 @@ -/************************************************************************* - * - * 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 - * - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef com_sun_star_chart2_XUndoManager_idl -#define com_sun_star_chart2_XUndoManager_idl - -#include -#include - -module com -{ -module sun -{ -module star -{ -module chart2 -{ - -/** An interface for undo functionality based on the model which the undo manager belongs to - */ -interface XUndoManager : ::com::sun::star::uno::XInterface -{ - /** call this before you change the model which the undo manager belongs to - */ - void preAction(); - - /** call this before you change the model which the undo manager belongs to. You can pass - parameters to refine the undo action. - */ - void preActionWithArguments( [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ); - - /** call this after you successfully did changes to your current model - */ - void postAction( [in] string aUndoText ); - - /** call this if you aborted the current action. - */ - void cancelAction(); - - /** same as cancelAction() but restores the given model to the - state set in preAction. This is useful for cancellation in - live-preview dialogs. - */ - void cancelActionWithUndo(); - - /** give the current model to be put into the redo-stack - */ - void undo(); - - /** give the current model to be put into the undo-stack - */ - void redo(); - - /** @return if the undo stack is not empty, i.e. a call to undo() will succeed - */ - boolean undoPossible(); - - /** @return if the redo stack is not empty, i.e. a call to redo() will succeed - */ - boolean redoPossible(); - - /** Retrieves the undo string for the most recent undo step - */ - string getCurrentUndoString(); - - /** Retrieves the redo string for the most recent undo step - */ - string getCurrentRedoString(); - - /** Retrieves the undo strings of all stored undo actions in - chronological order starting with the most recent. - */ - sequence< string > getAllUndoStrings(); - - /** Retrieves the redo strings of all stored undo actions in - chronological order starting with the most recent. - */ - sequence< string > getAllRedoStrings(); -}; - -} ; // chart2 -} ; // com -} ; // sun -} ; // star - -#endif diff --git a/offapi/com/sun/star/chart2/XUndoSupplier.idl b/offapi/com/sun/star/chart2/XUndoSupplier.idl deleted file mode 100644 index 901ca49ad74f..000000000000 --- a/offapi/com/sun/star/chart2/XUndoSupplier.idl +++ /dev/null @@ -1,57 +0,0 @@ -/************************************************************************* - * - * 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 - * - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef com_sun_star_chart2_XUndoSupplier_idl -#define com_sun_star_chart2_XUndoSupplier_idl - -#include - -module com -{ -module sun -{ -module star -{ -module chart2 -{ - -/** An interface for providing an UndoManager based on frame::XModel - objects. - */ -interface XUndoSupplier : ::com::sun::star::uno::XInterface -{ - /** @return an undo manager that allows doing undo and redo of a - frame::XModel based object - */ - XUndoManager getUndoManager(); -}; - -} ; // chart2 -} ; // com -} ; // sun -} ; // star - -#endif diff --git a/offapi/com/sun/star/chart2/makefile.mk b/offapi/com/sun/star/chart2/makefile.mk index 2b2e87dbfbad..e646e2c74d74 100644 --- a/offapi/com/sun/star/chart2/makefile.mk +++ b/offapi/com/sun/star/chart2/makefile.mk @@ -101,8 +101,7 @@ IDLFILES= \ XTitle.idl \ XTitled.idl \ XTransformation.idl \ - XUndoManager.idl \ - XUndoSupplier.idl \ + XDocumentActions.idl \ # --- Targets ------------------------------------------------------ -- cgit From 5cee5c1628048b352c2c6c170c518f11cbdb953b Mon Sep 17 00:00:00 2001 From: "Thomas Lange [tl]" Date: Wed, 10 Nov 2010 14:26:24 +0100 Subject: cws tl84: #i114751# fingerprint data for Serbian --- offapi/com/sun/star/linguistic2/XLanguageGuessing.idl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/linguistic2/XLanguageGuessing.idl b/offapi/com/sun/star/linguistic2/XLanguageGuessing.idl index b6b618d5a01e..5535c6e98569 100644 --- a/offapi/com/sun/star/linguistic2/XLanguageGuessing.idl +++ b/offapi/com/sun/star/linguistic2/XLanguageGuessing.idl @@ -81,6 +81,7 @@ module com { module sun { module star { module linguistic2 {
        • ka : Georgian
        • ko : Korean
        • la : Latin
          • +
        • lb : Luxembourgish (added with OOo 3.3)
        • lt : Lithuanian
        • lv : Latvian
        • mr : Marathi
          • @@ -96,10 +97,11 @@ module com { module sun { module star { module linguistic2 {
        • ru : Russian
        • sa : Sanskrit
        • sco : Scots
          • -
        • sh-YU : Serbian (written with latin characters)
          • +
        • sh : Serbian (written with latin characters)
        • sk-SK : Slovak (written with latin characters)
        • sl : Slovenian
        • sq : Albanian
          • +
        • sr : Serbian (written with cyrillic characters) (added with OOo 3.4)
        • sv : Swedish
        • sw : Swahili
        • ta : Tamil
          • -- cgit From c44e3b9bd00e8a48a575167776ab9d5ab1c7d29d Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Mon, 15 Nov 2010 22:12:48 +0100 Subject: undoapi: step 2.2 of the migration of css.chart2.XUndoManager to css.document.XUndoManager: base the implementation of XDocumentActions on the document's UndoManager --- offapi/com/sun/star/chart2/XDocumentActions.idl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/chart2/XDocumentActions.idl b/offapi/com/sun/star/chart2/XDocumentActions.idl index c26ee34ee64e..22104917a1cd 100644 --- a/offapi/com/sun/star/chart2/XDocumentActions.idl +++ b/offapi/com/sun/star/chart2/XDocumentActions.idl @@ -29,6 +29,7 @@ #include #include +#include module com { @@ -50,7 +51,8 @@ interface XDocumentActions : ::com::sun::star::uno::XInterface /** call this before you change the model which the undo manager belongs to. You can pass parameters to refine the undo action. */ - void preActionWithArguments( [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ); + void preActionWithArguments( [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ) + raises ( ::com::sun::star::lang::IllegalArgumentException ); /** call this after you successfully did changes to your current model */ -- cgit From 346f21a522ef4ceb5ab397c7433f54cfea898956 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 16 Nov 2010 08:49:38 +0100 Subject: undoapi: step 2.3 of the migration of css.chart2.XUndoManager to css.document.XUndoManager: migrate the clients of XDocumentActions to using the new XUndoManager, and completely remove the (X)DocumentActions still some more cleanup needed --- offapi/com/sun/star/chart2/XDocumentActions.idl | 111 ------------------------ offapi/com/sun/star/chart2/makefile.mk | 1 - 2 files changed, 112 deletions(-) delete mode 100644 offapi/com/sun/star/chart2/XDocumentActions.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/chart2/XDocumentActions.idl b/offapi/com/sun/star/chart2/XDocumentActions.idl deleted file mode 100644 index 22104917a1cd..000000000000 --- a/offapi/com/sun/star/chart2/XDocumentActions.idl +++ /dev/null @@ -1,111 +0,0 @@ -/************************************************************************* - * - * 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 - * - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef com_sun_star_chart2_XDocumentActions_idl -#define com_sun_star_chart2_XDocumentActions_idl - -#include -#include -#include - -module com -{ -module sun -{ -module star -{ -module chart2 -{ - -/** An interface for undo functionality based on the model which the undo manager belongs to - */ -interface XDocumentActions : ::com::sun::star::uno::XInterface -{ - /** call this before you change the model which the undo manager belongs to - */ - void preAction(); - - /** call this before you change the model which the undo manager belongs to. You can pass - parameters to refine the undo action. - */ - void preActionWithArguments( [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments ) - raises ( ::com::sun::star::lang::IllegalArgumentException ); - - /** call this after you successfully did changes to your current model - */ - void postAction( [in] string aUndoText ); - - /** call this if you aborted the current action. - */ - void cancelAction(); - - /** same as cancelAction() but restores the given model to the - state set in preAction. This is useful for cancellation in - live-preview dialogs. - */ - void cancelActionWithUndo(); - - /** give the current model to be put into the redo-stack - */ - void undo(); - - /** give the current model to be put into the undo-stack - */ - void redo(); - - /** @return if the undo stack is not empty, i.e. a call to undo() will succeed - */ - boolean undoPossible(); - - /** @return if the redo stack is not empty, i.e. a call to redo() will succeed - */ - boolean redoPossible(); - - /** Retrieves the undo string for the most recent undo step - */ - string getCurrentUndoString(); - - /** Retrieves the redo string for the most recent undo step - */ - string getCurrentRedoString(); - - /** Retrieves the undo strings of all stored undo actions in - chronological order starting with the most recent. - */ - sequence< string > getAllUndoStrings(); - - /** Retrieves the redo strings of all stored undo actions in - chronological order starting with the most recent. - */ - sequence< string > getAllRedoStrings(); -}; - -} ; // chart2 -} ; // com -} ; // sun -} ; // star - -#endif diff --git a/offapi/com/sun/star/chart2/makefile.mk b/offapi/com/sun/star/chart2/makefile.mk index e646e2c74d74..438a81756713 100644 --- a/offapi/com/sun/star/chart2/makefile.mk +++ b/offapi/com/sun/star/chart2/makefile.mk @@ -101,7 +101,6 @@ IDLFILES= \ XTitle.idl \ XTitled.idl \ XTransformation.idl \ - XDocumentActions.idl \ # --- Targets ------------------------------------------------------ -- cgit From 00f0883d4763957e20c5116375654a7978510124 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 16 Nov 2010 12:22:48 +0100 Subject: undoapi: derive XUndoManager from XChild, to allow convenient access to the document it belongs to --- offapi/com/sun/star/document/XUndoManager.idl | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 9d8b3e11974f..5ac7118dc51d 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -32,6 +32,7 @@ #include #include #include +#include #include #include @@ -81,6 +82,13 @@ interface XUndoManager */ interface ::com::sun::star::util::XLockable; + /** allows accessing the component, usually a document, which the undo manager works for. + +

          XChild::setParent is not supported, and will throw + an NoSupportException.

          + */ + interface ::com::sun::star::container::XChild; + /** enters a new undo context.

          A new undo action will be added to the undo stack, with the title given as i_title. As long -- cgit From 7af6d80401076742888e210e6c690a568ab3934e Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Tue, 16 Nov 2010 22:35:25 +0100 Subject: undoapi: make reset an explicit, atomar operation at the IUndoManager, instead of simulating it in a higher layer --- offapi/com/sun/star/document/XUndoManager.idl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 5ac7118dc51d..9b485b93c4c1 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -303,7 +303,8 @@ interface XUndoManager /** resets the Undo manager

          In particular, this method will -

          • close all open undo contexts
            • +
            • remove all locks from the undo manager
              • +
            • close all open undo contexts
            • clear the undo stack
            • clear the redo stack

            -- cgit From 5fee0ab21c6b405da560cf4b78b6058230bcffa6 Mon Sep 17 00:00:00 2001 From: "Ingrid Halama [iha]" Date: Tue, 30 Nov 2010 01:45:03 +0100 Subject: chart46: #i25706# implement date axis --- offapi/com/sun/star/chart/ChartAxis.idl | 22 ++++ offapi/com/sun/star/chart/ChartAxisType.idl | 57 +++++++++ offapi/com/sun/star/chart/TimeIncrement.idl | 67 +++++++++++ offapi/com/sun/star/chart/TimeInterval.idl | 57 +++++++++ offapi/com/sun/star/chart/TimeUnit.idl | 50 ++++++++ offapi/com/sun/star/chart/XDateCategories.idl | 70 +++++++++++ offapi/com/sun/star/chart/makefile.mk | 5 + offapi/com/sun/star/chart2/AxisType.idl | 3 + offapi/com/sun/star/chart2/Break.idl | 46 -------- .../com/sun/star/chart2/ExplicitIncrementData.idl | 96 ---------------- offapi/com/sun/star/chart2/ExplicitScaleData.idl | 45 -------- .../com/sun/star/chart2/ExplicitSubIncrement.idl | 30 ----- offapi/com/sun/star/chart2/IncrementData.idl | 4 - offapi/com/sun/star/chart2/ScaleData.idl | 36 +++--- offapi/com/sun/star/chart2/SubIncrement.idl | 4 - .../com/sun/star/chart2/XAnyDescriptionAccess.idl | 103 +++++++++++++++++ offapi/com/sun/star/chart2/XPlotter.idl | 128 --------------------- offapi/com/sun/star/chart2/makefile.mk | 6 +- 18 files changed, 451 insertions(+), 378 deletions(-) create mode 100644 offapi/com/sun/star/chart/ChartAxisType.idl create mode 100644 offapi/com/sun/star/chart/TimeIncrement.idl create mode 100644 offapi/com/sun/star/chart/TimeInterval.idl create mode 100644 offapi/com/sun/star/chart/TimeUnit.idl create mode 100755 offapi/com/sun/star/chart/XDateCategories.idl delete mode 100644 offapi/com/sun/star/chart2/Break.idl delete mode 100644 offapi/com/sun/star/chart2/ExplicitIncrementData.idl delete mode 100644 offapi/com/sun/star/chart2/ExplicitScaleData.idl delete mode 100644 offapi/com/sun/star/chart2/ExplicitSubIncrement.idl create mode 100755 offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl delete mode 100644 offapi/com/sun/star/chart2/XPlotter.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/chart/ChartAxis.idl b/offapi/com/sun/star/chart/ChartAxis.idl index 4e564d848b9d..816bb92af003 100644 --- a/offapi/com/sun/star/chart/ChartAxis.idl +++ b/offapi/com/sun/star/chart/ChartAxis.idl @@ -55,6 +55,14 @@ #include #endif +#ifndef __com_sun_star_chart_ChartAxisType_idl__ +#include +#endif + +#ifndef __com_sun_star_chart_TimeIncrement_idl__ +#include +#endif + #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_ #include #endif @@ -169,6 +177,20 @@ published service ChartAxis //------------------------------------------------------------------------- + /** determines which type of axis this is, e.g. a date-axis or a category-axis @see ChartAxisType + @since OOo 3.4 + */ + [optional, property] long AxisType; + + //------------------------------------------------------------------------- + + /** if the current axis is a date-time the intervals are choosen as given with TimeIncrement + @since OOo 3.4 + */ + [optional, maybevoid, property] TimeIncrement TimeIncrement; + + //------------------------------------------------------------------------- + /** Determines if the axis orientation is mathematical or reversed. */ [optional, property] boolean ReverseDirection; diff --git a/offapi/com/sun/star/chart/ChartAxisType.idl b/offapi/com/sun/star/chart/ChartAxisType.idl new file mode 100644 index 000000000000..e705424115e8 --- /dev/null +++ b/offapi/com/sun/star/chart/ChartAxisType.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef com_sun_star_chart_ChartAxisType_idl +#define com_sun_star_chart_ChartAxisType_idl + +module com +{ +module sun +{ +module star +{ +module chart +{ +/** @since OOo 3.4 +*/ +published constants ChartAxisType +{ + /** the type of the axis is choosen automatically dependent on the chart type, the dimension and the underlying data + */ + const long AUTOMATIC = 0; + + /** the axis represent discrete category texts if chart type and the dimension allows + */ + const long CATEGORY = 1; + + /** the axis shows dates if the given data and chart type and the dimension allows + */ + const long DATE = 2; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/TimeIncrement.idl b/offapi/com/sun/star/chart/TimeIncrement.idl new file mode 100644 index 000000000000..3eba8d903c63 --- /dev/null +++ b/offapi/com/sun/star/chart/TimeIncrement.idl @@ -0,0 +1,67 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef com_sun_star_chart_TimeIncrement_idl +#define com_sun_star_chart_TimeIncrement_idl + +#include + +//============================================================================= + +module com { module sun { module star { module chart { + +//============================================================================= + +/** A TimeIncrement describes how tickmarks are positioned on the scale of a date-time axis. +@since OOo 3.4 +*/ +published struct TimeIncrement +{ + /** if the any contains a struct of type ::com::sun::star::chart::TimeInterval + this is used as a fixed distance value for the major tickmarks. Otherwise, if the any is empty or contains an + incompatible type, the distance between major tickmarks is calculated automatically by the application. + */ + any MajorTimeInterval; + + /** if the any contains a struct of type ::com::sun::star::chart::TimeInterval + this is used as a fixed distance value for the minor tickmarks. Otherwise, if the any is empty or contains an + incompatible type, the distance between minor tickmarks is calculated automatically by the application. + */ + any MinorTimeInterval; + + /** if the any contains a constant of type ::com::sun::star::chart::TimeUnit + this is the smallest time unit that is displayed on the date-time axis. + Otherwise, if the any is empty or contains an incompatible type, + the resolution is choosen automatically by the application. + */ + any TimeResolution; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/TimeInterval.idl b/offapi/com/sun/star/chart/TimeInterval.idl new file mode 100644 index 000000000000..565a46d8b4b7 --- /dev/null +++ b/offapi/com/sun/star/chart/TimeInterval.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef com_sun_star_chart_TimeInterval_idl +#define com_sun_star_chart_TimeInterval_idl + +#include + +//============================================================================= + +module com { module sun { module star { module chart { + +//============================================================================= + +/** Describes an interval on a date-time axis +@since OOo 3.4 +*/ +published struct TimeInterval +{ + /** specifies the number of units + */ + long Number; + + /** specifies a unit for the interval +

            is a value out of the constant group ::com::sun::star::chart::TimeUnit.

            + */ + long TimeUnit; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/TimeUnit.idl b/offapi/com/sun/star/chart/TimeUnit.idl new file mode 100644 index 000000000000..37cbd55d1a94 --- /dev/null +++ b/offapi/com/sun/star/chart/TimeUnit.idl @@ -0,0 +1,50 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_chart_TimeUnit_idl__ +#define __com_sun_star_chart_TimeUnit_idl__ + +//============================================================================= + + module com { module sun { module star { module chart { + +//============================================================================= + +/** Specifies a unit for intervals on a date-time axis +@since OOo 3.4 + */ +published constants TimeUnit +{ + const long DAY = 0; + const long MONTH = 1; + const long YEAR = 2; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/XDateCategories.idl b/offapi/com/sun/star/chart/XDateCategories.idl new file mode 100755 index 000000000000..868670cb9c6f --- /dev/null +++ b/offapi/com/sun/star/chart/XDateCategories.idl @@ -0,0 +1,70 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_chart_XDateCategories_idl__ +#define __com_sun_star_chart_XDateCategories_idl__ + +#include + +//============================================================================= + + module com { module sun { module star { module chart { + +//============================================================================= + +/** Allows to set date values as categories. + +

            Can be obtained from interface XChartDocument via method getData().

            + +@since OOo 3.4 +*/ + +published interface XDateCategories +{ + //------------------------------------------------------------------------- + + /** sets dates as categories + + @param rDates + a sequence of sequences of doubles representing dates. + */ + void setDateCategories( [in] sequence< double > rDates ); + + //------------------------------------------------------------------------- + + /** retrieves the date values if the category x-axis id a date axis + + @returns + a sequence of doubles representing dates. + */ + sequence< double > getDateCategories(); +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/makefile.mk b/offapi/com/sun/star/chart/makefile.mk index fdbf07173c5e..b05edf2ad5dd 100644 --- a/offapi/com/sun/star/chart/makefile.mk +++ b/offapi/com/sun/star/chart/makefile.mk @@ -52,6 +52,7 @@ IDLFILES=\ ChartAxisPosition.idl\ ChartAxisLabelPosition.idl\ ChartAxisMarkPosition.idl\ + ChartAxisType.idl\ ChartAxisXSupplier.idl\ ChartAxisYSupplier.idl\ ChartAxisZSupplier.idl\ @@ -84,6 +85,7 @@ IDLFILES=\ ChartTwoAxisXSupplier.idl\ ChartTwoAxisYSupplier.idl\ DataLabelPlacement.idl\ + TimeIncrement.idl \ Diagram.idl\ Dim3DDiagram.idl\ DonutDiagram.idl\ @@ -94,6 +96,8 @@ IDLFILES=\ PieDiagram.idl\ StackableDiagram.idl\ StockDiagram.idl\ + TimeUnit.idl\ + TimeInterval.idl\ X3DDefaultSetter.idl\ X3DDisplay.idl\ XAxisXSupplier.idl\ @@ -104,6 +108,7 @@ IDLFILES=\ XChartDataChangeEventListener.idl\ XChartDocument.idl\ XComplexDescriptionAccess.idl\ + XDateCategories.idl\ XDiagram.idl\ XDiagramPositioning.idl\ XStatisticDisplay.idl\ diff --git a/offapi/com/sun/star/chart2/AxisType.idl b/offapi/com/sun/star/chart2/AxisType.idl index 16d977c34801..47cebc96388e 100644 --- a/offapi/com/sun/star/chart2/AxisType.idl +++ b/offapi/com/sun/star/chart2/AxisType.idl @@ -50,6 +50,9 @@ constants AxisType /** the axis shows the series names (z axis) */ const long SERIES = 3; + /** the axis shows dates + */ + const long DATE = 4; }; } ; // chart2 diff --git a/offapi/com/sun/star/chart2/Break.idl b/offapi/com/sun/star/chart2/Break.idl deleted file mode 100644 index b5dbe80d2933..000000000000 --- a/offapi/com/sun/star/chart2/Break.idl +++ /dev/null @@ -1,46 +0,0 @@ -/************************************************************************* - * - * 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 - * - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef com_sun_star_chart2_Break_idl -#define com_sun_star_chart2_Break_idl - -//============================================================================= - -module com { module sun { module star { module chart2 { - -//============================================================================= - -struct Break -{ - double Min; - double Max; -}; - -//============================================================================= - -}; }; }; }; - -#endif diff --git a/offapi/com/sun/star/chart2/ExplicitIncrementData.idl b/offapi/com/sun/star/chart2/ExplicitIncrementData.idl deleted file mode 100644 index 48f01c7560c4..000000000000 --- a/offapi/com/sun/star/chart2/ExplicitIncrementData.idl +++ /dev/null @@ -1,96 +0,0 @@ -#ifndef com_sun_star_chart2_ExplicitIncrementData_idl -#define com_sun_star_chart2_ExplicitIncrementData_idl - -#include - -//============================================================================= - -module com { module sun { module star { module chart2 { - -//============================================================================= - -/** An Increment describes how tickmarks are positioned on the scale of an axis. - -@see Axis -@see Grid -@see Scale -@see XScaling -*/ -struct ExplicitIncrementData -{ - /** Distance describes the distance between two - neighboring main tickmarks on a Scale of an axis. - All neighboring main tickmarks have the same constant distance. - -

            If the Scale has a XScaling the Distance - may be measured in two different ways - that is - before or after the - scaling is applied.

            - -

            On a logarithmic scale for example the distance between two main - tickmarks is typically measured after the scaling is applied: - Distance = log(tick2)-log(tick1) - ( log(1000)-log(100)==log(100)-log(10)==log(10)-log(1)==1==Distance ). - The resulting tickmarks will always look equidistant on the screen. - The other possibility is to have a Distance = tick2-tick1 measured constant - before a scaling is applied, which may lead to non equidistant tickmarks - on the screen.

            - -

            PostEquidistant rules wether the Distance - is meant to be a value before or after scaling.

            - */ - double Distance; - - /** - PostEquidistant rules wether the member Distance - describes a distance before or after the scaling is applied. - -

            If PostEquidistant equals Distance - is given in values after XScaling is applied, thus resulting - main tickmarks will always look equidistant on the screen. - If PostEquidistant equals Distance - is given in values before XScaling is applied.

            - */ - boolean PostEquidistant; - - /** The BaseValue gives a starting point on the scale - to which all further main tickmarks are relatively positioned. - -

            The BaseValue is always a value on the scale before - a possible scaling is applied. If the given value is not valid in the - associated scaling the minimum of the scaling is assumed, - if there is no minimum any other obvious value will be assumed.

            - -

            E.g.: assume a scale from 0 to 6 with identical scaling. - Further assume this Increment to have Distance==2 and PostEquidistant==false. - Setting BaseValue=0 would lead to main tickmarks 0; 2; 4; 6; - Setting BaseValue=1,3 would lead to main tickmarks 1,3; 3,3; 5,3; - Setting BaseValue=-0,7 would also lead to main tickmarks 1,3; 3,3; 5,3; - And setting BaseValue to 2, -2, 4, -4 etc. in this example - leads to the same result as BaseValue=0.

            - */ - double BaseValue; - - /** SubIncrements describes the positioning of further - sub tickmarks on the scale of an axis. - -

            The first SubIncrement in this sequence determines how the - distance between two neighboring main tickmarks is divided for positioning - of further sub tickmarks. Every following SubIncrement determines the - positions of subsequent tickmarks in relation to their parent tickmarks - iven by the preceding SubIncrement.

            - */ - sequence< ::com::sun::star::chart2::ExplicitSubIncrement > SubIncrements; - - /** If ShiftedPosition is false all ticks are set at the positions as described above. - E.g. having tickmarks for whole numbers 1, 2 and 3 the ticks are exactly placed on positions for the values 1, 2 and 3. - In contrast it is possible to have the tickmarks shifted thus they are placed between the indicated values. - So if ShiftedPosition is set to true the tickmarks in the example are placed at 0.5 1.5 2.5 and 3.5. - */ - boolean ShiftedPosition; -}; - -//============================================================================= - -}; }; }; }; - -#endif diff --git a/offapi/com/sun/star/chart2/ExplicitScaleData.idl b/offapi/com/sun/star/chart2/ExplicitScaleData.idl deleted file mode 100644 index 7639a4d33378..000000000000 --- a/offapi/com/sun/star/chart2/ExplicitScaleData.idl +++ /dev/null @@ -1,45 +0,0 @@ -#ifndef com_sun_star_chart2_ExplicitScaleData_idl -#define com_sun_star_chart2_ExplicitScaleData_idl - -#ifndef com_sun_star_chart2_Break_idl -#include -#endif - -#ifndef com_sun_star_chart2_XScaling_idl -#include -#endif - -#ifndef com_sun_star_chart2_AxisOrientation_idl -#include -#endif - -//============================================================================= - -module com { module sun { module star { module chart2 { - -//============================================================================= - -/** This structure contains the explicit values for a scale like Minimum and Maximum. - In contrast these values may also be implicit (automatically - calculated) as indicated within the structure ScaleData. - */ -struct ExplicitScaleData -{ - double Minimum; - double Maximum; - double Origin; - - AxisOrientation Orientation; - - XScaling Scaling; - - sequence< Break > Breaks; - - long AxisType; -}; - -//============================================================================= - -}; }; }; }; - -#endif diff --git a/offapi/com/sun/star/chart2/ExplicitSubIncrement.idl b/offapi/com/sun/star/chart2/ExplicitSubIncrement.idl deleted file mode 100644 index c1af626c5db1..000000000000 --- a/offapi/com/sun/star/chart2/ExplicitSubIncrement.idl +++ /dev/null @@ -1,30 +0,0 @@ -#ifndef com_sun_star_chart2_ExplicitSubIncrement_idl -#define com_sun_star_chart2_ExplicitSubIncrement_idl - -//============================================================================= - -module com { module sun { module star { module chart2 { - -//============================================================================= - -struct ExplicitSubIncrement -{ - /** Numbers of intervals between two superior ticks. For an axis - this usually means, that IntervalCount - 1 - sub-tick-marks are displayed between two superior ticks. - - */ - long IntervalCount; - - /** If , the distance between two sub-tick-marks on the - screen is always the same. If , the distances may - differ depending on the XScaling. - */ - boolean PostEquidistant; -}; - -//============================================================================= - -}; }; }; }; - -#endif diff --git a/offapi/com/sun/star/chart2/IncrementData.idl b/offapi/com/sun/star/chart2/IncrementData.idl index f487c26e576d..ffd595807ce9 100644 --- a/offapi/com/sun/star/chart2/IncrementData.idl +++ b/offapi/com/sun/star/chart2/IncrementData.idl @@ -23,8 +23,6 @@ struct IncrementData incompatible type, the Distance is meant to be calculated automatically by the view component representing the model containing this increment. - - @see ExplicitIncrementData */ any Distance; @@ -45,8 +43,6 @@ struct IncrementData incompatible type, the BaseValue is meant to be calculated automatically by the view component representing the model containing this increment. - - @see ExplicitIncrementData */ any BaseValue; diff --git a/offapi/com/sun/star/chart2/ScaleData.idl b/offapi/com/sun/star/chart2/ScaleData.idl index addd66e10320..9bb51005e206 100644 --- a/offapi/com/sun/star/chart2/ScaleData.idl +++ b/offapi/com/sun/star/chart2/ScaleData.idl @@ -1,29 +1,12 @@ #ifndef com_sun_star_chart2_ScaleData_idl #define com_sun_star_chart2_ScaleData_idl -#ifndef com_sun_star_chart2_Break_idl -#include -#endif - -#ifndef com_sun_star_chart2_XScaling_idl #include -#endif - -#ifndef com_sun_star_chart2_AxisOrientation_idl #include -#endif - -#ifndef com_sun_star_chart2_data_XLabeledDataSequence_idl #include -#endif - -#ifndef com_sun_star_chart2_AxisType_idl #include -#endif - -#ifndef com_sun_star_chart_IncrementData_idl #include -#endif +#include //============================================================================= @@ -76,8 +59,6 @@ struct ScaleData XScaling Scaling; - sequence< Break > Breaks; - data::XLabeledDataSequence Categories; /** describes the type of the axis. @@ -87,7 +68,22 @@ struct ScaleData */ long AxisType; + /** if true an AxisType CATEGORY is interpreted as DATE if the underlying data given in Categories are dates + */ + boolean AutoDateAxis; + + /** describes wether data points on category or date axis are placed between tickmarks or not + if true the maximum on the scale will be expanded for one interval + */ + boolean ShiftedCategoryPosition; + + /** increment data to be used for not date-time axis + */ IncrementData IncrementData; + + /** increment data to be used in case of date-time axis + */ + ::com::sun::star::chart::TimeIncrement TimeIncrement; }; //============================================================================= diff --git a/offapi/com/sun/star/chart2/SubIncrement.idl b/offapi/com/sun/star/chart2/SubIncrement.idl index f076db0eef92..b886f2c531fb 100644 --- a/offapi/com/sun/star/chart2/SubIncrement.idl +++ b/offapi/com/sun/star/chart2/SubIncrement.idl @@ -11,15 +11,11 @@ struct SubIncrement { /** should contain nothing for auto, or an integer value for an explicit interval count. - - @see ExplicitSubIncrement */ any IntervalCount; /** should contain nothing for auto, or a boolean value for an explicit setting. - - @see ExplicitSubIncrement */ any PostEquidistant; }; diff --git a/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl b/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl new file mode 100755 index 000000000000..ca455c401264 --- /dev/null +++ b/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl @@ -0,0 +1,103 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_chart2_XAnyDescriptionAccess_idl__ +#define __com_sun_star_chart2_XAnyDescriptionAccess_idl__ + +#ifndef __com_sun_star_chart_XComplexDescriptionAccess_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module chart2 { + +//============================================================================= + +/** Offers any access to column and row descriptions. +This allows to set date values as categories. + +

            Can be obtained from interface XChartDocument via method getData().

            + +@since OOo 3.4 +*/ + +interface XAnyDescriptionAccess : ::com::sun::star::chart::XComplexDescriptionAccess +{ + //------------------------------------------------------------------------- + + /** retrieves the descriptions for all rows. + + @returns + a sequence of sequences of anys representing the descriptions + of all rows. The outer index represents different rows. + The inner index represents the different levels (usually there is only one). + The any might be strings for category text axis or doubles for date axis. + */ + sequence< sequence< any > > getAnyRowDescriptions(); + + //------------------------------------------------------------------------- + + /** sets the descriptions for all rows. + + @param rRowDescriptions + a sequence of sequences of anys representing the descriptions of all + rows. The outer index represents different rows. + The inner index represents the different levels (usually there is only one). + The any might be strings for category text axis or doubles for date axis. + */ + void setAnyRowDescriptions( [in] sequence< sequence< any > > rRowDescriptions ); + + //------------------------------------------------------------------------- + + /** retrieves the descriptions for all columns. + + @returns + a sequence of sequences of anys representing the descriptions + of all columns. The outer index represents different columns. + The inner index represents the different levels (usually there is only one). + The any might be strings for category text axis or doubles for date axis. + */ + sequence< sequence< any > > getAnyColumnDescriptions(); + + //------------------------------------------------------------------------- + + /** sets the descriptions for all columns. + + @param rColumnDescriptions + a sequence of sequences of anys which represent the descriptions of + all columns. The outer index represents different columns. + The inner index represents the different levels (usually there is only one). + The any might be strings for category text axis or doubles for date axis. + */ + void setAnyColumnDescriptions( [in] sequence< sequence< any > > rColumnDescriptions ); +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart2/XPlotter.idl b/offapi/com/sun/star/chart2/XPlotter.idl deleted file mode 100644 index dfa77e09c38e..000000000000 --- a/offapi/com/sun/star/chart2/XPlotter.idl +++ /dev/null @@ -1,128 +0,0 @@ -#ifndef com_sun_star_chart2_XPlotter_idl -#define com_sun_star_chart2_XPlotter_idl - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include -#endif - -#ifndef __com_sun_star_drawing_XShapes_idl__ -#include -#endif - -#ifndef _com_sun_star_drawing_XShapeGrouper_idl_ -#include -#endif - -#ifndef _com_sun_star_lang_xmultiservicefactory_idl_ -#include -#endif - -#ifndef com_sun_star_chart2_CoordinateSystemTypeID_idl -#include -#endif - -#ifndef com_sun_star_chart2_ScaleData_idl -#include -#endif - -#ifndef com_sun_star_chart2_XTransformation_idl -#include -#endif - -//============================================================================= - -module com { module sun { module star { module chart2 { - -//============================================================================= - -/** The main task of a Plotter is to create grafic objects which have a certain - logic place within a coordinate system. For example the bars of a barchart - are such grafic objects. The created grafic objects need to be of type - com::sun::star::drawing::Shape. - -

            - Within the chart application we differentiatebetween two 'types' of shapes - which can be created by a Plotter. - The first type are shapes which are completely defined by coordinates - in the logic coordinate system and will be positioned within this logic - coordinate system. Those shapes are called 'logic shapes' - or 'logically placed shapes'. For example a rectangle of a bar chart - is a 'logic shape'. -

            - -

            - The second type of shapes are those who can not or should not - be placed in the logic coordinate system. For example consider a three - dimensional bar chart with text labels for each data point. You probably - would not like to place the text shapes as three dimensional objects within - the logic coordinate system, rather you would like to position the texts as - two dimensional objects on the two dimensional final page. Those shapes are - called 'illogic shapes' in contrast to 'logic shapes'. - 'Illogic shapes' are always two dimensional and placed on the documents page. -

            - -

            - For each type of shapes the Plotter gets one Target where it can add - or remove shapes. -

            - -

            A Plotter is not allowed to set the property 'Transformation' on a - shape as this will be done elsewhere. -

            -*/ - -//@ todo ? should this be a XComponent? -interface XPlotter : ::com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - /** Each Plotter implicit uses a certain type of logic coordinate - system for interpreting data as coordinates. - For example a bar-chart uses a cartesian coordinate system for - interpreting x- and y-values from a spreadsheet as cartesian - coordinates. In contrast the pie chart assumes a polar coordinate - system. - The type of this implicit used source coordinate system has to be - returned here. - The returned type of an implementation never changes. - */ - CoordinateSystemTypeID getCoordinateSystemTypeID(); - - //------------------------------------------------------------------------- - /** For each type of shapes ('logic' or 'illogic') there exists one - container. The Plotter will create shapes and then add (or remove) - them from these containers. - -

            - The lifetime of the container has to be handled by the calling object. The - calling object must assure that the container will exist longer than the - XPlotter Object. -

            - ... - */ - void init( [in] com::sun::star::drawing::XShapes xLogicTarget - , [in] com::sun::star::drawing::XShapes xFinalTarget - , [in] com::sun::star::lang::XMultiServiceFactory xFactory ); - - //------------------------------------------------------------------------- - /** For each dimension of the 'logic source coordinate system' the - XPlotter object needs a Scale to decide which shapes - need to be created and maybe logically clipped. The XPlotter object - becomes the new owner of the given scales and directions and needs to keep - them alive. Nobody else will change them. - Pay attention that a 'Scale' can have several breaks. - */ - void setScales( [in] sequence< ScaleData > rScales); - - //------------------------------------------------------------------------- - /** - */ - void setTransformation( [in] XTransformation xTransformationToLogicTarget - , [in] XTransformation xTransformationToFinalPage ); -}; - -//============================================================================= - -}; }; }; }; - -#endif - diff --git a/offapi/com/sun/star/chart2/makefile.mk b/offapi/com/sun/star/chart2/makefile.mk index dcce7e71d4d2..33071a594338 100644 --- a/offapi/com/sun/star/chart2/makefile.mk +++ b/offapi/com/sun/star/chart2/makefile.mk @@ -41,14 +41,10 @@ PRJNAME=offapi IDLFILES= \ AxisType.idl \ AxisOrientation.idl \ - Break.idl \ CoordinateSystemTypeID.idl \ CurveStyle.idl \ DataPointGeometry3D.idl \ DataPointLabel.idl \ - ExplicitIncrementData.idl \ - ExplicitScaleData.idl \ - ExplicitSubIncrement.idl \ FillBitmap.idl \ IncrementData.idl \ InterpretedData.idl \ @@ -67,6 +63,7 @@ IDLFILES= \ TickmarkStyle.idl \ TransparencyStyle.idl \ ViewLegendEntry.idl \ + XAnyDescriptionAccess.idl\ XAxis.idl \ XCoordinateSystem.idl \ XCoordinateSystemContainer.idl \ @@ -91,7 +88,6 @@ IDLFILES= \ XLegend.idl \ XLegendEntry.idl \ XLegendSymbolProvider.idl \ - XPlotter.idl \ XRegressionCurve.idl \ XRegressionCurveCalculator.idl \ XRegressionCurveContainer.idl \ -- cgit From 24f500ecd35320078a8bfa5dbb6d753ffc6b69a2 Mon Sep 17 00:00:00 2001 From: "Ingrid Halama [iha]" Date: Tue, 30 Nov 2010 19:17:18 +0100 Subject: chart46: #i25706# implement date axis - some docu issues --- offapi/com/sun/star/chart/ChartAxis.idl | 2 +- offapi/com/sun/star/chart/TimeInterval.idl | 2 +- offapi/com/sun/star/chart/XChartDocument.idl | 7 +++++++ 3 files changed, 9 insertions(+), 2 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/chart/ChartAxis.idl b/offapi/com/sun/star/chart/ChartAxis.idl index 816bb92af003..42a93cb96d50 100644 --- a/offapi/com/sun/star/chart/ChartAxis.idl +++ b/offapi/com/sun/star/chart/ChartAxis.idl @@ -184,7 +184,7 @@ published service ChartAxis //------------------------------------------------------------------------- - /** if the current axis is a date-time the intervals are choosen as given with TimeIncrement + /** if the current axis is a date-axis the intervals are choosen as given with TimeIncrement @since OOo 3.4 */ [optional, maybevoid, property] TimeIncrement TimeIncrement; diff --git a/offapi/com/sun/star/chart/TimeInterval.idl b/offapi/com/sun/star/chart/TimeInterval.idl index 565a46d8b4b7..c1280f815655 100644 --- a/offapi/com/sun/star/chart/TimeInterval.idl +++ b/offapi/com/sun/star/chart/TimeInterval.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module chart { //============================================================================= -/** Describes an interval on a date-time axis +/** Describes an interval on a date-axis @since OOo 3.4 */ published struct TimeInterval diff --git a/offapi/com/sun/star/chart/XChartDocument.idl b/offapi/com/sun/star/chart/XChartDocument.idl index 14322c6edf4a..1ffd268be59d 100644 --- a/offapi/com/sun/star/chart/XChartDocument.idl +++ b/offapi/com/sun/star/chart/XChartDocument.idl @@ -144,9 +144,12 @@ published interface XChartDocument: com::sun::star::frame::XModel

            Since OOo 3.3 the returned object also supports interface XComplexDescriptionAccess which can be used to access complex hierarchical axis descriptions.

            +

            Since OOo 3.4 the returned object also supports interface XDateCategories.

            + @see XChartData @see XChartDataArray @see XComplexDescriptionAccess + @see XDateCategories */ com::sun::star::chart::XChartData getData(); @@ -159,12 +162,16 @@ published interface XChartDocument: com::sun::star::frame::XModel

            Since OOo 3.3 if the given object might support interface XComplexDescriptionAccess which allows to set complex hierarchical axis descriptions.

            +

            Since OOo 3.4 if the given object might support interface XDateCategories + which allows to set date values as x values for category charts.

            +

            The given data is copied before it is applied to the chart. So changing xData after this call will have no effect on the chart.

            @see XChartData @see XChartDataArray @see XComplexDescriptionAccess + @see XDateCategories @param xData the object that provides the new data. -- cgit From fd8593ad2d504fe354c0cba1e91bfbaa4f354304 Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Wed, 1 Dec 2010 15:30:01 +0100 Subject: undoapi: clear the redo stack when leaving an Undo context resp. list action, not when entering it. This is a pre-requisite for Writer's upcoming migratin to SfxUndoManager --- offapi/com/sun/star/document/XUndoManager.idl | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 9b485b93c4c1..be43ca899b94 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -102,8 +102,6 @@ interface XUndoManager

            Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext and enterHiddenUndoContext multiple times without calling leaveUndoContext inbetween.

            -

            The redo stack is cleared when a new Undo context is entered.

            - @see leaveUndoContext */ void enterUndoContext( @@ -132,8 +130,6 @@ interface XUndoManager

            Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext and enterHiddenUndoContext multiple times without calling leaveUndoContext inbetween.

            -

            The redo stack is cleared when a new hidden Undo context is entered.

            - @throws EmptyUndoStackException if the undo stack is currently empty, in which case it is impossible to push a hidden undo action onto it. @@ -149,8 +145,11 @@ interface XUndoManager

            If no undo action has been added since the context has been opened, the context is not only left, but silently removed, and does not contribute to the undo stack at all. In this case, possible - listeners will be notified via XUndoManagerListener::cancelledContext, - instead of XUndoManagerListener::leftContext.

            + listeners will be notified via XUndoManagerListener::cancelledContext.

            + +

            Otherwise, the undo context will be closed, and added to the Undo stack; the redo stack will be cleared, + and listeners will be notified via XUndoManagerListener::leftContext resp. + XUndoManagerListener::leftHiddenContext

            @throws ::com::sun::star::util::InvalidStateException if no undo context is currently open. -- cgit From e86fc3238cfd425bd49a2e6033521aa11a67b9bb Mon Sep 17 00:00:00 2001 From: "Frank Schoenheit [fs]" Date: Thu, 2 Dec 2010 09:27:22 +0100 Subject: undoapi: #i33781# include XUndoManagerSupplier --- offapi/com/sun/star/document/OfficeDocument.idl | 40 ++++--------------------- 1 file changed, 5 insertions(+), 35 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl index 4a3418e4da64..8467d206ff38 100644 --- a/offapi/com/sun/star/document/OfficeDocument.idl +++ b/offapi/com/sun/star/document/OfficeDocument.idl @@ -27,53 +27,19 @@ #ifndef __com_sun_star_document_OfficeDocument_idl__ #define __com_sun_star_document_OfficeDocument_idl__ -#ifndef __com_sun_star_frame_XModel_idl__ #include -#endif - -#ifndef __com_sun_star_util_XModifiable_idl__ #include -#endif - -#ifndef __com_sun_star_frame_XStorable_idl__ #include -#endif - -#ifndef __com_sun_star_view_XPrintable_idl__ #include -#endif - -#ifndef __com_sun_star_view_XPrintJobBroadcaster_idl__ #include -#endif - -#ifndef __com_sun_star_document_XEventBroadcaster_idl__ #include -#endif - -#ifndef __com_sun_star_document_XEventsSupplier_idl__ #include -#endif - -#ifndef __com_sun_star_document_XDocumentInfoSupplier_idl__ #include -#endif - -#ifndef __com_sun_star_document_XViewDataSupplier_idl__ #include -#endif - -#ifndef __com_sun_star_document_XDocumentEventBroadcaster_idl__ #include -#endif - -#ifndef __com_sun_star_document_XEmbeddedScripts_idl__ #include -#endif - -#ifndef __com_sun_star_document_XDocumentPropertiesSupplier_idl__ #include -#endif +#include //============================================================================= @@ -192,6 +158,10 @@ published service OfficeDocument */ [optional] interface XDocumentPropertiesSupplier; + /** provides access to the document's undo manager. + */ + [optional] interface XUndoManagerSupplier; + //------------------------------------------------------------------------- /** controls the focus behaviour of the form controls in the document -- cgit From 0c1fb57fe1588ba0d2ed07145fd07e834c96623f Mon Sep 17 00:00:00 2001 From: "Ingrid Halama [iha]" Date: Fri, 3 Dec 2010 23:01:44 +0100 Subject: chart46: #i25706# implement date axis - simplify axis access in chart api --- offapi/com/sun/star/chart/ChartAxis.idl | 17 +++++-- offapi/com/sun/star/chart/Diagram.idl | 10 +++- offapi/com/sun/star/chart/XAxis.idl | 60 +++++++++++++++++++++++ offapi/com/sun/star/chart/XAxisSupplier.idl | 61 ++++++++++++++++++++++++ offapi/com/sun/star/chart/makefile.mk | 2 + offapi/com/sun/star/chart2/XAxis.idl | 26 ++++++++++ offapi/com/sun/star/chart2/XCoordinateSystem.idl | 26 ++++++++++ 7 files changed, 196 insertions(+), 6 deletions(-) create mode 100755 offapi/com/sun/star/chart/XAxis.idl create mode 100755 offapi/com/sun/star/chart/XAxisSupplier.idl (limited to 'offapi') diff --git a/offapi/com/sun/star/chart/ChartAxis.idl b/offapi/com/sun/star/chart/ChartAxis.idl index 42a93cb96d50..20a6722af5d8 100644 --- a/offapi/com/sun/star/chart/ChartAxis.idl +++ b/offapi/com/sun/star/chart/ChartAxis.idl @@ -63,6 +63,10 @@ #include #endif +#ifndef __com_sun_star_chart_XAxis_idl__ +#include +#endif + #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_ #include #endif @@ -80,8 +84,6 @@ */ published service ChartAxis { - - /** set the properties for the entire axis line as well as for the tick marks. */ @@ -91,14 +93,19 @@ published service ChartAxis */ service com::sun::star::style::CharacterProperties; - /** If a ChartAxis may be stored as XML element, this - service should be supported in order to preserve unparsed XML - attributes. + /** If a ChartAxis may be stored as XML element, this + service should be supported in order to preserve unparsed XML + attributes. @since OOo 1.1.2 */ [optional] service com::sun::star::xml::UserDefinedAttributeSupplier; + /** Access to the sub elements of an axis like title and grids. + @since OOo 3.4 + */ + [optional] interface com::sun::star::chart::XAxis; + interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/chart/Diagram.idl b/offapi/com/sun/star/chart/Diagram.idl index b57fc88f3804..854baadb38cc 100644 --- a/offapi/com/sun/star/chart/Diagram.idl +++ b/offapi/com/sun/star/chart/Diagram.idl @@ -31,6 +31,10 @@ #include #endif +#ifndef __com_sun_star_chart_XAxisSupplier_idl__ +#include +#endif + #ifndef __com_sun_star_chart_XDiagramPositioning_idl__ #include #endif @@ -72,8 +76,12 @@ published service Diagram interface com::sun::star::chart::XDiagram; - /** Provides access to the titles of the secondary X axis and Y axis. + /** Provides easier access to the differnet axes and their sub elements. + @since OOo 3.4 + */ + [optional] interface com::sun::star::chart::XAxisSupplier; + /** Provides access to the titles of the secondary X axis and Y axis. @since OOo 3.0 */ [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier; diff --git a/offapi/com/sun/star/chart/XAxis.idl b/offapi/com/sun/star/chart/XAxis.idl new file mode 100755 index 000000000000..763e2f45412b --- /dev/null +++ b/offapi/com/sun/star/chart/XAxis.idl @@ -0,0 +1,60 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef com_sun_star_chart_XAxis_idl +#define com_sun_star_chart_XAxis_idl + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include +#endif + +module com { module sun { module star { module chart { + +/** Allows easier access to the different subelements of an axis. +@since OOo 3.4 +*/ + +interface XAxis : ::com::sun::star::uno::XInterface +{ + /** @returns + the title of the axis. The returned object supports the properties described in service ChartTitle. + */ + com::sun::star::beans::XPropertySet getAxisTitle(); + + /** @returns + the properties of the major grid of the axis. The returned object supports service ChartGrid. + */ + com::sun::star::beans::XPropertySet getMajorGrid(); + + /** @returns + the properties of the minor grid of the axis. The returned object supports service ChartGrid. + */ + com::sun::star::beans::XPropertySet getMinorGrid(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/XAxisSupplier.idl b/offapi/com/sun/star/chart/XAxisSupplier.idl new file mode 100755 index 000000000000..cf2bde2e310d --- /dev/null +++ b/offapi/com/sun/star/chart/XAxisSupplier.idl @@ -0,0 +1,61 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef com_sun_star_chart_XAxisSupplier_idl +#define com_sun_star_chart_XAxisSupplier_idl + +#ifndef __com_sun_star_chart_XAxis_idl__ +#include +#endif + +module com { module sun { module star { module chart { + +/** Easier access to the different axes within a chart. +@since OOo 3.4 +*/ + +interface XAxisSupplier : ::com::sun::star::uno::XInterface +{ + /** @returns + the primary axis of the specified dimension. The returned object supports service ChartAxis. + + @param nDimensionIndex + Parameter nDimensionIndex says wether it is a x, y or z-axis (0 for x). + */ + com::sun::star::chart::XAxis getAxis( [in] long nDimensionIndex ); + + /** @returns + the secondary axis of the specified dimension. The returned object supports service ChartAxis. + + @param nDimensionIndex + Parameter nDimensionIndex says wether it is a x, y or z-axis (0 for x). + */ + com::sun::star::chart::XAxis getSecondaryAxis( [in] long nDimensionIndex ); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/chart/makefile.mk b/offapi/com/sun/star/chart/makefile.mk index b05edf2ad5dd..7c9d53e12eed 100644 --- a/offapi/com/sun/star/chart/makefile.mk +++ b/offapi/com/sun/star/chart/makefile.mk @@ -100,6 +100,8 @@ IDLFILES=\ TimeInterval.idl\ X3DDefaultSetter.idl\ X3DDisplay.idl\ + XAxis.idl\ + XAxisSupplier.idl\ XAxisXSupplier.idl\ XAxisYSupplier.idl\ XAxisZSupplier.idl\ diff --git a/offapi/com/sun/star/chart2/XAxis.idl b/offapi/com/sun/star/chart2/XAxis.idl index 9a116c1a3bd4..55a9089da0cf 100644 --- a/offapi/com/sun/star/chart2/XAxis.idl +++ b/offapi/com/sun/star/chart2/XAxis.idl @@ -1,3 +1,29 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ #ifndef com_sun_star_chart_XAxis_idl #define com_sun_star_chart_XAxis_idl diff --git a/offapi/com/sun/star/chart2/XCoordinateSystem.idl b/offapi/com/sun/star/chart2/XCoordinateSystem.idl index 689abba33cf4..0756321cdbed 100644 --- a/offapi/com/sun/star/chart2/XCoordinateSystem.idl +++ b/offapi/com/sun/star/chart2/XCoordinateSystem.idl @@ -1,3 +1,29 @@ +/************************************************************************* + * + * 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 + * + * for a copy of the LGPLv3 License. + * + ************************************************************************/ #ifndef com_sun_star_chart2_XCoordinateSystem_idl #define com_sun_star_chart2_XCoordinateSystem_idl -- cgit From 7fce163b03c10eb200a7b7f6f8d7f10c47a152ec Mon Sep 17 00:00:00 2001 From: "Ingrid Halama [iha]" Date: Fri, 10 Dec 2010 14:10:17 +0100 Subject: chart46: #i25706# implement date axis - cleanup --- offapi/com/sun/star/chart2/XDiagram.idl | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/chart2/XDiagram.idl b/offapi/com/sun/star/chart2/XDiagram.idl index 3836489b7aed..23b256e63349 100644 --- a/offapi/com/sun/star/chart2/XDiagram.idl +++ b/offapi/com/sun/star/chart2/XDiagram.idl @@ -32,9 +32,10 @@ #endif #include - +#include #include #include +#include #include module com @@ -48,11 +49,6 @@ module chart2 interface XDiagram : ::com::sun::star::uno::XInterface { - /** gets the component that creates a new diagram or modifies - an existing diagram according to its rules. - */ -// string getChartTypeTemplateServiceName(); - /** returns the property set that determines the visual appearance of the wall. @@ -87,6 +83,25 @@ interface XDiagram : ::com::sun::star::uno::XInterface colors for data series (or data points) in the diagram. */ void setDefaultColorScheme( [in] XColorScheme xColorScheme ); + + /** sets new data to the diagram. + + @param xDataSource + This data source will be interpreted in a chart-type + specific way and the DataSeries found in + xDiagram will be adapted to the new data. + Missing data series will be created and unused ones will + be deleted. + + @param aArguments + Arguments tells how to slice the given data. + +

            For standard parameters that may be used, see the + service StandardDiagramCreationParameters. +

            + */ + void setDiagramData( [in] data::XDataSource xDataSource, + [in] sequence< com::sun::star::beans::PropertyValue > aArguments ); }; } ; // chart2 -- cgit From ba52f782aa34f7d5eb8b697bccfbd953861e6aa3 Mon Sep 17 00:00:00 2001 From: "Ingrid Halama [iha]" Date: Fri, 10 Dec 2010 17:07:53 +0100 Subject: chart46: #i25706# implement date axis - switching to scatter or bubble --- offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'offapi') diff --git a/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl b/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl index e5bc31759ace..6733715f1703 100644 --- a/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl +++ b/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl @@ -49,6 +49,11 @@ service StandardDiagramCreationParameters a data-source is used as categories. */ [optional, property] boolean HasCategories; + + /** If categories are given they should be used as x values also if a chart type requires x values. + Default is true. + */ + [optional, property] boolean UseCategoriesAsX; }; } ; // chart2 -- cgit From 4cd688d3ab0b4726ac30a7ed8e12f76cc28efad3 Mon Sep 17 00:00:00 2001 From: Kurt Zenker Date: Thu, 3 Feb 2011 13:32:58 +0100 Subject: masterfix: #i10000# add missing dependency in offapi --- offapi/prj/build.lst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'offapi') diff --git a/offapi/prj/build.lst b/offapi/prj/build.lst index e5c9a72f312f..a4ed8a8ceaf8 100644 --- a/offapi/prj/build.lst +++ b/offapi/prj/build.lst @@ -107,4 +107,4 @@ oa offapi\com\sun\star\rendering nmake - all oa_rendering oa_geometry NU oa offapi\com\sun\star\rdf nmake - all oa_rdf oa_datatransfer oa_text NULL oa offapi\com\sun\star\office nmake - all oa_office oa_text NULL oa offapi\drafts\com\sun\star\form nmake - all oa_drafts_form NULL -oa offapi\util nmake - all oa_util oa_auth oa_awt oa_awttree oa_awtgrid oa_awttab oa_chart oa_chart2 oa_chart2_data oa_config oa_configbootstrap oa_configbackend oa_configbackend_xml oa_datatrans_clip oa_datatrans_dnd oa_datatransfer oa_docu oa_draw oa_draw_framework oa_embed oa_fcomp oa_finsp oa_fcontr oa_fieldmaster oa_form oa_xforms oa_formula oa_frame oa_i18n oa_inst oa_ldap oa_ling2 oa_logging oa_mail oa_media oa_mozilla oa_packages oa_manifest oa_zippackage oa_plug oa_pres oa_animations oa_putil oa_resrc oa_sax oa_xml_input oa_scan oa_sdb oa_sdbtools oa_sdbapp oa_sdbc oa_sdbcx oa_setup oa_sheet oa_style oa_svg oa_sync oa_sync2 oa_system oa_table oa_task oa_text oa_textfield oa_docinfo oa_ucb oa_view oa_xml oa_xml_dom oa_xml_xpath oa_xml_views oa_xml_events oa_image oa_xsd oa_inspection oa_ui oa_ui_dialogs oa_accessibility oa_form_binding oa_form_validation oa_form_submission oa_fruntime oa_geometry oa_rendering oa_sfprovider oa_sfbrowse oa_drafts_form oa_deployment oa_deploymenttest oa_deployment_ui oa_frame_status oa_gallery oa_graphic oa_security oa_crypto_sax oa_crypto oa_csax oa_wrapper oa_script oa_smarttags oa_report oa_reportins oa_reportmeta oa_rdf oa_oooimprovement oa_office oa_prestextfield oa_starme NULL +oa offapi\util nmake - all oa_util oa_auth oa_awt oa_awttree oa_awtgrid oa_awttab oa_chart oa_chart2 oa_chart2_data oa_config oa_configbootstrap oa_configbackend oa_configbackend_xml oa_datatrans_clip oa_datatrans_dnd oa_datatransfer oa_docu oa_draw oa_draw_framework oa_embed oa_fcomp oa_finsp oa_fcontr oa_fieldmaster oa_form oa_xforms oa_formula oa_frame oa_i18n oa_inst oa_ldap oa_ling2 oa_logging oa_mail oa_media oa_mozilla oa_packages oa_manifest oa_zippackage oa_plug oa_pres oa_animations oa_putil oa_resrc oa_sax oa_xml_input oa_scan oa_sdb oa_sdbtools oa_sdbapp oa_sdbc oa_sdbcx oa_setup oa_sheet oa_style oa_svg oa_sync oa_sync2 oa_system oa_table oa_task oa_text oa_textfield oa_docinfo oa_ucb oa_view oa_xml oa_xml_dom oa_xml_xpath oa_xml_views oa_xml_events oa_image oa_xsd oa_inspection oa_ui oa_ui_dialogs oa_accessibility oa_form_binding oa_form_validation oa_form_submission oa_fruntime oa_geometry oa_rendering oa_sfprovider oa_sfbrowse oa_drafts_form oa_deployment oa_deploymenttest oa_deployment_ui oa_frame_status oa_gallery oa_graphic oa_security oa_crypto_sax oa_crypto oa_csax oa_wrapper oa_script oa_smarttags oa_report oa_reportins oa_reportmeta oa_rdf oa_oooimprovement oa_office oa_prestextfield oa_starme oa_script_vba NULL -- cgit