~ubuntu-branches/ubuntu/utopic/nautilus-python/utopic

« back to all changes in this revision

Viewing changes to examples/documentation.py

  • Committer: Bazaar Package Importer
  • Author(s): Michael Terry
  • Date: 2011-07-06 13:17:39 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20110706131739-ardhj06fem65n3l3
Tags: 1.0-0ubuntu1
* New upstream release that works with nautilus 3.0
* debian/control.in:
  - Update dependencies

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
class ColumnProvider:
2
 
    def get_columns(self):
3
 
        """
4
 
        @returns columns to show
5
 
        @rtype   a sequence of nautilus.Column
6
 
        """
7
 
 
8
 
class MenuProvider:
9
 
    def get_file_items(self, window, files):
10
 
        """
11
 
        @param window the window it was sent from
12
 
        @type  window gtk.Window
13
 
        @param files  selected files
14
 
        @type  files  list of nautilus.FileInfo
15
 
        @returns      menu items to show
16
 
        @rtype        a sequence of nautilus.MenuItems
17
 
        """
18
 
 
19
 
    def get_background_items(self, window, file):
20
 
        """
21
 
        @param window the window it was sent from
22
 
        @type  window gtk.Window
23
 
        @param file   file that was clicked on
24
 
        @type  file   nautilus.FileInfo
25
 
        @returns      menu items to show
26
 
        @rtype        a sequence of nautilus.MenuItems
27
 
        """
28
 
 
29
 
    def get_toolbar_items(self, window, file):
30
 
        """
31
 
        @param window the window it was sent from
32
 
        @type  window gtk.Window
33
 
        @param file   file that was clicked on
34
 
        @type  file   nautilus.FileInfo
35
 
        @returns      menu items to show
36
 
        @rtype        a sequence of nautilus.MenuItems
37
 
        """
38
 
 
39
 
class PropertyPageProvider:
40
 
    def get_property_pages(self, files):
41
 
        """
42
 
        @param files  selected files
43
 
        @type  files  list of nautilus.FileInfo
44
 
        @returns      property pages to show
45
 
        @rtype        a sequence of nautilus.PropertyPage
46
 
 
47
 
        Creates a property page for files
48
 
        """
49
 
        
50
 
class InfoProvider:
51
 
    def update_file_info(self, file):
52
 
        """
53
 
        @param file   selected file
54
 
        @type  file   list of nautilus.FileInfo
55
 
 
56
 
        This is used to update data for file, use the set_data method,
57
 
        and use together with the other extensions
58
 
        """
59
 
 
60
 
class Menu:
61
 
    def append(self, menu_item):
62
 
        """
63
 
        @type   menu_item   nautilus.MenuItem
64
 
        """
65
 
        pass
66
 
        
67
 
    def get_items(self):
68
 
        """
69
 
        @rtype  list of nautilus.MenuItem
70
 
        """
71
 
        pass
72
 
 
73
 
class MenuItem:
74
 
    """
75
 
    Properties:
76
 
      name (string)        - the identifier for the menu item
77
 
      label (string)       - the user-visible label of the menu item
78
 
      tip (string)         - the tooltip of the menu item 
79
 
      icon (string)        - the name of the icon to display in the menu item
80
 
      sensitive (boolean)  - whether the menu item is sensitive or not
81
 
      priority (boolean)   - used for toolbar items, whether to show priority
82
 
 
83
 
    Signals:
84
 
      activate (button)
85
 
    """
86
 
    
87
 
    def __init__(self, name, label, tip, icon=None):
88
 
        pass
89
 
    
90
 
    def activate(self):
91
 
        pass
92
 
 
93
 
    def set_submenu(self, menu):
94
 
        """
95
 
        @type   menu    nautilus.Menu
96
 
        """
97
 
        pass
98
 
    
99
 
class Column:
100
 
    """
101
 
    Properties:
102
 
      name (string)        - the identifier for the column
103
 
      attribute (string)   - the file attribute to be displayed in the 
104
 
                              column
105
 
      label (string)       - the user-visible label for the column
106
 
      description (string) - a user-visible description of the column
107
 
      xalign (float)       - x-alignment of the column 
108
 
    """
109
 
    
110
 
    def __init__(self, name, attribute, label, description):
111
 
        pass
112
 
 
113
 
class FileInfo:
114
 
    def is_gone(self):
115
 
        """
116
 
        @rtype   boolean
117
 
        """
118
 
        pass
119
 
 
120
 
    def get_file_type(self):
121
 
        """
122
 
        @rtype   gio FileType enum
123
 
        """
124
 
        pass
125
 
 
126
 
    def get_location(self):
127
 
        """
128
 
        @rtype   gio.File
129
 
        """
130
 
        pass
131
 
 
132
 
    def get_name(self):
133
 
        """
134
 
        @rtype   string
135
 
        """
136
 
        pass
137
 
 
138
 
    def get_uri(self):
139
 
        """
140
 
        @rtype   string
141
 
        """
142
 
        pass
143
 
 
144
 
    def get_activation_uri(self):
145
 
        """
146
 
        @rtype   string
147
 
        """
148
 
        pass
149
 
 
150
 
    def get_parent_location(self):
151
 
        """
152
 
        @rtype   gio.File
153
 
        """
154
 
        pass
155
 
 
156
 
    def get_parent_uri(self):
157
 
        """
158
 
        @rtype   string
159
 
        """
160
 
        pass
161
 
 
162
 
    def get_mount(self):
163
 
        """
164
 
        @rtype   gio.Mount
165
 
        """
166
 
        pass
167
 
 
168
 
    def get_uri_scheme(self):
169
 
        """
170
 
        @rtype   string
171
 
        """
172
 
        pass
173
 
 
174
 
    def get_mime_type(self):
175
 
        """
176
 
        @rtype   string
177
 
        """
178
 
        pass
179
 
    
180
 
    def is_mime_type(self, mime_type):
181
 
        """
182
 
        @type   mime_type   string
183
 
        @rtype  boolean
184
 
        """
185
 
        pass
186
 
 
187
 
    def is_directory(self):
188
 
        """
189
 
        @rtype   boolean
190
 
        """
191
 
        pass
192
 
    
193
 
    def can_write(self):
194
 
        """
195
 
        @rtype   boolean
196
 
        """
197
 
        pass
198
 
 
199
 
    def add_emblem(self, emblem):
200
 
        """
201
 
        @rtype   void
202
 
        """
203
 
        pass
204
 
    
205
 
    def get_string_attribute(self, attribute_name):
206
 
        """
207
 
        @rtype   string
208
 
        """
209
 
        pass
210
 
 
211
 
    def add_string_attribute(self, attribute_name, value):
212
 
        """
213
 
        @rtype   void
214
 
        """
215
 
        pass
216
 
 
217
 
    def invalidate_extension_info(self):
218
 
        """
219
 
        @rtype   void
220
 
        """
221
 
        pass
222
 
    
223
 
class PropertyPage:
224
 
    """
225
 
    Properties:
226
 
      name (string)        - the identifier for the property page
227
 
      label (widget)       - the user-visible label of the property page
228
 
      page (widget)        - the property page to display
229
 
    """
230
 
 
231
 
    def __init__(self, name, label, page):
232
 
        pass
233
 
    
234