Modifications/corrections to IDL to streamline and bring in line with ATK
authorbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>
Tue, 4 Sep 2001 14:28:58 +0000 (14:28 +0000)
committerbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>
Tue, 4 Sep 2001 14:28:58 +0000 (14:28 +0000)
interfaces.

git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@50 e2bd861d-eb25-0410-b326-f6ed22b6b98c

18 files changed:
idl/Accessibility_Action.idl
idl/Accessibility_EditableText.idl
idl/Accessibility_Hyperlink.idl
idl/Accessibility_Hypertext.idl
idl/Accessibility_Image.idl
idl/Accessibility_Selection.idl
idl/Accessibility_Table.idl
idl/Accessibility_Text.idl
idl/Accessibility_Value.idl
idl/Action.idl
idl/EditableText.idl
idl/Hyperlink.idl
idl/Hypertext.idl
idl/Image.idl
idl/Selection.idl
idl/Table.idl
idl/Text.idl
idl/Value.idl

index ea869f5..2f8c586 100644 (file)
@@ -24,45 +24,59 @@ module Accessibility {
 
   interface Action : Bonobo::Unknown {
 
-        /**
-         * getNActions:
-         * return values: a @long containing the number of actions this object supports.
-         *
-         * Returns the number of actions supported by this object.
-         **/
-        long getNActions ();
+    /**
+     * getNActions:
+     * return values: a @long containing the number of actions this object supports.
+     *
+     * Returns the number of actions supported by this object.
+     **/
+    long getNActions ();
 
-        /**
-        * getDescription:
-        * return values: a @wstring containing the description of the specified action.
-        * @index: an %in parameter specifying the index of the action 
-         *   for which a description is desired.
-        *
-        * Gets the description of the specified action.
-        *
-        **/
-        string getDescription (in long index);
+    /**
+     * getDescription:
+     * @index: an %in parameter specifying the index of the action 
+     *   for which a description is desired.
+     *
+     * Gets the description of the specified action.
+     *
+     * return values: a @wstring containing the description of the specified action.
+     *
+     **/
+    string getDescription (in long index);
 
-        /**
-         * doAction:
-         * @index: an %in parameter specifying the 0-based index of the action to perform.
-         *
-         * Causes the object to perform the specified action.
-        *
-         **/
-        void doAction (in long index);
+    /**
+     * getName:
+     * @index: an %in parameter specifying the index of the action 
+     *   whose name is requested.
+     *
+     * Gets the name of the specified action.
+     *
+     * return values: a @string containing the name of the specified action.
+     *
+     **/
+    string getName (in long index);
 
-        /**
-        * getKeyBinding:
-        * return values: a @wstring containing the key binding for the specified action,
-         *   "" if none exists.
-        * @index: an %in parameter specifying the 0-based index of the action 
-         *   for which a key binding is requested.
-        *
-        * Gets the key binding associated with a specific action.
-        *
-        **/
-        string getKeyBinding (in long index);
-  };
+    /**
+     * doAction:
+     * @index: an %in parameter specifying the 0-based index of the action to perform.
+     *
+     * Causes the object to perform the specified action.
+     *
+     * return values: a @boolean indicating success or failure.
+     *
+     **/
+    void doAction (in long index);
 
+    /**
+     * getKeyBinding:
+     * return values: a @string containing the key binding for the specified action,
+     *   "" if none exists.
+     * @index: an %in parameter specifying the 0-based index of the action 
+     *   for which a key binding is requested.
+     *
+     * Gets the key binding associated with a specific action.
+     *
+     **/
+    string getKeyBinding (in long index);
+  };
 };
index c2b960a..dc8218f 100644 (file)
@@ -26,13 +26,12 @@ module Accessibility {
 
   interface EditableText : Text {
 
-        void setTextContents (in string newContents);
-        void insertText (in long position, in string text, in long length);
-        void selectText (in long startPos, in long endPos);
-        void setAttributes (in long startPos, in long endPos, in wstring attributes);
-        void copyText (in long startPos, in long endPos);
-        void cutText (in long startPos, in long endPos);
-        void deleteText (in long startPos, in long endPos);
-        void pasteText (in long position);
+    void    setTextContents (in string newContents);
+    void    insertText (in long position, in string text, in long length);
+    boolean setAttributes (in string attributes, in long startPos, in long endPos);
+    void    copyText (in long startPos, in long endPos);
+    void    cutText (in long startPos, in long endPos);
+    void    deleteText (in long startPos, in long endPos);
+    void    pasteText (in long position);
   };
 };
index 012dce5..a52646d 100644 (file)
@@ -26,11 +26,10 @@ module Accessibility {
 
   interface Hyperlink : Bonobo::Unknown {
     readonly attribute short n_anchors;
-    readonly attribute string uri;
-    Accessible getAnchor (in long i);
+    readonly attribute long startIndex;
+    readonly attribute long endIndex;
     Accessible getObject (in long i);
-    long getStartIndex ();
-    long getEndIndex ();
+    string getURI (in long i);
     boolean isValid ();
   };
 };
index 05952ba..383400b 100644 (file)
@@ -25,8 +25,8 @@
 module Accessibility {
 
   interface Hypertext : Text {
-        long getNLinks ();
-        Hyperlink getLink (in long linkIndex);
-        long getLinkIndex (in long characterIndex);
+    long getNLinks ();
+    Hyperlink getLink (in long linkIndex);
+    long getLinkIndex (in long characterIndex);
   };
 };
index b25aa5c..f1ea4d3 100644 (file)
@@ -24,9 +24,8 @@ module Accessibility {
 
   interface Image : Bonobo::Unknown  {
     readonly attribute string imageDescription;
-    readonly attribute long height;
-    readonly attribute long width;
-    readonly attribute long xpos;
-    readonly attribute long ypos;
+    void getImagePosition (out long x, out long y, in short coordType);
+    void getImageExtents (out long x, out long y, out long width, out long height, in short coodrType);
+    void getImageSize (out long width, out long height);
   };
 };
index e1da97a..42a2dfb 100644 (file)
 module Accessibility {
 
   interface Selection : Bonobo::Unknown {
-        long getNSelectedChildren ();
-        Accessible getSelectedChild (in long selectedChildIndex);
-        boolean selectChild (in long childIndex);
-        boolean deselectSelectedChild (in long selectedChildIndex);
-        boolean isChildSelected (in long childIndex);
-        void selectAll ();
-        void clearSelection ();
+    readonly attribute long nSelectedChildren;
+    Accessible getSelectedChild (in long selectedChildIndex);
+    boolean selectChild (in long childIndex);
+    boolean deselectSelectedChild (in long selectedChildIndex);
+    boolean isChildSelected (in long childIndex);
+    void selectAll ();
+    void clearSelection ();
   };
 };
index cfe5cbc..24c8a61 100644 (file)
@@ -26,25 +26,25 @@ module Accessibility {
 
 typedef sequence<long> LongSeq;
 
 interface Table {
-        Accessible getCaption ();
-        Accessible getSummary ();
-        long getNRows ();
-        long getNColumns ();
-        Accessible getAccessibleAt (in long row, in long column);
-        long getIndexAt (in long row, in long column);
-        long getRowAtIndex (in long index);
-        long getColumnAtIndex (in long index);
-        string getRowDescription (in long row);
-        string getColumnDescription (in long column);
-        long getRowExtentAt (in long row, in long column);
-        long getColumnExtentAt (in long row, in long column);
-        Table getRowHeaders ();
-        Table getColumnHeaders ();
-        LongSeq getSelectedRows ();
-        LongSeq getSelectedColumns ();
-        boolean isRowSelected (in long row);
-        boolean isColumnSelected (in long column);
-        boolean isSelected (in long row, in long column);
 };
+ interface Table {
+   readonly attribute long nRows;
+   readonly attribute long nColumns;
+   readonly attribute Accessible caption;
+   readonly attribute Accessible summary;
+   Accessible getAccessibleAt (in long row, in long column);
+   long getIndexAt (in long row, in long column);
+   long getRowAtIndex (in long index);
+   long getColumnAtIndex (in long index);
+   string getRowDescription (in long row);
+   string getColumnDescription (in long column);
+   long getRowExtentAt (in long row, in long column);
+   long getColumnExtentAt (in long row, in long column);
+   Accessible getRowHeader (in long row);
+   Accessible getColumnHeader (in long column);
+   LongSeq getSelectedRows ();
+   LongSeq getSelectedColumns ();
+   boolean isRowSelected (in long row);
+   boolean isColumnSelected (in long column);
+   boolean isSelected (in long row, in long column);
+ };
 };
index f472c76..0cb873e 100644 (file)
@@ -31,24 +31,27 @@ module Accessibility {
     TEXT_BOUNDARY_SENTENCE_END,
     TEXT_BOUNDARY_LINE_START,
     TEXT_BOUNDARY_LINE_END
-};
+  };
 
-  interface Text {
-        long getCharacterCount ();
-        string getText (in long startOfffset, in long endOffset);
-        long getCaretOffset ();
-        boolean setCaretOffset (in long offset);
-        string getTextBeforeOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
-        string getTextAtOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
-        string getTextAfterOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
-        /* could be string instead, to allow unicode chars > 16 bits */
-        wchar getCharacterAtOffset (in long offset);
-        void getRowColAtOffset (in long offset, out long row, out long column);
-        string getAttributes (in long startOffset, in long endOffset);
-        boolean getCharacterExtents (in long offset, out long x, out long y, out long length, out long width);
-        long getOffsetAtPoint (in long x, in long y);
-        string getSelectedText ();
-        void getSelectionBounds (out long startOffset, out long endOffset);
-        boolean setSelectionBounds (in long startOffset, in long endOffset);
+  interface Text : Bonobo::Unknown {
+    readonly attribute long characterCount;
+    readonly attribute long caretOffset;
+    string getText (in long startOffset, in long endOffset);
+    boolean setCaretOffset (in long offset);
+    string getTextBeforeOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
+    string getTextAtOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
+    string getTextAfterOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
+    wchar getCharacterAtOffset (in long offset); /* could be string instead, 
+                                                 * to allow unicode chars > 16 bits 
+                                                 */
+    /* void getRowColAtOffset (in long offset, out long row, out long column); */
+    string getAttributes (in long startOffset, in long endOffset);
+    boolean getCharacterExtents (in long offset, out long x, out long y, out long length, out long width);
+    long getOffsetAtPoint (in long x, in long y);
+    long getNSelections ();
+    void getSelection (in long selectionNum, out long startOffset, out long endOffset);
+    boolean addSelection (in long startOffset, in long endOffset);
+    boolean removeSelection (in long selectionNum);
+    boolean setSelection (in long selectionNum, in long startOffset, in long endOffset);
   };
 };
index ea46f5b..e45b78c 100644 (file)
 module Accessibility {
 
   interface Value {
-        float getMinimumValue ();
-        float getCurrentValue ();
-        float getMaximumValue ();
-        float getMinimumIncrement ();
-        boolean setCurrentValue (in float value);
+    readonly attribute float minimumValue;
+    readonly attribute float maximumValue;
+    readonly attribute float minimumIncrement;
+    attribute float currentValue;
   };
 };
index ea869f5..2f8c586 100644 (file)
@@ -24,45 +24,59 @@ module Accessibility {
 
   interface Action : Bonobo::Unknown {
 
-        /**
-         * getNActions:
-         * return values: a @long containing the number of actions this object supports.
-         *
-         * Returns the number of actions supported by this object.
-         **/
-        long getNActions ();
+    /**
+     * getNActions:
+     * return values: a @long containing the number of actions this object supports.
+     *
+     * Returns the number of actions supported by this object.
+     **/
+    long getNActions ();
 
-        /**
-        * getDescription:
-        * return values: a @wstring containing the description of the specified action.
-        * @index: an %in parameter specifying the index of the action 
-         *   for which a description is desired.
-        *
-        * Gets the description of the specified action.
-        *
-        **/
-        string getDescription (in long index);
+    /**
+     * getDescription:
+     * @index: an %in parameter specifying the index of the action 
+     *   for which a description is desired.
+     *
+     * Gets the description of the specified action.
+     *
+     * return values: a @wstring containing the description of the specified action.
+     *
+     **/
+    string getDescription (in long index);
 
-        /**
-         * doAction:
-         * @index: an %in parameter specifying the 0-based index of the action to perform.
-         *
-         * Causes the object to perform the specified action.
-        *
-         **/
-        void doAction (in long index);
+    /**
+     * getName:
+     * @index: an %in parameter specifying the index of the action 
+     *   whose name is requested.
+     *
+     * Gets the name of the specified action.
+     *
+     * return values: a @string containing the name of the specified action.
+     *
+     **/
+    string getName (in long index);
 
-        /**
-        * getKeyBinding:
-        * return values: a @wstring containing the key binding for the specified action,
-         *   "" if none exists.
-        * @index: an %in parameter specifying the 0-based index of the action 
-         *   for which a key binding is requested.
-        *
-        * Gets the key binding associated with a specific action.
-        *
-        **/
-        string getKeyBinding (in long index);
-  };
+    /**
+     * doAction:
+     * @index: an %in parameter specifying the 0-based index of the action to perform.
+     *
+     * Causes the object to perform the specified action.
+     *
+     * return values: a @boolean indicating success or failure.
+     *
+     **/
+    void doAction (in long index);
 
+    /**
+     * getKeyBinding:
+     * return values: a @string containing the key binding for the specified action,
+     *   "" if none exists.
+     * @index: an %in parameter specifying the 0-based index of the action 
+     *   for which a key binding is requested.
+     *
+     * Gets the key binding associated with a specific action.
+     *
+     **/
+    string getKeyBinding (in long index);
+  };
 };
index c2b960a..dc8218f 100644 (file)
@@ -26,13 +26,12 @@ module Accessibility {
 
   interface EditableText : Text {
 
-        void setTextContents (in string newContents);
-        void insertText (in long position, in string text, in long length);
-        void selectText (in long startPos, in long endPos);
-        void setAttributes (in long startPos, in long endPos, in wstring attributes);
-        void copyText (in long startPos, in long endPos);
-        void cutText (in long startPos, in long endPos);
-        void deleteText (in long startPos, in long endPos);
-        void pasteText (in long position);
+    void    setTextContents (in string newContents);
+    void    insertText (in long position, in string text, in long length);
+    boolean setAttributes (in string attributes, in long startPos, in long endPos);
+    void    copyText (in long startPos, in long endPos);
+    void    cutText (in long startPos, in long endPos);
+    void    deleteText (in long startPos, in long endPos);
+    void    pasteText (in long position);
   };
 };
index 012dce5..a52646d 100644 (file)
@@ -26,11 +26,10 @@ module Accessibility {
 
   interface Hyperlink : Bonobo::Unknown {
     readonly attribute short n_anchors;
-    readonly attribute string uri;
-    Accessible getAnchor (in long i);
+    readonly attribute long startIndex;
+    readonly attribute long endIndex;
     Accessible getObject (in long i);
-    long getStartIndex ();
-    long getEndIndex ();
+    string getURI (in long i);
     boolean isValid ();
   };
 };
index 05952ba..383400b 100644 (file)
@@ -25,8 +25,8 @@
 module Accessibility {
 
   interface Hypertext : Text {
-        long getNLinks ();
-        Hyperlink getLink (in long linkIndex);
-        long getLinkIndex (in long characterIndex);
+    long getNLinks ();
+    Hyperlink getLink (in long linkIndex);
+    long getLinkIndex (in long characterIndex);
   };
 };
index b25aa5c..f1ea4d3 100644 (file)
@@ -24,9 +24,8 @@ module Accessibility {
 
   interface Image : Bonobo::Unknown  {
     readonly attribute string imageDescription;
-    readonly attribute long height;
-    readonly attribute long width;
-    readonly attribute long xpos;
-    readonly attribute long ypos;
+    void getImagePosition (out long x, out long y, in short coordType);
+    void getImageExtents (out long x, out long y, out long width, out long height, in short coodrType);
+    void getImageSize (out long width, out long height);
   };
 };
index e1da97a..42a2dfb 100644 (file)
 module Accessibility {
 
   interface Selection : Bonobo::Unknown {
-        long getNSelectedChildren ();
-        Accessible getSelectedChild (in long selectedChildIndex);
-        boolean selectChild (in long childIndex);
-        boolean deselectSelectedChild (in long selectedChildIndex);
-        boolean isChildSelected (in long childIndex);
-        void selectAll ();
-        void clearSelection ();
+    readonly attribute long nSelectedChildren;
+    Accessible getSelectedChild (in long selectedChildIndex);
+    boolean selectChild (in long childIndex);
+    boolean deselectSelectedChild (in long selectedChildIndex);
+    boolean isChildSelected (in long childIndex);
+    void selectAll ();
+    void clearSelection ();
   };
 };
index cfe5cbc..24c8a61 100644 (file)
@@ -26,25 +26,25 @@ module Accessibility {
 
 typedef sequence<long> LongSeq;
 
 interface Table {
-        Accessible getCaption ();
-        Accessible getSummary ();
-        long getNRows ();
-        long getNColumns ();
-        Accessible getAccessibleAt (in long row, in long column);
-        long getIndexAt (in long row, in long column);
-        long getRowAtIndex (in long index);
-        long getColumnAtIndex (in long index);
-        string getRowDescription (in long row);
-        string getColumnDescription (in long column);
-        long getRowExtentAt (in long row, in long column);
-        long getColumnExtentAt (in long row, in long column);
-        Table getRowHeaders ();
-        Table getColumnHeaders ();
-        LongSeq getSelectedRows ();
-        LongSeq getSelectedColumns ();
-        boolean isRowSelected (in long row);
-        boolean isColumnSelected (in long column);
-        boolean isSelected (in long row, in long column);
 };
+ interface Table {
+   readonly attribute long nRows;
+   readonly attribute long nColumns;
+   readonly attribute Accessible caption;
+   readonly attribute Accessible summary;
+   Accessible getAccessibleAt (in long row, in long column);
+   long getIndexAt (in long row, in long column);
+   long getRowAtIndex (in long index);
+   long getColumnAtIndex (in long index);
+   string getRowDescription (in long row);
+   string getColumnDescription (in long column);
+   long getRowExtentAt (in long row, in long column);
+   long getColumnExtentAt (in long row, in long column);
+   Accessible getRowHeader (in long row);
+   Accessible getColumnHeader (in long column);
+   LongSeq getSelectedRows ();
+   LongSeq getSelectedColumns ();
+   boolean isRowSelected (in long row);
+   boolean isColumnSelected (in long column);
+   boolean isSelected (in long row, in long column);
+ };
 };
index f472c76..0cb873e 100644 (file)
@@ -31,24 +31,27 @@ module Accessibility {
     TEXT_BOUNDARY_SENTENCE_END,
     TEXT_BOUNDARY_LINE_START,
     TEXT_BOUNDARY_LINE_END
-};
+  };
 
-  interface Text {
-        long getCharacterCount ();
-        string getText (in long startOfffset, in long endOffset);
-        long getCaretOffset ();
-        boolean setCaretOffset (in long offset);
-        string getTextBeforeOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
-        string getTextAtOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
-        string getTextAfterOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
-        /* could be string instead, to allow unicode chars > 16 bits */
-        wchar getCharacterAtOffset (in long offset);
-        void getRowColAtOffset (in long offset, out long row, out long column);
-        string getAttributes (in long startOffset, in long endOffset);
-        boolean getCharacterExtents (in long offset, out long x, out long y, out long length, out long width);
-        long getOffsetAtPoint (in long x, in long y);
-        string getSelectedText ();
-        void getSelectionBounds (out long startOffset, out long endOffset);
-        boolean setSelectionBounds (in long startOffset, in long endOffset);
+  interface Text : Bonobo::Unknown {
+    readonly attribute long characterCount;
+    readonly attribute long caretOffset;
+    string getText (in long startOffset, in long endOffset);
+    boolean setCaretOffset (in long offset);
+    string getTextBeforeOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
+    string getTextAtOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
+    string getTextAfterOffset (in long offset, in TEXT_BOUNDARY_TYPE type);
+    wchar getCharacterAtOffset (in long offset); /* could be string instead, 
+                                                 * to allow unicode chars > 16 bits 
+                                                 */
+    /* void getRowColAtOffset (in long offset, out long row, out long column); */
+    string getAttributes (in long startOffset, in long endOffset);
+    boolean getCharacterExtents (in long offset, out long x, out long y, out long length, out long width);
+    long getOffsetAtPoint (in long x, in long y);
+    long getNSelections ();
+    void getSelection (in long selectionNum, out long startOffset, out long endOffset);
+    boolean addSelection (in long startOffset, in long endOffset);
+    boolean removeSelection (in long selectionNum);
+    boolean setSelection (in long selectionNum, in long startOffset, in long endOffset);
   };
 };
index ea46f5b..e45b78c 100644 (file)
 module Accessibility {
 
   interface Value {
-        float getMinimumValue ();
-        float getCurrentValue ();
-        float getMaximumValue ();
-        float getMinimumIncrement ();
-        boolean setCurrentValue (in float value);
+    readonly attribute float minimumValue;
+    readonly attribute float maximumValue;
+    readonly attribute float minimumIncrement;
+    attribute float currentValue;
   };
 };