@TODO: rewrite docstring
Admin classes, specify how objects should be rendered in the gui
An admin class has class attributes like ‘list_display’ which contains the columns that should be displayed in a list view (again, see Django)
So this ‘list_display’ attribute can be overwritten in the Admin class for each model.
But for the gui generation itself, we don’t use the class attributes, but we use methods, like ‘getColumns’, that way, we can make the gui very specific, on the context
Bases: PyQt4.QtCore.QObject
The ApplicationAdmin class defines how the application should look like, it also ties Python classes to their associated camelot.admin.object_admin.ObjectAdmin class or subclass. It’s behaviour can be steered by overwriting its static attributes or it’s methods :
The name of the application, as it will appear in the title of the main window.
The url of the web site where the user can find more information on the application.
Points to either a local html file or a web site that contains the documentation of the application.
The name of the author of the application
The domain name of the author of the application, eg ‘mydomain.com’, this domain will be used to store settings of the application.
A string with the version of the application
A subclass of camelot.core.backup.BackupMechanism that enables the application to perform backups an restores.
The wizard that should be used to create new database profiles. Defaults to camelot.view.database_selection.ProfileWizard
if this is set to True, present the user with a database selection wizard prior to starting the application. Defaults to False.
alias of BackupMechanism
Create the main window that will be shown when the application starts up. By default, returns an instance of
Returns: | a PyQt4.QtGui.QWidget |
---|
alias of ProfileWizard
Dump the state of the application to the output, this method is triggered by pressing Ctrl-Alt-D in the GUI
Returns: | a list of camelot.admin.application_action.ApplicationAction objects |
---|
that should be added to the menu and the icon bar for this application
Returns: | a PyQt4.QtCore.QUrl pointing to an affiliated webpage |
---|
When this method returns a QUrl, an additional item will be available in the ‘Help’ menu, when clicked the system browser will be opened an pointing to this url.
This can be used to connect the user to a website that is used a lot in the organization, but hard to remember.
Get the default camelot.admin.object_admin.ObjectAdmin class for a specific entity, return None, if not known. The ObjectAdmin should either be registered through the register() method or be defined as an inner class with name Admin of the entity.
Parameters: | entity – a class |
---|
deprecated : use get_related_admin instead
Returns: | the camelot.view.art.Icon that should be used for the application |
---|
Returns: | the name of the application, by default this is the class |
---|
attribute name
Get the default camelot.admin.object_admin.ObjectAdmin class for a specific class, return None, if not known. The ObjectAdmin should either be registered through the register() method or be defined as an inner class with name Admin of the entity.
Parameters: | entity – a class |
---|
Returns: | a PyQt4.QtCore.QUrl pointing to a page to get remote support |
---|
When this method returns a QUrl, an additional item will be available in the ‘Help’ menu, when clicked the system browser will be opened an pointing to this url.
This can be used to connect the user to services like logmein.com, an online ticketing system or others.
A list of camelot.admin.section.Section objects, these are the sections to be displayed in the left panel.
Returns: | a string with the qt stylesheet to be used for this application as a string |
---|
or None if no stylesheet needed.
Camelot comes with a couple of default stylesheets :
- stylesheet/office2007_blue.qss
- stylesheet/office2007_black.qss
- stylesheet/office2007_silver.qss
Have a look at the default implementation to use another stylesheet.
Reimplement this method to add application specific translations to your application. The default method returns a list with the default Qt and the default Camelot translator for the current system locale. Call QLocale.setDefault() before this method is called if you want to load different translations then the system default.
Returns: | a list of QtCore.QTranslator objects that should be used to translate the application |
---|
Returns: | string representing version of the application, by default this |
---|
is the class attribute verion
Create a segmentation fault by reading null, this is to test the faulthandling functions. this method is triggered by pressing Ctrl-Alt-0 in the GUI
Associate a certain ObjectAdmin class with another class. This ObjectAdmin will be used as default to render object the specified type.
Parameters: |
|
---|
Pops up a messagebox showing the version of certain libraries used. This is for debugging purposes.
Bases: camelot.admin.object_admin.ObjectAdmin
Admin class specific for classes that are mapped by sqlalchemy. This allows for much more introspection than the standard camelot.admin.object_admin.ObjectAdmin.
It has additional class attributes that customise its behaviour.
Basic
The camelot.admin.action.Action that will be triggered when the user selects an item in a list of objects. This defaults to camelot.admin.action.list_action.OpenFormView, which opens a form for the current object.
Filtering
A list of fields that should be used to generate filters for in the table view. If the field named is a one2many, many2one or many2many field, the field name should be followed by a field name of the related entity
class Project(Entity):
oranization = OneToMany('Organization')
name = Field(Unicode(50))
class Admin(EntityAdmin):
list_display = ['organization']
list_filter = ['organization.name']
Copying
A dictionary of fields that will be deep copied when the user presses the copy button. This is usefull for OneToMany fields. The key in the dictionary should be the name of the field, and the value is a new dictionary that can contain other fields that need to be copied:
copy_deep = {'addresses':{}}
A list of fields that should not be copied when the user presses the copy button:
copy_exclude = ['name']
The fields that form the primary key of the object will be excluded by default.
Searching
A list of fields that should be searched when the user enters something in the search box in the table view. By default all fields are searched for which Camelot can do a conversion of the entered string to the datatype of the underlying column.
For use with one2many, many2one or many2many fields, the same rules as for the list_filter attribute apply
Defaults to True, meaning that by default all searchable fields should be searched. If this is set to False, one should explicitely set the list_search attribute to enable search.
A list of fields that will be searchable through the expanded search. When set to None, all the fields in list_display will be searchable. Use this attribute to limit the number of search widgets. Defaults to None.
Duplicate an object. If no new object is given to copy to, a new one will be created. This function will be called every time the user presses a copy button.
Parameters: |
|
---|---|
Returns: | the new object |
This function takes into account the deep_copy and the copy_exclude attributes. It tries to recreate relations with a minimum of side effects.
Returns a Qt widget that can be used to select an element from a query
Parameters: |
|
---|
returned widget has an entity_selected_signal signal that will be fired when a entity has been selected.
Takes the dynamic field attributes from through the ObjectAdmin its get_dynamic_field_attributes and add the new_message attributes for One2Many fields where the object was not flushed yet
Returns: | a list of tuples of type [(field_name, field_attributes)] |
---|
Get the attributes needed to visualize the field field_name :param field_name: the name of the field
Returns: | a dictionary of attributes needed to visualize the field, |
---|
Returns the filters applicable for these entities each filter is
Returns: | [(filter_name, [(option_name, query_decorator), ...), ... ] |
---|
Returns: | an sqlalchemy query for all the objects that should be |
---|
displayed in the table or the selection view. Overwrite this method to change the default query, which selects all rows in the database.
Returns: | True if the object has been deleted from the persistent |
---|
state, False otherwise
Returns: | True if the object has a persisted state, False otherwise |
---|
Undo the pending changes to the backend and restore the original state
Set the fields of an object to their default state.
Parameters: | include_nullable_fields – also set defaults for nullable fields, depending on the context, this should be set to False to allow the user to set the field to None |
---|
alias of EntityValidator
Class decorator to make all fields visualized with the Admin into read-only fields
Turn all fields visualized with original_admin into read only fields :param original_admin: an implementation of ObjectAdmin :param actions: True if the notEditableAdmin should have its actions enabled, default to False :param editable_fields: list of fields that should remain editable
usage
class Movie(Entity):
name = Field(Unicode(50))
contributions = Field(Unicode(255))
class Admin(EntityAdmin):
list_display = ['name', 'contributions]
Admin = notEditableAdmin(Admin, editable_fields=['contributions'])
Admin class for Plain Old Python Object
Bases: list
A list with field attributes that documents them for sphinx
Bases: object
The ObjectAdmin class describes the interface that will be used to interact with objects of a certain class. The behaviour of this class and the resulting interface can be tuned by specifying specific class attributes:
The name used in the GUI
The name used in the GUI for things like window titles and such can be specified using the verbose_name attribute.
A human-readable name for the object, singular
verbose_name = _('movie')
If this isn’t given, the class name will be used
A human-readable name for the object, plural
verbose_name_plural = _('movies')
If this isn’t given, Camelot will use verbose_name + “s”
Fields displayed
a list with the fields that should be displayed in a table view
the number of columns on the left of the tableview that should be frozen (don’t dissapear when the user uses the horizontal scroll bar), defaults to zero
An integer number specifying the height of a row in the table view, expressed as the number of lines of text it should be able to display. Defaults to 1.
a list with the fields that should be displayed in a form view, defaults to the same fields as those specified in list_display
class Admin(EntityAdmin):
form_display = ['title', 'rating', 'cover']
instead of telling which fields to display. It is also possible to define the form itself
from camelot.view.forms import Form, TabForm, WidgetOnlyForm, HBoxForm
class Admin(EntityAdmin):
form_display = TabForm([
('Movie', Form([
HBoxForm([['title', 'rating'], WidgetOnlyForm('cover')]),
'short_description',
'releasedate',
'director',
'script',
'genre',
'description', 'tags'], scrollbars=True)),
('Cast', WidgetOnlyForm('cast'))
])
Behaviour
Specifies when the data should be send from the view to the model and flushed to the database. The default mode is ‘on_change’, meaning that every change in the view will be send immediately to the database. Other possibilities are :
- ‘on_leave’ : the data will be send from the view to the model when the view
is closed, eg. : the form is closed.
Indicates if the deletion of an object should be confirmed by the user, defaults to ‘on_request’, indicating object should be deleted when the user hits the trash button. Other possibilities are :
- ‘on_confirm’ : the user will be asked for confirmation before the delete takes place.
a tuple indicating the size of a form view, defaults to (700,500)
Actions to be accessible by pushbuttons on the side of a form, a list of tuples (button_label, action_function) where action_function takes as its single argument, a method that returns the the object that was displayed by the form when the button was pressed:
class Admin(EntityAdmin):
form_actions = [('Foo', lamda o_getter:print 'foo')]
Field attributes
A dictionary specifying for each field of the model some additional attributes on how they should be displayed. All of these attributes are propagated to the constructor of the delegate of this field:
class Movie(Entity):
title = Field(Unicode(50))
class Admin(EntityAdmin):
list_display = ['title']
field_attributes = dict(title=dict(editable=False))
The Field Attributes documentation describes the various keys that can be used in the field attributes class attribute of an ObjectAdmin or EntityAdmin.
Window state
Set this attribute to ‘maximized’ or ‘minimized’ for respective behaviour. These are the only two defined at the moment. Please use the constants defined in camelot.core.constants (MINIMIZE and MAXIMIZE). Note that this attr needs to be set at the form, highest in the form hierarchy to work. Setting this on embedded forms will not influence the window state. Example:
class Movie(Entity):
title = Field(Unicode(50))
class Admin(EntityAdmin):
from camelot.core import constants
list_display = ['title']
form_state = constants.MAXIMIZED
field_attributes = dict(title=dict(editable=False))
Varia
The QAbstractItemModel class to be used to display collections of this object, defaults to a CollectionProxy
The QWidget class to be used when a table view is needed
Bases: camelot.view.controls.view.AbstractView
A generic tableview widget that puts together some other widgets. The behaviour of this class and the resulting interface can be tuned by specifying specific class attributes which define the underlying widgets used
class MovieRentalTableView(TableView):
title_format = 'Grand overview of recent movie rentals'
The attributes that can be specified are :
The widget class to be used as a header in the table view:
header_widget = HeaderWidget
The widget class used to display a table within the table view
table_widget = TableWidget
A string used to format the title of the view
title_format = ‘%(verbose_name_plural)s’
A class implementing QAbstractTableModel that will be used as a model for the table view
table_model = QueryTableProxy
Bases: camelot.view.controls.tableview.TableWidget
A table widget that inspects the admin class and changes the behavior of the table as specified in the admin class
resets search filtering to default
reimplements close event
Copy the selected rows in this tableview
Create a table model for the given admin interface
delete the selected rows in this tableview
return the columns to be displayed in the table view
generator for data queried by table model
return the name of the entity managed by the admin attribute
Returns: | a list with all the objects corresponding to the rows in the table |
---|
Returns: | a function that when called return an iterable with all the |
---|
objects corresponding to the selected rows in the table.
alias of HeaderWidget
“import data : the data will be imported in the activeMdiChild
Create a new row in the tableview
resets the table model query
Refresh the whole view
emits a row_selected signal
selects the specified row
returns a list of selected rows indexes
Switch to a different subclass, where admin is the admin object of the subclass
sets filters for the tableview
rebuilds query based on filtering text
alias of QueryTableProxy
generates html of the table
selects first row
selects last row
selects next row
selects previous row
Creates a Qt widget containing a form view, for a specific index in a model. Use this method to create a form view for a collection of objects, the user will be able to use PgUp/PgDown to move to the next object.
Parameters: |
|
---|
Create a Qt widget containing a form to create a new instance of the entity related to this admin class
The returned class has an ‘entity_created_signal’ that will be fired when a valid new entity was created by the form
Parameters: | collection_proxy – if specified, the object will be appended to |
---|
its underlying collection upon creation and removed from it upon discarding.
Create a form view for a single object, PgUp/PgDown will do nothing.
Parameters: |
|
---|
Flush the pending changes of this entity instance to the backend
A dictionary of (field_name:field_attributes) for all fields that can possibly appear in a list or a form or for which field attributes have been defined
The columns to be displayed in the list view, returns a list of pairs of the name of the field and its attributes needed to display it properly
- {‘widget’: widget_type,
- ‘editable’: True or False, ‘blank’: True or False, ‘validator_list’:[...], ‘name’:’Field name’}),
...]
Overwrite this function to generate a list of objects that depend on a given object. When obj is modified by the user, this function will be called to determine which other objects need their views updated.
Parameters: | obj – an object of the type that is managed by this admin class |
---|---|
Returns: | an iterator over objects that depend on obj |
Convenience function to get all the field attributes that are dynamic (depend on the object being visualized). This method is called once for each object/row in a table view and once for each object being visualized in a form view.
Parameters: |
|
---|---|
Returns: | [{field_attribute_name:field_attribute_value, ...}, {}, ...] |
The returned list has the same order than the requested field_names.
Get the attributes needed to visualize the field field_name. This function is called by get_static_field_attributes and get_dynamic_field_attributes.
This function first tries to fill the dictionary with field attributes for a field with those gathered through introspection, and then updates them with those found in the field_attributes class attribute.
Parameters: | field_name – the name of the field |
---|---|
Returns: | a dictionary of attributes needed to visualize the field |
The values of the returned dictionary either contain the value of the field attribute, or in the case of dynamic field attributes, a function that returns the value of the field attribute.
Get an admin object for another object class. Taking into account preferences of this admin object or for those of admin object higher up the chain such as the application admin object.
Parameters: | cls – the class for which an admin object is requested |
---|
deprecated : use get_related_admin
Convenience function to get all the field attributes that are static (don’t depend on the object being visualized). This method is only called once for a table or form view, independent of the number of objects/records being visualized.
Parameters: | field_names – a list of field names |
---|---|
Returns: | [{field_attribute_name:field_attribute_value, ...}, {}, ...] |
The returned list has the same order than the requested field_names.
Get a tree of admin classes representing the subclasses of the class represented by this admin class
Returns: | [(subclass_admin, [(subsubclass_admin, [...]),...]),...] |
---|
Create an identifier for an object that is interpretable for the user, eg : the primary key of an object. This verbose identifier can be used to generate a title for a form view of an object.
Returns: | True if the object has been deleted from the persistent |
---|
state, False otherwise
Returns: | True if the object has a persisted state, False otherwise |
---|
alias of CollectionProxy
Undo the pending changes to the backend and restore the original state
Set the defaults of an object :param include_nullable_fields: also set defaults for nullable fields, depending on the context, this should be set to False to allow the user to set the field to None
alias of ObjectValidator
Bases: object
A Section as displayed in the left pane of the application. Each Section contains a list of SectionItems the user can click on. Sections should be used in the definition of the Application admin:
Section( _('Movies'),
self,
Icon('tango/22x22/mimetypes/x-office-presentation.png'),
items = [ Movie,
Tag,
VisitorReport,
VisitorsPerDirector,
ImportCovers() ]),