archived-doc-es/reference/ncurses/functions/ncurses-mousemask.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0551a90caa8dc6cfa72a3c700524857fc6fbfc7a Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ncurses-mousemask" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ncurses_mousemask</refname>
  <refpurpose>Establece las opciones del ratón</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>ncurses_mousemask</methodname>
   <methodparam><type>int</type><parameter>newmask</parameter></methodparam>
   <methodparam><type>int</type><parameter role="reference">oldmask</parameter></methodparam>
  </methodsynopsis>
  &warn.experimental.func;
  <para>
   Establece los eventos del ratón para ser reportados. Por omisión no se informará de ningún evento
   de ratón.
  </para>
  <para>
   Los eventos de ratón están representados por <constant>NCURSES_KEY_MOUSE</constant> en el
   flujo de entrada de <function>ncurses_wgetch</function>. Para leer la información del evento
   y sacar el evento de la cola, llame a <function>ncurses_getmouse</function>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>newmask</parameter></term>
     <listitem>
      <para>
       Las opciones de máscara del ratón pueden ser establecida con las siguienetes constantes predefinidas:
       <itemizedlist>
        <listitem><para>NCURSES_BUTTON1_PRESSED</para></listitem>
        <listitem><para>NCURSES_BUTTON1_RELEASED</para></listitem>
        <listitem><para>NCURSES_BUTTON1_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON1_DOUBLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON1_TRIPLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON2_PRESSED</para></listitem>
        <listitem><para>NCURSES_BUTTON2_RELEASED</para></listitem>
        <listitem><para>NCURSES_BUTTON2_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON2_DOUBLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON2_TRIPLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON3_PRESSED</para></listitem>
        <listitem><para>NCURSES_BUTTON3_RELEASED</para></listitem>
        <listitem><para>NCURSES_BUTTON3_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON3_DOUBLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON3_TRIPLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON4_PRESSED</para></listitem>
        <listitem><para>NCURSES_BUTTON4_RELEASED</para></listitem>
        <listitem><para>NCURSES_BUTTON4_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON4_DOUBLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON4_TRIPLE_CLICKED</para></listitem>
        <listitem><para>NCURSES_BUTTON_SHIFT></para></listitem>
        <listitem><para>NCURSES_BUTTON_CTRL</para></listitem>
        <listitem><para>NCURSES_BUTTON_ALT</para></listitem>
        <listitem><para>NCURSES_ALL_MOUSE_EVENTS</para></listitem>
        <listitem><para>NCURSES_REPORT_MOUSE_POSITION</para></listitem>
       </itemizedlist>
      </para>
      <para>
       Como efecto secundario, establecer una máscara de ratón a cero en
       <parameter>newmask</parameter> descativa el puntero del
       ratón. Establecer un valor distinto de cero activa el puntero del ratón.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>oldmask</parameter></term>
     <listitem>
      <para>
       Esto establecerá el valor anterior de la máscara de eventos del ratón.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve la máscara de los eventos que pueden ser notificador. En caso de
   fallo completo devuelve <literal>0</literal>.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>ncurses_mousemask</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$newmask = NCURSES_BUTTON1_CLICKED + NCURSES_BUTTON1_RELEASED;
$mask = ncurses_mousemask($newmask, $oldmask);
if ($mask & $newmask){
    printf("Todas las opciones de ratón especificadas serán soportadas\n");
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ncurses_getch</function></member>
    <member><function>ncurses_getmouse</function></member>
    <member><function>ncurses_ungetmouse</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->