summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkrecentchooserwidget.xml
blob: d36a47c880cab927d4e1190d74ba4a9aeb690774 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkrecentchooserwidget">

  <refnamediv>
    <refname>gtk.RecentChooserWidget</refname>
      <refpurpose>Displays recently used files (new in PyGTK 2.10)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.RecentChooserWidget</classname></ooclass>
      <ooclass><classname><link linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
      <ooclass><classname><link linkend="class-gtkrecentchooser">gtk.RecentChooser</link></classname></ooclass>
      <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkrecentchooserwidget">gtk.RecentChooserWidget</link></methodname>
        <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbox">gtk.Box</link>
          +-- <link linkend="class-gtkvbox">gtk.VBox</link>
            +-- <link linkend="class-gtkrecentchooserwidget">gtk.RecentChooserWidget</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
            <link linkend="class-gtkrecentchooser">gtk.RecentChooser</link>            
		</para>
	</refsect1>


  <refsect1 id="properties-gtkrecentchooserwidget">
    <title>gtk.RecentChooserWidget Properties</title>

    <para><link linkend="properties-gtkrecentchooser">gtk.RecentChooser Properties</link></para>
    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkrecentchooserwidget">
    <title>gtk.RecentChooserWidget Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>

  </refsect1>

  <refsect1 id="child-properties-gtkrecentchooserwidget">
    <title>gtk.RecentChooserWidget Child Properties</title>

    <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkrecentchooserwidget">
    <title>gtk.RecentChooserWidget Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkrecentchooser">gtk.RecentChooser Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
    linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
    is a widget suitable for selecting recently used files.  It is the main
    building block of a <link
    linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>.
    Most applications will only need to use the latter; you can use <link
    linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
    as part of a larger window if you have special needs.</para>

    <para>Note that <link
    linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
    does not have any methods of its own.  Instead, you should use the
    methods that work on a <link
    linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.</para>

    <para>Recently used files are supported since GTK+ 2.10.</para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <refsect2 id="constructor-gtkrecentchooserwidget">
      <title>gtk.RecentChooserWidget</title>

      <programlisting><constructorsynopsis language="python">
        <methodname>gtk.RecentChooserWidget</methodname>
        <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">manager</parameter>&nbsp;:</term>
          <listitem><simpara>a <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link
          linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This constructor is available in PyGTK 2.10 and above.</para>
      </note>

      <para>Creates a new <link
      linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
      with an optional <link
      linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>.</para>
      
      <para>This is useful if you have implemented your own recent manager,
      or if you have a customized instance of a <link
      linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
      object.</para>

    </refsect2>

  </refsect1>

</refentry>