Class: GOffice::GraphTheme

Inherits:

Object

• Object
• GOffice::GraphTheme

Defined in:

(unknown)

Class Method Summary

• .foreach(handler, user_data) ⇒ nil

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

• .registry_get_theme_names ⇒ GLib::SList<String>

  A newly allocated theme name list from theme registry.

• .registry_lookup(name) ⇒ GOffice::GraphTheme

  A Gog::Theme from theme registry.

Instance Method Summary

• #delete ⇒ Boolean

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

• #description ⇒ String
• #dup ⇒ GOffice::GraphTheme

  Duplicates theme with a new Id.

• #edit(cc) ⇒ GOffice::GraphTheme

  Displays a dialog box to edit the theme.

• #fillin_style(style, obj, ind, relevant_fields) ⇒ nil

  Fill in the auto aspects of style based on theme 's element for objects of type/role similar to obj with index ind.

• #get_color_map(discrete) ⇒ GOffice::GraphAxisColorMap

  Retrieves the themed color map.

• #id ⇒ String

  Retrieves the theme Id.

• #name ⇒ String

  The GogTheme name.

• #resource_type ⇒ GOffice::ResourceType

  Resource-type.

• #resource_type=(resource_type) ⇒ GOffice::ResourceType
• #save_to_home_dir ⇒ nil

  Writes the theme to the user directory so that it becomes permanently available.

Class Method Details

.foreach(handler, user_data) ⇒ nil

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

Parameters:

• handler (GLib::Func) —

  a #GFunc using a theme as first argument

• user_data (GObject) —

  data to pass to handler

Returns:

• (nil)

.registry_get_theme_names ⇒ GLib::SList<String>

Returns a newly allocated theme name list from theme registry.

Returns:

• (GLib::SList<String>) —

  a newly allocated theme name list from theme registry.

.registry_lookup(name) ⇒ GOffice::GraphTheme

Returns a Gog::Theme from theme registry.

Parameters:

• name (String) —

  a theme name

Returns:

• (GOffice::GraphTheme) —

  a Gog::Theme from theme registry.

Instance Method Details

#delete ⇒ Boolean

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

Returns:

• (Boolean) —

  true on success.

#description ⇒ String

Returns:

• (String)

#dup ⇒ GOffice::GraphTheme

Duplicates theme with a new Id.

Returns:

• (GOffice::GraphTheme) —

  the new theme.

#edit(cc) ⇒ GOffice::GraphTheme

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

Parameters:

• cc (GOffice::CmdContext) —

  a GOCmd::Context or nil.

Returns:

• (GOffice::GraphTheme) —

  The edited theme or nil if the edition has

#fillin_style(style, obj, ind, relevant_fields) ⇒ nil

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

Parameters:

• style (GOffice::Style) —

  #GOStyle to initialize

• obj (GOffice::GraphObject) —

  Gog::Object The object associated with style

• ind (Integer) —

  an optional index

• relevant_fields (GOffice::StyleFlag) —

  GOStyleFlag

Returns:

• (nil)

#get_color_map(discrete) ⇒ GOffice::GraphAxisColorMap

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

Parameters:

• discrete (Boolean) —

  whether the map is for a discrete axis.

Returns:

• (GOffice::GraphAxisColorMap) —

  the requested color map.

#id ⇒ String

Retrieves the theme Id.

Returns:

• (String) —

  the GogTheme Id.

#name ⇒ String

Returns the GogTheme name.

Returns:

• (String) —

  the GogTheme name.

#resource_type ⇒ GOffice::ResourceType

Returns resource-type.

Returns:

• (GOffice::ResourceType) —

  resource-type

#resource_type=(resource_type) ⇒ GOffice::ResourceType

Parameters:

• resource_type (GOffice::ResourceType)

Returns:

• (GOffice::ResourceType) —

  resource-type

• (GOffice::ResourceType) —

  resource-type

#save_to_home_dir ⇒ nil

Writes the theme to the user directory so that it becomes permanently available.

Returns:

• (nil)