Difference between revisions of "Gestinux util"

From Gestinux Wiki
Jump to: navigation, search
(Package location)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Gestinux_util is an utility package containing visual and non-visual components. It is the base of Gestinux and it allows even quicker developments.
+
Gestinux_util is a set of utility packages containing visual and non-visual components. It is the base of Gestinux and it allows even quicker developments.
  
 
== Package location ==
 
== Package location ==
  
Each version of Gestinux uses a specific version of Gestinux_util. The trunk version requires Gestinux_util 1.5.
+
Each version of Gestinux uses a specific version of Gestinux_util package(s).
  
Currently, sources and translation files are located in subdirectories of the main Gestinux directory.  
+
The 1.4 version requires gestinux_util 1.4.  
  
But, since the package can be used for other applications, its sources, including its translations, can be located anywhere outside the application sources. To have appropriate translations when running from within Lazarus EDI, you should add in the run parameters (Menu : Run > Run parameters) this qualifier :
+
In the trunk or 1.5 version, gestinux_util has been splitted in 2 different packages, both required : gestinux_base and gestinux_ctrl 1.5.
 +
 
 +
This allows to make console or web application using these components, and some gestinux units (unit*base.pas), without linking user-interface code.
 +
 
 +
== Translations location ==
 +
 
 +
Sources and translation files are located in subdirectories of the main Gestinux directory.
 +
 
 +
But, since the package can be used for other applications, its sources, including its translations, can be located anywhere outside the application sources. To have appropriate translations when running from within Lazarus EDI, you must have in the run parameters (Menu : Run > Run parameters) this qualifier :
  
 
   -u ${GESTINUX_UTIL}
 
   -u ${GESTINUX_UTIL}
  
It refer to the macro ${GESTINUX_UTIL}, which is set automatically to the right value when you install the package. It is used to find the translation files specific to Gestinux_util, which can be outside application sources.
+
It refer to the macro ${GESTINUX_UTIL}, which is set automatically to the right value when you install the package gestinux_util or gestinux_base and is used to find the appropriate translation files, possibily outside project  sources.
 +
 
 +
This is only for execution with EDI.  
  
This is only for execution with EDI.
+
If you are wanting to compile and execute gestinux, you have nothing to add, this parameter is saved in the project file.
  
 
== Database Non-Visual components ==
 
== Database Non-Visual components ==
  
They are only for database connection and management.  
+
They are only for database connection and management.
  
 
Currently based on Zeos Dbo components, with some methods added to create (and update) table structure from the datamodule.
 
Currently based on Zeos Dbo components, with some methods added to create (and update) table structure from the datamodule.
Line 45: Line 55:
 
All these visual components are enabling dynamic translation of their captions and other texts.  
 
All these visual components are enabling dynamic translation of their captions and other texts.  
  
We plan also to manage text orientation (LTR/RTL) automatically.
+
We have started in version 1.5 to manage text orientation (LTR/RTL) automatically. Sample hebraic translation file are provided, but not finished. If you can complete it, or provide other RTL language, you are welcome.
  
 
=== Display only components ===
 
=== Display only components ===

Latest revision as of 11:38, 5 November 2019

Gestinux_util is a set of utility packages containing visual and non-visual components. It is the base of Gestinux and it allows even quicker developments.

Package location

Each version of Gestinux uses a specific version of Gestinux_util package(s).

The 1.4 version requires gestinux_util 1.4.

In the trunk or 1.5 version, gestinux_util has been splitted in 2 different packages, both required : gestinux_base and gestinux_ctrl 1.5.

This allows to make console or web application using these components, and some gestinux units (unit*base.pas), without linking user-interface code.

Translations location

Sources and translation files are located in subdirectories of the main Gestinux directory.

But, since the package can be used for other applications, its sources, including its translations, can be located anywhere outside the application sources. To have appropriate translations when running from within Lazarus EDI, you must have in the run parameters (Menu : Run > Run parameters) this qualifier :

 -u ${GESTINUX_UTIL}

It refer to the macro ${GESTINUX_UTIL}, which is set automatically to the right value when you install the package gestinux_util or gestinux_base and is used to find the appropriate translation files, possibily outside project sources.

This is only for execution with EDI.

If you are wanting to compile and execute gestinux, you have nothing to add, this parameter is saved in the project file.

Database Non-Visual components

They are only for database connection and management.

Currently based on Zeos Dbo components, with some methods added to create (and update) table structure from the datamodule.

Gestinux uses only descendants of TZConnection, TZQuery and TZTable.

Other midleware, specially the interface provided with Lazarus are said to be faster. One bad point is that components are specific to only one DBMS, and not following DBMS versions quickly enough. However, if someone wants to develop the same functionnalities and compare, he is welcome !

Forms

TGForm is a descendant of TForm with some common code handling keys and translations.

To create a new form, use File > New, and select only Module : GForm.

This will help to have a consistent handling of all forms in the application, and will allow future changes.

Visual components

Currently these components are based on LCL Controls. In the future, we plan to base them on CustomDrawn visual components, as soon as these components will be available, to enable portability on Androïd.

All these visual components are enabling dynamic translation of their captions and other texts.

We have started in version 1.5 to manage text orientation (LTR/RTL) automatically. Sample hebraic translation file are provided, but not finished. If you can complete it, or provide other RTL language, you are welcome.

Display only components

  • TGMainMenu : a descendant of TMainMenu with automatic translation of captions and hints of all menu items, from the language file.
  • TGPopupMenu : a similar descendant of TPopupMenu
  • TGPageControl : a descendant of TPageControl with automatic translation of captions and hints of tabsheets, from the language file.
  • TGPanel and TGEntryPanel
  • TGLabel
  • TGDbGrid
  • TGNavButtons : a set of buttons, similar to DbNavigator to manage table data.
  • TGButton and TGSpeedButton

Data Entry components

These components are containing a label and an entry component.

The first 6 (and more in the future) are usable in the TGEntryPanel for a quick integration with database.

Others