skype4py.client-pysrc.html

基于python的skype的API的说明文档

<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-docstring">'''Skype client user interface control.</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module Skype4Py.enums=Skype4Py.enums-module.html"><a title="Skype4Py.enums" class="py-name" href="#" onclick="return doclink('link-0', 'enums', 'link-0');">enums</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Module Skype4Py.errors=Skype4Py.errors-module.html"><a title="Skype4Py.errors" class="py-name" href="#" onclick="return doclink('link-1', 'errors', 'link-1');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Class Skype4Py.errors.ISkypeError=Skype4Py.errors.ISkypeError-class.html"><a title="Skype4Py.errors.ISkypeError" class="py-name" href="#" onclick="return doclink('link-2', 'ISkypeError', 'link-2');">ISkypeError</a></tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name" targets="Module Skype4Py.utils=Skype4Py.utils-module.html"><a title="Skype4Py.utils" class="py-name" href="#" onclick="return doclink('link-3', 'utils', 'link-3');">utils</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">weakref</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"> </tt>
<a name="IClient"></a><div id="IClient-def"><a name="L10"></a><tt class="py-lineno"> 10</tt> <a class="py-toggle" href="#" id="IClient-toggle" onclick="return toggle('IClient');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html">IClient</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="IClient-expanded"><a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line">    <tt class="py-docstring">'''Represents a Skype client. Access using L{ISkype.Client&lt;skype.ISkype.Client&gt;}.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"> </tt>
<a name="IClient.__init__"></a><div id="IClient.__init__-def"><a name="L14"></a><tt class="py-lineno"> 14</tt> <a class="py-toggle" href="#" id="IClient.__init__-toggle" onclick="return toggle('IClient.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Skype</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.__init__-expanded"><a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line">        <tt class="py-docstring">'''__init__.</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">        @param Skype: Skype</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring">        @type Skype: L{ISkype}</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_SkypeRef</tt> <tt class="py-op">=</tt> <tt class="py-name">weakref</tt><tt class="py-op">.</tt><tt class="py-name">ref</tt><tt class="py-op">(</tt><tt class="py-name">Skype</tt><tt class="py-op">)</tt> </tt>
</div><a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"> </tt>
<a name="IClient.ButtonPressed"></a><div id="IClient.ButtonPressed-def"><a name="L22"></a><tt class="py-lineno"> 22</tt> <a class="py-toggle" href="#" id="IClient.ButtonPressed-toggle" onclick="return toggle('IClient.ButtonPressed');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#ButtonPressed">ButtonPressed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.ButtonPressed-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.ButtonPressed-expanded"><a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sends button button pressed to client.</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">        @param Key: Key</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">        @type Key: unicode</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">.</tt><tt class="py-name">_DoCommand</tt><tt class="py-op">(</tt><tt class="py-string">'BTN_PRESSED %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">Key</tt><tt class="py-op">)</tt> </tt>
</div><a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"> </tt>
<a name="IClient.ButtonReleased"></a><div id="IClient.ButtonReleased-def"><a name="L30"></a><tt class="py-lineno"> 30</tt> <a class="py-toggle" href="#" id="IClient.ButtonReleased-toggle" onclick="return toggle('IClient.ButtonReleased');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#ButtonReleased">ButtonReleased</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">Key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.ButtonReleased-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.ButtonReleased-expanded"><a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line">        <tt class="py-docstring">'''Sends button released event to client.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">        @param Key: Key</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">        @type Key: unicode</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">.</tt><tt class="py-name">_DoCommand</tt><tt class="py-op">(</tt><tt class="py-string">'BTN_RELEASED %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">Key</tt><tt class="py-op">)</tt> </tt>
</div><a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"> </tt>
<a name="IClient.CreateEvent"></a><div id="IClient.CreateEvent-def"><a name="L38"></a><tt class="py-lineno"> 38</tt> <a class="py-toggle" href="#" id="IClient.CreateEvent-toggle" onclick="return toggle('IClient.CreateEvent');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#CreateEvent">CreateEvent</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">EventId</tt><tt class="py-op">,</tt> <tt class="py-param">Caption</tt><tt class="py-op">,</tt> <tt class="py-param">Hint</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.CreateEvent-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.CreateEvent-expanded"><a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line">        <tt class="py-docstring">'''Creates a custom event displayed in Skype client's events pane.</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">        @param EventId: Unique identifier for the event.</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">        @type EventId: unicode</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">        @param Caption: Caption text.</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring">        @type Caption: unicode</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">        @param Hint: Hint text. Shown when mouse hoovers over the event.</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">        @type Hint: unicode</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Event object.</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: L{IPluginEvent}</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">.</tt><tt class="py-name">_DoCommand</tt><tt class="py-op">(</tt><tt class="py-string">'CREATE EVENT %s CAPTION %s HINT %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">EventId</tt><tt class="py-op">,</tt> <tt id="link-4" class="py-name" targets="Function Skype4Py.utils.quote()=Skype4Py.utils-module.html#quote"><a title="Skype4Py.utils.quote" class="py-name" href="#" onclick="return doclink('link-4', 'quote', 'link-4');">quote</a></tt><tt class="py-op">(</tt><tt id="link-5" class="py-name" targets="Variable Skype4Py.client.IPluginMenuItem.Caption=Skype4Py.client.IPluginMenuItem-class.html#Caption"><a title="Skype4Py.client.IPluginMenuItem.Caption" class="py-name" href="#" onclick="return doclink('link-5', 'Caption', 'link-5');">Caption</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-6" class="py-name"><a title="Skype4Py.utils.quote" class="py-name" href="#" onclick="return doclink('link-6', 'quote', 'link-4');">quote</a></tt><tt class="py-op">(</tt><tt id="link-7" class="py-name" targets="Variable Skype4Py.client.IPluginMenuItem.Hint=Skype4Py.client.IPluginMenuItem-class.html#Hint"><a title="Skype4Py.client.IPluginMenuItem.Hint" class="py-name" href="#" onclick="return doclink('link-7', 'Hint', 'link-7');">Hint</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-8" class="py-name" targets="Class Skype4Py.client.IPluginEvent=Skype4Py.client.IPluginEvent-class.html"><a title="Skype4Py.client.IPluginEvent" class="py-name" href="#" onclick="return doclink('link-8', 'IPluginEvent', 'link-8');">IPluginEvent</a></tt><tt class="py-op">(</tt><tt class="py-name">EventId</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_Skype</tt><tt class="py-op">)</tt> </tt>
</div><a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"> </tt>
<a name="IClient.CreateMenuItem"></a><div id="IClient.CreateMenuItem-def"><a name="L53"></a><tt class="py-lineno"> 53</tt> <a class="py-toggle" href="#" id="IClient.CreateMenuItem-toggle" onclick="return toggle('IClient.CreateMenuItem');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="Skype4Py.client.IClient-class.html#CreateMenuItem">CreateMenuItem</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">MenuItemId</tt><tt class="py-op">,</tt> <tt class="py-param">PluginContext</tt><tt class="py-op">,</tt> <tt class="py-param">CaptionText</tt><tt class="py-op">,</tt> <tt class="py-param">HintText</tt><tt class="py-op">=</tt><tt class="py-string">u''</tt><tt class="py-op">,</tt> <tt class="py-param">IconPath</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-param">Enabled</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line">                       <tt class="py-param">ContactType</tt><tt class="py-op">=</tt><tt id="link-9" class="py-name" targets="Variable Skype4Py.enums.pluginContactTypeAll=Skype4Py.enums-module.html#pluginContactTypeAll"><a title="Skype4Py.enums.pluginContactTypeAll" class="py-name" href="#" onclick="return doclink('link-9', 'pluginContactTypeAll', 'link-9');">pluginContactTypeAll</a></tt><tt class="py-op">,</tt> <tt class="py-param">MultipleContacts</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IClient.CreateMenuItem-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IClient.CreateMenuItem-expanded"><a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line">        <tt class="py-docstring">'''Creates custom menu item in Skype client's "Do More" menus.</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">        @param MenuItemId: Unique identifier for the menu item.</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">        @type MenuItemId: unicode</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">        @param PluginContext: Menu item context. Allows to choose in which client windows will</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">        the menu item appear.</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">        @type PluginContext: L{Plug-in context&lt;enums.pluginContextUnknown&gt;}</tt> </tt>