Skip to content
Permalink
Browse files

Add function help

  • Loading branch information
NathanW2 committed May 11, 2013
1 parent 09f5ee6 commit bbdecebd9a3341008de284355ed509b2c9da16df
@@ -0,0 +1,2 @@
<h3>Conditionals Group</h3>
This group contains functions to handle conditional checks in expressions.
@@ -0,0 +1,14 @@
<h3>format() function</h3>
Format a string using supplied arguments.

<h4>Syntax</h4>
<code>format('string', arg, [arg...n])</code><br>

<h4>Arguments</h4>
<code>string</code> - is string. String with Qt QString place holders. Use %1, %2, etc for placeholders. Placeholders can be repeated.
<br>
<code>arg [arg...n]</code> - any type. Any number of args.

<h4>Example</h4>
<!-- Show example of function.-->
<code>format('This %1 a %2','is', 'test') &rarr; This is a test</code><br>
@@ -0,0 +1,174 @@
<h3>format_date() function</h3>
Format a date type or string into a custom string format. Uses Qt data time format strings. See <a href='http://qt-project.org/doc/qt-4.8/qdatetime.html#toString'>QDateTime::toString</a>

<h4>Syntax</h4>
<code>format_date('string', 'format_string')</code><br>

<h4>Arguments</h4>
<code>string</code> - is string. Date/Time/DateTime string.
<br>
<code>format_string</code> - is string. String template used to format the string.

<table>
<thead>
<tr>
<th>Expression</th>

<th>Output</th>
</tr>
</thead>

<tr valign="top">
<td>d</td>

<td>the day as number without a leading zero (1 to 31)</td>
</tr>

<tr valign="top">
<td>dd</td>

<td>the day as number with a leading zero (01 to 31)</td>
</tr>

<tr valign="top">
<td>ddd</td>

<td>the abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses <a href=
"qdate.html#shortDayName">QDate::shortDayName</a>().</td>
</tr>

<tr valign="top">
<td>dddd</td>

<td>the long localized day name (e.g. 'Monday' to 'Sunday'). Uses <a href=
"qdate.html#longDayName">QDate::longDayName</a>().</td>
</tr>

<tr valign="top">
<td>M</td>

<td>the month as number without a leading zero (1-12)</td>
</tr>

<tr valign="top">
<td>MM</td>

<td>the month as number with a leading zero (01-12)</td>
</tr>

<tr valign="top">
<td>MMM</td>

<td>the abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses <a href=
"qdate.html#shortMonthName">QDate::shortMonthName</a>().</td>
</tr>

<tr valign="top">
<td>MMMM</td>

<td>the long localized month name (e.g. 'January' to 'December'). Uses <a href=
"qdate.html#longMonthName">QDate::longMonthName</a>().</td>
</tr>

<tr valign="top">
<td>yy</td>

<td>the year as two digit number (00-99)</td>
</tr>

<tr valign="top">
<td>yyyy</td>

<td>the year as four digit number</td>
</tr>
</table>

<p>These expressions may be used for the time part of the format string:</p>

<table>
<thead>
<tr>
<th>Expression</th>

<th>Output</th>
</tr>
</thead>

<tr valign="top">
<td>h</td>

<td>the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)</td>
</tr>

<tr valign="top">
<td>hh</td>

<td>the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)</td>
</tr>

<tr valign="top">
<td>H</td>

<td>the hour without a leading zero (0 to 23, even with AM/PM display)</td>
</tr>

<tr valign="top">
<td>HH</td>

<td>the hour with a leading zero (00 to 23, even with AM/PM display)</td>
</tr>

<tr valign="top">
<td>m</td>

<td>the minute without a leading zero (0 to 59)</td>
</tr>

<tr valign="top">
<td>mm</td>

<td>the minute with a leading zero (00 to 59)</td>
</tr>

<tr valign="top">
<td>s</td>

<td>the second without a leading zero (0 to 59)</td>
</tr>

<tr valign="top">
<td>ss</td>

<td>the second with a leading zero (00 to 59)</td>
</tr>

<tr valign="top">
<td>z</td>

<td>the milliseconds without leading zeroes (0 to 999)</td>
</tr>

<tr valign="top">
<td>zzz</td>

<td>the milliseconds with leading zeroes (000 to 999)</td>
</tr>

<tr valign="top">
<td>AP or A</td>

<td>interpret as an AM/PM time. <i>AP</i> must be either "AM" or "PM".</td>
</tr>

<tr valign="top">
<td>ap or a</td>

<td>Interpret as an AM/PM time. <i>ap</i> must be either "am" or "pm".</td>
</tr>
</table>

<br>

<h4>Example</h4>
<!-- Show example of function.-->
<code>format_date('2012-05-15','dd.mm.yyyy') &rarr; 15.00.2012</code><br>
File renamed without changes.
@@ -0,0 +1,13 @@
<h3>todate() function</h3>
Convert a string into Qt data type.

<h4>Syntax</h4>
<code>todate('string')</code><br>

<h4>Arguments</h4>
<code>string</code> - is string in Qt date format.
<br>

<h4>Example</h4>
<!-- Show example of function.-->
<code>todate('2012-05-04') &rarr; 2012-05-04</code><br>
@@ -0,0 +1,13 @@
<h3>todatetime() function</h3>
Convert a string into Qt data time type.

<h4>Syntax</h4>
<code>todatetime('string')</code><br>

<h4>Arguments</h4>
<code>string</code> - is string in Qt date time format.
<br>

<h4>Example</h4>
<!-- Show example of function.-->
<code>todatetime('2012-05-04 12:50:00') &rarr; 2012-05-04T12:50:00</code><br>
@@ -0,0 +1,13 @@
<h3>tointerval() function</h3>
Converts a string to a interval type. Can be used to take days, hours, month, etc off a date.

<h4>Syntax</h4>
<code>tointerval('string')</code><br>

<h4>Arguments</h4>
<code>string</code> - is string. Format {n} days {n} hours {n} months
<br>

<h4>Example</h4>
<!-- Show example of function.-->
<code>todatetime('2012-05-05 12:00:00') - tointerval('1 day 2 hours') &rarr; 2012-05-04T10:00:00</code><br>
@@ -0,0 +1,13 @@
<h3>totime() function</h3>
Convert a string into Qt time type.

<h4>Syntax</h4>
<code>totime('string')</code><br>

<h4>Arguments</h4>
<code>string</code> - is string in Qt time format.
<br>

<h4>Example</h4>
<!-- Show example of function.-->
<code>totime('12:30:01') &rarr; 12:30:01</code><br>

0 comments on commit bbdeceb

Please sign in to comment.
You can’t perform that action at this time.