offapi/com/sun/star/chart2/XUndoHelper.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef com_sun_star_chart2_XUndoHelper_idl
  28 #define com_sun_star_chart2_XUndoHelper_idl
  29
  30 #include <com/sun/star/uno/XInterface.idl>
  31 #include <com/sun/star/frame/XModel.idl>
  32 // #include <com/sun/star/beans/PropertyValue.idl>
  33
  34 module com
  35 {
  36 module sun
  37 {
  38 module star
  39 {
  40 module chart2
  41 {
  42
  43 /** An interface for storing frame::XModel objects for container undo.
  44  */
  45 interface XUndoHelper : ::com::sun::star::uno::XInterface
  46 {
  47     /** call this before you change the xCurrentModel
  48
  49         @return a clone of the current model that can later be used to
  50                 restore the state of a changed model
  51      */
  52     ::com::sun::star::frame::XModel getModelCloneForUndo(
  53         [in] ::com::sun::star::frame::XModel xModelBeforeChange );
  54
  55     /** call this before you change the xCurrentModel. You can pass
  56         parameters to refine the information that is cloned.
  57
  58         @return a clone of the current model that can later be used to
  59                 restore the state of a changed model using the same
  60                 arguments in applyModelContentWithArguments.
  61      */
  62 //     ::com::sun::star::frame::XModel getModelCloneForUndoWithArguments(
  63 //         [in] ::com::sun::star::frame::XModel xModelBeforeChange,
  64 //         [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments );
  65
  66     /** apply the content of xModelToCopyFrom to the XModel in xModelToChange
  67      */
  68     void applyModelContent( [inout] ::com::sun::star::frame::XModel xModelToChange,
  69                             [in] ::com::sun::star::frame::XModel xModelToCopyFrom );
  70
  71     /** apply the content of xModelToCopyFrom to the XModel in
  72         xModelToChange. You can pass parameters to refine the
  73         information that is applied.
  74
  75         <p>Note that xModelToCopyFrom should have been created with
  76         getModelCloneForUndoWithArguments using the same arguments as
  77         are passed here.</p>
  78      */
  79 //     void applyModelContentWithArguments(
  80 //         [inout] ::com::sun::star::frame::XModel xModelToChange,
  81 //         [in] ::com::sun::star::frame::XModel xModelToCopyFrom,
  82 //         [in] sequence< ::com::sun::star::beans::PropertyValue > aArguments );
  83 };
  84
  85 } ; // chart2
  86 } ; // com
  87 } ; // sun
  88 } ; // star
  89
  90 #endif