The QTextCodecPlugin class provides an abstract base for custom QTextCodec plugins. More...

Inheritance diagram for QTextCodecPlugin:

Public Methods
	QTextCodecPlugin (QObject *parent=nullptr)

	~QTextCodecPlugin ()

virtual QStringList	aliases () const = 0

virtual QTextCodec *	createForMib (int mib) = 0

virtual QTextCodec *	createForName (const QString &name) = 0

virtual QList< int >	mibEnums () const = 0

virtual QStringList	names () const = 0

Public Methods inherited from QObject
	QObject (QObject *parent=nullptr)

	~QObject ()

bool	blockSignals (bool block)

const QList< QObject * > &	children () const

bool	connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

bool	connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

bool	disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const

bool	disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const

bool	disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QString >	dynamicPropertyNames () const

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

template<typename T >
T	findChild (const QString &childName=QString ()) const

template<class T >
QList< T >	findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<class T >
QList< T >	findChildren (const QString &childName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

bool	inherits (const QString &className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

QObject *	parent () const

template<class T = QVariant>
T	property (const QString &name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const QString &name, const QVariant &value)

bool	signalsBlocked () const

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

QThread *	thread () const

Additional Inherited Members
Public Signals inherited from QObject
void	destroyed (QObject *obj=nullptr)

void	objectNameChanged (const QString &objectName)

Public Slots inherited from QObject
void	deleteLater ()

Static Public Methods inherited from QObject
static bool	connect (const QObject sender, const QMetaMethod &signalMethod, const QObject receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

static bool	connect (const QObject sender, const QString &signalMethod, const QObject receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())

static bool	connect (const QObject sender, const QString &signalMethod, const QString &location, const QObject receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool	connect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver receiver, SlotReturn (SlotClass::slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool	connect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const QMetaMethod &signalMethod, const QObject receiver, const QMetaMethod &slotMethod)

static bool	disconnect (const QObject sender, const QString &signalMethod, const QObject receiver, const QString &slotMethod)

static bool	disconnect (const QObject sender, const QString &signalMethod, const QString &location, const QObject receiver, const QString &slotMethod)

static bool	disconnect (const QObject sender, std::nullptr_t, const QObject receiver, std::nullptr_t)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver receiver, SlotReturn (SlotClass::slotMethod)(SlotArgs...))

template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)

template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool	disconnect (const Sender sender, void (SignalClass::signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)

static QMetaObject &	staticMetaObject ()

static QString	tr (const char text, const char comment=nullptr, std::optional< int > numArg=std::optional< int >())

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

virtual void	connectNotify (const QMetaMethod &signalMethod) const

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signalMethod) const

bool	isSignalConnected (const QMetaMethod &signalMethod) const

int	receivers (const QString &signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Related Functions inherited from QObject
T	qobject_cast (QObject *object)

	QObjectList

Detailed Description

The QTextCodecPlugin class provides an abstract base class for custom QTextCodec plugins.

The text codec plugin is a plugin interface which supports creating custom text codecs which can be loaded dynamically. Writing a text codec plugin is achieved by inheriting from QTextCodecPlugin, override the pure virtual methods names(), aliases(), createForName(), mibEnums() and createForMib(), and export the class with the CS_PLUGIN_REGISTER() macro.

Refer to the IANA character-sets encoding file for more information on mime names and mib enums.

See also: mibEnums(), Creating Plugins

Constructor & Destructor Documentation

QTextCodecPlugin::QTextCodecPlugin ( QObject * parent = nullptr )

explicit

Constructs a text codec plugin with the given parent.

QTextCodecPlugin::~QTextCodecPlugin ( )

Destroys the text codec plugin. You never have to call this explicitly as CopperSpice destroys a plugin automatically when it is no longer used.

Method Documentation

QStringList QTextCodecPlugin::aliases ( ) const

pure virtual

Returns the list of aliases supported by this plugin.

QTextCodec * QTextCodecPlugin::createForMib ( int mib )

pure virtual

Creates a QTextCodec object for the mib enum mib.

Refer to the IANA character-sets encoding file for more information.

See also: mibEnums()

QTextCodec * QTextCodecPlugin::createForName ( const QString & name )

pure virtual

Creates a QTextCodec object for the codec called name. The name must come from the list of encodings returned by names(). Encoding names are case sensitive.

QList<QByteArray> MyCodecPlugin::names() const {
  return QList<QByteArray> << "IBM01140" << "hp15-tw";
}
 
QTextCodec *MyCodecPlugin::createForName(const QByteArray &name)
{
  if (name == "IBM01140") {
      return new Ibm01140Codec;
  } else if (name == "hp15-tw") {
      return new Hp15TwCodec;
  }
  return 0;
}

See also: names()

QList< int > QTextCodecPlugin::mibEnums ( ) const

pure virtual

Returns the list of mib enums supported by this plugin.

See also: createForMib()

QStringList QTextCodecPlugin::names ( ) const

pure virtual

Returns the list of MIME names supported by this plugin. If a codec has several names, the extra names are returned by aliases().

See also: createForName(), aliases()

Public Methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Method Documentation