spreadsheet_ods_formula/generated/
ext.rs

1//! 
2//! OpenFormula defines two functions, DDE and HYPERLINK, for accessing 
3//! external data.
4
5use crate::*;
6#[allow(unused_imports)]
7use crate::ext::*;
8
9/// Returns data from a DDE request
10///
11/// [documentfoundation->DDE](https://wiki.documentfoundation.org/Documentation/Calc_Functions/DDE)
12///
13/// __Syntax__: 
14/// ```ods
15///     DDE( Server: Text; Topic: Text; Item: Text )
16/// ```
17///
18/// __Constraints__:
19/// None
20///
21/// __Semantics__:
22/// Performs a DDE request and returns its result. The request invokes the 
23/// service Server on the topic named as Topic, requesting that it reply with 
24/// the information on Item.
25/// 
26/// Evaluators may choose to not perform this function on every recalculation, 
27/// but instead cache an answer and require a separate action to re-perform 
28/// these requests. Evaluators shall perform this request on initial load when 
29/// their security policies permit it.
30/// 
31/// Mode is an optional parameter that determines how the results are returned:
32/// 
33/// Data retrieved as text (not converted to number)
34/// 
35/// In an OpenDocument spreadsheet document the default table cell style is 
36/// specified with table:default-cell-style-name. Its number:number-style 
37/// specified by style:data-style-name specifies the locale to use in the 
38/// conversion.
39/// 
40/// The DDE function is non-portable because it depends on availability of 
41/// external programs (server parameter) and their interpretation of the topic 
42/// and item parameters.
43///
44/// __See also__: [crate::of::dde_()], 
45#[inline]
46pub fn dde<A: Text, B: Text, C: Text>(server: A, topic: B, item: C) -> FnText3<A, B, C> {
47    FnText3("DDE", server, topic, item)
48}
49
50/// Returns data from a DDE request
51///
52/// [documentfoundation->DDE](https://wiki.documentfoundation.org/Documentation/Calc_Functions/DDE)
53///
54/// __Syntax__: 
55/// ```ods
56///     DDE( Server: Text; Topic: Text; Item: Text; Mode: Integer )
57/// ```
58///
59/// __Constraints__:
60/// None
61///
62/// __Semantics__:
63/// Performs a DDE request and returns its result. The request invokes the 
64/// service Server on the topic named as Topic, requesting that it reply with 
65/// the information on Item.
66/// 
67/// Evaluators may choose to not perform this function on every recalculation, 
68/// but instead cache an answer and require a separate action to re-perform 
69/// these requests. Evaluators shall perform this request on initial load when 
70/// their security policies permit it.
71/// 
72/// Mode is an optional parameter that determines how the results are returned:
73/// 
74/// Data retrieved as text (not converted to number)
75/// 
76/// In an OpenDocument spreadsheet document the default table cell style is 
77/// specified with table:default-cell-style-name. Its number:number-style 
78/// specified by style:data-style-name specifies the locale to use in the 
79/// conversion.
80/// 
81/// The DDE function is non-portable because it depends on availability of 
82/// external programs (server parameter) and their interpretation of the topic 
83/// and item parameters.
84///
85/// __See also__: [crate::of::dde()], 
86#[inline]
87pub fn dde_<A: Text, B: Text, C: Text, D: Number>(server: A, topic: B, item: C, mode: D) -> FnText4<A, B, C, D> {
88    FnText4("DDE", server, topic, item, mode)
89}
90
91/// Creation of a hyperlink involving an evaluated expression.
92///
93/// [documentfoundation->HYPERLINK](https://wiki.documentfoundation.org/Documentation/Calc_Functions/HYPERLINK)
94///
95/// __Syntax__: 
96/// ```ods
97///     HYPERLINK( IRI: Text )
98/// ```
99///
100/// __Constraints__:
101/// None
102///
103/// __Semantics__:
104/// The default for the second argument is the value of the first argument. The 
105/// second argument value is returned.
106/// 
107/// In addition, hosting environments may interpret expressions containing 
108/// HYPERLINK function calls as calling for an implementation-dependent 
109/// creation of a hypertext link based on the expression containing the 
110/// HYPERLINK function calls.
111///
112/// __See also__: [crate::of::hyperlink_()], 
113#[inline]
114pub fn hyperlink<A: Text>(i_r_i: A) -> FnText1<A> {
115    FnText1("HYPERLINK", i_r_i)
116}
117
118/// Creation of a hyperlink involving an evaluated expression.
119///
120/// [documentfoundation->HYPERLINK](https://wiki.documentfoundation.org/Documentation/Calc_Functions/HYPERLINK)
121///
122/// __Syntax__: 
123/// ```ods
124///     HYPERLINK( IRI: Text; FunctionResult: Text|Number )
125/// ```
126///
127/// __Constraints__:
128/// None
129///
130/// __Semantics__:
131/// The default for the second argument is the value of the first argument. The 
132/// second argument value is returned.
133/// 
134/// In addition, hosting environments may interpret expressions containing 
135/// HYPERLINK function calls as calling for an implementation-dependent 
136/// creation of a hypertext link based on the expression containing the 
137/// HYPERLINK function calls.
138///
139/// __See also__: [crate::of::hyperlink()], 
140#[inline]
141pub fn hyperlink_<A: Text, B: TextOrNumber>(i_r_i: A, function_result: B) -> FnText2<A, B> {
142    FnText2("HYPERLINK", i_r_i, function_result)
143}
spreadsheet_ods_formula/generated/ext.rs

spreadsheet_ods_formula/generated/
ext.rs
