+2006-08-17 Bill Haneman <bill.haneman@sun.com>
+
+ * cspi/spi-private.h, cspi/spi_accessible.c:
+ (_cspi_attribute_set_from_sequence): Renamed from
+ cspi_attribute_set_from_sequence, to suppress export.
+
+ * cspi/spi.h:
+ (SPIRelationType): Fixed typo in PARENT_WINDOW_OF
+ inline docs, which was keeping the doc from appearing.
+ (SPIExceptionHandler): Doc this.
+
+ * cspi/spi_document.c:
+ Added inline gtk-docs cut-n-pasted from the doxygen
+ docs in the corresponding IDL files.
+ (AccessibleDocument_getAttributes): Fix the retval here.
+
+ * cspi/spi_streamablecontent.c:
+ Fixed some 'Since' tags that were accidentally doxygen-style.
+
+ * cspi/spi_table.c:
+ (AccessibleTable_getRowColumnExtentsAtIndex): Cut and pasted
+ docs from the IDL file.
+
+ * docs/reference/cspi/at-spi-cspi-docs.sgml:
+ Added entities for Document and StreamableContent interfaces.
+
+ * docs/reference/cspi/at-spi-cspi-sections.txt:
+ Added some docs that were present inline but not getting
+ exported to HTML.
+
2006-07-31 Bill Haneman <bill.haneman@sun.com>
* libspi/text.c:
gboolean cspi_exception_throw (CORBA_Environment *ev, char *desc_prefix);
AccessibleAttributeSet
- *cspi_attribute_set_from_sequence (const Accessibility_AttributeSet *seq);
+ *_cspi_attribute_set_from_sequence (const Accessibility_AttributeSet *seq);
#define cspi_return_if_fail(val) \
if (!(val)) \
return
* another's content.
*@SPI_RELATION_EMBEDDED_BY: Inverse of %SPI_RELATION_EMBEDS, indicates that
* this object's content is visualy embedded in another object.
- *@SPI_RELATION_POPUP_FOR: Indicates that an object is a popup for another objec *@SPI_RELATION_PARENT_WINDOW_OF: Indicates that an object is a parent window of another object.
+ *@SPI_RELATION_POPUP_FOR: Indicates that an object is a popup for another object.
+ *@SPI_RELATION_PARENT_WINDOW_OF: Indicates that an object is a parent window of another object.
*@SPI_RELATION_DESCRIBED_BY: Indicates that another object provides descriptive information about this object; more verbose than %SPI_RELATION_LABELLED_BY.
*@SPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides descriptive information about another object; more verbose than %SPI_RELATION_LABEL_FOR.
*@SPI_RELATION_LAST_DEFINED: Do not use, this is an implementation detail used
**/
typedef struct _SPIException SPIException;
-
+/**
+ * SPIExceptionHandler:
+ * @err: points to the SPIException opaque object.
+ * @is_fatal: indicates whether the exception is a fatal error or not.
+ *
+ * A function type for functions to be called when exceptions occur.
+ *
+ * Returns
+ **/
typedef SPIBoolean (*SPIExceptionHandler) (SPIException *err, SPIBoolean is_fatal);
/**
}
AccessibleAttributeSet *
-cspi_attribute_set_from_sequence (const Accessibility_AttributeSet *seq)
+_cspi_attribute_set_from_sequence (const Accessibility_AttributeSet *seq)
{
AccessibleAttributeSet *set = g_new0 (AccessibleAttributeSet, 1);
int i;
CSPI_OBJREF (obj), cspi_ev ());
cspi_return_val_if_ev ("getAttributes", NULL);
- retval = cspi_attribute_set_from_sequence (corba_seq);
+ retval = _cspi_attribute_set_from_sequence (corba_seq);
CORBA_free (corba_seq);
return retval;
#include <cspi/spi.h>
#include <cspi/spi-private.h>
-
/**
* AccessibleDocument_ref:
* @obj: a pointer to the #AccessibleDocument object on which to operate.
}
+/**
+ * AccessibleDocument_getLocale:
+ * @obj: a pointer to the #Accessible object on which to operate.
+ *
+ * Gets the locale associated with the document's content.
+ * e.g. the locale for LOCALE_TYPE_MESSAGES.
+ *
+ * Returns: a string compliant with the POSIX standard for locale description.
+ **/
char *
AccessibleDocument_getLocale (AccessibleDocument *obj)
{
}
+/**
+ * AccessibleDocument_getAttributeValue:
+ * @obj: a pointer to the #Accessible object on which to operate.
+ * @attribute: a string indicating the name of a specific attribute
+ *
+ * Gets the value of a single attribute, if specified for the document as a whole.
+ *
+ * (name-value pair) being queried.
+ *
+ * Returns a string corresponding to the value of the specified attribute, or
+ * an empty string if the attribute is unspecified for the object.
+ **/
char *
AccessibleDocument_getAttributeValue (AccessibleDocument *obj,
char *attribute)
}
+/**
+ * AccessibleDocument_getAttributes:
+ * @obj: a pointer to the #Accessible object on which to operate.
+ *
+ * Gets all attributes specified for a document as a whole.
+ *
+ * For attributes which change within
+ * the document content, see Accessibility::Text::getAttributes instead.
+ *
+ * Returns an ::AttributeSet containing the attributes of the document,
+ * as name-value pairs.
+ *
+ * Since AT-SPI 1.8.0
+ **/
AccessibleAttributeSet *
AccessibleDocument_getAttributes (AccessibleDocument *obj){
AccessibleAttributeSet *retval;
+ Accessibility_AttributeSet *corba_seq;
cspi_return_val_if_fail (obj != NULL, NULL);
- retval = Accessibility_Document_getAttributes (CSPI_OBJREF (obj),
+ corba_seq = Accessibility_Document_getAttributes (CSPI_OBJREF (obj),
cspi_ev ());
cspi_return_val_if_ev ("getAttributes", NULL);
+ retval = _cspi_attribute_set_from_sequence (corba_seq);
+ CORBA_free (corba_seq);
+
return retval;
}
* Free the memory associated with a call to #AccessibleStreamableContent_getContentTypes, once
* the result has been used.
*
-* @Since: AT-SPI 1.4
+* Since: AT-SPI 1.4
**/
void
AccessibleStreamableContent_freeContentTypesList (AccessibleStreamableContent *obj,
return retval;
}
-
+/**
+ * AccessibleTable_getRowColumnExtentsAtIndex:
+ * @obj: a pointer to the #AccessibleTable implementor on which to operate.
+ * @index: the index of the Table child whose row/column
+ * extents are requested.
+ * @row: back-filled with the first table row associated with
+ * the cell with child index \c index.
+ * @col: back-filled with the first table column associated
+ * with the cell with child index \c index.
+ * @row_extents: back-filled with the number of table rows
+ * across which child \c i extends.
+ * @col_extents: back-filled with the number of table columns
+ * across which child \c i extends.
+ * @is_selected: a boolean which is back-filled with \c True
+ * if the child at index \c i corresponds to a selected table cell,
+ * \c False otherwise.
+ *
+ * Given a child index, determine the row and column indices and
+ * extents, and whether the cell is currently selected. If
+ * the child at \c index is not a cell (for instance, if it is
+ * a summary, caption, etc.), \c False is returned.
+ *
+ * Example:
+ * If the Table child at index '6' extends across columns 5 and 6 of
+ * row 2 of a Table instance, and is currently selected, then
+ *
+ * retval = table::getRowColumnExtentsAtIndex (6, row, col,
+ * row_extents,
+ * col_extents,
+ * is_selected);
+ *
+ * will return True, and after the call
+ * row, col, row_extents, col_extents,
+ * and \c is_selected will contain 2, 5, 1, 2, and
+ * True, respectively.
+ *
+ * Returns: \c True if the index is associated with a valid table
+ * cell, \c False if the index does not correspond to a cell. If
+ * \c False is returned, the values of the out parameters are
+ * undefined.
+ *
+ * Since AT-SPI 1.7.0
+ **/
SPIBoolean
AccessibleTable_getRowColumnExtentsAtIndex (AccessibleTable *obj,
long int index, long int *row, long int *col,
*endOffset = retEndOffset;
}
- retval = cspi_attribute_set_from_sequence (attributes);
+ retval = _cspi_attribute_set_from_sequence (attributes);
return retval;
attributes = Accessibility_Text_getDefaultAttributeSet (CSPI_OBJREF (obj), cspi_ev ());
cspi_return_val_if_ev ("getDefaultAttributeSet", NULL);
- retval = cspi_attribute_set_from_sequence (attributes);
+ retval = _cspi_attribute_set_from_sequence (attributes);
retval = NULL;
return retval;
}
<!ENTITY at-spi-spi-accessible SYSTEM "xml/spi_accessible.xml">
<!ENTITY at-spi-spi-action SYSTEM "xml/spi_action.xml">
<!ENTITY at-spi-spi-component SYSTEM "xml/spi_component.xml">
+<!ENTITY at-spi-spi-document SYSTEM "xml/spi_document.xml">
<!ENTITY at-spi-spi-editabletext SYSTEM "xml/spi_editabletext.xml">
<!ENTITY at-spi-spi-hypertext SYSTEM "xml/spi_hypertext.xml">
<!ENTITY at-spi-spi-image SYSTEM "xml/spi_image.xml">
<!ENTITY at-spi-spi-selection SYSTEM "xml/spi_selection.xml">
+<!ENTITY at-spi-spi-streamable-content SYSTEM "xml/spi_streamable_content.xml">
<!ENTITY at-spi-spi-table SYSTEM "xml/spi_table.xml">
<!ENTITY at-spi-spi-text SYSTEM "xml/spi_text.xml">
<!ENTITY at-spi-spi-value SYSTEM "xml/spi_value.xml">
<title>Subinterface Methods</title>
&at-spi-spi-action;
&at-spi-spi-component;
+ &at-spi-spi-document;
&at-spi-spi-editabletext;
&at-spi-spi-hypertext;
&at-spi-spi-image;
&at-spi-spi-selection;
+ &at-spi-spi-streamable-content;
&at-spi-spi-table;
&at-spi-spi-text;
&at-spi-spi-value;
SPIException
SPIExceptionCode
SPIExceptionType
+SPIExceptionHandler
SPIBoolean
SPIRect
SPI_freeRect
Accessible_isAction
Accessible_isApplication
Accessible_isComponent
+Accessible_isDocument
Accessible_isEditableText
Accessible_isHypertext
Accessible_isImage
Accessible_getAction
Accessible_getApplication
Accessible_getComponent
+Accessible_getDocument
Accessible_getEditableText
Accessible_getHypertext
Accessible_getImage
cspi_return_if_ev
cspi_return_val_if_ev
cspi_check_ev
+cspi_peek_ev
cspi_dup_ref
cspi_release_unref
cspi_exception_get_text
+cspi_exception_throw
cspi_init
cspi_ping
cspi_main
cspi_main_quit
+cspi_role_from_spi_role
+cspi_streams_close_all
cspi_event_listener_get_type
cspi_event_listener_new
cspi_event_listener_get_corba
</SECTION>
<SECTION>
+<FILE>spi_document</FILE>
+<TITLE>AccessibleDocument Interface</TITLE>
+AccessibleDocument_ref
+AccessibleDocument_unref
+AccessibleDocument_getAttributeValue
+AccessibleDocument_getAttributes
+AccessibleDocument_getLocale
+</SECTION>
+
+<SECTION>
<FILE>spi_editabletext</FILE>
<TITLE>AccessibleEditableText Interface</TITLE>
AccessibleEditableText_ref
AccessibleSelection_selectChild
AccessibleSelection_isChildSelected
AccessibleSelection_deselectSelectedChild
+AccessibleSelection_deselectChild
AccessibleSelection_clearSelection
AccessibleSelection_selectAll
</SECTION>
<SECTION>
<FILE>spi_streamable_content</FILE>
<TITLE>AccessibleStreamableContent Interface</TITLE>
+AccessibleStreamableContentSeekType
+AccessibleStreamableContent_freeContentTypesList
AccessibleStreamableContent_ref
AccessibleStreamableContent_unref
AccessibleStreamableContent_getContentTypes
AccessibleTable_getNRows
AccessibleTable_getNSelectedColumns
AccessibleTable_getNSelectedRows
+AccessibleTable_getRowColumnExtentsAtIndex
AccessibleTable_getRowAtIndex
AccessibleTable_getRowDescription
AccessibleTable_getRowExtentAt
AccessibleText_setSelection
AccessibleText_getCharacterAtOffset
AccessibleText_getDefaultAttributes
+AccessibleText_getAttributeRun
+AccessibleText_getDefaultAttributeSet
AccessibleTextRange_freeRanges
</SECTION>
AccessibleValue_getMaximumValue
AccessibleValue_getMinimumValue
AccessibleValue_setCurrentValue
+AccessibleValue_getMinimumIncrement
</SECTION>
<SECTION>
@Returns:
+<!-- ##### FUNCTION Accessible_isDocument ##### -->
+<para>
+
+</para>
+
+@obj:
+@Returns:
+
+
<!-- ##### FUNCTION Accessible_isEditableText ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION Accessible_getDocument ##### -->
+<para>
+
+</para>
+
+@obj:
+@Returns:
+
+
<!-- ##### FUNCTION Accessible_getEditableText ##### -->
<para>
@type:
@source:
-@detail1:
-@detail2:
<!-- ##### USER_FUNCTION AccessibleEventListenerCB ##### -->
<para>
@SPI_EXCEPTION_SOURCE_REGISTRY:
@SPI_EXCEPTION_SOURCE_DEVICE:
+<!-- ##### USER_FUNCTION SPIExceptionHandler ##### -->
+<para>
+
+</para>
+
+@err:
+@is_fatal:
+@Returns:
+
+
<!-- ##### STRUCT SPIRect ##### -->
<para>
</para>
-@x:
-@y:
-@width:
-@height:
<!-- ##### FUNCTION SPI_freeRect ##### -->
<para>
AccessibleDeviceEvent is a struct which encapsulates a device event.
</para>
-@keyID:
@keystring:
-@timestamp:
@type:
@is_text:
@Returns:
+<!-- ##### FUNCTION AccessibleSelection_deselectChild ##### -->
+<para>
+
+</para>
+
+@obj:
+@childIndex:
+@Returns:
+
+
<!-- ##### FUNCTION AccessibleSelection_clearSelection ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION AccessibleTable_getRowColumnExtentsAtIndex ##### -->
+<para>
+
+</para>
+
+@obj:
+@index:
+@row:
+@col:
+@row_extents:
+@col_extents:
+@is_selected:
+@Returns:
+
+
<!-- ##### FUNCTION AccessibleTable_getRowAtIndex ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION AccessibleText_getAttributeRun ##### -->
+<para>
+
+</para>
+
+@obj:
+@offset:
+@startOffset:
+@endOffset:
+@includeDefaults:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleText_getDefaultAttributeSet ##### -->
+<para>
+
+</para>
+
+@obj:
+@Returns:
+
+
<!-- ##### FUNCTION AccessibleTextRange_freeRanges ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION AccessibleValue_getMinimumIncrement ##### -->
+<para>
+
+</para>
+
+@obj:
+@Returns:
+
+
LDADD = ../libspi/libspi.la ../cspi/libcspi.la ../login-helper/libloginhelper.la $(TESTS_LIBS) $(X_LIBS) $(XINPUT_LIBS)
TESTS = test-simple
+
+TESTS_ENVIRONMENT = \
+ LD_LIBRARY_PATH=$(top_builddir)/libspi/.libs/:$(top_builddir)/cspi/.libs/ \
+ PATH=$(top_builddir)/registryd/.libs
+
{65, NULL, SPI_KEY_PRESSRELEASE},
{64, NULL, SPI_KEY_SYM},
{0, "--hello!", SPI_KEY_STRING},
- {0, "StudlyCaps", SPI_KEY_STRING}
+ {0, "StudlyCaps!", SPI_KEY_STRING}
};
static void
projects / platform / core / uifw / at-spi2-atk.git / commitdiff