#include <option.h>

Inheritance diagram for KSaneCore::Option:

Public Types
enum	OptionState { StateHidden , StateDisabled , StateActive }

enum	OptionType { TypeDetectFail , TypeBool , TypeInteger , TypeDouble , TypeValueList , TypeString , TypeGamma , TypeAction }

enum	OptionUnit { UnitNone , UnitPixel , UnitBit , UnitMilliMeter , UnitDPI , UnitPercent , UnitMicroSecond , UnitSecond }

Public Types inherited from QObject
typedef	QObjectList

Signals
void	optionReloaded ()

void	valueChanged (const QVariant &value)

Public Slots
bool	setValue (const QVariant &value)

Public Member Functions
	Option (QObject *parent=nullptr)

QString	description () const

QVariantList	internalValueList () const

QVariant	maximumValue () const

QVariant	minimumValue () const

QString	name () const

bool	restoreSavedData ()

OptionState	state () const

QVariant	stepValue () const

bool	storeCurrentData ()

QString	title () const

OptionType	type () const

QVariant	value () const

QVariantList	valueList () const

int	valueSize () const

OptionUnit	valueUnit () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Protected Attributes
std::unique_ptr< KSaneCore::OptionPrivate >	d

Additional Inherited Members
Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

A wrapper class providing access to the internal KSaneBaseOption to access all options provided by KSANECore/SANE.

Definition at line 28 of file option.h.

Member Enumeration Documentation

◆ OptionState

enum KSaneCore::Option::OptionState

This enumeration describes the current statue of the value of the option, indicating if this option should be displayed or not.

Definition at line 46 of file option.h.

◆ OptionType

enum KSaneCore::Option::OptionType

This enumeration describes the type of the option.

Definition at line 34 of file option.h.

◆ OptionUnit

enum KSaneCore::Option::OptionUnit

This enumeration describes the unit of the value of the option, if any.

Definition at line 40 of file option.h.

Constructor & Destructor Documentation

◆ Option()

KSaneCore::Option::Option ( QObject * parent = nullptr )

explicit

Definition at line 16 of file option.cpp.

Member Function Documentation

◆ description()

QString KSaneCore::Option::description ( ) const

This function returns a more verbose, translated description of the option.

Returns: the description

Definition at line 51 of file option.cpp.

◆ internalValueList()

QVariantList KSaneCore::Option::internalValueList ( ) const

This function returns the list of possible values if the option is of type OptionType::TypeValueList.

The list contains the raw internal values without any formatting or translation.

Returns: a list with all possible internal values

Definition at line 105 of file option.cpp.

◆ maximumValue()

QVariant KSaneCore::Option::maximumValue ( ) const

This function returns the maximum value for the option.

Returns an empty QVariant if this value is not applicable for the option type.

Returns: the maximum value

Definition at line 78 of file option.cpp.

◆ minimumValue()

QVariant KSaneCore::Option::minimumValue ( ) const

This function returns the minimum value for the option.

Returns an empty QVariant if this value is not applicable for the option type.

Returns: the minimum value

Definition at line 69 of file option.cpp.

◆ name()

QString KSaneCore::Option::name ( ) const

This function returns the internal name of the option.

Returns: the internal name

Definition at line 33 of file option.cpp.

◆ optionReloaded

void KSaneCore::Option::optionReloaded ( )

signal

This signal is emitted when the option is reloaded, which may happen if the value of other options has changed.

◆ restoreSavedData()

bool KSaneCore::Option::restoreSavedData ( )

This function restores the previously saved value and makes it the current value.

Definition at line 159 of file option.cpp.

◆ setValue

bool KSaneCore::Option::setValue ( const QVariant & value )

slot

This slot allows to change the current value of the option.

Parameters

value the new value of option inside a QVariant. In case the variant cannot be cast to a value suitable for the specific option, the value is discarded.

Definition at line 141 of file option.cpp.

◆ state()

Option::OptionState KSaneCore::Option::state ( ) const

This function returns the state of the option indicating if the function is disabled or should be hidden.

Returns: the state of option the of value OptionState

Definition at line 24 of file option.cpp.

◆ stepValue()

QVariant KSaneCore::Option::stepValue ( ) const

This function returns the step value for the option.

Returns an empty QVariant if this value is not applicable for the option type.

Returns: the step value

Definition at line 87 of file option.cpp.

◆ storeCurrentData()

bool KSaneCore::Option::storeCurrentData ( )

This function temporarily stores the current value in a member variable.

Definition at line 150 of file option.cpp.

◆ title()

QString KSaneCore::Option::title ( ) const

This function returns the translated title of the option.

Returns: the title

Definition at line 42 of file option.cpp.

◆ type()

Option::OptionType KSaneCore::Option::type ( ) const

This function the type of the option as determined by KSANECore.

Each type provides a different implementation for different variable types, e.g. integer, float or string.

Returns: the type of option the of value OptionType

Definition at line 60 of file option.cpp.

◆ value()

QVariant KSaneCore::Option::value ( ) const

This function returns the currently active value for the option.

Returns: the current value

Definition at line 114 of file option.cpp.

◆ valueChanged

void KSaneCore::Option::valueChanged ( const QVariant & value )

signal

This signal is emitted when the current value is updated, either when a user sets a new value or by a reload by the backend.

◆ valueList()

QVariantList KSaneCore::Option::valueList ( ) const

This function returns the list of possible values if the option is of type OptionType::TypeValueList.

The list may contain formatted or translated values.

Returns: a list with all possible values

Definition at line 96 of file option.cpp.

◆ valueSize()

int KSaneCore::Option::valueSize ( ) const

This function returns the size of the values of the option of type CoreOptionType::TypeValueList.

If the size is greater than one, value() and setValue() return and expect a QVariantList with an accordingly number of elements. If the option is a CoreOptionType::TypeString, the size represents the number of characters in the string.

Returns: the number of elements

Definition at line 132 of file option.cpp.

◆ valueUnit()

Option::OptionUnit KSaneCore::Option::valueUnit ( ) const

This function returns an enum specifying whether the values of the option have a unit, e.g.

mm, px, etc.

Returns: unit of value CoreOptionUnit

Definition at line 123 of file option.cpp.

Member Data Documentation

◆ d

std::unique_ptr<KSaneCore::OptionPrivate> KSaneCore::Option::d

protected

Definition at line 151 of file option.h.

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

Class Picker

Quick Links

About KSaneCore

KSaneCore::Option

Public Types

Signals

Public Slots

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ OptionState

◆ OptionType

◆ OptionUnit

Constructor & Destructor Documentation

◆ Option()

Member Function Documentation

◆ description()

◆ internalValueList()

◆ maximumValue()

◆ minimumValue()

◆ name()

◆ optionReloaded

◆ restoreSavedData()

◆ setValue

◆ state()

◆ stepValue()

◆ storeCurrentData()

◆ title()

◆ type()

◆ value()

◆ valueChanged

◆ valueList()

◆ valueSize()

◆ valueUnit()

Member Data Documentation

◆ d