LibreOffice
LibreOffice 5.1 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 #ifndef __com_sun_star_xforms_XFormsUIHelper1_idl__
20 #define __com_sun_star_xforms_XFormsUIHelper1_idl__
21 
23 
31 
32 
33 
34 module com { module sun { module star { module xforms {
35 
36 
42 interface XFormsUIHelper1
43 {
44  string getDefaultServiceNameForNode( [in] com::sun::star::xml::dom::XNode xNode );
45 
46  string getDefaultBindingExpressionForNode( [in] com::sun::star::xml::dom::XNode xNode );
47 
48  string getNodeDisplayName( [in] com::sun::star::xml::dom::XNode xNode,
49  [in] boolean bDetail );
50 
51  string getNodeName( [in] com::sun::star::xml::dom::XNode xNode );
52 
53  string getBindingName( [in] com::sun::star::beans::XPropertySet xBinding,
54  [in] boolean bDetail );
55 
56  string getSubmissionName( [in] com::sun::star::beans::XPropertySet xSubm,
57  [in] boolean bDetail );
58 
59  // Creates a new binding based on the one passed as argument.
60  // The new binding does *not* contribute to the MIPs table and acts
61  // as a property set in disguise, which is what the UI needs this object for...
63 
64  void removeBindingIfUseless( [in] com::sun::star::beans::XPropertySet xBinding );
65 
66  // handle instances
67 
68  com::sun::star::xml::dom::XDocument newInstance( [in] string sName,
69  [in] string sURL,
70  [in] boolean bURLOnce );
71 
72  void renameInstance( [in] string sFrom, [in] string sTo,
73  [in] string sURL,
74  [in] boolean bURLOnce );
75 
76  void removeInstance( [in] string sName );
77 
78 
79  // handle models
81  [in] string sName );
82  void renameModel( [in] com::sun::star::frame::XModel xModel,
83  [in] string sFrom, [in] string sTo );
84  void removeModel( [in] com::sun::star::frame::XModel xModel,
85  [in] string sName );
86 
87 
88  // DOM helpers
90  createElement( [in] com::sun::star::xml::dom::XNode xParent,
91  [in] string sName );
93  createAttribute( [in] com::sun::star::xml::dom::XNode xParent,
94  [in] string sName );
95 
98  [in] string sName );
99 
100  com::sun::star::beans::XPropertySet getBindingForNode(
102  [in] boolean bCreate );
103 
104  void removeBindingForNode(
105  [in] com::sun::star::xml::dom::XNode xNode );
106 
107  string getResultForExpression(
109  [in] boolean bIsBindingExpression,
110  [in] string sExpression );
111 
112  boolean isValidXMLName( [in] string sName );
113 
114  boolean isValidPrefixName( [in] string sName );
115 
116  void setNodeValue(
118  [in] string sValue );
119 
120 };
121 
122 
123 }; }; }; };
124 
125 #endif
126 
127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
represent an XForms model
Definition: XModel.idl:40
The primary dom datatype.
Definition: XNode.idl:68
Definition: Ambiguous.idl:22
represents a component which is created from an URL and arguments.
Definition: XModel.idl:58
provide several helper methods for the UI
Definition: XFormsUIHelper1.idl:42
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:63
Definition: XDocument.idl:35