← Back to branch summary

~vcs-imports/gnome-mag/master

« back to all changes in this revision

Viewing changes to xml/org.freedesktop.gnome.Magnifier.xml

  • Committer: Carlos Eduardo Rodrigues DiÃgenes
  • Date: 2010-01-22 22:27:27 UTC
  • Revision ID: git-v1:e8aa4ff7c7d782d8319482418bbb945f6373e9d9
Committing the changes to support D-BUS. This initial implementation still support CORBA, so in some parts the D-BUS code affect the CORBA code to make the migration easier. After the CORBA deprecation the code can be better refactored.

Show diffs side-by-side

added added

removed removed

Lines of Context:
xml/org.freedesktop.gnome.Magnifier.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/org/freedesktop/gnome/Magnifier">
 
3
  <interface name="org.freedesktop.gnome.Magnifier">
 
4
    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
5
      <p>
 
6
        Properties and methods of Magnifier instance.
 
7
      </p>
 
8
    </tp:docstring>
 
9
 
 
10
    <method name="fullScreenCapable">
 
11
      <tp:docstring>
 
12
        <p>
 
13
          Consult if the Magnifier can magnify in full-screen mode.
 
14
        </p>
 
15
      </tp:docstring>
 
16
      <arg type="b" name="b-ret" direction="out">
 
17
        <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="" />
 
18
        <tp:docstring>TRUE if it can or FALSE otherwise.</tp:docstring>
 
19
      </arg>
 
20
    </method>
 
21
 
 
22
    <method name="hideCursor">
 
23
      <tp:docstring>
 
24
        <p>Hide the original cursor.</p>
 
25
      </tp:docstring>
 
26
      <annotation name="org.freedesktop.DBus.GLib.NoReply" value="true"/>
 
27
    </method>
 
28
 
 
29
    <method name="showCursor">
 
30
      <tp:docstring>
 
31
        <p>Show the original cursor.</p>
 
32
      </tp:docstring>
 
33
      <annotation name="org.freedesktop.DBus.GLib.NoReply" value="true"/>
 
34
    </method>
 
35
 
 
36
    <method name="supportColorblindFilters">
 
37
      <tp:docstring>
 
38
        <p>Consult if the Magnifier can apply colorblind image filters.</p>
 
39
      </tp:docstring>
 
40
      <arg type="b" name="b-ret" direction="out">
 
41
        <tp:docstring>TRUE if it can or FALSE otherwise.</tp:docstring>
 
42
      </arg>
 
43
    </method>
 
44
 
 
45
    <method name="createZoomRegion">
 
46
      <tp:docstring>
 
47
        <p>
 
48
          Create a new zoom region for the magnifier.
 
49
          The new region is initially 'unmanaged'; that is, it is not associated
 
50
          with a particular sub-region of the "source" display.
 
51
        </p>
 
52
      </tp:docstring>
 
53
      <arg type="d" name="zx" direction="in">
 
54
        <tp:docstring>
 
55
          the scale factor in the x direction for the new zoom region
 
56
        </tp:docstring>
 
57
      </arg>
 
58
      <arg type="d" name="zy" direction="in">
 
59
        <tp:docstring>
 
60
          the scale factor in the y direction for the new zoom region
 
61
        </tp:docstring>
 
62
      </arg>
 
63
      <arg type="ai" name="ROI" tp:type="RectBounds" direction="in">
 
64
        <tp:docstring>
 
65
          the initial ROI (region of interest) of the zoom region.  RectBounds
 
66
          of negative  width/height indicates that the zoom region has no
 
67
          initial ROI.
 
68
        </tp:docstring>
 
69
      </arg>
 
70
      <arg type="ai" name="viewPort" tp:type="RectBounds" direction="in">
 
71
        <tp:docstring>
 
72
          the initial bounds of the ZoomRegion's viewport, in the target
 
73
          display coordinate system.
 
74
        </tp:docstring>
 
75
      </arg>
 
76
      <arg type="o" name="zoomRegion-ret" direction="out">
 
77
        <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="" />
 
78
        <tp:docstring>
 
79
          the newly created ZoomRegion
 
80
        </tp:docstring>
 
81
      </arg>
 
82
    </method>
 
83
 
 
84
    <method name="getZoomRegions">
 
85
      <tp:docstring>
 
86
        <p>
 
87
          Return a list of ZoomRegion's for this Magnifier.
 
88
         </p>
 
89
      </tp:docstring>
 
90
      <arg type="as" name="zoomRegionList-ret" direction="out">
 
91
        <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="" />
 
92
        <tp:docstring>
 
93
          ZoomRegionList including all currently defined ZoomRegions for this
 
94
          Magnifier instance.
 
95
        </tp:docstring>
 
96
      </arg>
 
97
    </method>
 
98
 
 
99
    <method name="addZoomRegion">
 
100
      <tp:docstring>
 
101
        <p>
 
102
          Add a new ZoomRegion to the list of currently defined ZoomRegions 
 
103
          for this Magnifier instance.
 
104
        </p>
 
105
      </tp:docstring>
 
106
      <arg type="o" name="region" direction="in">
 
107
        <tp:docstring>ZoomRegion to add</tp:docstring>
 
108
      </arg>
 
109
      <arg type="b" name="b-ret" direction="out">
 
110
        <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="" />
 
111
        <tp:docstring>
 
112
          returns True if successful, False if the ZoomRegion cannot be
 
113
          added.
 
114
        </tp:docstring>
 
115
      </arg>
 
116
   </method>
 
117
   
 
118
    <method name="clearAllZoomRegions">
 
119
      <tp:docstring>
 
120
        <p>
 
121
          Clears and destroys all currently defined zoom regions.
 
122
        </p>
 
123
      </tp:docstring>
 
124
      <annotation name="org.freedesktop.DBus.GLib.NoReply" value="true"/>
 
125
    </method>
 
126
 
 
127
    <method name="dispose">
 
128
      <tp:docstring>
 
129
        <p>
 
130
          Unmap the current magnifier from the display, destroy its resources,
 
131
          and exit.
 
132
        </p>
 
133
      </tp:docstring>
 
134
      <annotation name="org.freedesktop.DBus.GLib.NoReply" value="true"/>
 
135
    </method>
 
136
    
 
137
  </interface>  <!-- org.freedesktop.gnome.Magnifier -->
 
138
</node>         <!-- /org/freedesktop/gnome/Magnifier -->