summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLSoftButton.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLSoftButton.html')
-rw-r--r--docs/Classes/SDLSoftButton.html39
1 files changed, 26 insertions, 13 deletions
diff --git a/docs/Classes/SDLSoftButton.html b/docs/Classes/SDLSoftButton.html
index 08d57c80e..8e73e209d 100644
--- a/docs/Classes/SDLSoftButton.html
+++ b/docs/Classes/SDLSoftButton.html
@@ -16,7 +16,7 @@
<h3>Overview</h3>
-<p>Undocumented</p>
+<p>Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts</p>
<section class="section task-group-section">
@@ -78,12 +78,14 @@
type
</h3>
- <p>Undocumented</p>
+ <p>Describes whether this soft button displays only text, only an image, or both</p>
+
+<p>Required</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">type</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">_Nonnull</span> <span class="n">type</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -96,12 +98,14 @@
text
</h3>
- <p>Undocumented</p>
+ <p>Optional text to display (if defined as TEXT or BOTH type)</p>
+
+<p>Optional</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -114,12 +118,14 @@
image
</h3>
- <p>Undocumented</p>
+ <p>Optional image struct for SoftButton (if defined as IMAGE or BOTH type)</p>
+
+<p>Optional</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -132,12 +138,15 @@
isHighlighted
</h3>
- <p>Undocumented</p>
+ <p>Displays in an alternate mode, e.g. with a colored background or foreground. Depends on the IVI system.</p>
+
+<p>Optional</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">isHighlighted</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
+ <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">isHighlighted</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -150,12 +159,14 @@
softButtonID
</h3>
- <p>Undocumented</p>
+ <p>Value which is returned via OnButtonPress / OnButtonEvent</p>
+
+<p>Required</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">softButtonID</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">softButtonID</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -168,12 +179,14 @@
systemAction
</h3>
- <p>Undocumented</p>
+ <p>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</p>
+
+<p>Optional</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span><span class="p">;</span></code></pre>
<h4>Swift</h4>