From fff4ecc82f2bcfa7427596e7ad9c3769fcab040b Mon Sep 17 00:00:00 2001 From: Perberos Date: Fri, 4 Nov 2011 22:16:15 -0300 Subject: first commit --- doc/Makefile.am | 27 +++ doc/config.xsl | 6 + doc/dbus-interface.xml | 479 ++++++++++++++++++++++++++++++++++++++++++++ doc/docbook.css | 18 ++ doc/mate-screensaver.xml.in | 23 +++ 5 files changed, 553 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/config.xsl create mode 100644 doc/dbus-interface.xml create mode 100644 doc/docbook.css create mode 100644 doc/mate-screensaver.xml.in (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..a8851b7 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,27 @@ +NULL = + +SPEC_XML_FILES = \ + mate-screensaver.xml \ + dbus-interface.xml \ + $(NULL) + +if DOCBOOK_DOCS_ENABLED + +htmldocdir = $(DOCDIR)/spec +htmldoc_DATA = mate-screensaver.html + +mate-screensaver.html : dbus-interface.xml + $(XMLTO) html-nochunks -m config.xsl mate-screensaver.xml + +endif # DOCBOOK_DOCS_ENABLED + +EXTRA_DIST = \ + mate-screensaver.xml.in \ + config.xsl \ + docbook.css \ + $(SPEC_XML_FILES) + $(NULL) + +clean-local: + rm -f *~ + rm -f mate-screensaver.html diff --git a/doc/config.xsl b/doc/config.xsl new file mode 100644 index 0000000..7aa9def --- /dev/null +++ b/doc/config.xsl @@ -0,0 +1,6 @@ + + + + diff --git a/doc/dbus-interface.xml b/doc/dbus-interface.xml new file mode 100644 index 0000000..d245bf1 --- /dev/null +++ b/doc/dbus-interface.xml @@ -0,0 +1,479 @@ + + + + + DBUS Interface + + This API is currently unstable and is likely to change in the future. + + + + Introduction + + MATE Screensaver exposes a DBUS API for programs to obtain information about + the screensaver state and to interact with the screensaver in limited ways. + + + The following constants are used to uniquely refer to the MateScreensaver + object when making DBUS method calls: + + + + + + DBUS Service: + org.mate.ScreenSaver + + + DBUS Object Path: + /org/mate/ScreenSaver + + + DBUS Interface: + org.mate.ScreenSaver + + + + + + + + Methods + + These are the DBUS methods. + + + + + <literal>Lock</literal> + + + Request that the screen be locked. This bypasses all Inhibit requests. + + + + + + <literal>Cycle</literal> + + + Request that the screen saver theme be restarted and, if applicable, + switch to the next one in the list. + + + + + + <literal>SimulateUserActivity</literal> + + + Simulate user activity. If the screensaver is activated this + will attempt to deactivate and authentication will be + requested if necessary. If the screensaver is not activated + then the idle timers will be reset. + + + + + + <literal>Inhibit</literal> + + + Request that saving the screen due to system idleness be blocked until + UnInhibit is called or the calling process exits. + + + + + + Direction + Type + Description + + + + + in + string + the application name, e.g. "totem" + + + in + string + the localized reason to inhibit, e.g. "playing movie" + + + out + unsigned integer + the cookie + + + + + + A cookie is a random, unique, non-zero UINT32 used to identify the inhibit request. + + + + + + <literal>UnInhibit</literal> + + + Cancel a previous call to Inhibit() identified by the cookie. + + + + + + Direction + Type + Description + + + + + in + unsigned integer + the cookie + + + + + + + + + <literal>Throttle</literal> + + + Request that running themes while the screensaver is active be blocked + until UnThrottle is called or the calling process exits. + + + + + + Direction + Type + Description + + + + + in + string + the application name, e.g. "mate-power-manager" + + + in + string + the localized reason to inhibit, e.g. "on battery power" + + + out + unsigned integer + the cookie + + + + + + A cookie is a random, unique, non-zero UINT32 used to identify the throttle request. + + + + + + <literal>UnThrottle</literal> + + + Cancel a previous call to Throttle() identified by the cookie. + + + + + + Direction + Type + Description + + + + + in + unsigned integer + the cookie + + + + + + + + + <literal>SetActive</literal> + + + Request a change in the state of the screensaver. + Set to TRUE to request that the screensaver activate. + Active means that the screensaver has blanked the screen and may run a + graphical theme. This does not necessary mean that the screen is locked. + + + + + + Direction + Type + Description + + + + + in + boolean + TRUE to request activation, FALSE to request deactivation + + + + + + + + + <literal>GetActive</literal> + + + Returns the value of the current state of activity. See SetActive(). + + + + + + Direction + Type + Description + + + + + out + boolean + Activation state + + + + + + + + + <literal>GetActiveTime</literal> + + + Returns the number of seconds that the screensaver has been active. + Returns zero if the screensaver is not active. + + + + + + Direction + Type + Description + + + + + out + unsigned integer + Active time in seconds + + + + + + + + + <literal>GetSessionIdle</literal> + + + Returns the value of the current state of session idleness. + + + + + + Direction + Type + Description + + + + + out + boolean + If the session is idle + + + + + + + + + <literal>GetSessionIdleTime</literal> + + + Returns the number of seconds that the session has been idle. + Returns zero if the session is not idle. + + + + + + Direction + Type + Description + + + + + out + unsigned integer + Idle time in seconds + + + + + + + + + Signals + + These are the DBUS signals. + + + + + <literal>ActiveChanged</literal> + + + See method GetActive(). + + + + + + Direction + Type + Description + + + + + out + boolean + Returns the value of the current state of activity. + + + + + + + + + <literal>SessionIdleChanged</literal> + + + See method GetActive(). + + + + + + Direction + Type + Description + + + + + out + boolean + Returns the value of the current state of activity. + + + + + + + + + <literal>AuthenticationRequestBegin</literal> + + + Emitted before an authentication request + + + + + + <literal>AuthenticationRequestEnd</literal> + + + Emitted after an authentication request + + + + + + Examples + + You can get the number of seconds the screensaver has been active by + running the following: + + +dbus-send --session \ + --dest=org.mate.ScreenSaver \ + --type=method_call \ + --print-reply \ + --reply-timeout=20000 \ + /org/mate/ScreenSaver \ + org.mate.ScreenSaver.GetSessionIdleTime + + + You can activate the screensaver like so: + + +dbus-send --session \ + --dest=org.mate.ScreenSaver \ + --type=method_call \ + --print-reply \ + --reply-timeout=20000 \ + /org/mate/ScreenSaver \ + org.mate.ScreenSaver.SetActive \ + boolean:true + + + + You can monitor screensaver changes: + + +dbus-monitor --session \ + "type='signal',interface='org.mate.ScreenSaver'" + + + + Or watch for a specific screensaver signal: + + +dbus-monitor --session \ + "type='signal',interface='org.mate.ScreenSaver',member='SessionIdleChanged'" + + + + diff --git a/doc/docbook.css b/doc/docbook.css new file mode 100644 index 0000000..9a0e72a --- /dev/null +++ b/doc/docbook.css @@ -0,0 +1,18 @@ +body { + font-family: luxi sans,sans-serif; +} + +table { + border: solid 1pt; + border-collapse: collapse; +} + +th { + background: #eeeeee; + padding: 5px; +} + +td { + border: solid 1pt; + padding: 5px; +} diff --git a/doc/mate-screensaver.xml.in b/doc/mate-screensaver.xml.in new file mode 100644 index 0000000..51a747a --- /dev/null +++ b/doc/mate-screensaver.xml.in @@ -0,0 +1,23 @@ + + + + + + MATE Screensaver @VERSION@ Documentation + Version @VERSION@ + 6 June, 2006 + + + William Jon + McCann + +
+ mccann@jhu.edu +
+ + + + + + + -- cgit v1.2.1