Switch to: V9V8V7V6V5

Form Editor - JavaScript Reference

The Valentina Studio Form Editor incorporates the Qt API.

The JavaScript Reference contains the description of objects available from the JavaScript code in scripts and slots.

It consists of the following parts:

  • Classes - The reference for classes that can be used in scripts. There are two groups of classes - Qt and own Valentina Studio
  • Enums - The reference for available enumerated types.
  • Global Constants - The list of global constants. Their values, for example, can be compared to the values of the appropriate object's properties.
  • Global Constructors - The list of constructors that can be called at any place.
  • Global Objects - The list of global objects available in any script

Class Reference

At the top of the class reference you can find:

  • Short description.
  • Example of this class usage.
  • The list of classes this class is extending.
  • The list of other classes extending this class.

You can see an example of the QAbstractButton class reference on the following picture:

You can run the example to see it in action using the RUN button on the right.

A detailed reference for a class consists of the following parts:

  • Methods
  • Properties
  • Signals
  • Enums

Each part contains the list of all class members - inherited and own.

Own methods, properties and signals are marked with bold font.

Like the class reference example, usage examples of the class members can be executed.

Click on each item of the list opens its detailed description.

Methods

Methods list contains all methods of this class.

Each row of the list contains the return type of method, its name and input parameters.

Detailed description:

Properties

The list of properties for the class:

Each row of the list contains the type of property and its name.

Detailed description:

Signals

The list of signals for the class:

Each row of the list contains the name of the signal.

Detailed description:

Enums

The list of enums of the class:

Each row of the list contains the name of the enum.

The detailed description includes the list of constants in the enum:

Enum Reference

Enum reference consists of a short description, usage example and the list of constants in this enum.

Global Constant Reference

The global constants reference consists of a short description, enum type and usage example of the global constant. Enum values are accessible via global constants.

Global Constructor Reference