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

http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/pt_BR/reference/gtk/gtkfontbutton.xml?view=markup&rev=1.1
Index: php-gtk-doc/manual/pt_BR/reference/gtk/gtkfontbutton.xml
+++ php-gtk-doc/manual/pt_BR/reference/gtk/gtkfontbutton.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<classentry id="gtk.gtkfontbutton">
 <classmeta>
  <classtitle>GtkFontButton</classtitle>
  <classparent>GtkButton</classparent>
  <classimage fileref="&directory.images;/reference/gtk/gtkfontbutton.png"/> 
  <shortdesc>
   Um botão que lança um dialogo de seleção de fonte.
  </shortdesc>
  <desc>
   <para>
    Este botão é muito parecido com
    <classname>GtkColorButton</classname> ou 
    <classname>GtkFileChooserButton</classname>. As duas funções deste botão 
    são exibir a fonte atualmente selecionada, e lançar um dialogo
    de seleção de fonte quando clicado.
   </para>
   <para>
    When clicked the <classname>GtkFontButton</classname>, will launch a
    <classname>GtkFontSelectionDialog</classname>. You may set many of the
    dialog's properties using its methods. The button is most suitable in
    preference dialogs, where you need the user to select a font.
   </para>
  </desc>
 </classmeta>

 <constructors>

  <constructor id="gtk.gtkfontbutton.constructor">
   <funcsynopsis>
    <funcprototype>
    <funcdef> <function>GtkFontButton</function></funcdef>
    <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Creates a new GtkFontButton.
   </shortdesc>
   <desc>
    <para>
     Use the constructor to generate a new font button that will launch a
     <classname>GtkFontSelectionDialog</classname> when clicked.
    </para>
   </desc>
  </constructor>

  <constructor id="gtk.gtkfontbutton.constructor.new_with_font">
   <funcsynopsis>
    <funcprototype>
    <funcdef> <function>GtkFontButton::new_with_font</function></funcdef>
    <paramdef>string <parameter>fontname</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Create a new GtkFontButton with a preset font selected.
   </shortdesc>
   <desc>
    <para>
     Use this method if you want to the font button to show a preset font
     already selected. Pass the name of the font that you would like
     selected as a parameter to this method.
    </para>
    <simpara>
     &static;
    </simpara>
   </desc>
  </constructor>

 </constructors>

 <methods>

  <method id="gtk.gtkfontbutton.method.get_font_name">
   <funcsynopsis>
    <funcprototype>
     <funcdef>string <function>get_font_name</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Retrieves the name of the font selected.
   </shortdesc>
   <desc>
    <para>
     Use this method to retrieve the name of the font that is selected by
     the user. Note that if the user hasn't used the button at all, the
     method will return the default font that
     <classname>GtkFontButton</classname> had initially showed.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">set_font_name</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.get_show_size">
   <funcsynopsis>
    <funcprototype>
     <funcdef>bool <function>get_show_size</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Returns whether the font size is displayed on the label.
   </shortdesc>
   <desc>
    <para>
     Use this method to determine whether the font size is displayed in the
     label of the <classname>GtkFontButton</classname>. The method will
     return <literal>true</literal> if it does show,
     <literal>false</literal> otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">set_show_size</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.get_show_style">
   <funcsynopsis>
    <funcprototype>
     <funcdef>bool <function>get_show_style</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Returns whether the font style is displayed on the label.
   </shortdesc>
   <desc>
    <para>
     Use this method to determine whether the font style is displayed in
     the label of the <classname>GtkFontButton</classname>. The method will
     return <literal>true</literal> if the styles such as bold, italic;
     will be shown, <literal>false</literal> otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">set_show_style</function>
    </para>

   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.get_title">
   <funcsynopsis>
    <funcprototype>
     <funcdef>string <function>get_title</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Retrieves the title of the resulting font selection dialog.
   </shortdesc>
   <desc>
    <para>
     Use this method when you want to retrieve the title that is displayed
     on the font selection dialog that results when the
     <classname>GtkFontButton</classname> is clicked.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">set_title</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.get_use_font">
   <funcsynopsis>
    <funcprototype>
     <funcdef>bool <function>get_use_font</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Returns whether the selected font is used by the button.
   </shortdesc>
   <desc>
    <para>
     Use this method when you want to determine whether the
     <classname>GtkFontButton</classname> uses the font selected in the
     font selection dialog. This means that the label of the font button 
     itself will be displayed in the selected font. The function will 
     return <literal>true</literal> if it does, <literal>false</literal>
     otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">set_use_font</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.get_use_size">
   <funcsynopsis>
    <funcprototype>
     <funcdef>bool <function>get_use_size</function></funcdef>
     <paramdef>void</paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Returns whether the selected font size is used by the button.
   </shortdesc>
   <desc>
    <para>
     Use this method to determine whether the font size selected in the
     font selection dialog will be used by the
     <classname>GtkFontButton</classname> This means that the label of 
     the font button itself will be displayed in the selected font size. 
     The function will return <literal>true</literal> if it does, 
     <literal>false</literal> otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">set_use_size</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.set_font_name">
   <funcsynopsis>
    <funcprototype>
     <funcdef>bool <function>set_font_name</function></funcdef>
     <paramdef>string <parameter>fontname</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Sets the font used by the button.
   </shortdesc>
   <desc>
    <para>
     This function will set the font name used by the
     <classname>GtkFontButton</classname>. It is therefore, the font
     displayed on the button's label. Pass the name of the font as a
     parameter to this method.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">get_font_name</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.set_show_size">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>set_show_size</function></funcdef>
     <paramdef>bool <parameter>show_size</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Sets whether the font size will be shown on the button.
   </shortdesc>
   <desc>
    <para>
     Use this method to set whether the font size selected by the font
     selection dialog will be shown on the label of the
     <classname>GtkFontButton</classname>. Pass <literal>true</literal> as
     a parameter if you want it to, <literal>false</literal> otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">get_show_size</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.set_show_style">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>set_show_style</function></funcdef>
     <paramdef>bool <parameter>show_style</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Sets whether the font style will be shown on the button. 
   </shortdesc>
   <desc>
    <para>
     Use this method to set whether the font style selected by the font
     selection dialog, such as bold or italics, will be shown on the
     <classname>GtkFontButton</classname>. Pass <literal>true</literal> as
     a parameter if you want it to, <literal>false</literal> otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">get_show_style</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.set_title">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>set_title</function></funcdef>
     <paramdef>string <parameter>title</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Sets the title of the resulting font selection dialog.
   </shortdesc>
   <desc>
    <para>
     Use this function to set the title that will be displayed on the font
     selection dialog that will appear when the
     <classname>GtkFontButton</classname> is clicked. You may pass the
     title to be displayed as a parameter to the method. Note that, if you
     do not use this method, the title will appear as "Pick a Font".
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">get_title</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.set_use_font">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>set_use_font</function></funcdef>
     <paramdef>bool <parameter>use_font</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Sets whether the font button will use the selected font.
   </shortdesc>
   <desc>
    <para>
     If you want the label of the font button itself to be displayed in the
     font that is selected, then pass <literal>true</literal> as a
     parameter to the function; <literal>false</literal> otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">get_use_font</function>
    </para>
   </desc>
  </method>

  <method id="gtk.gtkfontbutton.method.set_use_size">
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <function>set_use_size</function></funcdef>
     <paramdef>bool <parameter>use_size</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Sets whether the font button will use the selected font size.
   </shortdesc>
   <desc>
    <para>
     If you want the label of the font button to be displayed in the font
     size as selected in the font selection dialog, then pass
     <literal>true</literal> as a parameter to this function;
     <literal>false</literal> otherwise.
    </para>
    <para>
     &seealso;
     <function class="GtkFontButton">get_use_size</function>
    </para>
   </desc>
  </method>

 </methods>

 <signals>

  <signal id="gtk.gtkfontbutton.signal.font-set">
   <signalname>font-set</signalname>
   <funcsynopsis>
    <funcprototype>
     <funcdef>void <cbfunction>callback</cbfunction></funcdef>
     <paramdef>GtkFontButton <parameter>fontbutton</parameter></paramdef>
    </funcprototype>
   </funcsynopsis>
   <shortdesc>
    Emitted when the user selects a font.    
   </shortdesc>
   <desc>
   </desc>
  </signal>
  
 </signals>

</classentry>