From 279ca1adeda1d071666f7423ec59cd17a1b60fbc Mon Sep 17 00:00:00 2001 From: Hieromon Ikasamo Date: Thu, 21 Feb 2019 23:36:32 +0900 Subject: [PATCH] Add missing explanation --- mkdocs/apielements.md | 164 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 157 insertions(+), 7 deletions(-) diff --git a/mkdocs/apielements.md b/mkdocs/apielements.md index d416271..40074ca 100644 --- a/mkdocs/apielements.md +++ b/mkdocs/apielements.md @@ -230,6 +230,18 @@ Returns type of AutoConnectElement.
AC_Input
+#### isValid + +```cpp +bool isValid(void) +``` +Evaluate the pattern as a regexp and return whether value matches. Always return true if the pattern is undefined. +
+
**Return value**
+
trueThe value matches a pattern.
+
falseThe value does not match a pattern.
+
+ ## AutoConnectRadio ### Constructor @@ -332,10 +344,10 @@ Indicates the check of the specified option for the radio buttons. You can use t ```cpp void empty(const size_t reserve = 0) ``` -Clear the array of option strings that AutoConnectRadio has in values. When a **_reserve_** parameter is specified, a vector container of that size is reserved. +Clear the array of option strings that AutoConnectRadio has in the values. When a **_reserve_** parameter is specified, a vector container of that size is reserved.
**Parameters**
-
reserveReserved size of a container for option strings.
+
reserveReserved size of a container for the radio button option strings.
#### operator [ ] @@ -343,10 +355,23 @@ Clear the array of option strings that AutoConnectRadio has in values. When a ** ```cpp const String& operator[] (const std::size_t n) ``` -Returns the option string of the index specified by **_n_**. +Returns a value string of the index specified by **_n_**.
**Parameters**
-
nIndex of values array to return.
+
nIndex of values array to return. Its base number is 0.
+
**Return value**
+
A reference of a value string indexed by the specified the **n**.
+
+ +#### size + +```cpp +size_t size(void) +``` +Returns number of options which contained. +
+
**Return value**
+
Number of options which contained.
#### value @@ -418,25 +443,150 @@ Returns type of AutoConnectElement. ```cpp void add(const String& option) ``` +Adds a selectable option string for the selection list. +
+
**Parameters**
+
optionA string of selectable item to be contained in the select element.
+
#### empty ```cpp void empty(const size_t reserve = 0) ``` +Clear the array of options list that AutoConnectSelect has in the options. When a **_reserve_** parameter is specified, a vector container of that size is reserved. +
+
**Parameters**
+
reserveReserved size of a container for the options.
+
+ +#### operator [ ] + +```cpp +const String& operator[] (const std::size_t n) +``` +Returns an option string of the index specified by **_n_**. +
+
**Parameters**
+
nIndex of options array to return. Its base number is 0.
+
**Return value**
+
A reference of a option string indexed by the specified the **n**.
+
+
#### size ```cpp size_t size(void) ``` +Returns number of options which contained. +
+
**Return value**
+
Number of options which contained.
+
-#### operator [ ] +## AutoConnectSubmit + +### Constructor ```cpp -const String& operator[] (const std::size_t n) +AutoConnectSubmit(const char* name = "", const char* value ="", char* uri = "") ``` +
+
**Parameters**
+
nameThe element name.
+
valueThe name of the submit button as an HTML `#!html ` tag, it will also be the label of the button.
+
uriDestination URI.
+
-## AutoConnectSubmit +### Public member variables + +#### name + +The element name. +
+
**Type**
+
String
+
+ +#### value + +The name of the submit button. It will also be the label of the button. +
+
**Type**
+
String
+
+ +#### uri + +Destination URI. +
+
**Type**
+
String
+
+ +### Public member functions + +#### typeOf + +```cpp +ACElement_t typeOf(void) +``` +Returns type of AutoConnectElement. +
+
**Return value**
+
AC_Submit
+
## AutoConnectText + +### Constructor + +```cpp +AutoConnectText(const char* name = "", const char* value = "", const char* style = "") +``` +
+
**Parameters**
+
nameThe element name.
+
valueString of content for the text element.
+
styleA style code with CSS format that qualifiers the text.
+
+ +### Public member variables + +#### name + +The element name. +
+
**Type**
+
String
+
+ +#### value + +A content string of the text element. +
+
**Type**
+
String
+
+ +#### style + +A style code with CSS format that qualifiers the text. +
+
**Type**
+
String
+
+ +### Public member functions + +#### typeOf + +```cpp +ACElement_t typeOf(void) +``` +Returns type of AutoConnectElement. +
+
**Return value**
+
AC_Text
+