GUPnPAV.SearchCriteriaParser¶

Subclasses:: None

Methods¶

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

class	`error_quark` ()
class	`new` ()
	`parse_text` (text)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_begin_parens` ()
	`do_conjunction` ()
	`do_disjunction` ()
	`do_end_parens` ()
	`do_expression` (property, op, value)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`begin-parens`	The ::begin_parens signal is emitted to mark the beginning of a parenthetical expression.
`conjunction`	The `::conjuction` signal is emitted whenever a conjuction marker (and) is parsed.
`disjunction`	The `::disjuction` signal is emitted whenever a disjuction marker (or&rpar is parsed.
`end-parens`	The ::end_parens signal is emitted to mark the end of a parenthetical expression.
`expression`	The `::expression` signal is emitted whenever an expression is parsed.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class GUPnPAV.SearchCriteriaParser(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GUPnPAV.SearchCriteriaParserClass

classmethod error_quark()¶

Return type:: int

classmethod new()¶

Returns:: A new GUPnPAV.SearchCriteriaParser object.
Return type:: GUPnPAV.SearchCriteriaParser

parse_text(text)¶

Parameters:: text (str) – The search criteria string to be parsed
Raises:: GLib.Error
Returns:: True on success.
Return type:: bool

Parses text, emitting the various defined signals on the way. If an error occured error will be set.

do_begin_parens() virtual¶

do_conjunction() virtual¶

do_disjunction() virtual¶

do_end_parens() virtual¶

do_expression(property, op, value) virtual¶

Parameters:

property (str) –
op (GUPnPAV.SearchCriteriaOp) –
value (str) –

Return type:

bool

Signal Details¶

GUPnPAV.SearchCriteriaParser.signals.begin_parens(search_criteria_parser)¶

Signal Name:: begin-parens
Flags:: RUN_LAST
Parameters:: search_criteria_parser (GUPnPAV.SearchCriteriaParser) – The object which received the signal

The ::begin_parens signal is emitted to mark the beginning of a parenthetical expression.

GUPnPAV.SearchCriteriaParser.signals.conjunction(search_criteria_parser)¶

Signal Name:: conjunction
Flags:: RUN_LAST
Parameters:: search_criteria_parser (GUPnPAV.SearchCriteriaParser) – The object which received the signal

The ::conjuction signal is emitted whenever a conjuction marker (and) is parsed.

GUPnPAV.SearchCriteriaParser.signals.disjunction(search_criteria_parser)¶

Signal Name:: disjunction
Flags:: RUN_LAST
Parameters:: search_criteria_parser (GUPnPAV.SearchCriteriaParser) – The object which received the signal

The ::disjuction signal is emitted whenever a disjuction marker (or&rpar is parsed.

GUPnPAV.SearchCriteriaParser.signals.end_parens(search_criteria_parser)¶

Signal Name:: end-parens
Flags:: RUN_LAST
Parameters:: search_criteria_parser (GUPnPAV.SearchCriteriaParser) – The object which received the signal

The ::end_parens signal is emitted to mark the end of a parenthetical expression.

GUPnPAV.SearchCriteriaParser.signals.expression(search_criteria_parser, property, op, value, error)¶

Signal Name:

expression

Flags:

RUN_LAST

Parameters:

search_criteria_parser (GUPnPAV.SearchCriteriaParser) – The object which received the signal
property (str) – The property
op (GUPnPAV.SearchCriteriaOp) – The operator as GUPnPAV.SearchCriteriaOp
value (str) – The value as string
error (object or None) – Place-holder for any possible errors from handler

Return type:

bool

The ::expression signal is emitted whenever an expression is parsed. Set error and return False if an error occurred.