This document is the reference about the concepts of the graphical user interface (also known as Tryton client ) of the Tryton application framework.
tryton - Graphical user client of the Tryton application framework
tryton [options] [url]
|--version||Show program version number and exit|
|-h, --help||Show help message and exit|
|-c FILE, --config=FILE|
|Specify alternate configuration file|
|-v, --verbose||Enable basic debugging|
|-d LOG_LOGGER, --log=LOG_LOGGER|
|Specify channels to log (ex: rpc.request, rpc.result, ...)|
|-l LOG_LEVEL, --log-level=LOG_LEVEL|
|Specify the log level: INFO, DEBUG, WARNING, ERROR, CRITICAL|
|-u LOGIN, --user=LOGIN|
|Specify the login user|
|-p PORT, --port=PORT|
|Specify the server port|
|-s SERVER, --server=SERVER|
|Specify the server hostname|
When an url is passed, the client will try to find already running client that could handle it and send to this one to open the url. If it doesn’t find one then it will start the GUI and open the url itself.
The url schemes are:
where parameters are the corresponding fields of actions encoded in JSON.
model is for act_window
report must have at least a data parameter with ids, id and model name
The following schematic illustration of the Tryton client shows the names of all important visual parts.
Figure: Tryton client application:
Client Window ________________________________________________________________ | Tryton _ o x| |----------------------------------------------------------------| Menu bar | File User Options Plugins Shortcuts Help | |________________________________________________________________| | | ______ | Tabs | Menu | [Tab1] |[Tab2]| [Tab3]... | |-------------| +-------+ +--------------------------------+| | + | | Menu Tab2 || | |-+ | |-----------------------------------------------|| Tool bar | | |- | | New Save Switch Reload | Prev Next | Attach v || | | |- | |-----------------------------------------------|| | + | | ____________________ || Search widget | |-+ | | Search | | <- -> Find Clear || | | |- | |-----------------------------------------------|| | | |- | | || | + | | || View | |-+ | | || | |- | | || | |- | | || | | | || | | | || | | | || | | | || | | | || |_____________| |_______________________________________________|| |________________________________________________________________| Status bar |username company Waiting requests... login@...| |________________________________________________________________|
This part of the client contains all the related contents and functions provided by the Tryton server modules. All aspects inside the main frame depend at least on the individual set of installed modules.
The main frame provides a `tabbed document interface`__ to arrange different views side by side. New tabs are opened by special actions, like choosing a menu item or clicking some action buttons. All tabs include titles which show the name of the provided view.
Tabs can be arranged by Drag and Drop.
Inside views there can be tabs, too.
The status bar provides general informations of the state of the Tryton client. It is divided in three parts.
On its left side the real name and company name of the users actual company is shown.
In the center of the status bar the number of waiting requests for the actual user are displayed.
On its right side are details of the server connection shown including database and user informations if connected. It is also noted there, if there is no connection to a Tryton server at all. The right side information of the status bar is build with the following pattern:
If the client is connected to the server with an SSL-secured connection, an additional lock icon appears rightmost some certificate details in a mouse hover popup.
The Status bar can be enabled and disabled in the menu at Options > Form > Status bar
The tool bar contains the functionalities linked to the current tab. Some operations are working with one record or with a selection of records. In form view the actual record is selected for operations. In tree view all selected records are used for operations.
Switches the actual view aspect to:
Not all views provide all aspects.
Export of current/selected records into CSV-file or open it in Excel.
Import records from CSV-file.
There are a several widgets used on Tryton in client side. The follow sections will explains some of them.
The search widget adds the ability to easily search for records on the current tab. This widget is visible only on tree view.
A query is composed of search clauses. A clause is composed of a field name (with : at the end), an operator and a value. The field name is optional and defaults to the record name. The operator is also optional and defaults to like or equal depending on the type of the field. The default operator is = except for fields of type char, text and many2one which is ilike.
All field names shown in the tree view can be searched. Field names must be followed by a :
For example: Name:
If the field name contains spaces, it is possible to escape it using double quotes.
For example: "Receivable Today":
The following operators can be used:
- =: equal to
- <: less then
- <=: less then or equal to
- >: greater then
- >=: greater then or equal to
- !=: not equal
- !: not equal or not like (depending of the type of field)
For example: Name: != Dwight
The ilike operator is never explicit and % is appended to the value to make it behaves like starts with
The format of the value depends on the type of the field. A list of values can be set using ; as separator.
For example: Name: Michael; Pam
It will find all records having the Name starting with Michael or Pam.
A range of number values can be set using ...
For example: Amount: 100..500
It will find all records with Amount between 100 and 500 (left included and right excluded)
There are two wildcards:
- %: matches any string of zero or more characters.
- _: matches any single character.
It is possible to escape special characters in values by using double quotes.
For example: Name: "Michael:Scott"
Here it will search with the value Michael:Scott.
The clauses can be composed using the two boolean operators and and or. By default, there is an implicit and between each clause if no operator is specified.
For example: Name: Michael Amount: 100
is the same as Name: Michael and Amount: 100
The and operator has a highest precedence than or but you can change it by using parenthesis.
For example: (Name: Michael or Name: Pam) and Amount: 100
is different than Name: Michael or Name: Pam and Amount: 100
which is evaluated as Name: Michael or (Name: Pam and Amount: 100)
This feature create a rich text editor with various features that allow for text formatting. The features are:
- Bold: On/off style of bold text
- Italic: On/off style of italic text
- Underline: On/off style of underline text
- Choose font family: Choice from a combo box the desired font family
- Choose font size: Choice from a combo box the desired size font
- Text justify: Choice between four options for alignment of the line (left, right, center, fill)
- Background color: Choose the background color of text from a color palette
- Foreground color: Choose the foreground color of text from a color palette
Besides these features, it can change and edit text markup. The text markup feature has a similar HTML tags and is used to describe the format specified by the user and is a way of storing this format for future opening of a correct formatted text. The tags are explain follows:
- Bold: Tag b is used, i.e. <b>text</b>
- Italic: Tag i is used, i.e. <i>text</i>
- Underline: Tag u is used, i.e. <u>text</u>
- Font family: It is a attrbute font-family for span tag, i.e. <span font-family=”Arial”>text</span>
- Font size: It is a attrbute size for span tag, i.e. <span size=”12”> text</span>
- Text Justify: For justification text is used paragraph tag p. The paragraph tag is used to create new lines and the alignment is applied across the board. Example: <p align=’center’>some text</p>
- Background color: It is a attrbute background for span tag, i.e. <span background=’#7f7f7f’>text</span>
- Foreground color: It is a attrbute foreground for span tag, i.e. <span foreground=’#00f’>text</span>
~/.config/tryton/x.y/tryton.conf # General configuration ~/.config/tryton/x.y/accel.map # Accelerators configuration ~/.config/tryton/x.y/known_hosts # Fingerprints ~/.config/tryton/x.y/ca_certs # Certification Authority (http://docs.python.org/library/ssl.html#ssl-certificates) ~/.config/tryton/x.y/profiles.cfg # Profile configuration