Inheritance diagram for ActiveSettings:

Signals
void	rulerChanged (bool rulerOn)

void	rulerStyleChanged (Q3270::RulerStyle r)

void	cursorBlinkChanged (bool cursorBlink)

void	cursorBlinkSpeedChanged (int b)

void	cursorInheritChanged (bool cursorInherit)

void	terminalModelChanged (int x, int y, int model)

void	fontChanged (QFont font)

void	fontTweakChanged (Q3270::FontTweak t)

void	codePageChanged (QString codepage)

void	keyboardThemeChanged (const QString &keyboardThemeName)

void	colourThemeChanged (QString colourThemeName)

void	hostChanged (const QString &hostName, const int hostPort, const QString &hostLu)

void	stretchScreenChanged (bool stretchScreen)

void	backspacesStopChanged (bool backspaceStop)

void	cursorColourInheritChanged (bool cursorColourInherit)

void	fontScalingChanged (bool scaling)

void	secureModeChanged (bool secureMode)

void	verifyCertsChanged (bool verifyCerts)

void	sessionNameChanged (const QString name)

void	descriptionChanged (const QString description)

Public Member Functions
	ActiveSettings ()
	ActiveSettings represents the currently active settings. This is literally just the various flags and values that would be written to the saved settings file.

QString	getHostName () const

int	getHostPort () const

QString	getHostLU () const

QString	getHostAddress () const
	ActiveSettings::getHostAddress.

void	setHostAddress (const QString &hostName, int port, const QString &hostLU)
	ActiveSettings::setHostAddress.

void	setHostAddress (const QString &address)
	ActiveSettings::setHostAddress.

void	applyUserHostChange (const QString &hostName, int port, const QString &hostLU)
	ActiveSettings::applyUserHostChange.

bool	getRulerState () const

void	setRulerState (bool rulerOn)
	ActiveSettings::setRulerState - hide or display the ruler.

Q3270::RulerStyle	getRulerStyle () const

void	setRulerStyle (Q3270::RulerStyle r)
	ActiveSettings::setRulerStyle.

QString	getRulerStyleName () const
	ActiveSettings::getRulerStyleName.

void	setRulerStyleName (const QString &s)
	ActiveSettings::setRulerStyleName.

bool	getCursorBlink () const

void	setCursorBlink (bool blink)
	ActiveSettings::setCursorBlink.

int	getCursorBlinkSpeed () const

void	setCursorBlinkSpeed (int blinkSpeed)
	ActiveSettings::setCursorBlinkSpeed.

bool	getCursorColourInherit () const

void	setCursorColourInherit (bool inherit)
	ActiveSettings::setCursorColourInherit.

bool	getStretchScreen () const

void	setStretchScreen (bool stretch)
	ActiveSettings::setStretchScreen.

bool	getBackspaceStop () const

void	setBackspaceStop (bool backspaceStop)
	ActiveSettings::setBackspaceStop.

bool	getSecureMode () const

void	setSecureMode (bool secureMode)
	ActiveSettings::setSecureMode.

bool	getVerifyCerts () const

void	setVerifyCerts (bool verifyCerts)
	ActiveSettings::setVerifyCerts.

QFont	getFont () const

void	setFont (const QFont &font)
	ActiveSettings::setFont.

Q3270::FontTweak	getTweak () const

void	setTweak (Q3270::FontTweak tweak)

int	getTerminalX () const

int	getTerminalY () const

int	getTerminalModel () const

QString	getTerminalModelName () const
	ActiveSettings::getTerminalModelName.

void	setTerminal (int x, int y, int model)
	ActiveSettings::setTerminal.

void	setTerminal (int x, int y, const QString &modelName)
	ActiveSettings::setTerminal.

QString	getCodePage () const

void	setCodePage (const QString &codePage)
	ActiveSettings::setCodePage.

QString	getKeyboardThemeName () const

void	setKeyboardTheme (const QString &keyboardThemeName)
	ActiveSettings::setKeyboardTheme.

QString	getColourThemeName () const

void	setColourTheme (const QString &colourThemeName)
	ActiveSettings::setColourTheme.

QString	getSessionName () const

void	setSessionName (const QString &name)
	Sets the session name.

QString	getDescription () const

void	setDescription (const QString &description)
	Sets the session description.

Constructor & Destructor Documentation

◆ ActiveSettings()

ActiveSettings::ActiveSettings ( )

ActiveSettings represents the currently active settings. This is literally just the various flags and values that would be written to the saved settings file.

When a setting is changed (rather than just set back to the value it currently is), a singal is emitted. this avoids flagging a change when actually there wasn't one.

The constructor sets (my) factory setting defaults.

Member Function Documentation

◆ applyUserHostChange()

void ActiveSettings::applyUserHostChange	(	const QString &	hostName,
		int	hostPort,
		const QString &	hostLU
	)

ActiveSettings::applyUserHostChange.

Parameters

hostName	- new host name from Preferences dialog
hostPort	- new port from Preferences Dialog
hostLU	- new LU name from Preferences Dialog

◆ getHostAddress()

QString ActiveSettings::getHostAddress ( ) const

ActiveSettings::getHostAddress.

Returns: The address of the host.

The address of the host that Q3270 is connected to. This may include a port and LU.

◆ getRulerStyleName()

QString ActiveSettings::getRulerStyleName ( ) const

ActiveSettings::getRulerStyleName.

See also: Q3270.h

Return the name of the ruler style (CrossHair, Horizontal, Vertical).

◆ getTerminalModelName()

QString ActiveSettings::getTerminalModelName ( ) const

ActiveSettings::getTerminalModelName.

Returns: The string form of the model name.

This function returns the string format of the model name, which is stored in the config file.

◆ setBackspaceStop()

void ActiveSettings::setBackspaceStop ( bool backspaceStop )

ActiveSettings::setBackspaceStop.

Parameters

backspaceStop - whether pressing backspace will allow the user to move the cursor beyond the field start.

When backspace stop is enabled, the cursor will be prevented from continuing beyond the beginning of the start of the field. When backspace stop is disabled, and backspace is pressed, it will act like cursor left, rather than backspace.

◆ setCodePage()

void ActiveSettings::setCodePage ( const QString & codepage )

ActiveSettings::setCodePage.

Parameters

codepage - the new codepage.

Change the code page to the one specified.

◆ setColourTheme()

void ActiveSettings::setColourTheme ( const QString & colourthemeName )

ActiveSettings::setColourTheme.

Parameters

colourthemeName - the name of the colour theme.

The colour theme is set by name.

◆ setCursorBlink()

void ActiveSettings::setCursorBlink ( bool cursorBlink )

ActiveSettings::setCursorBlink.

Parameters

cursorBlink - true to blink the cursor, false to make it static.

Change whether the cursor blinks or not.

◆ setCursorBlinkSpeed()

void ActiveSettings::setCursorBlinkSpeed ( int cursorBlinkSpeed )

ActiveSettings::setCursorBlinkSpeed.

Parameters

cursorBlinkSpeed - the speed of the cursor blink.

Set the speed of cursor blink. This setting has no effect if the cursor isn't set to blink.

◆ setCursorColourInherit()

void ActiveSettings::setCursorColourInherit ( bool cursorInherit )

ActiveSettings::setCursorColourInherit.

Parameters

cursorInherit - true to inherit the colour of the cell, false for grey

The cursor can inherit the colour of the underlying character cell, meaning that there is some visual feedback to the user of the colour of the field in which the cursor resides, or the cursor can be a simple grey colour.

◆ setDescription()

void ActiveSettings::setDescription ( const QString & desc )

Sets the session description.

Parameters

desc	- The new description.

Updates the session description and emits a signal if it changes.

◆ setFont()

void ActiveSettings::setFont ( const QFont & font )

ActiveSettings::setFont.

Parameters

font

Change the font used for the display.

◆ setHostAddress() [1/2]

void ActiveSettings::setHostAddress ( const QString & address )

ActiveSettings::setHostAddress.

Parameters

address - target host address.

Set the host address. Host addresses can be of the form:

0700@localhost:3270
console@1.2.3.4:23
1.2.3.4:23

◆ setHostAddress() [2/2]

void ActiveSettings::setHostAddress	(	const QString &	hostName,
		int	hostPort,
		const QString &	hostLU
	)

ActiveSettings::setHostAddress.

Parameters

hostName
hostPort
hostLU

Set the host address, port and LU name. Called when a session is loaded, and when the user sets the host address manually, via

◆ setKeyboardTheme()

void ActiveSettings::setKeyboardTheme ( const QString & keyboardThemeName )

ActiveSettings::setKeyboardTheme.

Parameters

keyboardThemeName - the name of the keyboard theme

This setting holds the name of the keyboard theme. The KeyboardTheme class is needed because that's actually where the keyboard definitions are stored.

◆ setRulerState()

void ActiveSettings::setRulerState ( bool rulerState )

ActiveSettings::setRulerState - hide or display the ruler.

Parameters

rulerState - true to show the ruler, false to hide it.

Change the state of the ruler display.

◆ setRulerStyle()

void ActiveSettings::setRulerStyle ( Q3270::RulerStyle newStyle )

ActiveSettings::setRulerStyle.

Parameters

newStyle

Value	Ruler Style
0	Crosshair
1	Vertical
2	Horizontal

See also: Q3270.h

Change the ruler style (crosshair, vertical, horizontal)

◆ setRulerStyleName()

void ActiveSettings::setRulerStyleName ( const QString & newStyle )

ActiveSettings::setRulerStyleName.

Parameters

newStyle - a string representing the keys in enum Q3270::RulerStyle

See also: Q3270.h

Change the ruler style by name (CrossHair, Horizontal, Vertical). Defaults to CrossHair if an invalid one is passed.

◆ setSecureMode()

void ActiveSettings::setSecureMode ( bool secureMode )

ActiveSettings::setSecureMode.

Parameters

secureMode - true to use SSL, TLS

Switches to SSL mode

◆ setSessionName()

void ActiveSettings::setSessionName ( const QString & name )

Sets the session name.

Parameters

name	- The new session name.

Updates the session name and emits a signal if it changes.

◆ setStretchScreen()

void ActiveSettings::setStretchScreen ( bool stretch )

ActiveSettings::setStretchScreen.

Parameters

stretch - true to ignore 4:3 ratio, and fill the window, false to enforce a 4:3 ratio.

The screen can be made to fill the application window, so that the display is stretched to fill all space in the application window. If this setting is disabled, the characters form a fixed 4:3 ratio size, and will have white space either side if the window is resized outside of a 4:3 ratio.

◆ setTerminal() [1/2]

void ActiveSettings::setTerminal	(	int	x,
		int	y,
		const QString &	modelName
	)

ActiveSettings::setTerminal.

Parameters

x	- the number of columns for the display
y	- the number of rows for the display
modelName	- the name of the model

This routine is used to set the terminal size; it is called by Terminal when the configuration file is read in (so that the config file stores an English name rather than just a number)

Like setTerminal(), the size parameters are ignored if the model is a standard model.

◆ setTerminal() [2/2]

void ActiveSettings::setTerminal	(	int	x,
		int	y,
		int	model
	)

ActiveSettings::setTerminal.

Parameters

x	- the number of columns for the display
y	- the number of rows for the display
model	- the model number

Sets the size of the 3270 display (for the alternate screen). The primary screen is always 24x80 (model 2). The setting is only changed when there is no active connection because part of the connection negotiation is to determine the screen size.

If one of the standard model types is used (2, 3, 4 or 5), the size is overridden and any size paramteres passed are ignored.

This routine is called when the Preferences dialog's OK button is clicked.

◆ setVerifyCerts()

void ActiveSettings::setVerifyCerts ( bool verify )

ActiveSettings::setVerifyCerts.

Parameters

verify - true to verify certificates of hosts

Allows for self-signed certificates

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

/home/runner/work/Q3270/Q3270/src/ActiveSettings.h
/home/runner/work/Q3270/Q3270/src/ActiveSettings.cpp

Signals

Public Member Functions

Constructor & Destructor Documentation

◆ ActiveSettings()

Member Function Documentation

◆ applyUserHostChange()

◆ getHostAddress()

◆ getRulerStyleName()

◆ getTerminalModelName()

◆ setBackspaceStop()

◆ setCodePage()

◆ setColourTheme()

◆ setCursorBlink()

◆ setCursorBlinkSpeed()

◆ setCursorColourInherit()

◆ setDescription()

◆ setFont()

◆ setHostAddress() [1/2]

◆ setHostAddress() [2/2]

◆ setKeyboardTheme()

◆ setRulerState()

◆ setRulerStyle()

◆ setRulerStyleName()

◆ setSecureMode()

◆ setSessionName()

◆ setStretchScreen()

◆ setTerminal() [1/2]

◆ setTerminal() [2/2]

◆ setVerifyCerts()