GOffice.GraphTheme¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), GOffice.Persist (2)
Structs:: GObject.ObjectClass (5)

class	`foreach` (handler, *user_data)
class	`registry_get_theme_names` ()
class	`registry_lookup` (name)
	`delete` ()
	`dup` ()
	`edit` (cc)
	`fillin_style` (style, obj, ind, relevant_fields)
	`get_color_map` (discrete)
	`get_description` ()
	`get_id` ()
	`get_name` ()
	`get_resource_type` ()
	`save_to_home_dir` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`resource-type`	`GOffice.ResourceType`	r/w/co	The resource type for the theme

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class GOffice.GraphTheme(**kwargs)¶

Bases:: GObject.Object, GOffice.Persist
Abstract:: No

classmethod foreach(handler, *user_data)¶

Parameters:

handler (GLib.Func) – a GLib.Func using a theme as first argument
user_data (object or None) – data to pass to handler

Executes handler to each theme installed on the system, including built-in themes.

classmethod registry_get_theme_names()¶

Returns:: a newly allocated theme name list from theme registry.
Return type:: [str]

classmethod registry_lookup(name)¶

Parameters:: name (str) – a theme name
Returns:: a GOffice.GraphTheme from theme registry.
Return type:: GOffice.GraphTheme

delete()¶

Returns:: True on success.
Return type:: bool

Destroys the theme and remove it from the user directory and from the database.

dup()¶

Returns:: the new theme.
Return type:: GOffice.GraphTheme

Duplicates self with a new Id.

edit(cc)¶

Parameters:: cc (GOffice.CmdContext) – a GOffice.CmdContext or None.
Returns:: The edited theme or None if the edition has been cancelled.
Return type:: GOffice.GraphTheme

Displays a dialog box to edit the theme. This can be done only for locally installed themes that are writeable.

fillin_style(style, obj, ind, relevant_fields)¶

Parameters:

style (GOffice.Style) – GOffice.Style to initialize
obj (GOffice.GraphObject) – GOffice.GraphObject The object associated with style
ind (int) – an optional index
relevant_fields (GOffice.StyleFlag) – GOffice.StyleFlag

Fill in the auto aspects of style based on self ‘s element for objects of type/role similar to obj with index ind. If relevant_fields is GOffice.StyleFlag.ALL, fillin the entire style, not just the auto portions included in relevant_fields.

get_color_map(discrete)¶

Parameters:: discrete (bool) – whether the map is for a discrete axis.
Returns:: the requested color map.
Return type:: GOffice.GraphAxisColorMap

Retrieves the themed color map. Each theme has a discrete color map and a continuous one.

get_description()¶

Return type:: str

get_id()¶

Returns:: the GOffice.GraphTheme Id.
Return type:: str

Retrieves the theme Id.

get_name()¶

Returns:: the GOffice.GraphTheme name.
Return type:: str

get_resource_type()¶

Return type:: GOffice.ResourceType

save_to_home_dir()¶: Writes the theme to the user directory so that it becomes permanently available.

Property Details¶

GOffice.GraphTheme.props.resource_type¶

Name:: resource-type
Type:: GOffice.ResourceType
Default Value:: GOffice.ResourceType.INVALID
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The resource type for the theme