User Tools

Site Tools


DzStyle

Class that defines the look and feel of the DAZ Studio interface.

More...

Inherits :

Enumerations

Methods

Signals

Detailed Description

Example:

Reset the current style colors to their default values.

		var oSTYLE = App.getStyle();
		var nCOLORS = oSTYLE.getNumInterfaceColors();
		for( var i = 0; i < nCOLORS; i += 1 )
		{
			oSTYLE.setInterfaceColor( i, oSTYLE.getInterfaceColorDefault( i ) );
		}

Enumerations


: PixmapMode

TODO: Add description.

  • Normal - The mode when the user is not interacting with the pixmap, but the item represented by the pixmap is available.
  • Disabled - The mode when the item represented by the pixmap is not available.
  • Active - The mode when the item represented by the pixmap is available and the user is interacting with it.
  • Selected - The mode when the item represented by the pixmap is selected.

—–

: PixmapState

TODO: Add description.

  • On - The pixmap when the widget is in the On state.
  • Off - The pixmap when the widget is in the Off state.

Methods


Pixmap : actionPixmap( String className, PixmapMode mode, PixmapState state )

Return Value:


DzError : compileStyleDefinition( String infile, String outfile )

Compiles a text-based style definition and its images into a single binary style definition file.

Parameter(s):

  • infile - The name of the XML-based text style description
  • outfile - The name of the DAZ Studio style definition file to create

Return Value:

  • true on success, false on failure

Number : findInterfaceColor( String name )

Return Value:

  • The index of the given interface color, or -1 if the color cannot be found.

Number : findInterfaceNumber( String name )

Return Value:

  • The index of the given interface number, or -1 if the number cannot be found.

Since:

  • 4.9.0.43

Color : getInterfaceColor( String name )

Return Value:

  • The current value of the given interface color.

Color : getInterfaceColor( Number which )

Return Value:

  • The current value of the given interface color.

Color : getInterfaceColorDefault( Number which )

Return Value:

  • The default value of the given interface color.

String : getInterfaceColorDescription( Number which )

Return Value:

  • A user-readable description for the given interface color

void : getInterfaceColorDisplaySettings( Number which, DzSettings settings )

Since:

  • 4.9.0.43

String : getInterfaceColorName( Number which )

Return Value:

  • The name for the given interface color

Number : getInterfaceNumber( String name )

Return Value:

  • The current value of the given interface number.

Since:

  • 4.9.0.43

Number : getInterfaceNumber( Number which )

Return Value:

  • The current value of the given interface number.

Since:

  • 4.9.0.43

Number : getInterfaceNumberDefault( Number which )

Return Value:

  • The default value of the given interface number.

Since:

  • 4.9.0.43

String : getInterfaceNumberDescription( Number which )

Return Value:

  • A user-readable description for the given interface number

Since:

  • 4.9.0.43

void : getInterfaceNumberDisplaySettings( Number which, DzSettings settings )

Since:

  • 4.9.0.43

String : getInterfaceNumberName( Number which )

Return Value:

  • The name for the given interface number

Since:

  • 4.9.0.43

Number : getNumInterfaceColors()

Return Value:

  • The number of user-customizable interface colors for the current style

Number : getNumInterfaceNumbers()

Return Value:

  • The number of user-customizable interface numbers for the current style

Since:

  • 4.9.0.43

String : getStyleDefinition()

Return Value:

  • The name of the currently active style definition.

Number : pixelMetric( String metricName )

Return Value:

  • The value of the pixel metric with the given name. The name must match one of the pixel metric names from the style definition.

void : setInterfaceColor( Number which, Color color )

Sets the given interface color to the new value. The interface will not automatically update - the current style must be reloaded before the changes will take affect.


void : setInterfaceNumber( Number which, Number number )

Sets the given interface number to the new value. The interface will not automatically update - the current style must be reloaded before the changes will take affect.

Since:

  • 4.9.0.43

Pixmap : standardPixmap( String pixmapName )

Return Value:

  • A Pixmap with the given name. The name must match one of the standard pixmap names from the style definition.

Font : textStyle( String styleName )

Return Value:

  • The Font of the text style with the given name. The name must match one of the text style names from the style definition.

Color : textStyleColor( String styleName )

Return Value:

  • The Color of the text style with the given name. The name must match one of the text style names from the style definition.

Signals


void : interfaceColorsChanged()

Emitted when the interface color settings have changed.