~ubuntu-branches/debian/experimental/gtk+2.0/experimental

« back to all changes in this revision

Viewing changes to docs/reference/gtk/xml/gtkrecentchooser.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-09-17 11:15:05 UTC
  • mto: (72.1.1 lenny) (1.4.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 55.
  • Revision ID: james.westby@ubuntu.com-20070917111505-giz9c5xltxkb5y54
Tags: upstream-2.12.0
ImportĀ upstreamĀ versionĀ 2.12.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
118
118
 
119
119
</refsect1>
120
120
 
 
121
<refsect1 role="properties">
 
122
<title role="properties.title">Properties</title>
 
123
<synopsis>
 
124
 
 
125
  &quot;<link linkend="GtkRecentChooser--filter">filter</link>&quot;                   <link linkend="GtkRecentFilter">GtkRecentFilter</link>       : Read / Write
 
126
  &quot;<link linkend="GtkRecentChooser--limit">limit</link>&quot;                    <link linkend="gint">gint</link>                  : Read / Write
 
127
  &quot;<link linkend="GtkRecentChooser--local-only">local-only</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write
 
128
  &quot;<link linkend="GtkRecentChooser--recent-manager">recent-manager</link>&quot;           <link linkend="GtkRecentManager">GtkRecentManager</link>      : Write / Construct Only
 
129
  &quot;<link linkend="GtkRecentChooser--select-multiple">select-multiple</link>&quot;          <link linkend="gboolean">gboolean</link>              : Read / Write
 
130
  &quot;<link linkend="GtkRecentChooser--show-icons">show-icons</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write
 
131
  &quot;<link linkend="GtkRecentChooser--show-not-found">show-not-found</link>&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write
 
132
  &quot;<link linkend="GtkRecentChooser--show-private">show-private</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write
 
133
  &quot;<link linkend="GtkRecentChooser--show-tips">show-tips</link>&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write
 
134
  &quot;<link linkend="GtkRecentChooser--sort-type">sort-type</link>&quot;                <link linkend="GtkRecentSortType">GtkRecentSortType</link>     : Read / Write
 
135
</synopsis>
 
136
</refsect1>
121
137
 
122
138
<refsect1 role="signal_proto">
123
139
<title role="signal_proto.title">Signals</title>
124
140
<synopsis>
125
141
 
126
 
  <link linkend="GtkRecentChooser-item-activated">item-activated</link>                                 : Run Last
127
 
  <link linkend="GtkRecentChooser-selection-changed">selection-changed</link>                              : Run Last
 
142
  &quot;<link linkend="GtkRecentChooser-item-activated">item-activated</link>&quot;                                 : Run Last
 
143
  &quot;<link linkend="GtkRecentChooser-selection-changed">selection-changed</link>&quot;                              : Run Last
128
144
</synopsis>
129
145
</refsect1>
130
146
 
443
459
<indexterm role="2.10"><primary>gtk_recent_chooser_set_show_tips</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_recent_chooser_set_show_tips    (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser,
444
460
                                                         <link linkend="gboolean">gboolean</link> show_tips);</programlisting>
445
461
<para>
446
 
Sets whether to show a tooltips on the widget.</para>
 
462
Sets whether to show a tooltips containing the full path of each
 
463
recently used resource in a <link linkend="GtkRecentChooser"><type>GtkRecentChooser</type></link> widget.</para>
447
464
<para>
448
465
 
449
466
</para><variablelist role="params">
459
476
<title><anchor id="gtk-recent-chooser-get-show-tips" role="function" condition="since:2.10"/>gtk_recent_chooser_get_show_tips ()</title>
460
477
<indexterm role="2.10"><primary>gtk_recent_chooser_get_show_tips</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_recent_chooser_get_show_tips    (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser);</programlisting>
461
478
<para>
462
 
Gets whether <parameter>chooser</parameter> should display tooltips.</para>
 
479
Gets whether <parameter>chooser</parameter> should display tooltips containing the full path
 
480
of a recently user resource.</para>
463
481
<para>
464
482
 
465
483
</para><variablelist role="params">
473
491
</variablelist><para role="since">Since  2.10
474
492
</para></refsect2>
475
493
<refsect2>
476
 
<title><anchor id="gtk-recent-chooser-set-show-numbers" role="function" condition="since:2.10"/>gtk_recent_chooser_set_show_numbers ()</title>
477
 
<indexterm role="2.10"><primary>gtk_recent_chooser_set_show_numbers</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_recent_chooser_set_show_numbers (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser,
 
494
<title><anchor id="gtk-recent-chooser-set-show-numbers" role="function" condition="deprecated:2.12: Use gtk_recent_chooser_menu_set_show_numbers() instead.|since:2.10"/>gtk_recent_chooser_set_show_numbers ()</title>
 
495
<indexterm role="deprecated"><primary>gtk_recent_chooser_set_show_numbers</primary></indexterm><indexterm role="2.10"><primary>gtk_recent_chooser_set_show_numbers</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_recent_chooser_set_show_numbers (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser,
478
496
                                                         <link linkend="gboolean">gboolean</link> show_numbers);</programlisting>
479
 
<para>
480
 
Whether to show recently used resources prepended by a unique number.
481
 
</para>
482
 
<para>
483
 
Do not use this function: use <link linkend="gtk-recent-chooser-menu-set-show-numbers"><function>gtk_recent_chooser_menu_set_show_numbers()</function></link>
484
 
instead.</para>
 
497
<warning><para><literal>gtk_recent_chooser_set_show_numbers</literal> has been deprecated since version 2.12 and should not be used in newly-written code. Use <link linkend="gtk-recent-chooser-menu-set-show-numbers"><function>gtk_recent_chooser_menu_set_show_numbers()</function></link> instead.</para></warning>
 
498
<para>
 
499
Whether to show recently used resources prepended by a unique number.</para>
485
500
<para>
486
501
 
487
502
</para><variablelist role="params">
494
509
</variablelist><para role="since">Since  2.10
495
510
</para></refsect2>
496
511
<refsect2>
497
 
<title><anchor id="gtk-recent-chooser-get-show-numbers" role="function" condition="since:2.10"/>gtk_recent_chooser_get_show_numbers ()</title>
498
 
<indexterm role="2.10"><primary>gtk_recent_chooser_get_show_numbers</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_recent_chooser_get_show_numbers (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser);</programlisting>
 
512
<title><anchor id="gtk-recent-chooser-get-show-numbers" role="function" condition="deprecated:2.12: use gtk_recent_chooser_menu_get_show_numbers() instead.|since:2.10"/>gtk_recent_chooser_get_show_numbers ()</title>
 
513
<indexterm role="deprecated"><primary>gtk_recent_chooser_get_show_numbers</primary></indexterm><indexterm role="2.10"><primary>gtk_recent_chooser_get_show_numbers</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_recent_chooser_get_show_numbers (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser);</programlisting>
 
514
<warning><para><literal>gtk_recent_chooser_get_show_numbers</literal> has been deprecated since version 2.12 and should not be used in newly-written code. use <link linkend="gtk-recent-chooser-menu-get-show-numbers"><function>gtk_recent_chooser_menu_get_show_numbers()</function></link> instead.</para></warning>
499
515
<para>
500
516
Returns whether <parameter>chooser</parameter> should display recently used resources
501
 
prepended by a unique number.
502
 
</para>
503
 
<para>
504
 
Do not use this function: use <link linkend="gtk-recent-chooser-menu-get-show-numbers"><function>gtk_recent_chooser_menu_get_show_numbers()</function></link>
505
 
instead.</para>
 
517
prepended by a unique number.</para>
506
518
<para>
507
519
 
508
520
</para><variablelist role="params">
912
924
</para></refsect2>
913
925
 
914
926
</refsect1>
 
927
<refsect1 role="property_details">
 
928
<title role="property_details.title">Property Details</title>
 
929
<refsect2><title><anchor id="GtkRecentChooser--filter"/>The <literal>&quot;filter&quot;</literal> property</title>
 
930
<indexterm role="2.10"><primary>GtkRecentChooser:filter</primary></indexterm><programlisting>  &quot;filter&quot;                   <link linkend="GtkRecentFilter">GtkRecentFilter</link>       : Read / Write</programlisting>
 
931
<para>
 
932
The <link linkend="GtkRecentFilter"><type>GtkRecentFilter</type></link> object to be used when displaying
 
933
the recently used resources.</para>
 
934
<para>
 
935
 
 
936
</para><para>Since  2.10
 
937
</para>
 
938
</refsect2>
 
939
<refsect2><title><anchor id="GtkRecentChooser--limit"/>The <literal>&quot;limit&quot;</literal> property</title>
 
940
<indexterm role="2.10"><primary>GtkRecentChooser:limit</primary></indexterm><programlisting>  &quot;limit&quot;                    <link linkend="gint">gint</link>                  : Read / Write</programlisting>
 
941
<para>
 
942
The maximum number of recently used resources to be displayed,
 
943
or -1 to display all items. By default, the
 
944
GtkSetting:gtk-recent-files-limit setting is respected: you can
 
945
override that limit on a particular instance of <link linkend="GtkRecentChooser"><type>GtkRecentChooser</type></link>
 
946
by setting this property.</para>
 
947
<para>
 
948
 
 
949
</para><para>Allowed values: &gt;= -1</para>
 
950
<para>Default value: -1</para>
 
951
<para>Since  2.10
 
952
</para>
 
953
</refsect2>
 
954
<refsect2><title><anchor id="GtkRecentChooser--local-only"/>The <literal>&quot;local-only&quot;</literal> property</title>
 
955
<indexterm role="2.10"><primary>GtkRecentChooser:local-only</primary></indexterm><programlisting>  &quot;local-only&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
956
<para>
 
957
Whether this <link linkend="GtkRecentChooser"><type>GtkRecentChooser</type></link> should display only local (file:)
 
958
resources.</para>
 
959
<para>
 
960
 
 
961
</para><para>Default value: TRUE</para>
 
962
<para>Since  2.10
 
963
</para>
 
964
</refsect2>
 
965
<refsect2><title><anchor id="GtkRecentChooser--recent-manager"/>The <literal>&quot;recent-manager&quot;</literal> property</title>
 
966
<indexterm role="2.10"><primary>GtkRecentChooser:recent-manager</primary></indexterm><programlisting>  &quot;recent-manager&quot;           <link linkend="GtkRecentManager">GtkRecentManager</link>      : Write / Construct Only</programlisting>
 
967
<para>
 
968
The <link linkend="GtkRecentManager"><type>GtkRecentManager</type></link> instance used by the <link linkend="GtkRecentChooser"><type>GtkRecentChooser</type></link> to
 
969
display the list of recently used resources.</para>
 
970
<para>
 
971
 
 
972
</para><para>Since  2.10
 
973
</para>
 
974
</refsect2>
 
975
<refsect2><title><anchor id="GtkRecentChooser--select-multiple"/>The <literal>&quot;select-multiple&quot;</literal> property</title>
 
976
<indexterm role="2.10"><primary>GtkRecentChooser:select-multiple</primary></indexterm><programlisting>  &quot;select-multiple&quot;          <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
977
<para>
 
978
Allow the user to select multiple resources.</para>
 
979
<para>
 
980
 
 
981
</para><para>Default value: FALSE</para>
 
982
<para>Since  2.10
 
983
</para>
 
984
</refsect2>
 
985
<refsect2><title><anchor id="GtkRecentChooser--show-icons"/>The <literal>&quot;show-icons&quot;</literal> property</title>
 
986
<indexterm role="2.10"><primary>GtkRecentChooser:show-icons</primary></indexterm><programlisting>  &quot;show-icons&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
987
<para>
 
988
Whether this <link linkend="GtkRecentChooser"><type>GtkRecentChooser</type></link> should display an icon near the item.</para>
 
989
<para>
 
990
 
 
991
</para><para>Default value: TRUE</para>
 
992
<para>Since  2.10
 
993
</para>
 
994
</refsect2>
 
995
<refsect2><title><anchor id="GtkRecentChooser--show-not-found"/>The <literal>&quot;show-not-found&quot;</literal> property</title>
 
996
<indexterm role="2.10"><primary>GtkRecentChooser:show-not-found</primary></indexterm><programlisting>  &quot;show-not-found&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
997
<para>
 
998
Whether this <link linkend="GtkRecentChooser"><type>GtkRecentChooser</type></link> should display the recently used resources
 
999
even if not present anymore. Setting this to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> will perform a
 
1000
potentially expensive check on every local resource (every remote
 
1001
resource will always be displayed).</para>
 
1002
<para>
 
1003
 
 
1004
</para><para>Default value: FALSE</para>
 
1005
<para>Since  2.10
 
1006
</para>
 
1007
</refsect2>
 
1008
<refsect2><title><anchor id="GtkRecentChooser--show-private"/>The <literal>&quot;show-private&quot;</literal> property</title>
 
1009
<indexterm><primary>GtkRecentChooser:show-private</primary></indexterm><programlisting>  &quot;show-private&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
1010
<para>Whether the private items should be displayed.</para><para>Default value: FALSE</para>
 
1011
</refsect2>
 
1012
<refsect2><title><anchor id="GtkRecentChooser--show-tips"/>The <literal>&quot;show-tips&quot;</literal> property</title>
 
1013
<indexterm role="2.10"><primary>GtkRecentChooser:show-tips</primary></indexterm><programlisting>  &quot;show-tips&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
1014
<para>
 
1015
Whether this <link linkend="GtkRecentChooser"><type>GtkRecentChooser</type></link> should display a tooltip containing the
 
1016
full path of the recently used resources.</para>
 
1017
<para>
 
1018
 
 
1019
</para><para>Default value: FALSE</para>
 
1020
<para>Since  2.10
 
1021
</para>
 
1022
</refsect2>
 
1023
<refsect2><title><anchor id="GtkRecentChooser--sort-type"/>The <literal>&quot;sort-type&quot;</literal> property</title>
 
1024
<indexterm role="2.10"><primary>GtkRecentChooser:sort-type</primary></indexterm><programlisting>  &quot;sort-type&quot;                <link linkend="GtkRecentSortType">GtkRecentSortType</link>     : Read / Write</programlisting>
 
1025
<para>
 
1026
Sorting order to be used when displaying the recently used resources.</para>
 
1027
<para>
 
1028
 
 
1029
</para><para>Default value: GTK_RECENT_SORT_NONE</para>
 
1030
<para>Since  2.10
 
1031
</para>
 
1032
</refsect2>
 
1033
 
 
1034
</refsect1>
915
1035
 
916
1036
<refsect1 role="signals">
917
1037
<title role="signals.title">Signal Details</title>
918
 
<refsect2><title><anchor id="GtkRecentChooser-item-activated"/>The <literal>::item-activated</literal> signal</title>
 
1038
<refsect2><title><anchor id="GtkRecentChooser-item-activated"/>The <literal>&quot;item-activated&quot;</literal> signal</title>
919
1039
<indexterm role="2.10"><primary>GtkRecentChooser::item-activated</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser,
920
1040
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run Last</programlisting>
921
1041
<para>
932
1052
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
933
1053
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
934
1054
</variablelist><para>Since  2.10
935
 
</para></refsect2><refsect2><title><anchor id="GtkRecentChooser-selection-changed"/>The <literal>::selection-changed</literal> signal</title>
 
1055
</para></refsect2><refsect2><title><anchor id="GtkRecentChooser-selection-changed"/>The <literal>&quot;selection-changed&quot;</literal> signal</title>
936
1056
<indexterm role="2.10"><primary>GtkRecentChooser::selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkRecentChooser">GtkRecentChooser</link> *chooser,
937
1057
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run Last</programlisting>
938
1058
<para>
961
1081
</para>
962
1082
</refsect1>
963
1083
 
 
1084
 
 
1085
<refsect1><refsect2 /><refsect2 /></refsect1>
964
1086
</refentry>