offapi/com/sun/star/xforms/XFormsUIHelper1.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_xforms_XFormsUIHelper1_idl__
  29 #define __com_sun_star_xforms_XFormsUIHelper1_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/xml/dom/XNode.idl>
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #include <com/sun/star/container/XSet.idl>
  36 #include <com/sun/star/xforms/XDataTypeRepository.idl>
  37 #include <com/sun/star/xml/dom/XDocument.idl>
  38 #include <com/sun/star/xml/dom/XNode.idl>
  39 #include <com/sun/star/frame/XModel.idl>
  40 #include <com/sun/star/xforms/XModel.idl>
  41
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module xforms {
  46
  47 //=============================================================================
  48
  49 /** provide several helper methods for the UI
  50
  51     <b>This interfaces is for UI use only, and will likely be unsupported in
  52     future versions.</p>
  53 */
  54 interface XFormsUIHelper1
  55 {
  56     string getDefaultServiceNameForNode( [in] com::sun::star::xml::dom::XNode xNode );
  57
  58     string getDefaultBindingExpressionForNode( [in] com::sun::star::xml::dom::XNode xNode );
  59
  60     string getNodeDisplayName( [in] com::sun::star::xml::dom::XNode xNode,
  61                                [in] boolean bDetail );
  62
  63     string getNodeName( [in] com::sun::star::xml::dom::XNode xNode );
  64
  65     string getBindingName( [in] com::sun::star::beans::XPropertySet xBinding,
  66                            [in] boolean bDetail );
  67
  68     string getSubmissionName( [in] com::sun::star::beans::XPropertySet xSubm,
  69                               [in] boolean bDetail );
  70
  71     // Creates a new binding based on the one passed as argument.
  72     // The new binding does *not* contribute to the MIPs table and acts
  73     // as a property set in disguise, which is what the UI needs this object for...
  74     com::sun::star::beans::XPropertySet cloneBindingAsGhost( [in] com::sun::star::beans::XPropertySet binding );
  75
  76     void removeBindingIfUseless( [in] com::sun::star::beans::XPropertySet xBinding );
  77
  78     // handle instances
  79
  80     com::sun::star::xml::dom::XDocument newInstance( [in] string sName,
  81                       [in] string sURL,
  82                       [in] boolean bURLOnce );
  83
  84     void renameInstance( [in] string sFrom, [in] string sTo,
  85                       [in] string sURL,
  86                       [in] boolean bURLOnce );
  87
  88     void removeInstance( [in] string sName );
  89
  90
  91     // handle models
  92     com::sun::star::xforms::XModel newModel( [in] com::sun::star::frame::XModel xModel,
  93                    [in] string sName );
  94     void renameModel( [in] com::sun::star::frame::XModel xModel,
  95                       [in] string sFrom, [in] string sTo );
  96     void removeModel( [in] com::sun::star::frame::XModel xModel,
  97                       [in] string sName );
  98
  99
 100     // DOM helpers
 101     com::sun::star::xml::dom::XNode
 102         createElement( [in] com::sun::star::xml::dom::XNode xParent,
 103                        [in] string sName );
 104     com::sun::star::xml::dom::XNode
 105         createAttribute( [in] com::sun::star::xml::dom::XNode xParent,
 106                          [in] string sName );
 107
 108     com::sun::star::xml::dom::XNode renameNode(
 109         [in] com::sun::star::xml::dom::XNode xNode,
 110         [in] string sName );
 111
 112     com::sun::star::beans::XPropertySet getBindingForNode(
 113         [in] com::sun::star::xml::dom::XNode xNode,
 114         [in] boolean bCreate );
 115
 116     void removeBindingForNode(
 117         [in] com::sun::star::xml::dom::XNode xNode );
 118
 119     string getResultForExpression(
 120         [in] com::sun::star::beans::XPropertySet xBinding,
 121         [in] boolean bIsBindingExpression,
 122         [in] string sExpression );
 123
 124     boolean isValidXMLName( [in] string sName );
 125
 126     boolean isValidPrefixName( [in] string sName );
 127
 128     void setNodeValue(
 129         [in] com::sun::star::xml::dom::XNode xNode,
 130         [in] string sValue );
 131
 132 };
 133
 134 //=============================================================================
 135
 136 }; }; }; };
 137
 138 /*=============================================================================
 139
 140 =============================================================================*/
 141 #endif
 142
 143 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */