LibreOffice
LibreOffice 24.2 SDK API Reference
XFormsUIHelper1.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 
21 
22 module com { module sun { module star { module xforms {
23 
24 
30 interface XFormsUIHelper1
31 {
32  string getDefaultServiceNameForNode( [in] com::sun::star::xml::dom::XNode xNode );
33 
34  string getDefaultBindingExpressionForNode( [in] com::sun::star::xml::dom::XNode xNode );
35 
36  string getNodeDisplayName( [in] com::sun::star::xml::dom::XNode xNode,
37  [in] boolean bDetail );
38 
39  string getNodeName( [in] com::sun::star::xml::dom::XNode xNode );
40 
41  string getBindingName( [in] com::sun::star::beans::XPropertySet xBinding,
42  [in] boolean bDetail );
43 
44  string getSubmissionName( [in] com::sun::star::beans::XPropertySet xSubm,
45  [in] boolean bDetail );
46 
47  // Creates a new binding based on the one passed as argument.
48  // The new binding does *not* contribute to the MIPs table and acts
49  // as a property set in disguise, which is what the UI needs this object for...
51 
52  void removeBindingIfUseless( [in] com::sun::star::beans::XPropertySet xBinding );
53 
54  // handle instances
55 
56  com::sun::star::xml::dom::XDocument newInstance( [in] string sName,
57  [in] string sURL,
58  [in] boolean bURLOnce );
59 
60  void renameInstance( [in] string sFrom, [in] string sTo,
61  [in] string sURL,
62  [in] boolean bURLOnce );
63 
64  void removeInstance( [in] string sName );
65 
66 
67  // handle models
69  [in] string sName );
70  void renameModel( [in] com::sun::star::frame::XModel xModel,
71  [in] string sFrom, [in] string sTo );
72  void removeModel( [in] com::sun::star::frame::XModel xModel,
73  [in] string sName );
74 
75 
76  // DOM helpers
78  createElement( [in] com::sun::star::xml::dom::XNode xParent,
79  [in] string sName );
81  createAttribute( [in] com::sun::star::xml::dom::XNode xParent,
82  [in] string sName );
83 
86  [in] string sName );
87 
88  com::sun::star::beans::XPropertySet getBindingForNode(
90  [in] boolean bCreate );
91 
92  void removeBindingForNode(
94 
95  string getResultForExpression(
97  [in] boolean bIsBindingExpression,
98  [in] string sExpression );
99 
100  boolean isValidXMLName( [in] string sName );
101 
102  boolean isValidPrefixName( [in] string sName );
103 
104  void setNodeValue(
106  [in] string sValue );
107 
108 };
109 
110 
111 }; }; }; };
112 
113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
represent an XForms model
Definition: XModel.idl:28
The primary dom datatype.
Definition: XNode.idl:60
Definition: Ambiguous.idl:20
represents a component which is created from a URL and arguments.
Definition: XModel.idl:50
provide several helper methods for the UI
Definition: XFormsUIHelper1.idl:30
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:45
Definition: XDocument.idl:22