~~NOTOC~~
====== Embed - xfce4-embed-plugin ======

<note important> This plugin project has been archived and is no longer supported. If you would like to contribute and help update this project, please see [[https://gitlab.xfce.org/panel-plugins/xfce4-embed-plugin/-/issues/2|this open issue]]</note>

This plugin enables the embedding of arbitrary application windows into the Xfce panel. The window is resized into the panel space available, and the associated program can be automatically launched if it is not open.

  * **[[#Usage|Usage]]**
  * **[[#Examples|Examples]]**
  * **[[#Screenshots|Screenshots]]**
  * **[[#Latest Release|Latest Release]]**
  * **[[#Source Code Repository|Source Code Repository]]**
  * **[[#Reporting Bugs|Reporting Bugs]]**

Example uses include embedding an instant messaging buddy list, a mail client's new mail ticker, a simple media application, or a fancy clock or timer. Combining with Xfce's ability to auto-hide panels can make this very convenient.

===== Usage =====
Upon creating the plugin in a panel, the preferences dialog will pop up, where you can set an optional launch command, window selection criteria (if any), label formatting and font, and the plugin size.  Hover your mouse over any item for extra information.

The plugin works as follows:
  - If there are any selection criteria specified, it will search for a window that meets all of the specified criteria.
  - If no windows are found and criteria were specified, it will start monitoring X11 events to check new windows against the criteria.  Regardless of whether or not there are criteria specified, if a launch command is provided, it will launch it at this point (once).
  - Once a window is found (or a window embeds itself, as is the case with GtkSockets), the original size of the window is captured and stored.  This is used when the window is popped out, or if the minimum size is set to 0.
  - The window is embedded and resized to fill the plugin, as specified.
  - If the label is to include the title, the window is monitored for title changes.
  - If the window is destroyed, the plugin returns to step 1.

If you have a label (even if it is just a space), you can left-click it once to change keyboard focus to the embedded window (since panels do not give keyboard focus by default), and double-click it to pop the window out and in.  You can do the same along with accessing the plugin preferences in the menu that pops up if you right-click the label.

----

===== Examples =====
The following are some sample configurations. Any selection criteria not mentioned are assumed to be blank, and any specified labels are only suggestions; they can certainly be modified to taste.

  * Embed Pidgin's buddy list:
    * Launch command (optional): ''pidgin''
    * Process name: ''pidgin''
    * Window title: ''^Buddy List$''
    * You may want to add a ''gtkrc-2.0'' file to your ''~/.purple'' directory to adjust the buddy list colors to match your panel, such as the following for the greybird theme:
<code>
style "buddylist_style"
{
    text[NORMAL] = "#ffffff"
    text[PRELIGHT] = "#ffffff"
    base[ACTIVE] = shade(.7,"#686868")
    base[NORMAL] = shade(.7,"#686868")
    bg[ACTIVE] = shade(.7,"#686868")
    bg[NORMAL] = shade(.7,"#686868")
    bg[PRELIGHT] = shade(.7,"#686868")
}
widget "*pidgin_blist*" style "buddylist_style"
</code>

  * Embed gvim to edit a notes file:
    * Launch command: ''gvim --socketid %s ~/path/to/note/file''
    * Label format: ''Notes''

  * Embed a terminal:
    * Launch command: ''xterm -into %s''
    * Label format: ''%t''


[[|Back To Top]]

----

===== Screenshots =====
Embedding Pidgin's buddy list into the panel:

{{:panel-plugins:embed-pidgin-config.png?nolink&|Buddy list embedding configuration dialog}}
{{:panel-plugins:embed-pidgin-panel.png?nolink&|Buddy list embedding result}}


Embedding Claws Mail's new mail ticker into a thin panel (the ticker moves, so the entire author/subject/folder can be read):

{{:panel-plugins:embed-claws-config.png?nolink&|Mail ticker embedding configuration dialog}}
{{:panel-plugins:embed-claws-panel.png?nolink&|Mail ticker embedding result}}


The label right-click menu:

{{:panel-plugins:embed-right-click-menu.png?nolink&|Right-click menu}}

The top of an example deskbar panel with a clock, two instances of [[:panel-plugins:xfce4-genmon-plugin:start|Genmon]], and two embedded windows:

{{:panel-plugins:embed-x2.png?nolink&|Example deskbar configuration with two embedded windows}}

[[|Back To Top]]

----
===== Latest Release =====

{{rss>https://archive.xfce.org/feeds/project/xfce4-embed-plugin 1 date 2h}}

[[https://gitlab.xfce.org/panel-plugins/xfce4-embed-plugin/-/blob/master/NEWS|Read the CHANGELOG]]

  * **[[https://archive.xfce.org/src/panel-plugins/xfce4-embed-plugin/|Download current release]]** (link also contains older versions)

[[|Back to Top]]

----

===== Source Code Repository =====

[[https://gitlab.xfce.org/panel-plugins/xfce4-embed-plugin]]

----

===== Reporting Bugs =====

  * **[[:panel-plugins:xfce4-embed-plugin:bugs|Reporting Bugs]]** -- Open bug reports and how to report new bugs

[[|Back To Top]]
----
[[ :xfce:xfce4-panel:start:|Return to Main Xfce4-panel page]]