Class: Handy::HeaderGroup

Inherits:

Object

• Object
• Handy::HeaderGroup

Defined in:

(unknown)

Instance Method Summary

• #add_gtk_header_bar(header_bar) ⇒ nil

  Adds header_bar to self.

• #add_header_bar(header_bar) ⇒ nil

  Adds header_bar to self.

• #add_header_group(header_group) ⇒ nil

  Adds header_group to self.

• #children ⇒ GLib::SList<Handy::HeaderGroupChild>

  Returns the list of children associated with self.

• #decorate_all ⇒ Boolean

  Gets whether the elements of the group should all receive the full decoration.

• #decorate_all=(decorate_all) ⇒ Boolean

  Whether the elements of the group should all receive the full decoration.

• #decorate_all? ⇒ Boolean

  Whether the elements of the group should all receive the full decoration.

• #initialize ⇒ Handy::HeaderGroup constructor

  Creates a new HdyHeaderGroup.

• #remove_child(child) ⇒ nil

  Removes child from self.

• #remove_gtk_header_bar(header_bar) ⇒ nil

  Removes header_bar from self.

• #remove_header_bar(header_bar) ⇒ nil

  Removes header_bar from self.

• #remove_header_group(header_group) ⇒ nil

  Removes a nested HdyHeaderGroup from self.

Constructor Details

#initialize ⇒ Handy::HeaderGroup

Creates a new HdyHeaderGroup.

Instance Method Details

#add_gtk_header_bar(header_bar) ⇒ nil

Adds header_bar to self.

When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

Parameters:

• header_bar (Gtk::HeaderBar) —

  the header bar to add

Returns:

• (nil)

#add_header_bar(header_bar) ⇒ nil

Adds header_bar to self.

When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

Parameters:

• header_bar (Handy::HeaderBar) —

  the header bar to add

Returns:

• (nil)

#add_header_group(header_group) ⇒ nil

Adds header_group to self.

When the nested group is no longer referenced elsewhere, it will be removed from the header group.

Parameters:

• header_group (Handy::HeaderGroup) —

  the header group to add

Returns:

• (nil)

#children ⇒ GLib::SList<Handy::HeaderGroupChild>

Returns the list of children associated with self.

Returns:

• (GLib::SList<Handy::HeaderGroupChild>) —

  the list of children

#decorate_all ⇒ Boolean

Gets whether the elements of the group should all receive the full decoration.

Returns:

• (Boolean) —

  whether the elements of the group should all receive the full decoration

#decorate_all=(decorate_all) ⇒ Boolean

Whether the elements of the group should all receive the full decoration.

This is useful in conjunction with [propertyLeaflet:folded] when the leaflet contains the header bars of the group, as you want them all to display the complete decoration when the leaflet is folded.

Parameters:

• decorate_all (Boolean)

Returns:

• (Boolean) —

  decorate-all

• (Boolean) —

  decorate-all

#decorate_all? ⇒ Boolean

Whether the elements of the group should all receive the full decoration.

This is useful in conjunction with [propertyLeaflet:folded] when the leaflet contains the header bars of the group, as you want them all to display the complete decoration when the leaflet is folded.

Returns:

• (Boolean) —

  decorate-all

#remove_child(child) ⇒ nil

Removes child from self.

Parameters:

• child (Handy::HeaderGroupChild) —

  the header group child to remove

Returns:

• (nil)

#remove_gtk_header_bar(header_bar) ⇒ nil

Removes header_bar from self.

Parameters:

• header_bar (Gtk::HeaderBar) —

  the header bar to remove

Returns:

• (nil)

#remove_header_bar(header_bar) ⇒ nil

Removes header_bar from self.

Parameters:

• header_bar (Handy::HeaderBar) —

  the header bar to remove

Returns:

• (nil)

#remove_header_group(header_group) ⇒ nil

Removes a nested HdyHeaderGroup from self.

Parameters:

• header_group (Handy::HeaderGroup) —

  the header group to remove

Returns:

• (nil)