API reference - Class QUrl_UrlFormattingOption

Notation used in Ruby API documentation

Module: QtCore

Description: This class represents the QUrl::UrlFormattingOption enum

This class is equivalent to the class QUrl::UrlFormattingOption

Public constructors

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

Public methods

[const]bool!=(const QUrl_UrlFormattingOption other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QUrl_UrlFormattingOption 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 QUrl_UrlFormattingOption other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
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 QUrl_UrlFormattingOption other)Assigns another object to self
[const]new QUrl_UrlFormattingOption ptrdupCreates a copy of self
[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]QUrl_QFlags_UrlFormattingOption|(const QUrl_UrlFormattingOption other)Creates a flag set by combining the two flags
[const]QUrl_QFlags_UrlFormattingOption|(const QUrl_QFlags_UrlFormattingOption other)Combines the flag and the flag set

Public static methods and constants

[static,const]QUrl_UrlFormattingOptionNoneEnum constant QUrl::None
[static,const]QUrl_UrlFormattingOptionNormalizePathSegmentsEnum constant QUrl::NormalizePathSegments
[static,const]QUrl_UrlFormattingOptionPreferLocalFileEnum constant QUrl::PreferLocalFile
[static,const]QUrl_UrlFormattingOptionRemoveAuthorityEnum constant QUrl::RemoveAuthority
[static,const]QUrl_UrlFormattingOptionRemoveFilenameEnum constant QUrl::RemoveFilename
[static,const]QUrl_UrlFormattingOptionRemoveFragmentEnum constant QUrl::RemoveFragment
[static,const]QUrl_UrlFormattingOptionRemovePasswordEnum constant QUrl::RemovePassword
[static,const]QUrl_UrlFormattingOptionRemovePathEnum constant QUrl::RemovePath
[static,const]QUrl_UrlFormattingOptionRemovePortEnum constant QUrl::RemovePort
[static,const]QUrl_UrlFormattingOptionRemoveQueryEnum constant QUrl::RemoveQuery
[static,const]QUrl_UrlFormattingOptionRemoveSchemeEnum constant QUrl::RemoveScheme
[static,const]QUrl_UrlFormattingOptionRemoveUserInfoEnum constant QUrl::RemoveUserInfo
[static,const]QUrl_UrlFormattingOptionStripTrailingSlashEnum constant QUrl::StripTrailingSlash

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 QUrl_UrlFormattingOption 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 QUrl_UrlFormattingOption 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 QUrl_UrlFormattingOption other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

None

Signature: [static,const] QUrl_UrlFormattingOption None

Description: Enum constant QUrl::None

Python specific notes:
This member is available as 'None_' in Python.
The object exposes a readable attribute 'None_'. This is the getter.

NormalizePathSegments

Signature: [static,const] QUrl_UrlFormattingOption NormalizePathSegments

Description: Enum constant QUrl::NormalizePathSegments

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

PreferLocalFile

Signature: [static,const] QUrl_UrlFormattingOption PreferLocalFile

Description: Enum constant QUrl::PreferLocalFile

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

RemoveAuthority

Signature: [static,const] QUrl_UrlFormattingOption RemoveAuthority

Description: Enum constant QUrl::RemoveAuthority

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

RemoveFilename

Signature: [static,const] QUrl_UrlFormattingOption RemoveFilename

Description: Enum constant QUrl::RemoveFilename

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

RemoveFragment

Signature: [static,const] QUrl_UrlFormattingOption RemoveFragment

Description: Enum constant QUrl::RemoveFragment

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

RemovePassword

Signature: [static,const] QUrl_UrlFormattingOption RemovePassword

Description: Enum constant QUrl::RemovePassword

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

RemovePath

Signature: [static,const] QUrl_UrlFormattingOption RemovePath

Description: Enum constant QUrl::RemovePath

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

RemovePort

Signature: [static,const] QUrl_UrlFormattingOption RemovePort

Description: Enum constant QUrl::RemovePort

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

RemoveQuery

Signature: [static,const] QUrl_UrlFormattingOption RemoveQuery

Description: Enum constant QUrl::RemoveQuery

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

RemoveScheme

Signature: [static,const] QUrl_UrlFormattingOption RemoveScheme

Description: Enum constant QUrl::RemoveScheme

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

RemoveUserInfo

Signature: [static,const] QUrl_UrlFormattingOption RemoveUserInfo

Description: Enum constant QUrl::RemoveUserInfo

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

StripTrailingSlash

Signature: [static,const] QUrl_UrlFormattingOption StripTrailingSlash

Description: Enum constant QUrl::StripTrailingSlash

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

_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 QUrl_UrlFormattingOption 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 QUrl_UrlFormattingOption ptr dup

Description: Creates a copy of self

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

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 QUrl_UrlFormattingOption 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 QUrl_UrlFormattingOption 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

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] QUrl_QFlags_UrlFormattingOption | (const QUrl_UrlFormattingOption other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set