efl/src/lib/elementary/elm_systray.eo

126 lines
3.4 KiB
Plaintext
Raw Normal View History

enum Elm.Systray.Category
{
[[
Category of the Status Notifier Item.
@since 1.8
]]
app_status, [[Indicators of application status]]
communications, [[Communications apps]]
sys_services, [[System Service apps]]
hardware, [[Hardware indicators]]
other [[Undefined category]]
}
enum Elm.Systray.Status
{
[[
Application status information.
@since 1.8
]]
passive, [[Passive (normal)]]
active, [[Active]]
attention [[Needs Attention]]
}
class Elm.Systray (Efl.Object)
2014-03-26 06:20:50 -07:00
{
[[Elementary systray class]]
legacy_prefix: elm_systray;
2014-03-26 06:20:50 -07:00
eo_prefix: elm_obj_systray;
data: null;
2015-05-07 09:32:53 -07:00
methods {
@property id {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the id of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the id of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
values {
id: string @nullable; [[Status notifier item ID]]
2014-03-26 06:20:50 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property category {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the category of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the category of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
values {
cat: Elm.Systray.Category; [[Category]]
2014-03-26 06:20:50 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property icon_theme_path {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the path to the theme where the icons can be found. Set this value to "" to use the default path.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the path to the icon's theme currently in use.]]
2014-03-26 06:20:50 -07:00
}
values {
icon_theme_path: string @nullable; [[Icon theme path]]
2014-03-26 06:20:50 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property menu {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the object path of the D-Bus Menu that is to be show when the Status Notifier Item is activated by the user.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the object path of the D-Bus Menu currently in use.]]
2014-03-26 06:20:50 -07:00
}
values {
menu: const(Efl.Object) @nullable; [[Object path for DBus menu]]
2014-03-26 06:20:50 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property att_icon_name {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the name of the attention icon to be used by the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the name of the attention icon used by the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
values {
att_icon_name: string @nullable; [[Attention icon name]]
2014-03-26 06:20:50 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property status {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the status of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the status of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
values {
st: Elm.Systray.Status; [[Status]]
2014-03-26 06:20:50 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property icon_name {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the name of the icon to be used by the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the name of the icon used by the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
values {
icon_name: string @nullable; [[Status icon name]]
2014-03-26 06:20:50 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property title {
2014-03-26 06:20:50 -07:00
set {
2015-07-03 07:09:26 -07:00
[[Set the title of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
get {
2015-07-03 07:09:26 -07:00
[[Get the title of the Status Notifier Item.]]
2014-03-26 06:20:50 -07:00
}
values {
title: string @nullable; [[Title]]
2014-03-26 06:20:50 -07:00
}
}
register {
2015-07-03 07:09:26 -07:00
[[Register this Status Notifier Item in the System Tray Watcher. This function should only be called after the event #ELM_EVENT_SYSTRAY_READY is emitted.]]
return: bool; [[$true on success, $false otherwise]]
2014-03-26 06:20:50 -07:00
}
}
}