Package flumotion :: Package component :: Package base :: Module admin_gtk :: Class BaseAdminGtkNode
[show private | hide private]
[frames | no frames]

Class BaseAdminGtkNode

Loggable --+
           |
          BaseAdminGtkNode

Known Subclasses:
EffectAdminGtkNode, FeedersAdminGtkNode

I am a base class for all GTK+-based Admin UI nodes. I am a view on a set of properties for a component.
Method Summary
  __init__(self, state, admin, title)
  callRemote(self, methodName, *args, **kwargs)
  getElementProperty(self, elementName, propertyName)
Get the value of the given property of the element with the given name.
  getWidget(self, name)
  gotUIState(self, state)
  haveWidgetTree(self)
I am called when the widget tree has been gotten from the glade file.
  loadGladeFile(self, gladeFile, domain)
Returns: a deferred returning the widget tree from the glade file.
  propertyChanged(self, name, value)
I am meant to be overridden.
  propertyErrback(self, failure, window)
  render(self, *args, **kwargs)
  setElementProperty(self, elementName, propertyName, value)
Set the given property on the element with the given name.
  setUIState(self, state)
Called by the BaseAdminGtk when it gets the UI state and the GUI is ready.
  stateAppend(self, state, key, value)
Override me
  stateDelitem(self, state, key, subkey, value)
Override me
  stateRemove(self, state, key, value)
Override me
  stateSet(self, state, key, value)
Override me
  stateSetitem(self, state, key, subkey, value)
Override me
  status_pop(self, mid)
  status_push(self, str)
    Inherited from Loggable
  debug(self, *args)
Log a debug message.
dict doLog(self, level, where, format, *args, **kwargs)
Log a message at the given level, with the possibility of going higher up in the stack.
  error(self, *args)
Log an error.
  info(self, *args)
Log an informational message.
  log(self, *args)
Log a log message.
  logFunction(self, *args)
Overridable log function.
  logObjectName(self)
Overridable object name function.
  warning(self, *args)
Log a warning.
  warningFailure(self, failure, swallow)
Log a warning about a Failure.

Instance Variable Summary
gtk.Widget widget: the main widget representing this node
  wtree: the widget tree representation for this node

Class Variable Summary
Implements __implemented__ = <implementedBy flumotion.component.bas...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
str gettext_domain = 'flumotion'
NoneType glade_file = None                                                                  
str logCategory: Implementors can provide a category to log their messages under.
    Inherited from Loggable
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...

Method Details

__init__(self, state, admin, title=None)
(Constructor)

Parameters:
state - state of component this is a UI node for
           (type=flumotion.common.planet.AdminComponentState)
admin - the admin model that interfaces with the manager for us
           (type=flumotion.admin.admin.AdminModel)
title - the (translated) title to show this node with
           (type=str)

getElementProperty(self, elementName, propertyName)

Get the value of the given property of the element with the given name.

Returns: twisted.internet.defer.Deferred returning the value.

haveWidgetTree(self)

I am called when the widget tree has been gotten from the glade file. Responsible for setting self.widget.

Override me to act on it.

loadGladeFile(self, gladeFile, domain='flumotion')

Returns: a deferred returning the widget tree from the glade file.

propertyChanged(self, name, value)

I am meant to be overridden.

setElementProperty(self, elementName, propertyName, value)

Set the given property on the element with the given name.

setUIState(self, state)

Called by the BaseAdminGtk when it gets the UI state and the GUI is ready. Chain up if you provide your own implementation.

stateAppend(self, state, key, value)

Override me

stateDelitem(self, state, key, subkey, value)

Override me

stateRemove(self, state, key, value)

Override me

stateSet(self, state, key, value)

Override me

stateSetitem(self, state, key, subkey, value)

Override me

Instance Variable Details

widget

the main widget representing this node
Type:
gtk.Widget

wtree

the widget tree representation for this node

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy flumotion.component.base.admin_gtk.BaseAdminGtkNode>    

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0x2b88c9265b10>   

gettext_domain

Type:
str
Value:
'flumotion'                                                            

glade_file

Type:
NoneType
Value:
None                                                                  

logCategory

Implementors can provide a category to log their messages under.
Type:
str
Value:
'admingtk'                                                             

Generated by Epydoc 2.1 on Fri Feb 2 11:29:21 2007 http://epydoc.sf.net