ocempgui.widgets.FileDialog.FileDialog

Package ocempgui :: Package widgets :: Module FileDialog :: Class FileDialog

[show private | hide private]

Type FileDialog

 object --+                            
          |                            
INotifyable --+                        
              |                        
     BaseObject --+                    
                  |                    
     object --+   |                    
              |   |                    
         Sprite --+                    
                  |                    
         BaseWidget --+                
                      |                
                    Bin --+            
                          |            
                     Window --+        
                              |        
                   DialogWindow --+    
                                  |    
                      GenericDialog --+
                                      |
                                     FileDialog

FileDialog (title, buttons, results, directory=None) -> FileDialog

A modal file selection dialog.

The FileDialog is a GenericDialog, that allows the user to select files and directories from a filesystem using a FileList widget. It also displays an entry widget to allow quick modifications of the current directory path.

The selected files and directories can be retrieved at any moment using the get_filenames() method, which returns them as a list.

selection = dialog.get_filenames ()

Default action (invoked by activate()): See the GenericDialog class.

Mnemonic action (invoked by activate_mnemonic()): See the GenericDialog class.

Attributes: filelist - The FileList widget displayed on the FileDialog.

Method Summary
	`__init__(self, title, buttons, results, directory)`
	`get_filenames(self)` F.get_filenames () -> list
	`_set_directory(self)` F._set_directory () -> None
	`_set_path(self)` F._set_path () -> None
Inherited from GenericDialog
	`set_buttons(self, buttons, results)` G.set_buttons (buttons.
	`_button_clicked(self, result)` G._button_clicked (...) -> None
Inherited from DialogWindow
	`destroy(self)` D.destroy () -> None
	`set_event_manager(self, manager)` D.set_event_manager (...) -> None
Inherited from Window
	`dispose_widget(self)` W.dispose_widget (...) -> int, int
	`draw(self)` W.draw () -> None
	`draw_bg(self)` W.draw_bg () -> Surface
	`notify(self, event)` W.notify (event) -> None
	`set_align(self, align)` W.set_align (...) -> None
	`set_focus(self, focus)` W.set_focus (...) -> None
	`set_title(self, text)` W.set_title (...) -> None
	`_contains(self, parent, widget)` W.contains (...) -> bool
	`_move_to_position(self, pos)` W._move_to_position (...) -> None
	`_notify_children(self, widget, event)` W._notify_children (...) -> None
Inherited from Bin
	`set_child(self, child)` B.set_child (...) -> None
	`set_depth(self, depth)` B.set_depth (...) -> None
	`set_indexable(self, indexable)` B.set_indexable (...) -> None
	`set_padding(self, padding)` B.set_padding (...) -> None
	`set_sensitive(self, sensitive)` B.set_sensitive (...) -> None
	`update(self, **kwargs)` B.update (...) -> None
Inherited from BaseWidget
	`activate(self)` W.activate () -> None
	`activate_mnemonic(self, mnemonic)` W.activate_mnemonic (...) -> bool
	`check_sizes(self, width, height)` W.check_sizes (...) -> int, int
	`create_style(self)` W.create_style () -> WidgetStyle
	`debug_update(self)` For debugging usage only
	`get_style(self)` W.get_style () -> WidgetStyle
	`initclass(cls)` B.initclass () -> None (Class method)
	`lock(self)` W.lock () -> None
	`rect_to_client(self, rect)` W.rect_to_client (...) -> pygame.Rect
	`set_dirty(self, dirty, update)` W.set_dirty (...) -> None
	`set_entered(self, entered)` W.set_entered (...) -> None
	`set_event_area(self, area)` W.set_event_area (...) -> None
	`set_index(self, index)` W.set_index (...) -> None
	`set_maximum_size(self, width, height)` W.set_maximum_size (...) -> None
	`set_minimum_size(self, width, height)` W.set_minimum_size (...) -> None
	`set_opacity(self, opacity)` W.set_opacity (...) -> None
	`set_position(self, x, y)` W.set_position (...) -> None
	`set_size(self, width, height)` W.set_size (...) -> None
	`set_state(self, state)` W.set_state (...) -> None
	`set_style(self, style)` W.set_style (...) -> None
	`set_tooltip(self, tooltip)` W.set_tooltip (...) -> None
	`unlock(self)` W.unlock () -> None
	`_get_rect(self)` W._get_rect () -> pygame.Rect
	`_get_rect_attr(self, attr)` W._get_rect_attr (...) -> var
	`_set_rect_attr(self, attr, value)` W._set_rect_attr (...) -> None
Inherited from BaseObject
	`connect_signal(self, signal, callback, *data)` B.connect_signal (...) -> EventCallback
	`disconnect_signal(self, event)` B.disconnect_signal (...) -> None
	`emit(self, signal, data)` B.emit (...) -> bool
	`run_signal_handlers(self, signal, *data)` B.run_signal_handlers (...) -> None
Inherited from Sprite
	`__repr__(self)`
	`add(self, *groups)` add(group or list of of groups, ...) add a sprite to container
	`add_internal(self, group)`
	`alive(self)` alive() -> bool check to see if the sprite is in any groups
	`groups(self)` groups() -> list of groups list used sprite containers
	`kill(self)` kill() remove this sprite from all groups
	`remove(self, *groups)` remove(group or list of groups, ...) remove a sprite from container
	`remove_internal(self, group)`
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Property Summary
	`filelist`: The filelist shown on the FileDialog.
Inherited from GenericDialog
	`content`: The content frame to add widgets to.
	`main`: The main frame of the dialog.
Inherited from Window
	`align`: The alignment of the child.
	`title`: The title caption of the Window.
Inherited from Bin
	`child`: The widget hold by the Bin.
	`padding`: Additional padding between child and borders.
Inherited from BaseWidget
	`bottom`
	`bottomleft`
	`bottomright`
	`center`
	`centerx`
	`centery`
	`controls`: Widgets associated with the widget.
	`depth`: The z-axis layer depth of the widget.
	`dirty`: Indicates, whether the widget need to be redrawn.
	`entered`: Indicates, whether the widget is entered.
	`eventarea`: The area, which gets the events.
	`focus`: The focus of the widget.
	`h`
	`height`
	`image`: The visible surface of the widget.
	`index`: The tab index position of the widget.
	`indexable`: The IIndexable, the widget is attached to.
	`left`
	`locked`: Indicates, whether the widget is locked.
	`maxsize`: The maximum size to occupy by the widget.
	`midbottom`
	`midleft`
	`midright`
	`midtop`
	`minsize`: The guaranteed size of the widget.
	`opacity`: The opacity of the widget.
	`position`: The position of the topleft corner.
	`rect`: The area occupied by the widget.
	`right`
	`sensitive`: The sensitivity of the widget.
	`size`
	`state`: The current state of the widget.
	`style`: The style of the widget.
	`tooltip`: The tool tip text to display for the widget.
	`top`
	`topleft`
	`topright`
	`w`
	`width`
	`x`
	`y`
Inherited from BaseObject
	`manager`: The event manager to use by the object.

Instance Method Details

get_filenames(self)

F.get_filenames () -> list

Gets a list with the selected filenames.

_set_directory(self)

F._set_directory () -> None

Sets the directory to list after a text input

_set_path(self)

F._set_path () -> None

Sets the entry text to the current directory path.

Property Details

filelist

The filelist shown on the FileDialog.

Get Method:: unknown-696725660(...)

Generated by Epydoc 2.1 on Thu Jan 10 10:18:44 2008

http://epydoc.sf.net