Foundry.DocumentationQuery

g Foundry.DocumentationQuery Foundry.DocumentationQuery GObject.Object GObject.Object GObject.Object->Foundry.DocumentationQuery

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

dup_function_name ()

dup_keyword ()

dup_property_name ()

dup_type_name ()

get_prefetch_all ()

set_function_name (function_name)

set_keyword (keyword)

set_prefetch_all (prefetch_all)

set_property_name (property_name)

set_type_name (type_name)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

function-name

str

r/w/en

keyword

str

r/w/en

prefetch-all

bool

r/w/en

property-name

str

r/w/en

type-name

str

r/w/en

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Foundry.DocumentationQuery(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Foundry.DocumentationQueryClass

Represents a query into the documentation engine.

classmethod new()
Return type:

Foundry.DocumentationQuery

dup_function_name()
Return type:

str

dup_keyword()
Return type:

str

dup_property_name()
Return type:

str

dup_type_name()
Return type:

str

get_prefetch_all()
Return type:

bool

set_function_name(function_name)
Parameters:

function_name (str) –

set_keyword(keyword)
Parameters:

keyword (str) –

set_prefetch_all(prefetch_all)
Parameters:

prefetch_all (bool) –

set_property_name(property_name)
Parameters:

property_name (str) –

set_type_name(type_name)
Parameters:

type_name (str) –

Property Details

Foundry.DocumentationQuery.props.function_name
Name:

function-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Foundry.DocumentationQuery.props.keyword
Name:

keyword

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Foundry.DocumentationQuery.props.prefetch_all
Name:

prefetch-all

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Foundry.DocumentationQuery.props.property_name
Name:

property-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Foundry.DocumentationQuery.props.type_name
Name:

type-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY