cvs: php-gtk-doc /manual/pt_BR/reference/gtk gtktreeselection.xml

http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/pt_BR/reference/gtk/gtktreeselection.xml?view=markup&rev=1.1
Index: php-gtk-doc/manual/pt_BR/reference/gtk/gtktreeselection.xml
+++ php-gtk-doc/manual/pt_BR/reference/gtk/gtktreeselection.xml
<?xml version="1.0" encoding="utf-8" ?>
<!-- EN-Revision: 1.9 Maintairer: dnfeitosa Status: ready -->
<classentry id="gtk.gtktreeselection">
 <classmeta>
  <classtitle>GtkTreeSelection</classtitle>
  <classparent>GObject</classparent>
  <shortdesc>
   Seleção de um <classname>GtkTreeView</classname>.
  </shortdesc>
  <desc>
   <para>
		 O objeto GtkTreeSelection é um objeto que auxilia o gerenciamento da seleção
		 de um widget <classname>GtkTreeView</classname>. O objeto GtkTreeSelection é
		 automaticamente criado quando um novo objeto GtkTreeView é criado, e não independente
		 deste widget. A razão primária para isso é manter o código e a API limpos.
		 Isto é, não há uma razão conceitual para os métodos deste objeto fazerem parte
		 do widget GtkTreeView.
   </para>
   <para>
		 O objeto GtkTreeSelection é obtido a partir de um
    <classname>GtkTreeView</classname> através da chamada de
		<function class="GtkTreeView">get_selection</function>. Ele pode ser manipulado
		para verificar o estado da seleção da árvore, bem como selecionar e remover a seleção
		de linhas individuais. A seleção é feita do lado da view. Como resultado, mútliplas views
		do mesmo modelo podem conter seleções diferentes. Adicionalmente, você não pode
		mudar a seleção de uma linha no modelo que não foi exibido sem a expansão de seus parents
		antes.
   </para>
   <para>
		 Uma das coisas importantes a se lembrar quando se monitora a seleção de uma view,
		 é que seu sinal <signalname class="GtkTreeSelection">changed</signalname>
		 é como uma dica. Adicionalmente, isto pode ocasionar a emissão do sinal
		 quando nada tenha acontecido (assim como o resultado do programador chamar
		 <function class="GtkTreeView">select_row</function> em uma linha já selecionada).
   </para>
  </desc>
 </classmeta>

 <methods>

  <method id="gtk.gtktreeselection.method.count_selected_rows">
   <funcsynopsis>
    <funcprototype>
     <funcdef>int <function>count_selected_rows</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Retorna o número de linhas selecionadas.
   </shortdesc>
   <desc>
    <para>
			Retorna o número de linhas selecionadas.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">get_selected</function>,
     <function class="GtkTreeSelection">get_selected_rows</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.get_mode">
   <funcsynopsis>
    <funcprototype>
     <funcdef><enumname>GtkSelectionMode</enumname> <function>get_mode</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Retorna o modo de seleção da seleção.
   </shortdesc>
   <desc>
    <para>
			Retorna o modo de seleção da seleção. O modo de seleção determina como as
			linhas na view podem ser selecionadas (apenas uma linha, múltiplas linhas, ...)
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">set_mode</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.get_selected">
   <funcsynopsis>
    <funcprototype>
     <funcdef>array <function>get_selected</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Retorna a linha selecionada.
   </shortdesc>
   <desc>
    <para>
			Retorna um array contendo o
			<link linkend="gtk.gtktreemodel">model</link> e o 
			<link linkend="gtk.gtktreeiter">iterator</link> da linha selecionada
			atualmente.
    </para>
    <para>
		 Este método funciona somente se o modo de seleção
     (<link linkend="gtk.enum.selectionmode">selection mode</link>) está definido
     (<link linkend="gtk.gtktreeselection.method.set_mode">set</link>)
     com
     <optionname enum="GtkSelectionMode">Gtk::SELECTION_SINGLE</optionname>
     ou
     <optionname enum="GtkSelectionMode">Gtk::SELECTION_BROWSE</optionname>.
		 Para outros modos, retorne a seleção com
     <function class="GtkTreeSelection">get_selected_rows</function>.
    </para>
    <example>
     <title>Usando get_selected</title>
     <programlisting role="php">
      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
                  href="&directory.examples;/reference/gtk/gtktreeview/selection.phpw" parse="text">
       <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
      </xi:include>
     </programlisting>
    </example>
    <para>
     &seealso;
     <function class="GtkTreeSelection">get_selected_rows</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.get_selected_rows">
   <funcsynopsis>
    <funcprototype>
     <funcdef>array <function>get_selected_rows</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Retorna as linhas selecionadas para uma seleção múltipla.
   </shortdesc>
   <desc>
    <para>
			Retorna um array contentdo o
			<link linkend="gtk.gtktreemodel">model</link> e um array com os caminhos
			da árvore das linhas selecionadas. O array do caminho pode ser percorrido
			por um <literal>foreach</literal> ou <literal>for</literal>, e os caminhos
			podem ser convertidos em iteradores através do método
			<function class="GtkTreeModel">get_iter</function>
     da classe <classname>GtkTreeModel</classname>.
    </para>
    <para>
			Diferentemente do método <function class="GtkTreeSelection">get_selected</function>,
			este funciona com todos os modos de seleção
     (<link linkend="gtk.enum.selectionmode">selection modes</link>).
    </para>
    <example>
     <title>Usando get_selected_rows</title>
     <programlisting role="php">
      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
                  href="&directory.examples;/reference/gtk/gtktreeselection/multi.phpw" parse="text">
       <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
      </xi:include>
     </programlisting>
    </example>
    <para>
     &seealso;
     <function class="GtkTreeSelection">get_selected</function>
     <function class="GtkTreeSelection">count_selected_rows</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.get_tree_view">
   <funcsynopsis>
    <funcprototype>
     <funcdef><classname>GtkTreeView</classname> <function>get_tree_view</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Retorna a treeview.
   </shortdesc>
   <desc>
    <para>
			Retorna o <classname>GtkTreeView</classname> no qual o objeto da seleção 
			pertence.
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.get_user_data">
   <funcsynopsis>
    <funcprototype>
     <funcdef> <function>get_user_data</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    FIXME
   </shortdesc>
   <desc>

   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.iter_is_selected">
   <funcsynopsis>
    <funcprototype>
     <funcdef>bool <function>iter_is_selected</function></funcdef>
     <paramdef><classname>GtkTreeIter</classname> <parameter>iter</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Verifica se um iterador está selecionado ou não.
   </shortdesc>
   <desc>
    <para>
			Verifica se um iterador está selecionado ou não.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">path_is_selected</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.path_is_selected">
   <funcsynopsis>
    <funcprototype>
     <funcdef>bool <function>path_is_selected</function></funcdef>
     <paramdef>string <parameter>path</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Verifica se o caminho de uma árvore está selecionado ou não.
   </shortdesc>
   <desc>
    <para>
			Verifica se o caminho de uma árvore está selecionado ou não.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">iter_is_selected</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.select_all">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>select_all</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Seleciona todas as linhas.
   </shortdesc>
   <desc>
    <para>
			Seleciona todas as linhas.
		</para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">unselect_all</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.select_iter">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>select_iter</function></funcdef>
     <paramdef><classname>GtkTreeIter</classname> <parameter>iter</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Seleciona uma linha.
   </shortdesc>
   <desc>
    <para>
			Seleciona uma linha especificada por <parameter>iter</parameter>.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">unselect_iter</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.select_path">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>select_path</function></funcdef>
     <paramdef>string <parameter>path</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Seleciona uma linha.
   </shortdesc>
   <desc>
    <para>
			Seleciona uma linha especificada por <parameter>path</parameter>.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">unselect_path</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.select_range">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>select_range</function></funcdef>
     <paramdef>int <parameter>lower</parameter></paramdef>
     <paramdef>int <parameter>upper</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Seleciona um itervalo de linhas.
   </shortdesc>
   <desc>
    <para>
     Seleciona as linhas entre <parameter>lower</parameter> e
     <parameter>upper</parameter>.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">unselect_range</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.selected_foreach">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>selected_foreach</function></funcdef>
     <paramdef>callback <parameter>function</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Chama uma função para cada linha selecionada.
   </shortdesc>
   <desc>
    <para>
			Chama a função ou método especificado pelo parâmetro
			<parameter>function</parameter> uma vez para cada linha 
			selecionada.
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.set_mode">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>set_mode</function></funcdef>
     <paramdef><enumname>GtkSelectionMode</enumname> <parameter>type</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Define o modo de seleção.
   </shortdesc>
   <desc>
    <para>
			Define o modo de seleção. O modo de seleção determina como as linhas
			na view serão selecionadas (apenas uma linha, múltiplas linhas, ...).
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">get_mode</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.set_select_function">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>set_select_function</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    FIXME
   </shortdesc>
   <desc>

   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.unselect_all">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>unselect_all</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Remove a seleção de todas as linhas.
   </shortdesc>
   <desc>
    <para>
			Remove a seleção de todas as linhas. Após a chamada deste método
			nenhuma linha permanecerá selecionada.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">select_all</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.unselect_iter">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>unselect_iter</function></funcdef>
     <paramdef><classname>GtkTreeIter</classname> <parameter>iter</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Remove a seleção de um iterador.
   </shortdesc>
   <desc>
    <para>
			Remove a seleção de um iterador.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">select_iter</function>,
     <function class="GtkTreeSelection">unselect_path</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.unselect_path">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>unselect_path</function></funcdef>
     <paramdef>string <parameter>path</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		 Remove a seleção de um caminho.
   </shortdesc>
   <desc>
    <para>
		 Remove a seleção de um caminho da árvore.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">select_path</function>,
     <function class="GtkTreeSelection">unselect_iter</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtktreeselection.method.unselect_range">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>unselect_range</function></funcdef>
     <paramdef>int <parameter>lower</parameter></paramdef>
     <paramdef>int <parameter>upper</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Remove a seleção de um intervalo de linhas.
   </shortdesc>
   <desc>
    <para>
			Remove a seleção de um intervalo de linhas entre
			<parameter>lower</parameter> e <parameter>upper</parameter>.
    </para>
    <para>
     &seealso;
     <function class="GtkTreeSelection">select_range</function>
    </para>
   </desc>
  </method>

 </methods>

 <signals>

  <signal id="gtk.gtktreeselection.signal.changed">
   <signalname>changed</signalname>
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <cbfunction>callback</cbfunction></funcdef>
     <paramdef><classname>GtkTreeSelection</classname> <parameter>treeselection</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
		Uma ou mais linhas foram selecionadas.
   </shortdesc>
   <desc>
    <para>
			Chamado se uma ou mais linhas foram selecionadas, ou se a seleção
			de alguma linha foi removida. Ele também pode ser chamado
			quando o programa seleciona uma linha que já está atualmente selecionada.
    </para>
    <para>
     Veja <function class="GtkTreeSelection">get_selected</function>
     para um exemplo.
    </para>
   </desc>
  </signal>
 </signals>

</classentry>