Foundry.ForgeQuery¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`contains_keywords_scope` (keywords_scope)
	`contains_state` (state)
	`dup_keywords` ()
	`dup_keywords_scope` ()
	`dup_state` ()
	`set_keywords` (keywords)
	`set_keywords_scope` (keywords_scope)
	`set_state` (state)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags
`keywords`	`str`	r/w/en
`keywords-scope`	`str`	r/w/en
`state`	`str`	r/w/en

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Foundry.ForgeQuery(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Foundry.ForgeQueryClass

classmethod new()¶

Return type:: Foundry.ForgeQuery

An empty forge query that does not have specifics provided to any known subsystem filterer.

contains_keywords_scope(keywords_scope)¶

Parameters:: keywords_scope (str) – the keywords scope to check for
Returns:: True if keywords_scope was found otherwise False
Return type:: bool

Helper to check [property`Foundry`.ForgeQuery:keywords-scope] if it contains keywords_scope while handling “,” separators.

New in version 1.1.

contains_state(state)¶

Parameters:: state (str) –
Returns:: True if state was found otherwise False
Return type:: bool

Helper to check [property`Foundry`.ForgeQuery:state] if it contains state while handling “,” separators.

New in version 1.1.

dup_keywords()¶

Returns:: the keywords string
Return type:: str or None

Gets the keywords for the query.

New in version 1.1.

dup_keywords_scope()¶

Returns:: the keywords scope string
Return type:: str or None

Gets the keywords scope for the query.

Multiple scopes are supported by separating with a comma.

New in version 1.1.

dup_state()¶

Return type:: str or None

Gets the states for the query.

Multiple states are supported by separating with a comma.

New in version 1.1.

set_keywords(keywords)¶

Parameters:: keywords (str or None) – the keywords to set

Sets the keywords for the query.

New in version 1.1.

set_keywords_scope(keywords_scope)¶

Parameters:: keywords_scope (str or None) – the keywords scope to set

Sets the keywords scope for the query.

You may specify multiple scopes with a comma.

New in version 1.1.

set_state(state)¶

Parameters:: state (str) –

Sets the allowed states for the query.

You may specify multiple states with a comma.

New in version 1.1.

Property Details¶

Foundry.ForgeQuery.props.keywords¶

Name:: keywords
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Foundry.ForgeQuery.props.keywords_scope¶

Name:: keywords-scope
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Foundry.ForgeQuery.props.state¶

Name:: state
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY