summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLAddSubMenu.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLAddSubMenu.html')
-rw-r--r--docs/Classes/SDLAddSubMenu.html154
1 files changed, 53 insertions, 101 deletions
diff --git a/docs/Classes/SDLAddSubMenu.html b/docs/Classes/SDLAddSubMenu.html
index 24f1ce665..0e96e364a 100644
--- a/docs/Classes/SDLAddSubMenu.html
+++ b/docs/Classes/SDLAddSubMenu.html
@@ -3,15 +3,14 @@
<h3>Section Contents</h3>
<ul>
- <li><a href="#section--initWithId:menuName:">-initWithId:menuName:</a></li>
- <li><a href="#section--initWithId:menuName:position:">-initWithId:menuName:position:</a></li>
- <li><a href="#section--initWithId:menuName:menuIcon:position:">-initWithId:menuName:menuIcon:position:</a></li>
- <li><a href="#section--initWithId:menuName:menuLayout:menuIcon:position:">-initWithId:menuName:menuLayout:menuIcon:position:</a></li>
+ <li><a href="#section--initWithMenuID:menuName:">-initWithMenuID:menuName:</a></li>
+ <li><a href="#section--initWithMenuID:menuName:position:menuIcon:menuLayout:parentID:">-initWithMenuID:menuName:position:menuIcon:menuLayout:parentID:</a></li>
<li><a href="#section-menuID">menuID</a></li>
<li><a href="#section-position">position</a></li>
<li><a href="#section-menuName">menuName</a></li>
<li><a href="#section-menuIcon">menuIcon</a></li>
<li><a href="#section-menuLayout">menuLayout</a></li>
+ <li><a href="#section-parentID">parentID</a></li>
</ul>
<h3>Overview</h3>
@@ -30,142 +29,74 @@
<section class="section task-group-section">
- <h3 id="section--initWithId:menuName:">
- -initWithId:menuName:
+ <h3 id="section--initWithMenuID:menuName:">
+ -initWithMenuID:menuName:
</h3>
- <p>Convenience init for creating an add submenu</p>
-
-
-
- <h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span>
- <span class="nf">menuName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span><span class="p">;</span></code></pre>
-
-
- <h4>Swift</h4>
- <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">id</span> <span class="nv">menuId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
-
- <h4>Parameters</h4>
- <dl>
- <dt>menuId</dt>
- <dd><p>A menu id</p></dd>
- <dt>menuName</dt>
- <dd><p>The menu name</p></dd>
- </dl>
- <div>
- <h4>Return Value</h4>
- <p>An SDLAddSubMenu object</p>
- </div>
-
- <h3 id="section--initWithId:menuName:position:">
- -initWithId:menuName:position:
- </h3>
-
- <p>Convenience init for creating an add submenu</p>
-
-
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span>
- <span class="nf">menuName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span>
- <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMenuID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuID</span>
+ <span class="nf">menuName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
- <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">id</span> <span class="nv">menuId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>
+ <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">menuID</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
- <dt>menuId</dt>
- <dd><p>A menu id</p></dd>
+ <dt>menuID</dt>
+ <dd><p>- @(menuID)</p></dd>
<dt>menuName</dt>
- <dd><p>The menu name</p></dd>
- <dt>position</dt>
- <dd><p>The position within the menu to add</p></dd>
+ <dd><p>- menuName</p></dd>
</dl>
<div>
<h4>Return Value</h4>
- <p>An SDLAddSubMenu object</p>
+ <p>A SDLAddSubMenu object</p>
</div>
- <h3 id="section--initWithId:menuName:menuIcon:position:">
- -initWithId:menuName:menuIcon:position:
+ <h3 id="section--initWithMenuID:menuName:position:menuIcon:menuLayout:parentID:">
+ -initWithMenuID:menuName:position:menuIcon:menuLayout:parentID:
</h3>
- <p>Convenience init for creating an add submenu</p>
-
-
-
- <h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span>
- <span class="nf">menuName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span>
- <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span>
- <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span><span class="p">;</span></code></pre>
-
-
- <h4>Swift</h4>
- <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">id</span> <span class="nv">menuId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n"><a href="../Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)menuIcon">menuIcon</a></span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>
-
-
- <h4>Parameters</h4>
- <dl>
- <dt>menuId</dt>
- <dd><p>A menu id</p></dd>
- <dt>menuName</dt>
- <dd><p>The menu name</p></dd>
- <dt>icon</dt>
- <dd><p>The icon to show on the menu item</p></dd>
- <dt>position</dt>
- <dd><p>The position within the menu to add</p></dd>
- </dl>
- <div>
- <h4>Return Value</h4>
- <p>An SDLAddSubMenu object</p>
- </div>
-
- <h3 id="section--initWithId:menuName:menuLayout:menuIcon:position:">
- -initWithId:menuName:menuLayout:menuIcon:position:
- </h3>
-
- <p>Convenience init for creating an add submenu with all properties.</p>
-
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuId</span>
- <span class="nf">menuName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span>
- <span class="nf">menuLayout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">)</span><span class="nv">menuLayout</span>
- <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span>
- <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMenuID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">menuID</span>
+ <span class="nf">menuName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">menuName</span>
+ <span class="nf">position</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">position</span>
+ <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">menuIcon</span>
+ <span class="nf">menuLayout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">)</span><span class="nv">menuLayout</span>
+ <span class="nf">parentID</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">parentID</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
- <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">id</span> <span class="nv">menuId</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">menuLayout</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">?,</span> <span class="n"><a href="../Classes/SDLAddSubMenu.html#/c:objc(cs)SDLAddSubMenu(py)menuIcon">menuIcon</a></span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>
+ <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">menuID</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">position</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="p">)?,</span> <span class="nv">menuIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">menuLayout</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">?,</span> <span class="nv">parentID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="p">)?)</span></code></pre>
<h4>Parameters</h4>
<dl>
- <dt>menuId</dt>
- <dd><p>A menu id</p></dd>
+ <dt>menuID</dt>
+ <dd><p>- @(menuID)</p></dd>
<dt>menuName</dt>
- <dd><p>The menu name</p></dd>
- <dt>menuLayout</dt>
- <dd><p>The sub-menu layout</p></dd>
- <dt>icon</dt>
- <dd><p>The icon to show on the menu item</p></dd>
+ <dd><p>- menuName</p></dd>
<dt>position</dt>
- <dd><p>The position within the menu to add</p></dd>
+ <dd><p>- position</p></dd>
+ <dt>menuIcon</dt>
+ <dd><p>- menuIcon</p></dd>
+ <dt>menuLayout</dt>
+ <dd><p>- menuLayout</p></dd>
+ <dt>parentID</dt>
+ <dd><p>- parentID</p></dd>
</dl>
<div>
<h4>Return Value</h4>
- <p>An SDLAddSubMenu object</p>
+ <p>A SDLAddSubMenu object</p>
</div>
<h3 id="section-menuID">
@@ -277,4 +208,25 @@
+ <h3 id="section-parentID">
+ parentID
+ </h3>
+
+ <p>Unique ID of the sub menu the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.
+ {&ldquo;default_value&rdquo;: 0, &ldquo;max_value&rdquo;: 2000000000, &ldquo;min_value&rdquo;: 0}</p>
+
+<p>@since SDL 7.0.0</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</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)SDLUInt">SDLUInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">parentID</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">parentID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
+
+
+
+
</section>