API reference - Class QRadioDataControl

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QRadioDataControl

Class hierarchy: QRadioDataControl » QMediaControl » QObject

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]boolalternativeFrequenciesEnabledMethod bool QRadioDataControl::isAlternativeFrequenciesEnabled()
voidalternativeFrequenciesEnabled=(bool enabled)Method void QRadioDataControl::setAlternativeFrequenciesEnabled(bool enabled)
voidalternativeFrequenciesEnabledChanged(bool enabled)Method void QRadioDataControl::alternativeFrequenciesEnabledChanged(bool enabled)
[const]QRadioData_ErrorerrorVirtual method QRadioData::Error QRadioDataControl::error()
[const]stringerrorStringVirtual method QString QRadioDataControl::errorString()
voiderror_sig(const QRadioData_Error err)Method void QRadioDataControl::error(QRadioData::Error err)
boolevent(QEvent ptr arg1)Virtual method bool QRadioDataControl::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QRadioDataControl::eventFilter(QObject *, QEvent *)
[const]boolisAlternativeFrequenciesEnabledVirtual method bool QRadioDataControl::isAlternativeFrequenciesEnabled()
[const]boolisAlternativeFrequenciesEnabled?Method bool QRadioDataControl::isAlternativeFrequenciesEnabled()
[const]QRadioData_ProgramTypeprogramTypeVirtual method QRadioData::ProgramType QRadioDataControl::programType()
voidprogramTypeChanged(const QRadioData_ProgramType programType)Method void QRadioDataControl::programTypeChanged(QRadioData::ProgramType programType)
[const]stringprogramTypeNameVirtual method QString QRadioDataControl::programTypeName()
voidprogramTypeNameChanged(string programTypeName)Method void QRadioDataControl::programTypeNameChanged(QString programTypeName)
[const]stringradioTextVirtual method QString QRadioDataControl::radioText()
voidradioTextChanged(string radioText)Method void QRadioDataControl::radioTextChanged(QString radioText)
voidsetAlternativeFrequenciesEnabled(bool enabled)Virtual method void QRadioDataControl::setAlternativeFrequenciesEnabled(bool enabled)
[const]stringstationIdVirtual method QString QRadioDataControl::stationId()
voidstationIdChanged(string stationId)Method void QRadioDataControl::stationIdChanged(QString stationId)
[const]stringstationNameVirtual method QString QRadioDataControl::stationName()
voidstationNameChanged(string stationName)Method void QRadioDataControl::stationNameChanged(QString stationName)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QRadioDataControl::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QRadioDataControl::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QRadioDataControl::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QRadioDataControl::customEvent(QEvent *)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QRadioDataControl::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QRadioDataControl::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QRadioDataControl::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QRadioDataControl::sender()
[const]intsenderSignalIndexMethod int QRadioDataControl::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QRadioDataControl::timerEvent(QTimerEvent *)

Detailed description

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

alternativeFrequenciesEnabled

Signature: [const] bool alternativeFrequenciesEnabled

Description: Method bool QRadioDataControl::isAlternativeFrequenciesEnabled()

Python specific notes:
The object exposes a readable attribute 'alternativeFrequenciesEnabled'. This is the getter.

alternativeFrequenciesEnabled=

Signature: void alternativeFrequenciesEnabled= (bool enabled)

Description: Method void QRadioDataControl::setAlternativeFrequenciesEnabled(bool enabled)

Python specific notes:
The object exposes a writable attribute 'alternativeFrequenciesEnabled'. This is the setter.

alternativeFrequenciesEnabledChanged

Signature: void alternativeFrequenciesEnabledChanged (bool enabled)

Description: Method void QRadioDataControl::alternativeFrequenciesEnabledChanged(bool enabled)

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QRadioDataControl::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QRadioDataControl::customEvent(QEvent *)

This method can be reimplemented in a derived class.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QRadioDataControl::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

error

Signature: [const] QRadioData_Error error

Description: Virtual method QRadioData::Error QRadioDataControl::error()

This method can be reimplemented in a derived class.

errorString

Signature: [const] string errorString

Description: Virtual method QString QRadioDataControl::errorString()

This method can be reimplemented in a derived class.

error_sig

Signature: void error_sig (const QRadioData_Error err)

Description: Method void QRadioDataControl::error(QRadioData::Error err)

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QRadioDataControl::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QRadioDataControl::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

isAlternativeFrequenciesEnabled

Signature: [const] bool isAlternativeFrequenciesEnabled

Description: Virtual method bool QRadioDataControl::isAlternativeFrequenciesEnabled()

This method can be reimplemented in a derived class.

isAlternativeFrequenciesEnabled?

Signature: [const] bool isAlternativeFrequenciesEnabled?

Description: Method bool QRadioDataControl::isAlternativeFrequenciesEnabled()

Python specific notes:
The object exposes a readable attribute 'alternativeFrequenciesEnabled'. This is the getter.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QRadioDataControl::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

programType

Signature: [const] QRadioData_ProgramType programType

Description: Virtual method QRadioData::ProgramType QRadioDataControl::programType()

This method can be reimplemented in a derived class.

programTypeChanged

Signature: void programTypeChanged (const QRadioData_ProgramType programType)

Description: Method void QRadioDataControl::programTypeChanged(QRadioData::ProgramType programType)

programTypeName

Signature: [const] string programTypeName

Description: Virtual method QString QRadioDataControl::programTypeName()

This method can be reimplemented in a derived class.

programTypeNameChanged

Signature: void programTypeNameChanged (string programTypeName)

Description: Method void QRadioDataControl::programTypeNameChanged(QString programTypeName)

radioText

Signature: [const] string radioText

Description: Virtual method QString QRadioDataControl::radioText()

This method can be reimplemented in a derived class.

radioTextChanged

Signature: void radioTextChanged (string radioText)

Description: Method void QRadioDataControl::radioTextChanged(QString radioText)

receivers

Signature: [const] int receivers (string signal)

Description: Method int QRadioDataControl::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QRadioDataControl::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QRadioDataControl::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setAlternativeFrequenciesEnabled

Signature: void setAlternativeFrequenciesEnabled (bool enabled)

Description: Virtual method void QRadioDataControl::setAlternativeFrequenciesEnabled(bool enabled)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stationId

Signature: [const] string stationId

Description: Virtual method QString QRadioDataControl::stationId()

This method can be reimplemented in a derived class.

stationIdChanged

Signature: void stationIdChanged (string stationId)

Description: Method void QRadioDataControl::stationIdChanged(QString stationId)

stationName

Signature: [const] string stationName

Description: Virtual method QString QRadioDataControl::stationName()

This method can be reimplemented in a derived class.

stationNameChanged

Signature: void stationNameChanged (string stationName)

Description: Method void QRadioDataControl::stationNameChanged(QString stationName)

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QRadioDataControl::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QRadioDataControl::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QRadioDataControl::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.