Bases: camelot.admin.action.base.ActionStep
Pop up a form for the user to change an object
Parameters: |
|
---|
Use this method to get access to the object to change in unit tests
Returns: | the object to change |
---|
Bases: camelot.admin.action.base.ActionStep
Pop up a list for the user to change objects
Parameters: |
|
---|
Use this method to get access to the objects to change in unit tests
Returns: | the object to change |
---|
Bases: camelot.admin.action.base.ActionStep
Inform the GUI that obj was created.
Parameters: | obj – the object that was created |
---|
Bases: camelot.admin.action.base.ActionStep
Inform the GUI that obj is going to be deleted.
Parameters: | obj – the object that is going to be deleted |
---|
Bases: camelot.admin.action.base.ActionStep
Flushes the session and informs the GUI about the changes.
Parameters: | session – an instance of sqlalchemy.orm.Session |
---|
Bases: camelot.admin.action.base.ActionStep
Open a file with the preferred application from the user. The absolute path is preferred, as this is most likely to work when running from an egg and in all kinds of setups.
Parameters: | path – the absolute path to the file to open |
---|
The yield statement will return True if the file was opend successfull.
Create a temporary filename that can be used to write to, and open later on.
Parameters: | suffix – the suffix of the file to create |
---|---|
Returns: | the filename of the temporary file |
Returns: | the path to the file that will be opened, use this method |
---|
to verify the content of the file in unit tests
Bases: camelot.admin.action.base.ActionStep
Open the form view for a list of objects, in a non blocking way :param objects: the list of objects to display in the form view :param admin: the admin class to use to display the form
Bases: camelot.view.action_steps.open_file.OpenStream
Render a jinja template into a temporary file and open that file with the prefered application of the user.
Parameters: |
|
---|
Bases: camelot.view.action_steps.open_file.OpenFile
Write a stream to a temporary file and open that file with the preferred application of the user.
Parameters: |
|
---|
Bases: camelot.view.action_steps.print_preview.PrintPreview
Display a print preview dialog box for an html string.
Parameters: | html – a string containing the html to render in the print preview. |
---|
the rendering of the html can be customised using the same attributes as those of the PrintPreview class.
Bases: camelot.view.action_steps.print_preview.PrintHtml
Render a jinja template into a print preview dialog.
Parameters: |
|
---|
Bases: camelot.admin.action.base.ActionStep
Display a print preview dialog box.
Parameters: | document – an instance of QtGui.QTextDocument or QtWebKit.QWebView that has a print_() method. The thread affinity of this object will be changed to be able to use it in the GUI. |
---|
the print preview can be customised using these attributes :
the page size, by default QtGui.QPrinter.A4 is used
the page orientation, by default QtGui.QPrinter.Portrait is used.
create the print preview widget. this method is used to unit test the action step.
Bases: camelot.admin.action.base.ActionStep
Refresh all the open screens on the desktop, this will reload queries from the database
Bases: camelot.admin.action.base.ActionStep
Select one or more files to open or to process.
Parameters: | file_name_filter – Filter on the names of the files that can be selected, such as ‘All files (*)’. See QtGui.QFileDialog for more documentation. |
---|
defaults to True, set to False if selection of multiple files is allowed
defaults to True, set to False if non existing files are allowed (to save something)
The yield statement of SelectFile returns a list of selected file names. This list has only one element when single is set to True. Raises a camelot.core.exception.CancelRequest when no file was selected.
create the file dialog widget. this method is used to unit test the action step.
Bases: camelot.admin.action.base.ActionStep
Show a full screen chart.
Parameters: | chart – a camelot.core.container.FigureContainer or camelot.core.container.AxesContainer |
---|
Bases: camelot.admin.action.base.ActionStep
Show a full screen pixmap
Parameters: | pixmap – a camelot.view.art.Pixmap object |
---|
Bases: camelot.admin.action.base.ActionStep
Inform the GUI that obj has changed.
Parameters: | obj – the object that has changed |
---|
Bases: camelot.admin.action.base.ActionStep
Inform the user about the progress the application is making while executing an action. This ActionStep is not blocking. So it can be used inside transactions and will result in a minimum of delay when yielded. Each time an object is yielded, the progress dialog will be updated.
Parameters: |
|
---|
This method will update the progress dialog, if such dialog exists within the GuiContext
Parameters: | gui_context – a camelot.admin.action.GuiContext instance |
---|
Bases: camelot.admin.action.base.ActionStep
Pop up a form for the user to change an object
Parameters: |
|
---|
Bases: camelot.view.controls.standalone_wizard_page.StandaloneWizardPage
A dialog to change an object. This differs from a FormView in that it does not contains Actions, and has an OK button that is enabled when the object is valid.
Parameters: |
|
---|
Bases: camelot.admin.action.base.ActionStep
Pop up a list for the user to change objects
Parameters: |
|
---|
Bases: camelot.view.controls.standalone_wizard_page.StandaloneWizardPage
A dialog to change a list of objects. This differs from a ListView in that it does not contains Actions, and has an OK button that is enabled when all objects are valid.
Parameters: |
|
---|
Various ActionStep subclasses that manipulate the GUI of the application.
Bases: camelot.admin.action.base.ActionStep
Open the form view for a list of objects, in a non blocking way :param objects: the list of objects to display in the form view :param admin: the admin class to use to display the form
Bases: camelot.admin.action.base.ActionStep
Refresh all the open screens on the desktop, this will reload queries from the database
Bases: camelot.admin.action.base.ActionStep
Show a full screen chart.
Parameters: | chart – a camelot.core.container.FigureContainer or camelot.core.container.AxesContainer |
---|
Bases: camelot.admin.action.base.ActionStep
Show a full screen pixmap
Parameters: | pixmap – a camelot.view.art.Pixmap object |
---|
Bases: camelot.admin.action.base.ActionStep
Open a file with the preferred application from the user. The absolute path is preferred, as this is most likely to work when running from an egg and in all kinds of setups.
Parameters: | path – the absolute path to the file to open |
---|
The yield statement will return True if the file was opend successfull.
Create a temporary filename that can be used to write to, and open later on.
Parameters: | suffix – the suffix of the file to create |
---|---|
Returns: | the filename of the temporary file |
Bases: camelot.view.action_steps.open_file.OpenStream
Render a jinja template into a temporary file and open that file with the prefered application of the user.
Parameters: |
|
---|
Bases: camelot.view.action_steps.open_file.OpenFile
Write a stream to a temporary file and open that file with the preferred application of the user.
Parameters: |
|
---|
Various ActionStep subclasses that inform the GUI of changes in the model.
Bases: camelot.admin.action.base.ActionStep
Inform the GUI that obj was created.
Parameters: | obj – the object that was created |
---|
Bases: camelot.admin.action.base.ActionStep
Inform the GUI that obj is going to be deleted.
Parameters: | obj – the object that is going to be deleted |
---|
Bases: camelot.admin.action.base.ActionStep
Flushes the session and informs the GUI about the changes.
Parameters: | session – an instance of sqlalchemy.orm.Session |
---|
Bases: camelot.admin.action.base.ActionStep
Inform the GUI that obj has changed.
Parameters: | obj – the object that has changed |
---|
Bases: camelot.view.action_steps.print_preview.PrintPreview
Display a print preview dialog box for an html string.
Parameters: | html – a string containing the html to render in the print preview. |
---|
the rendering of the html can be customised using the same attributes as those of the PrintPreview class.
Bases: camelot.view.action_steps.print_preview.PrintHtml
Render a jinja template into a print preview dialog.
Parameters: |
|
---|
Bases: camelot.admin.action.base.ActionStep
Display a print preview dialog box.
Parameters: | document – an instance of QtGui.QTextDocument or QtWebKit.QWebView that has a print_() method. The thread affinity of this object will be changed to be able to use it in the GUI. |
---|
the print preview can be customised using these attributes :
the page size, by default QtGui.QPrinter.A4 is used
the page orientation, by default QtGui.QPrinter.Portrait is used.
Bases: camelot.admin.action.base.ActionStep
Select one or more files to open or to process.
Parameters: | file_name_filter – Filter on the names of the files that can be selected, such as ‘All files (*)’. See QtGui.QFileDialog for more documentation. |
---|
defaults to True, set to False if selection of multiple files is allowed
defaults to True, set to False if non existing files are allowed (to save something)
The yield statement of SelectFile returns a list of selected file names. This list has only one element when single is set to True. Raises a camelot.core.exception.CancelRequest when no file was selected.
Bases: camelot.admin.action.base.ActionStep
Inform the user about the progress the application is making while executing an action. This ActionStep is not blocking. So it can be used inside transactions and will result in a minimum of delay when yielded. Each time an object is yielded, the progress dialog will be updated.
Parameters: |
|
---|
This method will update the progress dialog, if such dialog exists within the GuiContext
Parameters: | gui_context – a camelot.admin.action.GuiContext instance |
---|