KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QRadioData_ProgramType

Notation used in Ruby API documentation

Module: QtMultimedia

Description: This class represents the QRadioData::ProgramType enum

This class is equivalent to the class QRadioData::ProgramType

Public constructors

new QRadioData_ProgramType ptrnew(int i)Creates an enum from an integer value
new QRadioData_ProgramType ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QRadioData_ProgramType other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QRadioData_ProgramType other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QRadioData_ProgramType other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QRadioData_ProgramType ptr_const_castReturns a non-const reference to self.
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.
voidassign(const QRadioData_ProgramType other)Assigns another object to self
[const]new QRadioData_ProgramType ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QRadioData_QFlags_ProgramType|(const QRadioData_ProgramType other)Creates a flag set by combining the two flags
[const]QRadioData_QFlags_ProgramType|(const QRadioData_QFlags_ProgramType other)Combines the flag and the flag set

Public static methods and constants

[static,const]QRadioData_ProgramTypeAdultHitsEnum constant QRadioData::AdultHits
[static,const]QRadioData_ProgramTypeAlarmEnum constant QRadioData::Alarm
[static,const]QRadioData_ProgramTypeAlarmTestEnum constant QRadioData::AlarmTest
[static,const]QRadioData_ProgramTypeChildrensProgrammesEnum constant QRadioData::ChildrensProgrammes
[static,const]QRadioData_ProgramTypeClassicRockEnum constant QRadioData::ClassicRock
[static,const]QRadioData_ProgramTypeClassicalEnum constant QRadioData::Classical
[static,const]QRadioData_ProgramTypeCollegeEnum constant QRadioData::College
[static,const]QRadioData_ProgramTypeCountryMusicEnum constant QRadioData::CountryMusic
[static,const]QRadioData_ProgramTypeCultureEnum constant QRadioData::Culture
[static,const]QRadioData_ProgramTypeCurrentAffairsEnum constant QRadioData::CurrentAffairs
[static,const]QRadioData_ProgramTypeDocumentaryEnum constant QRadioData::Documentary
[static,const]QRadioData_ProgramTypeDramaEnum constant QRadioData::Drama
[static,const]QRadioData_ProgramTypeEasyListeningEnum constant QRadioData::EasyListening
[static,const]QRadioData_ProgramTypeEducationEnum constant QRadioData::Education
[static,const]QRadioData_ProgramTypeFinanceEnum constant QRadioData::Finance
[static,const]QRadioData_ProgramTypeFolkMusicEnum constant QRadioData::FolkMusic
[static,const]QRadioData_ProgramTypeInformationEnum constant QRadioData::Information
[static,const]QRadioData_ProgramTypeJazzMusicEnum constant QRadioData::JazzMusic
[static,const]QRadioData_ProgramTypeLanguageEnum constant QRadioData::Language
[static,const]QRadioData_ProgramTypeLeisureEnum constant QRadioData::Leisure
[static,const]QRadioData_ProgramTypeLightClassicalEnum constant QRadioData::LightClassical
[static,const]QRadioData_ProgramTypeNationalMusicEnum constant QRadioData::NationalMusic
[static,const]QRadioData_ProgramTypeNewsEnum constant QRadioData::News
[static,const]QRadioData_ProgramTypeNostalgiaEnum constant QRadioData::Nostalgia
[static,const]QRadioData_ProgramTypeOldiesMusicEnum constant QRadioData::OldiesMusic
[static,const]QRadioData_ProgramTypeOtherMusicEnum constant QRadioData::OtherMusic
[static,const]QRadioData_ProgramTypePersonalityEnum constant QRadioData::Personality
[static,const]QRadioData_ProgramTypePhoneInEnum constant QRadioData::PhoneIn
[static,const]QRadioData_ProgramTypePopMusicEnum constant QRadioData::PopMusic
[static,const]QRadioData_ProgramTypePublicEnum constant QRadioData::Public
[static,const]QRadioData_ProgramTypeReligionEnum constant QRadioData::Religion
[static,const]QRadioData_ProgramTypeReligiousMusicEnum constant QRadioData::ReligiousMusic
[static,const]QRadioData_ProgramTypeReligiousTalkEnum constant QRadioData::ReligiousTalk
[static,const]QRadioData_ProgramTypeRhythmAndBluesEnum constant QRadioData::RhythmAndBlues
[static,const]QRadioData_ProgramTypeRockMusicEnum constant QRadioData::RockMusic
[static,const]QRadioData_ProgramTypeScienceEnum constant QRadioData::Science
[static,const]QRadioData_ProgramTypeSeriousClassicalEnum constant QRadioData::SeriousClassical
[static,const]QRadioData_ProgramTypeSocialAffairsEnum constant QRadioData::SocialAffairs
[static,const]QRadioData_ProgramTypeSoftEnum constant QRadioData::Soft
[static,const]QRadioData_ProgramTypeSoftRhythmAndBluesEnum constant QRadioData::SoftRhythmAndBlues
[static,const]QRadioData_ProgramTypeSoftRockEnum constant QRadioData::SoftRock
[static,const]QRadioData_ProgramTypeSportEnum constant QRadioData::Sport
[static,const]QRadioData_ProgramTypeTalkEnum constant QRadioData::Talk
[static,const]QRadioData_ProgramTypeTop40Enum constant QRadioData::Top40
[static,const]QRadioData_ProgramTypeTravelEnum constant QRadioData::Travel
[static,const]QRadioData_ProgramTypeUndefinedEnum constant QRadioData::Undefined
[static,const]QRadioData_ProgramTypeVariedEnum constant QRadioData::Varied
[static,const]QRadioData_ProgramTypeWeatherEnum constant QRadioData::Weather

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

(1) Signature: [const] bool != (const QRadioData_ProgramType other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QRadioData_ProgramType other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QRadioData_ProgramType other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

AdultHits

Signature: [static,const] QRadioData_ProgramType AdultHits

Description: Enum constant QRadioData::AdultHits

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

Alarm

Signature: [static,const] QRadioData_ProgramType Alarm

Description: Enum constant QRadioData::Alarm

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

AlarmTest

Signature: [static,const] QRadioData_ProgramType AlarmTest

Description: Enum constant QRadioData::AlarmTest

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

ChildrensProgrammes

Signature: [static,const] QRadioData_ProgramType ChildrensProgrammes

Description: Enum constant QRadioData::ChildrensProgrammes

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

ClassicRock

Signature: [static,const] QRadioData_ProgramType ClassicRock

Description: Enum constant QRadioData::ClassicRock

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

Classical

Signature: [static,const] QRadioData_ProgramType Classical

Description: Enum constant QRadioData::Classical

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

College

Signature: [static,const] QRadioData_ProgramType College

Description: Enum constant QRadioData::College

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

CountryMusic

Signature: [static,const] QRadioData_ProgramType CountryMusic

Description: Enum constant QRadioData::CountryMusic

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

Culture

Signature: [static,const] QRadioData_ProgramType Culture

Description: Enum constant QRadioData::Culture

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

CurrentAffairs

Signature: [static,const] QRadioData_ProgramType CurrentAffairs

Description: Enum constant QRadioData::CurrentAffairs

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

Documentary

Signature: [static,const] QRadioData_ProgramType Documentary

Description: Enum constant QRadioData::Documentary

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

Drama

Signature: [static,const] QRadioData_ProgramType Drama

Description: Enum constant QRadioData::Drama

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

EasyListening

Signature: [static,const] QRadioData_ProgramType EasyListening

Description: Enum constant QRadioData::EasyListening

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

Education

Signature: [static,const] QRadioData_ProgramType Education

Description: Enum constant QRadioData::Education

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

Finance

Signature: [static,const] QRadioData_ProgramType Finance

Description: Enum constant QRadioData::Finance

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

FolkMusic

Signature: [static,const] QRadioData_ProgramType FolkMusic

Description: Enum constant QRadioData::FolkMusic

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

Information

Signature: [static,const] QRadioData_ProgramType Information

Description: Enum constant QRadioData::Information

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

JazzMusic

Signature: [static,const] QRadioData_ProgramType JazzMusic

Description: Enum constant QRadioData::JazzMusic

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

Language

Signature: [static,const] QRadioData_ProgramType Language

Description: Enum constant QRadioData::Language

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

Leisure

Signature: [static,const] QRadioData_ProgramType Leisure

Description: Enum constant QRadioData::Leisure

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

LightClassical

Signature: [static,const] QRadioData_ProgramType LightClassical

Description: Enum constant QRadioData::LightClassical

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

NationalMusic

Signature: [static,const] QRadioData_ProgramType NationalMusic

Description: Enum constant QRadioData::NationalMusic

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

News

Signature: [static,const] QRadioData_ProgramType News

Description: Enum constant QRadioData::News

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

Nostalgia

Signature: [static,const] QRadioData_ProgramType Nostalgia

Description: Enum constant QRadioData::Nostalgia

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

OldiesMusic

Signature: [static,const] QRadioData_ProgramType OldiesMusic

Description: Enum constant QRadioData::OldiesMusic

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

OtherMusic

Signature: [static,const] QRadioData_ProgramType OtherMusic

Description: Enum constant QRadioData::OtherMusic

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

Personality

Signature: [static,const] QRadioData_ProgramType Personality

Description: Enum constant QRadioData::Personality

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

PhoneIn

Signature: [static,const] QRadioData_ProgramType PhoneIn

Description: Enum constant QRadioData::PhoneIn

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

PopMusic

Signature: [static,const] QRadioData_ProgramType PopMusic

Description: Enum constant QRadioData::PopMusic

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

Public

Signature: [static,const] QRadioData_ProgramType Public

Description: Enum constant QRadioData::Public

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

Religion

Signature: [static,const] QRadioData_ProgramType Religion

Description: Enum constant QRadioData::Religion

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

ReligiousMusic

Signature: [static,const] QRadioData_ProgramType ReligiousMusic

Description: Enum constant QRadioData::ReligiousMusic

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

ReligiousTalk

Signature: [static,const] QRadioData_ProgramType ReligiousTalk

Description: Enum constant QRadioData::ReligiousTalk

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

RhythmAndBlues

Signature: [static,const] QRadioData_ProgramType RhythmAndBlues

Description: Enum constant QRadioData::RhythmAndBlues

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

RockMusic

Signature: [static,const] QRadioData_ProgramType RockMusic

Description: Enum constant QRadioData::RockMusic

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

Science

Signature: [static,const] QRadioData_ProgramType Science

Description: Enum constant QRadioData::Science

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

SeriousClassical

Signature: [static,const] QRadioData_ProgramType SeriousClassical

Description: Enum constant QRadioData::SeriousClassical

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

SocialAffairs

Signature: [static,const] QRadioData_ProgramType SocialAffairs

Description: Enum constant QRadioData::SocialAffairs

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

Soft

Signature: [static,const] QRadioData_ProgramType Soft

Description: Enum constant QRadioData::Soft

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

SoftRhythmAndBlues

Signature: [static,const] QRadioData_ProgramType SoftRhythmAndBlues

Description: Enum constant QRadioData::SoftRhythmAndBlues

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

SoftRock

Signature: [static,const] QRadioData_ProgramType SoftRock

Description: Enum constant QRadioData::SoftRock

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

Sport

Signature: [static,const] QRadioData_ProgramType Sport

Description: Enum constant QRadioData::Sport

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

Talk

Signature: [static,const] QRadioData_ProgramType Talk

Description: Enum constant QRadioData::Talk

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

Top40

Signature: [static,const] QRadioData_ProgramType Top40

Description: Enum constant QRadioData::Top40

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

Travel

Signature: [static,const] QRadioData_ProgramType Travel

Description: Enum constant QRadioData::Travel

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

Undefined

Signature: [static,const] QRadioData_ProgramType Undefined

Description: Enum constant QRadioData::Undefined

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

Varied

Signature: [static,const] QRadioData_ProgramType Varied

Description: Enum constant QRadioData::Varied

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

Weather

Signature: [static,const] QRadioData_ProgramType Weather

Description: Enum constant QRadioData::Weather

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

_const_cast

Signature: [const] QRadioData_ProgramType ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_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.

assign

Signature: void assign (const QRadioData_ProgramType other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QRadioData_ProgramType ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

Python specific notes:
This method is also available as 'hash(object)'.

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

new

(1) Signature: [static] new QRadioData_ProgramType ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QRadioData_ProgramType ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object.

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

Python specific notes:
This method is also available as 'int(object)'.

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.

|

(1) Signature: [const] QRadioData_QFlags_ProgramType | (const QRadioData_ProgramType other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QRadioData_QFlags_ProgramType | (const QRadioData_QFlags_ProgramType other)

Description: Combines the flag and the flag set