Special Usage

There there are situations in which you may prefer to show and hide the expanded widget yourself, such as when you want to actually create the widget at expansion time. In this case, create a gtk.Expander but do not add a child to it. The expander widget has the "expanded" property that can be used to monitor its expansion state. You should watch this property with a signal connection as follows:

  expander = gtk.expander_new_with_mnemonic("_More Options")
  expander.connect("notify::expanded", expander_callback)

  ...

  def expander_callback(expander, param_spec, user_data):
    if expander.get_expanded():
      # Show or create widgets
    else:
      # Hide or destroy widgets

The "activate" signal can also be used to track the expansion though it occurs before the "expanded" property is changed so the logic of the expander_callback() function would have to be reversed.

gtk.Expander.set_expanded

    def set_expanded(expanded)

The set_expanded() method sets the "expanded" property to the value of expanded. If expanded is True, the child widget is revealed; if False, the child widget is hidden.

gtk.Expander.get_expanded

    def get_expanded()

The get_expanded() method returns the value of the "expanded" property. If "expanded" is True the child widget is revealed.

gtk.Expander.set_spacing

    def set_spacing(spacing)

The set_spacing() method sets the "spacing" property to the value of spacing that sets is the number of pixels to place between expander and the child.

gtk.Expander.get_spacing

    def get_spacing()

The get_spacing() method returns the value of the "spacing" property set by the set_spacing() method.

gtk.Expander.set_label

    def set_label(label)

The set_label() method sets the "label" property to the value of label and sets the text of the label of the expander. Any previously set label will be cleared. If label is None the expander will have no label.

gtk.Expander.get_label

    def get_label()

The get_label() method returns the value of the "label" property that contains the text of the expander label, as set by the set_label() method. If the label text has not been set the return value will be None.

gtk.Expander.set_use_underline

    def set_use_underline(use_underline)

The set_use_underline() method sets the "use_underline" property to the value of use_underline. If use_underline is True, an underline in the text of the expander label indicates the next character should be used for the mnemonic accelerator key.

gtk.Expander.get_use_underline

    def get_use_underline()

The get_use_underline() method returns the value of the "use-underline" property. If "use-underline" is True an embedded underline in the expander label indicates a mnemonic. See the set_use_underline() method.

gtk.Expander.set_use_markup

    def set_use_markup(use_markup)

The set_use_markup() method sets the "use-markup" property to the value of use_markup. If use_markup is True the text of the label contains markup in the Pango text markup language. See the gtk.Label.set_markup() method for more information.

gtk.Expander.get_use_markup

    def get_use_markup()

The get_use_markup() method returns the value of the "use-markup" property. If "use-markup" is True, the label's text is interpreted as marked up with the Pango text markup language. See the set_use_markup() method.

gtk.Expander.set_label_widget

    def set_label_widget(label_widget)

The set_label_widget() method sets the expander to use the widget specified by label_widget as the label instead of a gtk.Label. This widget appears embedded alongside the expander arrow. If label_widget is None, the expander will have no label.

gtk.Expander.get_label_widget

    def get_label_widget()

The get_label_widget() method retrieves the expander's label widget. See the set_label_widget() method.

gtk.expander_new_with_mnemonic

    def gtk.expander_new_with_mnemonic(label=None)

The gtk.expander_new_with_mnemonic() function creates a new gtk.Expander using label as the text of the label. If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use '__' (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt with that key activates the button. If label is None the expander will have no label.

The "activate" gtk.Expander Signal

    def callback(expander, user_param1, ...)

The "activate" signal is emitted when the expander is activated by the user clicking on the expander toggle. Using the "notify:expanded" signal may be more appropriate in some cases as noted in the Special Usage description.