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

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