Package turbogears :: Package widgets :: Module base :: Class WidgetDescription

Class WidgetDescription

object --+        
         |        
    Widget --+    
             |    
CompoundWidget --+
                 |
                WidgetDescription

Known Subclasses:

CoreWD
, RenderOnlyWD

A description for a Widget.

Makes the 'for_widget' widget appear in the browser. It's a nice way to show off to your friends your coolest new widgets and to have a testing platform while developing them.

Nested Classes
	__metaclass__ Metaclass for widget descriptions.

Instance Methods

retrieve_css(self)
Get CSS for the member widgets.

source code

retrieve_javascript(self)
Get JavaScript for the member widgets.

source code

Inherited from CompoundWidget: __init__, display, iter_member_widgets, params_for, render, update_params, value_for

Inherited from Widget: __call__, __repr__, __setattr__, adjust_value

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __sizeof__, __str__, __subclasshook__

Class Variables
	template = `'\n <div xmlns:py="http://genshi.edgewall.org/"\...` hash(x)
	for_widget = `None` hash(x)
	member_widgets = `['for_widget']`
	show_separately = `False` hash(x)
	engine_name = `'genshi'` hash(x)
	template_c = `<MarkupTemplate "None">`
Inherited from `CompoundWidget`: `compound` Inherited from `Widget`: `css`, `default`, `javascript`, `params`, `params_doc`

Properties
	name
	for_widget_class
	description
	full_class_name
	source
Inherited from `Widget`: `is_named` Inherited from `object`: `__class__`

Method Details

retrieve_css(self)

source code

Get CSS for the member widgets.

Retrieve the CSS for all the member widgets and get an ordered union of them.

Overrides: Widget.retrieve_css: (inherited documentation)

retrieve_javascript(self)

source code

Get JavaScript for the member widgets.

Retrieve the JavaScript for all the member widgets and get an ordered union of them.

Overrides: Widget.retrieve_javascript: (inherited documentation)

Class Variable Details

template

hash(x)

Value:

'''
    <div xmlns:py="http://genshi.edgewall.org/"
        py:content="for_widget.display()"/>
    '''

Property Details

name

Get Method:: unreachable.name(self)

for_widget_class

Get Method:: unreachable.for_widget_class(self)

description

Get Method:: unreachable.description(self)

full_class_name

Get Method:: unreachable.full_class_name(self)

source

Get Method:: unreachable.source(self)