A set of helpful utility functions. More...

#include <Qtx.h>

Inheritance diagram for Qtx:

Classes
class	BackgroundData
	Stores background data. More...

class	CmdLineArgs
	Get access to the command line arguments in the C-like manner. More...

class	Localizer
	Localization helper. More...

Public Types
enum	AlignmentFlags { AlignLeft = Qt::AlignLeft , AlignLeading = Qt::AlignLeading , AlignRight = Qt::AlignRight , AlignTrailing = Qt::AlignTrailing , AlignHCenter = Qt::AlignHCenter , AlignJustify = Qt::AlignJustify , AlignAbsolute = Qt::AlignAbsolute , AlignHorizontal_Mask = Qt::AlignHorizontal_Mask , AlignTop = Qt::AlignTop , AlignBottom = Qt::AlignBottom , AlignVCenter = Qt::AlignVCenter , AlignVertical_Mask = Qt::AlignVertical_Mask , AlignCenter = Qt::AlignCenter , AlignOutLeft = Qt::AlignVCenter << 2 , AlignOutRight = AlignOutLeft << 2 , AlignOutTop = AlignOutRight << 2 , AlignOutBottom = AlignOutTop << 2 }
	Widget alignment flags. More...

enum	PathType { PT_OpenFile , PT_SaveFile , PT_Directory }
	Path type, indicates required directory/file operation. More...

enum	{ AppropriateRole = Qt::UserRole + 100 }
	Custom data roles. More...

enum	Appropriate { Shown , Hidden , Toggled }

enum	SubstMode { Always , Never , Auto }
	Environment variables substitution mode. More...

enum	VisibilityState { ShownState , HiddenState , UnpresentableState }
	object visibility state More...

enum	HeaderViewFlags { ShowNone = 0x000 , ShowText = 0x001 , ShowIcon = 0x010 , ShowAll = ShowText \| ShowIcon }
	Header view flags. More...

enum	CustomDataType { IdType }
	Type of the custom data (for custom tree model) More...

enum	BackgroundMode { NoBackground , ColorBackground , SimpleGradientBackground , CustomGradientBackground }
	Background mode. More...

enum	TextureMode { CenterTexture , TileTexture , StretchTexture }
	Texture mode. More...

Static Public Member Functions
static QString	toQString (const char *, const int=-1)
	Convert character array (ASCII string) to the QString. More...

static QString	toQString (const short *, const int=-1)
	Convert integer array (UNICODE string) to the QString. More...

static QString	toQString (const unsigned char *, const int=-1)
	Convert character array (ASCII string) to the QString. More...

static QString	toQString (const unsigned short *, const int=-1)
	Convert integer array (UNICODE string) to the QString. More...

static void	setTabOrder (QWidget *,...)
	Set tab order for specified list of widgets. More...

static void	setTabOrder (const QWidgetList &)
	Set tab order for specified list of widgets. More...

static void	alignWidget (QWidget , const QWidget , const int)
	Align widget src relative to widget ref acording to the alignment flags alignFlags. More...

static void	simplifySeparators (QWidget *, const bool=true)
	Remove (recursively) unnecessary separators from the menu or toolbar. More...

static bool	isParent (QObject , QObject )
	Return `true` if specified parent is a parent object of given child (in terms of QObject). More...

static QObject *	findParent (QObject , const char )
	Find the parent object of class specified by className (in terms of QObject). More...

static QString	dir (const QString &, const bool=true)
	Return directory part of the file path. More...

static QString	file (const QString &, const bool=true)
	Return file name part of the file path. More...

static QString	extension (const QString &, const bool=false)
	Return extension part of the file path. More...

static QString	libraryName (const QString &)
	EXtract base library name. More...

static QString	library (const QString &)
	Convert the given parameter to the platform-specific library name. More...

static QString	tmpDir ()
	Get the temporary directory name. More...

static bool	mkDir (const QString &)
	Create directory recursively including all intermediate sub directories. More...

static bool	rmDir (const QString &)
	Remove directory recursively including all subdirectories and files. More...

static bool	dos2unix (const QString &)
	Convert text file from DOS format to UNIX. More...

static QString	addSlash (const QString &)
	Add a slash (platform-specific) to the end of path if it is not already there. More...

static QString	joinPath (const QStringList &)
	Return full path obtained by joining given components with the native directory separator. More...

static QCompleter *	pathCompleter (const PathType, const QString &=QString())
	Create path completer which can be used in the widgets to provide auto completions. More...

static QString	findEnvVar (const QString &, int &, int &)
	Parse given string to retrieve environment variable. More...

static QString	makeEnvVarSubst (const QString &, const SubstMode=Auto)
	Substitute environment variables by their values. More...

static int	rgbSet (const QColor &)
	Pack the specified color into integer RGB set. More...

static int	rgbSet (const int, const int, const int)
	Pack the specified RGB color components into integer RGB set. More...

static QColor	rgbSet (const int)
	Unpack the specified integer RGB set to the color. More...

static void	rgbSet (const int, int &, int &, int &)
	Unpack the specified integer RGB set to the three RGB components. More...

static QColor	scaleColor (const int, const int, const int)
	Return the color specified by the index between min (blue) and max (red). More...

static void	scaleColors (const int, QColorList &)
	Generate required number of colors aligned from blue to red. More...

static QPixmap	scaleIcon (const QPixmap &, const unsigned, const unsigned=0)
	Scale the pixmap to the required size. More...

static QImage	grayscale (const QImage &)
	Convert given image to the grayscale format. More...

static QPixmap	grayscale (const QPixmap &)
	Convert given pixmap to the grayscale format. More...

static QImage	transparentImage (const int, const int, const int=-1)
	Create transparent image. More...

static QPixmap	transparentPixmap (const int, const int, const int=-1)
	Create transparent pixmap. More...

static QPixmap	composite (const QPixmap &, const int, const int, const QPixmap &=QPixmap())
	Create composite pixmap. More...

static QString	colorToString (const QColor &)
	Convert color to the string representation. More...

static bool	stringToColor (const QString &, QColor &)
	Create color from the string representation. More...

static QString	biColorToString (const QColor &, const int)
	Convert bi-color value to the string representation. More...

static bool	stringToBiColor (const QString &, QColor &, int &)
	Restore bi-color value from the string representation. More...

static QColor	mainColorToSecondary (const QColor &, int)
	Compute secondary color value from specified main color and delta. More...

static QString	gradientToString (const QLinearGradient &)
	Dump linear gradient to the string description. More...

static QString	gradientToString (const QRadialGradient &)
	Dump radial gradient to the string description. More...

static QString	gradientToString (const QConicalGradient &)
	Dump conical gradient to the string description. More...

static bool	stringToLinearGradient (const QString &, QLinearGradient &)
	Create linear gradient from its string representation. More...

static bool	stringToRadialGradient (const QString &, QRadialGradient &)
	Create radial gradient from its string representation. More...

static bool	stringToConicalGradient (const QString &, QConicalGradient &)
	Create conical gradient from its string representation. More...

static QString	backgroundToString (const BackgroundData &)
	Convert background data to the string representation. The resulting string consists of several sub-strings separated by ';' symbol. These sub-strings represent: More...

static BackgroundData	stringToBackground (const QString &)
	Restore background data from the string representation. More...

static long	versionToId (const QString &)
	Convert string representation of version identifier to the numerical value. Resulting value can be used for comparison of different versions (lower, higher, equal). More...

static QString	qtDir (const QString &=QString())
	Get Qt installation directory. More...

static QFont	stringToFont (const QString &fontDescription)

static QString	getenv (const QString &envVar)

static void *	getDisplay ()
	Open the default X display and returns pointer to it. This method is available on Linux only. More...

static Qt::HANDLE	getVisual ()
	Returns pointer to X visual suitable for 3D rendering. This method is available on Linux only. More...

static void	initDefaultSurfaceFormat ()
	Set default QSurfaceFormat for an application. More...

Detailed Description

A set of helpful utility functions.

The class implements a set of the static functions which can be used for the different purposes:

specify tab order for the set of widgets: setTabOrder()
align one widget to the coordinates of the another one: alignWidget()
remove extra separators from the menu or toolbar: simplifySeparators()
retrieve directory, file name and extension parts of the path: dir(), file(), extension()
get the path to the temporary directory: tmpDir()
create or remove a directory (recursively): mkDir(), rmDir()
convert text file from DOS to UNIX native format: dos2unix()
convert a picture to the gray scale: grayscale()
other

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Custom data roles.

Enumerator
AppropriateRole	can be used to return `true` if data is appropriate

◆ AlignmentFlags

enum Qtx::AlignmentFlags

Widget alignment flags.

Enumerator
AlignLeft	align left side of one widget to the left side of another widget
AlignLeading	synonim for AlignLeft
AlignRight	align right side of one widget to the right side of another widget
AlignTrailing	synonim for AlignRight
AlignHCenter	align one widget to the center of another widget in horizontal dimension
AlignJustify	synonym of Qt::AlignJustify
AlignAbsolute	synonym of Qt::AlignAbsolute
AlignHorizontal_Mask	synonym of Qt::AlignHorizontal_Mask
AlignTop	align top side of one widget to the top side of another widget
AlignBottom	align bottom side of one widget to the bottom side of another widget
AlignVCenter	align one widget to the center of another widget in vertical dimension
AlignVertical_Mask	synonym of Qt::AlignVertical_Mask
AlignCenter	align one widget to the center of another widget in both dimensions
AlignOutLeft	align right side of one widget to the left side of another widget
AlignOutRight	align left side of one widget to the right side of another widget
AlignOutTop	align bottom side of one widget to the top side of another widget
AlignOutBottom	align top side of one widget to the bottom side of another widget

◆ Appropriate

enum Qtx::Appropriate

Enumerator
Shown	column should be always visible
Hidden	column should be always hidden
Toggled	it should be possible to show/hide the column with help of popup menu

◆ BackgroundMode

enum Qtx::BackgroundMode

Background mode.

Enumerator
NoBackground
ColorBackground
SimpleGradientBackground
CustomGradientBackground

◆ CustomDataType

enum Qtx::CustomDataType

Type of the custom data (for custom tree model)

Enumerator
IdType

◆ HeaderViewFlags

enum Qtx::HeaderViewFlags

Header view flags.

Enumerator
ShowNone	Show nothing.
ShowText	Show only text in the header.
ShowIcon	Show only icon in the header.
ShowAll	Show icon and text in the header.

◆ PathType

enum Qtx::PathType

Path type, indicates required directory/file operation.

Enumerator
PT_OpenFile	the file is opened
PT_SaveFile	the file is saved
PT_Directory	the directory path is required

◆ SubstMode

enum Qtx::SubstMode

Environment variables substitution mode.

Enumerator
Always	substitute environment variable by it's value if variable exists, and "" otherwise
Never	keep environment variable as is without any substitution
Auto	substitute environment variable by it's value if variable exists, and keep it as is otherwise

◆ TextureMode

enum Qtx::TextureMode

Texture mode.

Enumerator
CenterTexture
TileTexture
StretchTexture

◆ VisibilityState

enum Qtx::VisibilityState

object visibility state

Enumerator
ShownState	Object is shown in viewer.
HiddenState	Object is hidden in viewer.
UnpresentableState	Unpresentable object.

Member Function Documentation

◆ addSlash()

QString Qtx::addSlash ( const QString & path )

static

Add a slash (platform-specific) to the end of path if it is not already there.

Parameters

path	directory path

Returns: modified path (with slash added to the end)

◆ alignWidget()

void Qtx::alignWidget	(	QWidget *	src,
		const QWidget *	ref,
		const int	alignFlags
	)

static

Align widget src relative to widget ref acording to the alignment flags alignFlags.

Parameters

src	source widget (being aligned)
ref	reference widget (source widget being aligned to)
alignFlags	alignment flags (Qtx::AlignmentFlags)

References AlignBottom, AlignHCenter, AlignLeft, AlignOutBottom, AlignOutLeft, AlignOutRight, AlignOutTop, AlignRight, AlignTop, and AlignVCenter.

◆ backgroundToString()

QString Qtx::backgroundToString ( const BackgroundData & bgData )

static

Convert background data to the string representation. The resulting string consists of several sub-strings separated by ';' symbol. These sub-strings represent:

background type (enumerator, see Qtx::BackgroundMode)
texture image file name (string)
texture mode (enumerator, see Qtx::TextureMode)
"show texture" flag (boolean)
first color (for simple gradient data) or solid color (for single-colored mode)
second color (for simple gradient data)
type of simple gradient (some integer identifier)
complex gradient data (for custom gradient mode) Each sub-string consists of keyword/value couple, in form of "<keyword>=<value>".

Backward conversion can be done with stringToBackground() method.

Parameters

bgData background data

Returns: string representation of the background data

See also: stringToBackground()

References colorToString(), Qtx::BackgroundData::gradient(), gradientToString(), Qtx::BackgroundData::isTextureShown(), Qtx::BackgroundData::mode(), and Qtx::BackgroundData::texture().

◆ biColorToString()

QString Qtx::biColorToString	(	const QColor &	color,
		const int	delta
	)

static

Convert bi-color value to the string representation.

Bi-color value is specified as main color and integer delta value that is used to calculate secondary color by changing paremeters of the main color ("saturation" and "value" components in HSV notation).

The resulting string consists of two sub-strings separated by '|' symbol. The first part represents main color (see colorToString() for more details), the second part is a delta value.

Backward conversion can be done with stringToBiColor() method.

Parameters

color	color to be converted
delta	delta value

Returns: string representation of the bi-color value

See also: stringToBiColor(), stringToColor()

References OCCViewer::color(), and colorToString().

◆ colorToString()

QString Qtx::colorToString ( const QColor & color )

static

Convert color to the string representation.

The resulting string is in the one of two possible formats (RR, GG, BB and AA value represent red, green, blue and alpha components of the color):

if color has alpha channel : "#RR,#GG,#BB,#AA"
if color does not have alpha channel : "#RRGGBB"

If color is invalid, null string is returned.

Backward conversion can be done with stringToColor() method.

Parameters

color color to be converted

Returns: string representation of the color

See also: stringToColor()

References OCCViewer::color().

◆ composite()

QPixmap Qtx::composite	(	const QPixmap &	pix,
		const int	x,
		const int	y,
		const QPixmap &	dest = `QPixmap()`
	)

static

Create composite pixmap.

Pixmap pix is drawn over pixmap dest with coordinates specified relatively to the upper left corner of dest. If dest is not given, the new empty pixmap with appropriate size created instead.

Parameters

pix	source pixmap
x	horizontal shift
y	vertical shift
dest	background pixmap

Returns: resulting pixmap

References transparentImage().

◆ dir()

QString Qtx::dir	(	const QString &	path,
		const bool	abs = `true`
	)

static

Return directory part of the file path.

If the file path does not include directory part (the file is in the current directory), null string is returned.

Parameters

path	file path
abs	if true (default) path parameter is treated as absolute file path

Returns: directory part of the file path

◆ dos2unix()

bool Qtx::dos2unix ( const QString & absName )

static

Convert text file from DOS format to UNIX.

The function replaces "LF/CR" symbols sequence by "LF" symbol.

Parameters

absName file name

Returns: true if the file is converted successfully and false in case of any error

< TODO: conversion from 'size_t' to 'int'

References dir().

◆ extension()

QString Qtx::extension	(	const QString &	path,
		const bool	full = `false`
	)

static

Return extension part of the file path.

Parameters

path	file path
full	if true complete extension (all extensions, dot separated) is returned, otherwise (default) only last extension is returned

Returns: extension part of the file path

◆ file()

QString Qtx::file	(	const QString &	path,
		const bool	withExt = `true`
	)

static

Return file name part of the file path.

Parameters

path	file path
withExt	if true (default) complete file name (with all extension except the last) is returned, otherwise only base name is returned

Returns: file name part of the file path

◆ findEnvVar()

QString Qtx::findEnvVar	(	const QString &	str,
		int &	start,
		int &	len
	)

static

Parse given string to retrieve environment variable.

Looks through the string for the environment variable patterns. If string contains variable satisfying any pattern, the variable name is returned, start index of the variable is returned in the start parameter, and length of the variable is returned in the len parameter.

Supported environment variables definitions:

${name} or $name : Linux shell variable
: GNU make substitution
name% : Windows shell variable
%(name)s : Python substitutions:

Parameters

str	string being processed
start	if variable is found, this parameter contains its starting position in the str
len	if variable is found, this parameter contains its length

Returns: first found variable or null QString if there is no ones

References rx.

◆ findParent()

QObject * Qtx::findParent	(	QObject *	obj,
		const char *	className
	)

static

Find the parent object of class specified by className (in terms of QObject).

Parameters

obj	current object
className	class name of the parent

Returns: parent object or null pointer if the parent not found

◆ getDisplay()

void * Qtx::getDisplay ( )

static

Open the default X display and returns pointer to it. This method is available on Linux only.

Returns: Pointer to X display.

See also: getVisual()

◆ getenv()

QString Qtx::getenv ( const QString & envVar )

static

◆ getVisual()

Qt::HANDLE Qtx::getVisual ( )

static

Returns pointer to X visual suitable for 3D rendering. This method is available on Linux only.

Returns: Pointer to X visual.

See also: getDisplay()

References getDisplay(), hex(), and Plot2d::None.

◆ gradientToString() [1/3]

QString Qtx::gradientToString ( const QConicalGradient & gradient )

static

Dump conical gradient to the string description.

Parameters

gradient conical gradient to be converted

Returns: string representation of the conical gradient

See also: stringToConicalGradient()

References colorToString().

◆ gradientToString() [2/3]

QString Qtx::gradientToString ( const QLinearGradient & gradient )

static

Dump linear gradient to the string description.

Parameters

gradient linear gradient to be converted

Returns: string representation of the linear gradient

See also: stringToLinearGradient()

References colorToString().

◆ gradientToString() [3/3]

QString Qtx::gradientToString ( const QRadialGradient & gradient )

static

Dump radial gradient to the string description.

Parameters

gradient radial gradient to be converted

Returns: string representation of the radial gradient

See also: stringToRadialGradient()

References colorToString().

◆ grayscale() [1/2]

QImage Qtx::grayscale ( const QImage & img )

static

Convert given image to the grayscale format.

Parameters

img	initial image

Returns: converted to the grayscale image

◆ grayscale() [2/2]

QPixmap Qtx::grayscale ( const QPixmap & pix )

static

Convert given pixmap to the grayscale format.

Parameters

pix	initial pixmap

Returns: converted to the grayscale pixmap

References grayscale().

◆ initDefaultSurfaceFormat()

void Qtx::initDefaultSurfaceFormat ( )

static

Set default QSurfaceFormat for an application.

This application property should be set before a creation of the QApplication.

◆ isParent()

bool Qtx::isParent	(	QObject *	child,
		QObject *	parent
	)

static

Return true if specified parent is a parent object of given child (in terms of QObject).

This function works recursively. It means that true is also returned if parent is a grand-father, grand-grand-father, etc of child. If the same object is given as both parent and child, true is also returned.

Parameters

child	child object
parent	parent object

Returns: true if the parent is a parent of child

◆ joinPath()

QString Qtx::joinPath ( const QStringList & path )

static

Return full path obtained by joining given components with the native directory separator.

Parameters

path	Separate path components

Returns: complete path

◆ library()

QString Qtx::library ( const QString & libName )

static

Convert the given parameter to the platform-specific library name.

The function appends platform-specific prefix (lib) and suffix (.dll/.so) to the library file name. For example, if libName = "mylib", "libmylib.so" is returned for Linux and mylib.dll for Windows.

Parameters

libName short library name

Returns: full library name

References addSlash(), dir(), extension(), and file().

◆ libraryName()

QString Qtx::libraryName ( const QString & libName )

static

EXtract base library name.

The function removes platform-specific prefix (lib) and suffix (.dll/.so) from the library file name. For example, if str = "libmylib.so", "mylib" is returned..

Parameters

libName library name

Returns: base library name

References extension(), and file().

◆ mainColorToSecondary()

QColor Qtx::mainColorToSecondary	(	const QColor &	color,
		int	delta
	)

static

Compute secondary color value from specified main color and delta.

Secondary color is calculated by changing paremeters of the main color ("saturation" and "value" components in HSV notation) using specified delta.

If main color is invalid, result of the function is also invalid color.

Parameters

color	source main color
delta	delta value

Returns: resulting secondary color

See also: biColorToString(), stringToBiColor()

References OCCViewer::color().

◆ makeEnvVarSubst()

QString Qtx::makeEnvVarSubst	(	const QString &	str,
		const SubstMode	mode = `Auto`
	)

static

Substitute environment variables by their values.

Environment variable is substituted by its value.

Parameters

str	string to be processed

Returns: processed string (with all substitutions made)

References Always, findEnvVar(), getenv(), and Never.

◆ mkDir()

bool Qtx::mkDir ( const QString & dirPath )

static

Create directory recursively including all intermediate sub directories.

Returns: true if the directory is successfully created and false otherwise

◆ pathCompleter()

QCompleter * Qtx::pathCompleter	(	const PathType	type,
		const QString &	filter = `QString()`
	)

static

Create path completer which can be used in the widgets to provide auto completions.

Create an instance of QCompleter class and returns the pointer on it. The calling function is responsible to the desstroying of the created completer object.

The QCompleter class provides completions based on a item model and can be used in such as QLineEdit and QComboBox. When the user starts typing a word, QCompleter suggests possible ways of completing the word, based on a word list.

Parameters

type	path type (Qtx::PathType)
filter	file/directory filters (list of wildcards, separated by ";;")

Returns: a pointer to the created completer

References PT_Directory, PT_OpenFile, PT_SaveFile, and rx.

◆ qtDir()

QString Qtx::qtDir ( const QString & context = QString() )

static

Get Qt installation directory.

The function tries to detect qt installation directory by analyzing the system variables in the following order:

QT5_ROOT_DIR
QT_ROOT_DIR
QTDIR

Optional parameter context allows obtaining subdirectory in the Qt installation directory.

Parameters

context optional sub-directory

Returns: path to the Qt installation directory (or its sub-folder, if context is specified)

References getenv().

◆ rgbSet() [1/4]

QColor Qtx::rgbSet ( const int rgb )

static

Unpack the specified integer RGB set to the color.

Parameters

rgb	packed color

Returns: unpacked color (QColor)

References rgbSet().

◆ rgbSet() [2/4]

int Qtx::rgbSet	(	const int	r,
		const int	g,
		const int	b
	)

static

Pack the specified RGB color components into integer RGB set.

Parameters

r	red component
g	green component
b	blue component

Returns: packed color

◆ rgbSet() [3/4]

void Qtx::rgbSet	(	const int	rgb,
		int &	r,
		int &	g,
		int &	b
	)

static

Unpack the specified integer RGB set to the three RGB components.

Parameters

rgb	packed color
r	returned unpacked red component
g	returned unpacked green component
b	returned unpacked blue component

◆ rgbSet() [4/4]

int Qtx::rgbSet ( const QColor & c )

static

Pack the specified color into integer RGB set.

Parameters

c	unpacked color

Returns: packed color

◆ rmDir()

bool Qtx::rmDir ( const QString & thePath )

static

Remove directory recursively including all subdirectories and files.

Returns: true if the directory is successfully removed and false otherwise

◆ scaleColor()

QColor Qtx::scaleColor	(	const int	index,
		const int	min,
		const int	max
	)

static

Return the color specified by the index between min (blue) and max (red).

Parameters

index	color index
min	required minimum hue value
max	required maximum hue value

Returns: resulting color

◆ scaleColors()

void Qtx::scaleColors	(	const int	num,
		QColorList &	lst
	)

static

Generate required number of colors aligned from blue to red.

Parameters

num	required number of colors
lst	returned set of colors

References scaleColor().

◆ scaleIcon()

QPixmap Qtx::scaleIcon	(	const QPixmap &	icon,
		const unsigned	w,
		const unsigned	h = `0`
	)

static

Scale the pixmap to the required size.

If h is 0 (default) the value of w is used instead (to create square pixmap).

Parameters

icon	pixmap to be resized
w	required pixmap width
h	required pixmap height

Returns: scaled pixmap

◆ setTabOrder() [1/2]

void Qtx::setTabOrder ( const QWidgetList & widgets )

static

Set tab order for specified list of widgets.

Parameters

widgets list of widgets

◆ setTabOrder() [2/2]

void Qtx::setTabOrder	(	QWidget *	first,
			...
	)

static

Set tab order for specified list of widgets.

The function has arbitrary number of parameters, each should be hovewer of QWidget* type. Last parameter should be null pointer.

Parameters

first first widget in the sequence

◆ simplifySeparators()

void Qtx::simplifySeparators	(	QWidget *	wid,
		const bool	recursive = `true`
	)

static

Remove (recursively) unnecessary separators from the menu or toolbar.

Parameters

wid	widget, should be of QMenu* or QToolBar* class

◆ stringToBackground()

Qtx::BackgroundData Qtx::stringToBackground ( const QString & str )

static

Restore background data from the string representation.

The string should consist of several sub-strings separated by ';' symbol. Each sub-string consists of keyword/value couple, in form of "<keyword>=<value>". The sub-strings can follow in arbitrary order, some keywords can be missing. The background data is described by the following values:

background type (enumerator, see Qtx::BackgroundMode), keyword "bt"
texture image file name (string), keyword "fn"
texture mode (enumerator, see Qtx::TextureMode), keyword "tm"
"show texture" flag (boolean), keyword "ts"
first color (for simple gradient data) or solid color (for single-colored mode), keyword "c1"
second color (for simple gradient data), keyword "c2"
name of gradient type (string), keyword "gt"
complex gradient data (for custom gradient mode), keyword "gr"

Also, for backward compatibility, background data can be represented by single color value, see stringToColor().

Backward conversion can be done with backgroundToString() method. Returns invalid background if conversion could not be done.

Qtx::BackgroundData bgData = Qtx::stringToBackground( str );

if ( bgData.isValid() ) ) doSomething( bgData );

Qtx::BackgroundData

Stores background data.

Definition: Qtx.h:178

Qtx::BackgroundData::isValid

bool isValid() const

Returns false if background data is not set (invalid)

Definition: Qtx.cxx:1941

Qtx::stringToBackground

static BackgroundData stringToBackground(const QString &)

Restore background data from the string representation.

Definition: Qtx.cxx:1682

Parameters

theString string representation of the background data

Returns: resulting background data (invalid if conversion has failed)

See also: backgroundToString()

References CenterTexture, ColorBackground, CustomGradientBackground, NoBackground, Qtx::BackgroundData::setColor(), Qtx::BackgroundData::setGradient(), Qtx::BackgroundData::setMode(), Qtx::BackgroundData::setTexture(), Qtx::BackgroundData::setTextureShown(), StretchTexture, stringToColor(), stringToConicalGradient(), stringToInt(), stringToLinearGradient(), and stringToRadialGradient().

◆ stringToBiColor()

bool Qtx::stringToBiColor	(	const QString &	str,
		QColor &	color,
		int &	delta
	)

static

Restore bi-color value from the string representation.

Bi-color value is specified as main color and integer delta value that is used to calculate secondary color by changing paremeters of the main color ("saturation" and "value" components in HSV notation).

The parameter str should consist of two sub-strings separated by '|' symbol. The first part represents main color (see stringToColor() for more details), the second part is a delta value.

Backward conversion can be done with biColorToString() method.

Parameters

str	string representation of the bi-color value
color	resulting color value
delta	resulting delta value

Returns: true if the conversion is successful and false otherwise

See also: biColorToString(), stringToColor(), rgbSet()

References OCCViewer::color(), and stringToColor().

◆ stringToColor()

bool Qtx::stringToColor	(	const QString &	str,
		QColor &	color
	)

static

Create color from the string representation.

The parameter str must be in the one of following formats (RR, GG, BB and AA value represent red, green, blue and alpha components of the color):

"#RR,#GG,#BB[,#AA]" or "#RR #GG #BB[ #AA]" (RR, GG, BB and optional AA values represent red, green, blue and alpha components of the color in hexadecimal form)
"RR,GG,BB[,AA]" or "RR GG BB[ AA]" (RR, GG, BB and optional AA values represent red, green, blue and alpha components of the color in decimal form)
"#RRGGBB" - (RR, GG and BB values represent red, green and blue components of the color in hexadecimal form)
an integer value representing packed color components (see rgbSet())
a name from the list of colors defined in the list of SVG color keyword names provided by the World Wide Web Consortium; for example, "steelblue" or "gainsboro".

Backward conversion can be done with colorToString() method.

Parameters

str	string representation of the color
color	resulting color value

Returns: true if the conversion is successful and false otherwise

See also: colorToString(), rgbSet()

References OCCViewer::color(), and rgbSet().

◆ stringToConicalGradient()

bool Qtx::stringToConicalGradient	(	const QString &	str,
		QConicalGradient &	gradient
	)

static

Create conical gradient from its string representation.

Parameters

str	string representation of the conical gradient
gradient	resulting conical gradient object

Returns: true if the conversion is successful and false otherwise

See also: gradientToString()

References stringToColor().

◆ stringToFont()

QFont Qtx::stringToFont ( const QString & fontDescription )

static

Creates font from string description

◆ stringToLinearGradient()

bool Qtx::stringToLinearGradient	(	const QString &	str,
		QLinearGradient &	gradient
	)

static

Create linear gradient from its string representation.

Parameters

str	string representation of the linear gradient
gradient	resulting linear gradient object

Returns: true if the conversion is successful and false otherwise

See also: gradientToString()

References stringToColor().

◆ stringToRadialGradient()

bool Qtx::stringToRadialGradient	(	const QString &	str,
		QRadialGradient &	gradient
	)

static

Create radial gradient from its string representation.

Parameters

str	string representation of the radial gradient
gradient	resulting radial gradient object

Returns: true if the conversion is successful and false otherwise

See also: gradientToString()

References stringToColor().

◆ tmpDir()

QString Qtx::tmpDir ( )

static

Get the temporary directory name.

Returns: temporary directory (platform specific)

References getenv().

◆ toQString() [1/4]

QString Qtx::toQString	(	const char *	str,
		const int	len = `-1`
	)

static

Convert character array (ASCII string) to the QString.

Parameters

str	character array
len	array length, if < 0, the array should be zero-terminated

Returns: QString object

◆ toQString() [2/4]

QString Qtx::toQString	(	const short *	str,
		const int	len = `-1`
	)

static

Convert integer array (UNICODE string) to the QString.

Parameters

str	integer array
len	array length, if < 0, the array should be zero-terminated

Returns: QString object

References toQString().

◆ toQString() [3/4]

QString Qtx::toQString	(	const unsigned char *	str,
		const int	len = `-1`
	)

static

Convert character array (ASCII string) to the QString.

Parameters

str	character array
len	array length, if < 0, the array should be zero-terminated

Returns: QString object

◆ toQString() [4/4]

QString Qtx::toQString	(	const unsigned short *	str,
		const int	len = `-1`
	)

static

Convert integer array (UNICODE string) to the QString.

Parameters

str	integer array
len	array length, if < 0, the array should be zero-terminated

Returns: QString object

◆ transparentImage()

QImage Qtx::transparentImage	(	const int	w,
		const int	h,
		const int	d = `-1`
	)

static

Create transparent image.

Parameters

w	required image width
h	required image height
d	required image depth

Returns: generated image

◆ transparentPixmap()

QPixmap Qtx::transparentPixmap	(	const int	w,
		const int	h,
		const int	d = `-1`
	)

static

Create transparent pixmap.

Parameters

w	required image width
h	required pixmap height
d	required pixmap depth

Returns: generated pixmap

References transparentImage().

◆ versionToId()

long Qtx::versionToId ( const QString & version )

static

Convert string representation of version identifier to the numerical value. Resulting value can be used for comparison of different versions (lower, higher, equal).

String representation of the version consists of zero or more components:

[major[.minor[.release[patchid]]]]

where

major is version major number
minor is version minor number
release is version release number
patchid is a version dev identifier which is one of the following 1 letter optionally followed by 1 or 2 digits, e.g. "a" for "alpha", "b1" for "beta 1" "rc" optionally followed by 1 or 2 digits, e.g. "rc1" for "release candidate 1" "dev" for development version (note: 7.4.0dev > 7.4.0, 7.4.0dev < 7.4.1, 7.4.0dev < 7.4.0a1)

If version string does not include any component or has invalid format, the function returns 0.

Examples: 1.0 - version 1.0 1.2.3a - version 1.2.3 alpha 3.3.3b1 - version 3.3.3 beta 1 7.4.0rc1 - version 7.4.0 release candidate 1 7.4.0dev - dev version, i.e. future version 7.4.1 (or 7.5.0)

Parameters

version string representation of version

Returns: numerical identifier of the version

The documentation for this class was generated from the following files:

src/Qtx/Qtx.h
src/Qtx/Qtx.cxx

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ AlignmentFlags

◆ Appropriate

◆ BackgroundMode

◆ CustomDataType

◆ HeaderViewFlags

◆ PathType

◆ SubstMode

◆ TextureMode

◆ VisibilityState

Member Function Documentation

◆ addSlash()

◆ alignWidget()

◆ backgroundToString()

◆ biColorToString()

◆ colorToString()

◆ composite()

◆ dir()

◆ dos2unix()

◆ extension()

◆ file()

◆ findEnvVar()

◆ findParent()

◆ getDisplay()

◆ getenv()

◆ getVisual()

◆ gradientToString() [1/3]

◆ gradientToString() [2/3]

◆ gradientToString() [3/3]

◆ grayscale() [1/2]

◆ grayscale() [2/2]

◆ initDefaultSurfaceFormat()

◆ isParent()

◆ joinPath()

◆ library()

◆ libraryName()

◆ mainColorToSecondary()

◆ makeEnvVarSubst()

◆ mkDir()

◆ pathCompleter()

◆ qtDir()

◆ rgbSet() [1/4]

◆ rgbSet() [2/4]

◆ rgbSet() [3/4]

◆ rgbSet() [4/4]

◆ rmDir()

◆ scaleColor()

◆ scaleColors()

◆ scaleIcon()

◆ setTabOrder() [1/2]

◆ setTabOrder() [2/2]

◆ simplifySeparators()

◆ stringToBackground()

◆ stringToBiColor()

◆ stringToColor()

◆ stringToConicalGradient()

◆ stringToFont()

◆ stringToLinearGradient()

◆ stringToRadialGradient()

◆ tmpDir()

◆ toQString() [1/4]

◆ toQString() [2/4]

◆ toQString() [3/4]

◆ toQString() [4/4]

◆ transparentImage()

◆ transparentPixmap()

◆ versionToId()