PanelPlugin

---

Object Hierarchy:

Description:

Content:

Properties:

• public string[] arguments { get; construct; }
  The arguments the plugin was started with.
• public string comment { get; construct; }
  The translated description of the PanelPlugin .
• public bool dark_mode { get; set; }
  Whether the PanelPlugin shall request the Gtk dark theme variant (based on the panel setting).
• public string display_name { get; construct; }
  The translated display name of the PanelPlugin .
• public bool expand { get; set; }
• public int icon_size { get; }
  The icon-size in pixels of the PanelPlugin.
• public PanelPluginMode mode { get; }
  Display mode of the plugin.
• public string name { get; construct; }
• public uint nrows { get; }
  Number of rows the plugin is embedded on.
• public Orientation orientation { get; }
  The Orientation of the PanelPlugin.
• public ScreenPosition screen_position { get; }
  The ScreenPosition of the PanelPlugin.
• public bool shrink { get; set; }
  Whether the PanelPlugin can shrink when there is no space left on the panel.
• public int size { get; }
  The size in pixels of the PanelPlugin.
• public bool small { get; set; }
  Whether the PanelPlugin is small enough to fit a single row of a multi-row panel.
• public int unique_id { get; construct; }

Static methods:

• public static void position_menu (Menu menu, out int x, out int y, bool push_in, void* panel_plugin)
  Function to be used as MenuPositionFunc in a call to popup.

Creation methods:

• protected PanelPlugin ()

Methods:

• public virtual void @construct ()
• public void add_action_widget (Widget widget)
  Attach the plugin menu to this widget.
• public ArrowType arrow_type ()
  Determine the ArrowType for a widget that opens a menu.
• public void block_autohide (bool blocked)
  Whether this plugin blocks the autohide functionality of the panel.
• public void block_menu ()
  Block configuring the plugin.
• public void focus_widget (Widget widget)
  Grab the focus on widget.
• public unowned string[] get_arguments ()
  Argument vector passed to the plugin when it was added.
• public unowned string get_comment ()
  This returns the translated comment of the plugin set in the .
• public unowned string get_display_name ()
  This returns the translated name of the plugin set in the .
• public bool get_expand ()
  Whether the plugin is expanded or not.
• public int get_icon_size ()
  Returns either the icon size defined in the panel's settings or a preferred icon size.
• public bool get_locked ()
  Whether the plugin is locked (not allowing customization).
• public PanelPluginMode get_mode ()
  The mode of the panel in which the plugin is embedded.
• public uint get_nrows ()
  The number of rows of the panel in which the plugin is embedded.
• public Orientation get_orientation ()
  The orientation of the panel in which the plugin is embedded.
• public unowned string get_property_base ()
  The property base for this plugin in the xfce4-panel XfconfChannel, this name is something like /plugins/plugin-1.
• public ScreenPosition get_screen_position ()
  The screen position of the panel in which the plugin is embedded.
• public bool get_shrink ()
  Whether the plugin can shrink if the size on the panel is limited.
• public int get_size ()
  The size of the panel in which the plugin is embedded.
• public bool get_small ()
  Whether the plugin is small enough to fit in a single row of a multi-row panel.
• public int get_unique_id ()
  The internal unique id of the plugin.
• public string lookup_rc_file ()
  Looks for the plugin resource file.
• public void menu_destroy ()
  Remove all custom menu items added through menu_insert_item from the menu.
• public void menu_insert_item (MenuItem item)
  Insert a custom menu item to the plugin's right click menu.
• public void menu_show_about ()
  Show the "About" item in the menu.
• public void menu_show_configure ()
  Show the "Properties" item in the menu.
• public void popup_menu (Menu menu, Widget? widget, Event? trigger_event)
  Pops up menu at widget if widget is non-null and if appropriate given the panel position, otherwise pops up menu at pointer.
• public void popup_window (Window window, Widget? widget)
  Pops up window at widget if widget is non-null, otherwise pops up window at this .
• public void position_widget (Widget menu_widget, Widget? attach_widget, out int x, out int y)
  Computes the x and y coordinates to position the menu_widget relative to attach_widget.
• public void register_menu (Menu menu)
  Register a menu that is about to popup.
• public void remove ()
  Remove this plugin from the panel and remove all its configuration.
• public string save_location (bool create)
  Returns the path that can be used to store configuration information.
• public void set_expand (bool expand)
  Whether the plugin should expand of not
• public void set_shrink (bool shrink)
  Whether the plugin can shrink if the size on the panel is limited.
• public void set_small (bool small)
  Whether the plugin is small enough to fit in a single row of a multi-row panel.
• public void take_window (Window window)
  Connect a dialog to a plugin.
• public void unblock_menu ()
  Unblock configuring the plugin.

Signals:

• public virtual signal void about ()
  This signal is emmitted when the About entry in the right-click menu is clicked.
• public virtual signal void configure_plugin ()
  This signal is emmitted when the Properties entry in the right-click menu is clicked.
• public virtual signal void free_data ()
  This signal is emmitted when the plugin is closing.
• public virtual signal void hidden_event (bool hidden)
  This signal is emmitted when the panel the plugin is on is transitioning between hidden/visble.
• public virtual signal void mode_changed (PanelPluginMode mode)
  This signal is emmitted whenever the mode of the panel the plugin is on changes.
• public virtual signal void nrows_changed (uint rows)
  This signal is emmitted whenever the nrows of the panel the plugin is on changes.
• public virtual signal void orientation_changed (Orientation orientation)
  This signal is emmitted whenever the orientation of the panel the plugin is on changes.
• public virtual signal void removed ()
  This signal is emmitted when the plugin is permanently removed from the panel configuration by the user.
• public virtual signal void save ()
  This signal is emitted when the plugin should save it's configuration.
• public virtual signal void screen_position_changed (ScreenPosition position)
  This signal is emmitted whenever the screen position of the panel the plugin is on changes.
• public virtual signal bool size_changed (int size)
  This signal is emmitted whenever the size of the panel the plugin is on changes.

Inherited Members: