vlc
/
VLCKit


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
							<!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"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>VLCKit: &lt;VLCCustomDialogRendererProtocol&gt; Protocol 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>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</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 -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- 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="protocol_v_l_c_custom_dialog_renderer_protocol-p-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">&lt;VLCCustomDialogRendererProtocol&gt; Protocol 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 &lt;VLCCustomDialogRendererProtocol&gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="protocol_v_l_c_custom_dialog_renderer_protocol-p.png" usemap="#_3CVLCCustomDialogRendererProtocol_3E_map" alt=""/>
  <map id="_3CVLCCustomDialogRendererProtocol_3E_map" name="&lt;VLCCustomDialogRendererProtocol&gt;_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>
<tr class="memitem:a55ed777080c858e89615b774bed8bd89"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html#a55ed777080c858e89615b774bed8bd89">showErrorWithTitle:message:</a></td></tr>
<tr class="separator:a55ed777080c858e89615b774bed8bd89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2a775dcb6a40617feb1874ccea4de37"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html#ac2a775dcb6a40617feb1874ccea4de37">showLoginWithTitle:message:defaultUsername:askingForStorage:withReference:</a></td></tr>
<tr class="separator:ac2a775dcb6a40617feb1874ccea4de37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c2544adcc4dfbf22c7218c34f74c905"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html#a1c2544adcc4dfbf22c7218c34f74c905">showQuestionWithTitle:message:type:cancelString:action1String:action2String:withReference:</a></td></tr>
<tr class="separator:a1c2544adcc4dfbf22c7218c34f74c905"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b752a12e5565ad7182ae7cc07c52a2e"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html#a9b752a12e5565ad7182ae7cc07c52a2e">showProgressWithTitle:message:isIndeterminate:position:cancelString:withReference:</a></td></tr>
<tr class="separator:a9b752a12e5565ad7182ae7cc07c52a2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa040bd1cddc3fb4bf1f5087b9f35481f"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html#aa040bd1cddc3fb4bf1f5087b9f35481f">updateProgressWithReference:message:postion:</a></td></tr>
<tr class="separator:aa040bd1cddc3fb4bf1f5087b9f35481f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a33b761b5aa9da31e6998d2ae9726b0"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_v_l_c_custom_dialog_renderer_protocol-p.html#a2a33b761b5aa9da31e6998d2ae9726b0">cancelDialogWithReference:</a></td></tr>
<tr class="separator:a2a33b761b5aa9da31e6998d2ae9726b0"><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>the protocol to use if you decide to run a custom dialog appearance </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a class="anchor" id="a2a33b761b5aa9da31e6998d2ae9726b0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) cancelDialogWithReference: </td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>reference</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>VLC decided to destroy a dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">reference</td><td>to the dialog to destroy </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a55ed777080c858e89615b774bed8bd89"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) showErrorWithTitle: </td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>error</em></td>
        </tr>
        <tr>
          <td class="paramkey">message:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>message</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>called when VLC wants to show an error </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">error</td><td>the dialog title </td></tr>
    <tr><td class="paramname">message</td><td>the error message </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac2a775dcb6a40617feb1874ccea4de37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) showLoginWithTitle: </td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>title</em></td>
        </tr>
        <tr>
          <td class="paramkey">message:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>message</em></td>
        </tr>
        <tr>
          <td class="paramkey">defaultUsername:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nullable)&#160;</td>
          <td class="paramname"><em>username</em></td>
        </tr>
        <tr>
          <td class="paramkey">askingForStorage:</td>
          <td></td>
          <td class="paramtype">(BOOL)&#160;</td>
          <td class="paramname"><em>askingForStorage</em></td>
        </tr>
        <tr>
          <td class="paramkey">withReference:</td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>reference</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>called when user logs in to something If VLC includes a keychain module for your platform, a user can store stuff </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">title</td><td>login dialog title </td></tr>
    <tr><td class="paramname">message</td><td>an explaining message </td></tr>
    <tr><td class="paramname">username</td><td>a default username within context </td></tr>
    <tr><td class="paramname">askingForStorage</td><td>indicator whether storing is even a possibility </td></tr>
    <tr><td class="paramname">reference</td><td>you need to send the results to </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a9b752a12e5565ad7182ae7cc07c52a2e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) showProgressWithTitle: </td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>title</em></td>
        </tr>
        <tr>
          <td class="paramkey">message:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>message</em></td>
        </tr>
        <tr>
          <td class="paramkey">isIndeterminate:</td>
          <td></td>
          <td class="paramtype">(BOOL)&#160;</td>
          <td class="paramname"><em>isIndeterminate</em></td>
        </tr>
        <tr>
          <td class="paramkey">position:</td>
          <td></td>
          <td class="paramtype">(float)&#160;</td>
          <td class="paramname"><em>position</em></td>
        </tr>
        <tr>
          <td class="paramkey">cancelString:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nullable)&#160;</td>
          <td class="paramname"><em>cancelString</em></td>
        </tr>
        <tr>
          <td class="paramkey">withReference:</td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>reference</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>called when VLC wants to show some progress </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">title</td><td>the dialog title </td></tr>
    <tr><td class="paramname">message</td><td>an explaining message </td></tr>
    <tr><td class="paramname">isIndeterminate</td><td>indicator whether progress indeterminate </td></tr>
    <tr><td class="paramname">position</td><td>initial progress position </td></tr>
    <tr><td class="paramname">cancelString</td><td>optional string for cancel button if operation is cancellable </td></tr>
    <tr><td class="paramname">reference</td><td>VLC will include in updates </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1c2544adcc4dfbf22c7218c34f74c905"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) showQuestionWithTitle: </td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>title</em></td>
        </tr>
        <tr>
          <td class="paramkey">message:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nonnull)&#160;</td>
          <td class="paramname"><em>message</em></td>
        </tr>
        <tr>
          <td class="paramkey">type:</td>
          <td></td>
          <td class="paramtype">(VLCDialogQuestionType)&#160;</td>
          <td class="paramname"><em>questionType</em></td>
        </tr>
        <tr>
          <td class="paramkey">cancelString:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nullable)&#160;</td>
          <td class="paramname"><em>cancelString</em></td>
        </tr>
        <tr>
          <td class="paramkey">action1String:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nullable)&#160;</td>
          <td class="paramname"><em>action1String</em></td>
        </tr>
        <tr>
          <td class="paramkey">action2String:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nullable)&#160;</td>
          <td class="paramname"><em>action2String</em></td>
        </tr>
        <tr>
          <td class="paramkey">withReference:</td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>reference</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>called when VLC needs the user to decide something </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">title</td><td>the dialog title </td></tr>
    <tr><td class="paramname">message</td><td>an explaining message text </td></tr>
    <tr><td class="paramname">questionType</td><td>a question type </td></tr>
    <tr><td class="paramname">cancelString</td><td>cancel button text </td></tr>
    <tr><td class="paramname">action1String</td><td>action 1 text </td></tr>
    <tr><td class="paramname">action2String</td><td>action 2 text </td></tr>
    <tr><td class="paramname">reference</td><td>you need to send the action to </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aa040bd1cddc3fb4bf1f5087b9f35481f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) updateProgressWithReference: </td>
          <td></td>
          <td class="paramtype">(NSValue *_Nonnull)&#160;</td>
          <td class="paramname"><em>reference</em></td>
        </tr>
        <tr>
          <td class="paramkey">message:</td>
          <td></td>
          <td class="paramtype">(NSString *_Nullable)&#160;</td>
          <td class="paramname"><em>message</em></td>
        </tr>
        <tr>
          <td class="paramkey">postion:</td>
          <td></td>
          <td class="paramtype">(float)&#160;</td>
          <td class="paramname"><em>position</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>called when VLC wants to update an existing progress dialog </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">reference</td><td>to the existing progress dialog </td></tr>
    <tr><td class="paramname">message</td><td>updated message </td></tr>
    <tr><td class="paramname">position</td><td>current position </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this protocol 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"/>
</a> 1.8.11
</small></address>
</body>
</html>