KCodecAction

#include <KCodecAction>

Inheritance diagram for KCodecAction:

[legend]

Properties
int	codecMib

QString	codecName

Properties inherited from QAction
	autoRepeat

	checkable

	checked

	enabled

	font

	icon

	iconText

	iconVisibleInMenu

	menuRole

	priority

	shortcut

	shortcutContext

	shortcutVisibleInContextMenu

	statusTip

	text

	toolTip

	visible

	whatsThis

Properties inherited from QObject
	objectName

Signals
void	codecNameTriggered (const QString &name)

void	codecTriggered (QTextCodec *codec)

void	defaultItemTriggered ()

void	encodingProberTriggered (KEncodingProber::ProberType)

void	triggered (const QString &text)

void	triggered (int index)

void	triggered (KEncodingProber::ProberType)

void	triggered (QAction *action)

void	triggered (QTextCodec *codec)

Signals inherited from KSelectAction
void	indexTriggered (int index)

void	textTriggered (const QString &text)

void	triggered (const QString &text)

void	triggered (int index)

void	triggered (QAction *action)

Public Member Functions
	KCodecAction (const QIcon &icon, const QString &text, QObject *parent, bool showAutoOptions=false)

	KCodecAction (const QString &text, QObject *parent, bool showAutoOptions=false)

	KCodecAction (QObject *parent, bool showAutoOptions=false)

QTextCodec *	codecForMib (int mib) const

QTextCodec *	currentCodec () const

int	currentCodecMib () const

QString	currentCodecName () const

KEncodingProber::ProberType	currentProberType () const

int	mibForName (const QString &codecName, bool *ok=nullptr) const

bool	setCurrentCodec (const QString &codecName)

bool	setCurrentCodec (int mib)

bool	setCurrentCodec (QTextCodec *codec)

bool	setCurrentProberType (KEncodingProber::ProberType)

Public Member Functions inherited from KSelectAction
	KSelectAction (const QIcon &icon, const QString &text, QObject *parent)

	KSelectAction (const QString &text, QObject *parent)

	KSelectAction (QObject *parent)

QAction *	action (const QString &text, Qt::CaseSensitivity cs=Qt::CaseSensitive) const

QAction *	action (int index) const

QList< QAction * >	actions () const

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text)

void	addAction (QAction *action)

void	changeItem (int index, const QString &text)

void	clear ()

int	comboWidth () const

QAction *	currentAction () const

int	currentItem () const

QString	currentText () const

virtual void	insertAction (QAction before, QAction action)

bool	isEditable () const

QStringList	items () const

bool	menuAccelsEnabled () const

virtual QAction *	removeAction (QAction *action)

void	removeAllActions ()

QActionGroup *	selectableActionGroup () const

void	setComboWidth (int width)

bool	setCurrentAction (const QString &text, Qt::CaseSensitivity cs=Qt::CaseSensitive)

bool	setCurrentAction (QAction *action)

bool	setCurrentItem (int index)

void	setEditable (bool)

void	setItems (const QStringList &lst)

void	setMaxComboViewCount (int n)

void	setMenuAccelsEnabled (bool b)

void	setToolBarMode (ToolBarMode mode)

void	setToolButtonPopupMode (QToolButton::ToolButtonPopupMode mode)

ToolBarMode	toolBarMode () const

QToolButton::ToolButtonPopupMode	toolButtonPopupMode () const

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

QWidget *	defaultWidget () const const

void	releaseWidget (QWidget *widget)

QWidget *	requestWidget (QWidget *parent)

void	setDefaultWidget (QWidget *widget)

Public Member Functions inherited from QAction
	QAction (const QIcon &icon, const QString &text, QObject *parent)

	QAction (const QString &text, QObject *parent)

	QAction (QObject *parent)

QActionGroup *	actionGroup () const const

void	activate (QAction::ActionEvent event)

QList< QGraphicsWidget * >	associatedGraphicsWidgets () const const

QList< QWidget * >	associatedWidgets () const const

bool	autoRepeat () const const

void	changed ()

QVariant	data () const const

QFont	font () const const

void	hover ()

void	hovered ()

QIcon	icon () const const

QString	iconText () const const

bool	isCheckable () const const

bool	isChecked () const const

bool	isEnabled () const const

bool	isIconVisibleInMenu () const const

bool	isSeparator () const const

bool	isShortcutVisibleInContextMenu () const const

bool	isVisible () const const

QMenu *	menu () const const

QAction::MenuRole	menuRole () const const

QWidget *	parentWidget () const const

QAction::Priority	priority () const const

void	setActionGroup (QActionGroup *group)

void	setAutoRepeat (bool)

void	setCheckable (bool)

void	setChecked (bool)

void	setData (const QVariant &userData)

void	setDisabled (bool b)

void	setEnabled (bool)

void	setFont (const QFont &font)

void	setIcon (const QIcon &icon)

void	setIconText (const QString &text)

void	setIconVisibleInMenu (bool visible)

void	setMenu (QMenu *menu)

void	setMenuRole (QAction::MenuRole menuRole)

void	setPriority (QAction::Priority priority)

void	setSeparator (bool b)

void	setShortcut (const QKeySequence &shortcut)

void	setShortcutContext (Qt::ShortcutContext context)

void	setShortcuts (const QList< QKeySequence > &shortcuts)

void	setShortcuts (QKeySequence::StandardKey key)

void	setShortcutVisibleInContextMenu (bool show)

void	setStatusTip (const QString &statusTip)

void	setText (const QString &text)

void	setToolTip (const QString &tip)

void	setVisible (bool)

void	setWhatsThis (const QString &what)

QKeySequence	shortcut () const const

Qt::ShortcutContext	shortcutContext () const const

QList< QKeySequence >	shortcuts () const const

bool	showStatusText (QWidget *widget)

QString	statusTip () const const

QString	text () const const

void	toggle ()

void	toggled (bool checked)

QString	toolTip () const const

void	trigger ()

void	triggered (bool checked)

QString	whatsThis () const const

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

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 ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

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

QList< T >	findChildren (const QRegExp &regExp, 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

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

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_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	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	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

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	setParent (QObject *parent)

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

bool	signalsBlocked () const const

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

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

QThread *	thread () const const

Protected Slots
void	actionTriggered (QAction *) override

Protected Slots inherited from KSelectAction
virtual void	actionTriggered (QAction *action)

void	slotToggled (bool)

Additional Inherited Members
Public Types inherited from KSelectAction
enum	ToolBarMode

Public Types inherited from QAction
enum	ActionEvent

enum	MenuRole

enum	Priority

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)

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

Public Attributes inherited from KSelectAction
	ComboBoxMode

	MenuMode

Public Attributes inherited from QAction
	AboutQtRole

	AboutRole

	ApplicationSpecificRole

	HighPriority

	Hover

	LowPriority

	NormalPriority

	NoRole

	PreferencesRole

	QuitRole

	TextHeuristicRole

	Trigger

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from KSelectAction
KWIDGETSADDONS_NO_EXPORT	KSelectAction (KSelectActionPrivate &dd, QObject *parent)

QWidget *	createWidget (QWidget *parent) override

void	deleteWidget (QWidget *widget) override

Protected Member Functions inherited from QWidgetAction
QList< QWidget * >	createdWidgets () const const

virtual bool	event (QEvent *event) override

virtual bool	eventFilter (QObject obj, QEvent event) override

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

Action for selecting one of several QTextCodec.

This action shows up a submenu with a list of the available codecs on the system.

Definition at line 29 of file kcodecaction.h.

Member Function Documentation

◆ codecForMib()

QTextCodec * KCodecAction::codecForMib ( int mib ) const

Deprecated:: since 5.103, use QTextCodec or QStringConverter.

Definition at line 139 of file kcodecaction.cpp.

◆ codecNameTriggered

void KCodecAction::codecNameTriggered ( const QString & name )

signal

Emitted when a codec was selected.

Parameters

name	the name of the selected encoding.

Note that textTriggered(const QString &) is emitted too (as defined in KSelectAction).

Since: 5.103

◆ codecTriggered

void KCodecAction::codecTriggered ( QTextCodec * codec )

signal

Specific (proper) codec was selected.

Note that textTriggered(const QString &) is emitted too (as defined in KSelectAction).

In your KCodecAction subclass to be backward-compatible to KF < 5.78, emit instead just the deprecated signal triggered(QTextCodec *). That will also automatically emit codecTriggered(QTextCodec *) because this signal is connected to the deprevcated one in the KCodecAction constructor. Only if you compile against a variant of KConfigWidgets built without all API deprecated up to version 5.78, then emit this signal directly. Your code would be like this:

#if KCONFIGWIDGETS_BUILD_DEPRECATED_SINCE(5, 78)
    // will also indirectly emit codecTriggered since 5.78
    Q_EMIT triggered(codec);
#else
    Q_EMIT codecTriggered(codec);
#endif

Since: 5.78

Deprecated:: since 5.103, use codecNameTriggered()

◆ currentCodec()

QTextCodec * KCodecAction::currentCodec ( ) const

Deprecated:: since 5.103, use currentCodecName

Definition at line 213 of file kcodecaction.cpp.

◆ currentCodecMib()

int KCodecAction::currentCodecMib ( ) const

Deprecated:: since 5.103, use currentCodecName

Definition at line 273 of file kcodecaction.cpp.

◆ currentProberType()

KEncodingProber::ProberType KCodecAction::currentProberType ( ) const

Applicable only if showAutoOptions in c'tor was true.

Returns: KEncodingProber::None if specific encoding is selected, not autodetection, otherwise... you know it!

Deprecated:: since 5.102, no known users.

Definition at line 291 of file kcodecaction.cpp.

◆ defaultItemTriggered

void KCodecAction::defaultItemTriggered ( )

signal

Emitted when the 'Default' codec action is triggered.

◆ encodingProberTriggered

void KCodecAction::encodingProberTriggered ( KEncodingProber::ProberType )

signal

Autodetection has been selected.

emits KEncodingProber::Universal if Default was selected.

Applicable only if showAutoOptions in c'tor was true

In your KCodecAction subclass to be backward-compatible to KF < 5.78, emit instead just the deprecated signal triggered(KEncodingProber::ProberType). That will also automatically emit encodingProberTriggered(KEncodingProber::ProberType) because this signal is connected to the deprecated one in the KCodecAction constructor. Only if you compile against a variant of KConfigWidgets built without all API deprecated up to version 5.78, then emit this signal directly. Your code would be like this:

#if KCONFIGWIDGETS_BUILD_DEPRECATED_SINCE(5, 78)
    // will also indirectly emit encodingProberTriggered since 5.78
    Q_EMIT triggered(encodingProber);
#else
    Q_EMIT encodingProberTriggered(encodingProber);
#endif

Since: 5.78

Deprecated:: since 5.102, no known users.

◆ mibForName()

int KCodecAction::mibForName	(	const QString &	codecName,
		bool *	ok = `nullptr`
	)		const

Deprecated:: since 5.103, use QTextCodec or QStringConverter.

Definition at line 103 of file kcodecaction.cpp.

◆ setCurrentCodec() [1/2]

bool KCodecAction::setCurrentCodec ( int mib )

Deprecated:: since 5.103, use setCurrentCodecName

Definition at line 280 of file kcodecaction.cpp.

◆ setCurrentCodec() [2/2]

bool KCodecAction::setCurrentCodec ( QTextCodec * codec )

Deprecated:: since 5.103, use setCurrentCodecName

Definition at line 220 of file kcodecaction.cpp.

◆ setCurrentProberType()

bool KCodecAction::setCurrentProberType ( KEncodingProber::ProberType scri )

Applicable only if showAutoOptions in c'tor was true.

KEncodingProber::Universal means 'Default' item

Deprecated:: since 5.102, no known users.

Definition at line 298 of file kcodecaction.cpp.

◆ triggered [1/2]

void KCodecAction::triggered ( KEncodingProber::ProberType )

signal

Autodetection has been selected.

emits KEncodingProber::Universal if Default was selected.

Applicable only if showAutoOptions in c'tor was true

Deprecated:: Since 5.78, use encodingProberTriggered(KEncodingProber::ProberType)

◆ triggered [2/2]

void KCodecAction::triggered ( QTextCodec * codec )

signal

Specific (proper) codec was selected.

Note that triggered(const QString &) is emitted too (as defined in KSelectAction).

Deprecated:: Since 5.78, use codecTriggered(QTextCodec *)

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

QObject::Q_EMIT

Q_EMITQ_EMIT

KCodecAction::triggered

void triggered(QTextCodec *codec)

Specific (proper) codec was selected.

KCodecAction::codecTriggered

void codecTriggered(QTextCodec *codec)

Specific (proper) codec was selected.

KCodecAction::encodingProberTriggered

void encodingProberTriggered(KEncodingProber::ProberType)

Autodetection has been selected.

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KConfigWidgets

KCodecAction

Properties

Signals

Public Member Functions

Protected Slots

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ codecForMib()

◆ codecNameTriggered

◆ codecTriggered

◆ currentCodec()

◆ currentCodecMib()

◆ currentProberType()

◆ defaultItemTriggered

◆ encodingProberTriggered

◆ mibForName()

◆ setCurrentCodec() [1/2]

◆ setCurrentCodec() [2/2]

◆ setCurrentProberType()

◆ triggered [1/2]

◆ triggered [2/2]