interface_v_l_c_dialog_provider.html 12.9 KB
Newer Older
1 2 3 4 5
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
6 7
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
<title>VLCKit: VLCDialogProvider Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">VLCKit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
Felix Paul Kühne's avatar
Felix Paul Kühne committed
32
<!-- Generated by Doxygen 1.8.13 -->
33 34 35
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
36 37 38 39 40 41 42 43 44
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Instance Methods</a> &#124;
<a href="#properties">Properties</a> &#124;
Felix Paul Kühne's avatar
Felix Paul Kühne committed
64
<a href="interface_v_l_c_dialog_provider-members.html">List of all members</a>  </div>
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
  <div class="headertitle">
<div class="title">VLCDialogProvider Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#import &lt;<a class="el" href="_v_l_c_dialog_provider_8h_source.html">VLCDialogProvider.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VLCDialogProvider:</div>
<div class="dyncontent">
 <div class="center">
  <img src="interface_v_l_c_dialog_provider.png" usemap="#VLCDialogProvider_map" alt=""/>
  <map id="VLCDialogProvider_map" name="VLCDialogProvider_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Instance Methods</h2></td></tr>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
82 83 84 85 86 87
<tr class="memitem:a4b1a9eebb34da055225b49207f80effb"><td class="memItemLeft" align="right" valign="top">(instancetype _Nullable)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a4b1a9eebb34da055225b49207f80effb">initWithLibrary:customUI:</a></td></tr>
<tr class="separator:a4b1a9eebb34da055225b49207f80effb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1398d049f3c32e7acf7198a675bbe22c"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a1398d049f3c32e7acf7198a675bbe22c">postUsername:andPassword:forDialogReference:store:</a></td></tr>
<tr class="separator:a1398d049f3c32e7acf7198a675bbe22c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a303f49c9d588e2bc64a62fb90e486be7"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a303f49c9d588e2bc64a62fb90e486be7">postAction:forDialogReference:</a></td></tr>
<tr class="separator:a303f49c9d588e2bc64a62fb90e486be7"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 89 90 91 92
<tr class="memitem:a067cfa85cd47a387ccccba06b6a14b3e"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_v_l_c_dialog_provider.html#a067cfa85cd47a387ccccba06b6a14b3e">dismissDialogWithReference:</a></td></tr>
<tr class="separator:a067cfa85cd47a387ccccba06b6a14b3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
93
<tr class="memitem:a15847411703d3b120abb0a9b4b7e8ed2"><td class="memItemLeft" align="right" valign="top">id&lt; VLCCustomDialogRendererProtocol &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_v_l_c_dialog_provider.html#a15847411703d3b120abb0a9b4b7e8ed2">customRenderer</a></td></tr>
94 95 96 97 98
<tr class="separator:a15847411703d3b120abb0a9b4b7e8ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>dialog provider base class </p><dl class="section note"><dt>Note</dt><dd>For iOS and tvOS, there are useable implementations available which don't require the use of a custom renderer </dd></dl>
</div><h2 class="groupheader">Method Documentation</h2>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
99 100 101
<a id="a067cfa85cd47a387ccccba06b6a14b3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a067cfa85cd47a387ccccba06b6a14b3e">&#9670;&nbsp;</a></span>dismissDialogWithReference:()</h2>

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) dismissDialogWithReference: </td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>dialogReference</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>if you requested custom UI mode for dialogs, use this method to cancel a progress dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dialogReference</td><td>reference to the dialog you want to cancel </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method does not have any effect if you don't use custom UI mode </dd></dl>

</div>
</div>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
124 125 126
<a id="a4b1a9eebb34da055225b49207f80effb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b1a9eebb34da055225b49207f80effb">&#9670;&nbsp;</a></span>initWithLibrary:customUI:()</h2>

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (instancetype _Nullable) initWithLibrary: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> *_Nullable)&#160;</td>
          <td class="paramname"><em>library</em></td>
        </tr>
        <tr>
          <td class="paramkey">customUI:</td>
          <td></td>
          <td class="paramtype">(BOOL)&#160;</td>
          <td class="paramname"><em>customUI</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>initializer method to run the dialog provider instance on a specific library instance</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">library</td><td>the <a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> instance </td></tr>
    <tr><td class="paramname">customUI</td><td>enable custom UI mode </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>if library param is NULL, [<a class="el" href="interface_v_l_c_library.html">VLCLibrary</a> sharedLibrary] will be used </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>the dialog provider instance, can be NULL on malloc failures </dd></dl>

</div>
</div>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
162 163 164
<a id="a303f49c9d588e2bc64a62fb90e486be7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a303f49c9d588e2bc64a62fb90e486be7">&#9670;&nbsp;</a></span>postAction:forDialogReference:()</h2>

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) postAction: </td>
          <td></td>
          <td class="paramtype">(int)&#160;</td>
          <td class="paramname"><em>buttonNumber</em></td>
        </tr>
        <tr>
          <td class="paramkey">forDialogReference:</td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>dialogReference</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>if you requested custom UI mode for dialogs, use this method respond to a question dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buttonNumber</td><td>the button number the user pressed, use 3 if s/he cancelled, otherwise respectively 1 or 2 depending on the selected action </td></tr>
    <tr><td class="paramname">dialogReference</td><td>reference to the dialog you respond to </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method does not have any effect if you don't use custom UI mode </dd></dl>

</div>
</div>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
198 199 200
<a id="a1398d049f3c32e7acf7198a675bbe22c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1398d049f3c32e7acf7198a675bbe22c">&#9670;&nbsp;</a></span>postUsername:andPassword:forDialogReference:store:()</h2>

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) postUsername: </td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>username</em></td>
        </tr>
        <tr>
          <td class="paramkey">andPassword:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>password</em></td>
        </tr>
        <tr>
          <td class="paramkey">forDialogReference:</td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>dialogReference</em></td>
        </tr>
        <tr>
          <td class="paramkey">store:</td>
          <td></td>
          <td class="paramtype">(BOOL)&#160;</td>
          <td class="paramname"><em>store</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>if you requested custom UI mode for dialogs, use this method respond to a login dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">username</td><td>or NULL if cancelled </td></tr>
    <tr><td class="paramname">password</td><td>or NULL if cancelled </td></tr>
    <tr><td class="paramname">dialogReference</td><td>reference to the dialog you respond to </td></tr>
    <tr><td class="paramname">store</td><td>shall VLC store the login securely? </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method does not have any effect if you don't use custom UI mode </dd></dl>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
249 250 251
<a id="a15847411703d3b120abb0a9b4b7e8ed2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15847411703d3b120abb0a9b4b7e8ed2">&#9670;&nbsp;</a></span>customRenderer</h2>

252 253 254 255 256 257 258
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
259
          <td class="memname">- (id&lt;VLCCustomDialogRendererProtocol&gt;) customRenderer</td>
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">nonatomic</span><span class="mlabel">weak</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>initializer method to run the dialog provider instance on a specific library instance</p>
<dl class="section return"><dt>Returns</dt><dd>the object set </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Headers/Public/<a class="el" href="_v_l_c_dialog_provider_8h_source.html">VLCDialogProvider.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
281
</a> 1.8.13
282 283 284
</small></address>
</body>
</html>