KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QTime

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QTime

Public constructors

new QTimenewConstructor QTime::QTime()
new QTimenew(int h,
int m,
int s = 0,
int ms = 0)
Constructor QTime::QTime(int h, int m, int s, int ms)

Public methods

[const]bool!=(const QTime other)Method bool QTime::operator!=(const QTime &other)
[const]bool<(const QTime other)Method bool QTime::operator<(const QTime &other)
[const]bool<=(const QTime other)Method bool QTime::operator<=(const QTime &other)
[const]bool==(const QTime other)Method bool QTime::operator==(const QTime &other)
[const]bool>(const QTime other)Method bool QTime::operator>(const QTime &other)
[const]bool>=(const QTime other)Method bool QTime::operator>=(const QTime &other)
[const]QTime 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.
[const]QTimeaddMSecs(int ms)Method QTime QTime::addMSecs(int ms)
[const]QTimeaddSecs(int secs)Method QTime QTime::addSecs(int secs)
voidassign(const QTime other)Assigns another object to self
[const]new QTime ptrdupCreates a copy of self
[const]intelapsedMethod int QTime::elapsed()
[const]inthourMethod int QTime::hour()
[const]boolisNull?Method bool QTime::isNull()
[const]boolisValid?Method bool QTime::isValid()
[const]intminuteMethod int QTime::minute()
[const]intmsecMethod int QTime::msec()
[const]intmsecsSinceStartOfDayMethod int QTime::msecsSinceStartOfDay()
[const]intmsecsTo(const QTime arg1)Method int QTime::msecsTo(const QTime &)
intrestartMethod int QTime::restart()
[const]intsecondMethod int QTime::second()
[const]intsecsTo(const QTime arg1)Method int QTime::secsTo(const QTime &)
boolsetHMS(int h,
int m,
int s,
int ms = 0)
Method bool QTime::setHMS(int h, int m, int s, int ms)
voidstartMethod void QTime::start()
[const]stringtoString(const Qt_DateFormat f = Qt::TextDate)Method QString QTime::toString(Qt::DateFormat f)
[const]stringtoString(string format)Method QString QTime::toString(const QString &format)

Public static methods and constants

QTimecurrentTimeStatic method QTime QTime::currentTime()
QTimefromMSecsSinceStartOfDay(int msecs)Static method QTime QTime::fromMSecsSinceStartOfDay(int msecs)
QTimefromString(string s,
const Qt_DateFormat f = Qt::TextDate)
Static method QTime QTime::fromString(const QString &s, Qt::DateFormat f)
QTimefromString(string s,
string format)
Static method QTime QTime::fromString(const QString &s, const QString &format)
boolisValid?(int h,
int m,
int s,
int ms = 0)
Static method bool QTime::isValid(int h, int m, int s, int ms)

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

!=

Signature: [const] bool != (const QTime other)

Description: Method bool QTime::operator!=(const QTime &other)

<

Signature: [const] bool < (const QTime other)

Description: Method bool QTime::operator<(const QTime &other)

<=

Signature: [const] bool <= (const QTime other)

Description: Method bool QTime::operator<=(const QTime &other)

==

Signature: [const] bool == (const QTime other)

Description: Method bool QTime::operator==(const QTime &other)

>

Signature: [const] bool > (const QTime other)

Description: Method bool QTime::operator>(const QTime &other)

>=

Signature: [const] bool >= (const QTime other)

Description: Method bool QTime::operator>=(const QTime &other)

_const_cast

Signature: [const] QTime 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.

addMSecs

Signature: [const] QTime addMSecs (int ms)

Description: Method QTime QTime::addMSecs(int ms)

addSecs

Signature: [const] QTime addSecs (int secs)

Description: Method QTime QTime::addSecs(int secs)

assign

Signature: void assign (const QTime 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.

currentTime

Signature: [static] QTime currentTime

Description: Static method QTime QTime::currentTime()

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

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 QTime ptr dup

Description: Creates a copy of self

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

elapsed

Signature: [const] int elapsed

Description: Method int QTime::elapsed()

fromMSecsSinceStartOfDay

Signature: [static] QTime fromMSecsSinceStartOfDay (int msecs)

Description: Static method QTime QTime::fromMSecsSinceStartOfDay(int msecs)

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

fromString

(1) Signature: [static] QTime fromString (string s, const Qt_DateFormat f = Qt::TextDate)

Description: Static method QTime QTime::fromString(const QString &s, Qt::DateFormat f)

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

(2) Signature: [static] QTime fromString (string s, string format)

Description: Static method QTime QTime::fromString(const QString &s, const QString &format)

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

hour

Signature: [const] int hour

Description: Method int QTime::hour()

isNull?

Signature: [const] bool isNull?

Description: Method bool QTime::isNull()

isValid?

(1) Signature: [const] bool isValid?

Description: Method bool QTime::isValid()

Python specific notes:
This instance method is available as '_inst_isValid' in Python.

(2) Signature: [static] bool isValid? (int h, int m, int s, int ms = 0)

Description: Static method bool QTime::isValid(int h, int m, int s, int ms)

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

Python specific notes:
This class method is available as '_class_isValid' in Python.

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.

minute

Signature: [const] int minute

Description: Method int QTime::minute()

msec

Signature: [const] int msec

Description: Method int QTime::msec()

msecsSinceStartOfDay

Signature: [const] int msecsSinceStartOfDay

Description: Method int QTime::msecsSinceStartOfDay()

msecsTo

Signature: [const] int msecsTo (const QTime arg1)

Description: Method int QTime::msecsTo(const QTime &)

new

(1) Signature: [static] new QTime new

Description: Constructor QTime::QTime()

This method creates an object of class QTime.

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

(2) Signature: [static] new QTime new (int h, int m, int s = 0, int ms = 0)

Description: Constructor QTime::QTime(int h, int m, int s, int ms)

This method creates an object of class QTime.

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

restart

Signature: int restart

Description: Method int QTime::restart()

second

Signature: [const] int second

Description: Method int QTime::second()

secsTo

Signature: [const] int secsTo (const QTime arg1)

Description: Method int QTime::secsTo(const QTime &)

setHMS

Signature: bool setHMS (int h, int m, int s, int ms = 0)

Description: Method bool QTime::setHMS(int h, int m, int s, int ms)

start

Signature: void start

Description: Method void QTime::start()

toString

(1) Signature: [const] string toString (const Qt_DateFormat f = Qt::TextDate)

Description: Method QString QTime::toString(Qt::DateFormat f)

(2) Signature: [const] string toString (string format)

Description: Method QString QTime::toString(const QString &format)