RB.SourceSearchBasic

Subclasses:

None

Methods

Inherited:

RB.SourceSearch (6), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	add_to_menu (menu, action_namespace, search_action, prop, name, label)
class	new (prop, description)
class	register (prop, name, description)

Virtual Methods

Inherited:

RB.SourceSearch (3), GObject.Object (7)

Properties

Name	Type	Flags	Short Description
description	str	r/w/co	description
prop	int	r/w/co	Property id

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
description	str	r
parent	RB.SourceSearch	r
search_prop	RB.RhythmDBPropType	r

Class Details

class RB.SourceSearchBasic(**kwargs)

Bases:

RB.SourceSearch

Abstract:

No

Structure:

RB.SourceSearchBasicClass

This implementation of RB.SourceSearch constructs queries that search on a single RB.RhythmDBEntry property. It’s useful for providing basic searches.

classmethod add_to_menu(menu, action_namespace, search_action, prop, name, label)

Parameters:

• menu (Gio.Menu) – the Gio.Menu to populate

• action_namespace (str) – action namespace to use for the action (“app” or “win”)

• search_action (Gio.Action) – the search action to associate the search with

• prop (RB.RhythmDBPropType) – the property to search on

• name (str) – short untranslated name for the search

• label (str) – descriptive translatable label for the search

Adds an item to menu that will select a search based on the specified property. If there isn’t already a registered search instance for the property, one is created.

classmethod new(prop, description)

Parameters:

• prop (RB.RhythmDBPropType) – the RB.RhythmDBPropType to search

• description (str) – description for the search

Returns:

newly created RB.SourceSearchBasic

Return type:

RB.SourceSearch

Creates a new RB.SourceSearchBasic instance. This performs simple string matching on a specified property.

classmethod register(prop, name, description)

Parameters:

• prop (RB.RhythmDBPropType) – the property to search on

• name (str) – short non-translated name for the search instance

• description (str) – user-visible description for the search

Ensures that a search instance is registered with the specified name.

Property Details

RB.SourceSearchBasic.props.description

Name:

description

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

description

RB.SourceSearchBasic.props.prop

Name:

prop

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Property id