spreadsheet-ods-formula 1.0.0

Create ods-formulas for use with spreadsheet-ods.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! 
//! OpenFormula defines two functions, DDE and HYPERLINK, for accessing 
//! external data.

use crate::*;
#[allow(unused_imports)]
use crate::ext::*;

/// Returns data from a DDE request
///
/// [documentfoundation->DDE](https://wiki.documentfoundation.org/Documentation/Calc_Functions/DDE)
///
/// __Syntax__: 
/// ```ods
///     DDE( Server: Text; Topic: Text; Item: Text )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Performs a DDE request and returns its result. The request invokes the 
/// service Server on the topic named as Topic, requesting that it reply with 
/// the information on Item.
/// 
/// Evaluators may choose to not perform this function on every recalculation, 
/// but instead cache an answer and require a separate action to re-perform 
/// these requests. Evaluators shall perform this request on initial load when 
/// their security policies permit it.
/// 
/// Mode is an optional parameter that determines how the results are returned:
/// 
/// Data retrieved as text (not converted to number)
/// 
/// In an OpenDocument spreadsheet document the default table cell style is 
/// specified with table:default-cell-style-name. Its number:number-style 
/// specified by style:data-style-name specifies the locale to use in the 
/// conversion.
/// 
/// The DDE function is non-portable because it depends on availability of 
/// external programs (server parameter) and their interpretation of the topic 
/// and item parameters.
///
/// __See also__: [crate::of::dde_()], 
#[inline]
pub fn dde<A: Text, B: Text, C: Text>(server: A, topic: B, item: C) -> FnText3<A, B, C> {
    FnText3("DDE", server, topic, item)
}

/// Returns data from a DDE request
///
/// [documentfoundation->DDE](https://wiki.documentfoundation.org/Documentation/Calc_Functions/DDE)
///
/// __Syntax__: 
/// ```ods
///     DDE( Server: Text; Topic: Text; Item: Text; Mode: Integer )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Performs a DDE request and returns its result. The request invokes the 
/// service Server on the topic named as Topic, requesting that it reply with 
/// the information on Item.
/// 
/// Evaluators may choose to not perform this function on every recalculation, 
/// but instead cache an answer and require a separate action to re-perform 
/// these requests. Evaluators shall perform this request on initial load when 
/// their security policies permit it.
/// 
/// Mode is an optional parameter that determines how the results are returned:
/// 
/// Data retrieved as text (not converted to number)
/// 
/// In an OpenDocument spreadsheet document the default table cell style is 
/// specified with table:default-cell-style-name. Its number:number-style 
/// specified by style:data-style-name specifies the locale to use in the 
/// conversion.
/// 
/// The DDE function is non-portable because it depends on availability of 
/// external programs (server parameter) and their interpretation of the topic 
/// and item parameters.
///
/// __See also__: [crate::of::dde()], 
#[inline]
pub fn dde_<A: Text, B: Text, C: Text, D: Number>(server: A, topic: B, item: C, mode: D) -> FnText4<A, B, C, D> {
    FnText4("DDE", server, topic, item, mode)
}

/// Creation of a hyperlink involving an evaluated expression.
///
/// [documentfoundation->HYPERLINK](https://wiki.documentfoundation.org/Documentation/Calc_Functions/HYPERLINK)
///
/// __Syntax__: 
/// ```ods
///     HYPERLINK( IRI: Text )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// The default for the second argument is the value of the first argument. The 
/// second argument value is returned.
/// 
/// In addition, hosting environments may interpret expressions containing 
/// HYPERLINK function calls as calling for an implementation-dependent 
/// creation of a hypertext link based on the expression containing the 
/// HYPERLINK function calls.
///
/// __See also__: [crate::of::hyperlink_()], 
#[inline]
pub fn hyperlink<A: Text>(i_r_i: A) -> FnText1<A> {
    FnText1("HYPERLINK", i_r_i)
}

/// Creation of a hyperlink involving an evaluated expression.
///
/// [documentfoundation->HYPERLINK](https://wiki.documentfoundation.org/Documentation/Calc_Functions/HYPERLINK)
///
/// __Syntax__: 
/// ```ods
///     HYPERLINK( IRI: Text; FunctionResult: Text|Number )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// The default for the second argument is the value of the first argument. The 
/// second argument value is returned.
/// 
/// In addition, hosting environments may interpret expressions containing 
/// HYPERLINK function calls as calling for an implementation-dependent 
/// creation of a hypertext link based on the expression containing the 
/// HYPERLINK function calls.
///
/// __See also__: [crate::of::hyperlink()], 
#[inline]
pub fn hyperlink_<A: Text, B: TextOrNumber>(i_r_i: A, function_result: B) -> FnText2<A, B> {
    FnText2("HYPERLINK", i_r_i, function_result)
}