offapi/com/sun/star/xforms/XFormsUIHelper1.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: XFormsUIHelper1.idl,v $
  10  * $Revision: 1.5 $
  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_xforms_XFormsUIHelper1_idl__
  31 #define __com_sun_star_xforms_XFormsUIHelper1_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_xml_dom_XNode_idl__
  38 #include <com/sun/star/xml/dom/XNode.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertySet_idl__
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_container_XIndexAccess_idl__
  46 #include <com/sun/star/container/XSet.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_xforms_XDataTypeRepository_idl__
  50 #include <com/sun/star/xforms/XDataTypeRepository.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_xml_dom_XDocument_idl__
  54 #include <com/sun/star/xml/dom/XDocument.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_xml_dom_XDocument_idl__
  58 #include <com/sun/star/xml/dom/XNode.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_frame_XModel_idl__
  62 #include <com/sun/star/frame/XModel.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_xforms_XModel_idl__
  66 #include <com/sun/star/xforms/XModel.idl>
  67 #endif
  68
  69
  70 //=============================================================================
  71
  72 module com {  module sun {  module star {  module xforms {
  73
  74 //=============================================================================
  75
  76 /** provide several helper methods for the UI
  77
  78     <b>This interfaces is for UI use only, and will likely be unsupported in
  79     future versions.</p>
  80 */
  81 interface XFormsUIHelper1
  82 {
  83     string getDefaultServiceNameForNode( [in] com::sun::star::xml::dom::XNode xNode );
  84
  85     string getDefaultBindingExpressionForNode( [in] com::sun::star::xml::dom::XNode xNode );
  86
  87     string getNodeDisplayName( [in] com::sun::star::xml::dom::XNode xNode,
  88                                [in] boolean bDetail );
  89
  90     string getNodeName( [in] com::sun::star::xml::dom::XNode xNode );
  91
  92     string getBindingName( [in] com::sun::star::beans::XPropertySet xBinding,
  93                            [in] boolean bDetail );
  94
  95     string getSubmissionName( [in] com::sun::star::beans::XPropertySet xSubm,
  96                               [in] boolean bDetail );
  97
  98     // Creates a new binding based on the one passed as argument.
  99     // The new binding does *not* contribute to the MIPs table and acts
 100     // as a propertyset in disguise, which is what the UI needs this object for...
 101     com::sun::star::beans::XPropertySet cloneBindingAsGhost( [in] com::sun::star::beans::XPropertySet binding );
 102
 103     void removeBindingIfUseless( [in] com::sun::star::beans::XPropertySet xBinding );
 104
 105     // handle instances
 106
 107     com::sun::star::xml::dom::XDocument newInstance( [in] string sName,
 108                       [in] string sURL,
 109                       [in] boolean bURLOnce );
 110
 111     void renameInstance( [in] string sFrom, [in] string sTo,
 112                       [in] string sURL,
 113                       [in] boolean bURLOnce );
 114
 115     void removeInstance( [in] string sName );
 116
 117
 118     // handle models
 119     com::sun::star::xforms::XModel newModel( [in] com::sun::star::frame::XModel xModel,
 120                    [in] string sName );
 121     void renameModel( [in] com::sun::star::frame::XModel xModel,
 122                       [in] string sFrom, [in] string sTo );
 123     void removeModel( [in] com::sun::star::frame::XModel xModel,
 124                       [in] string sName );
 125
 126
 127     // DOM helpers
 128     com::sun::star::xml::dom::XNode
 129         createElement( [in] com::sun::star::xml::dom::XNode xParent,
 130                        [in] string sName );
 131     com::sun::star::xml::dom::XNode
 132         createAttribute( [in] com::sun::star::xml::dom::XNode xParent,
 133                          [in] string sName );
 134
 135     com::sun::star::xml::dom::XNode renameNode(
 136         [in] com::sun::star::xml::dom::XNode xNode,
 137         [in] string sName );
 138
 139     com::sun::star::beans::XPropertySet getBindingForNode(
 140         [in] com::sun::star::xml::dom::XNode xNode,
 141         [in] boolean bCreate );
 142
 143     void removeBindingForNode(
 144         [in] com::sun::star::xml::dom::XNode xNode );
 145
 146     string getResultForExpression(
 147         [in] com::sun::star::beans::XPropertySet xBinding,
 148         [in] boolean bIsBindingExpression,
 149         [in] string sExpression );
 150
 151     boolean isValidXMLName( [in] string sName );
 152
 153     boolean isValidPrefixName( [in] string sName );
 154
 155     void setNodeValue(
 156         [in] com::sun::star::xml::dom::XNode xNode,
 157         [in] string sValue );
 158
 159 };
 160
 161 //=============================================================================
 162
 163 }; }; }; };
 164
 165 /*=============================================================================
 166
 167 =============================================================================*/
 168 #endif