diff options
| author | Aline Bessa <alibezz@gmail.com> | 2011-08-02 20:32:21 -0300 |
|---|---|---|
| committer | Mike Gorse <mgorse@novell.com> | 2011-08-23 22:04:36 -0500 |
| commit | afe9f3f62e34b3b20de7cfa9ab5348ca142b978d (patch) | |
| tree | 6f2b91f0bfb47ceb5b3780a71459adba4836f776 /atspi/atspi-matchrule.c | |
| parent | bf612b1048ad0e19d6945582ff8b13691e57acd7 (diff) | |
| download | at-spi2-core-afe9f3f62e34b3b20de7cfa9ab5348ca142b978d.tar.gz | |
Improving atspi-matchrule documentation.
Diffstat (limited to 'atspi/atspi-matchrule.c')
| -rw-r--r-- | atspi/atspi-matchrule.c | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/atspi/atspi-matchrule.c b/atspi/atspi-matchrule.c index 76415c28..d68cdb93 100644 --- a/atspi/atspi-matchrule.c +++ b/atspi/atspi-matchrule.c @@ -79,27 +79,41 @@ atspi_match_rule_class_init (AtspiMatchRuleClass *klass) * atspi_match_rule_new: * * @states: An #AtspiStateSet specifying the states to match or NULL if none. + * * @statematchtype: An #AtspiCollectionMatchType specifying how to interpret * @states. + * * @attributes: (element-type gchar* gchar*): A #GHashTable specifying * attributes to match. + * * @attributematchtype: An #AtspiCollectionMatchType specifying how to * interpret @attributes. + * * @interfaces: (element-type gchar*): An array of interfaces to match, or - * NUL if not applicable. Interface names should be specified + * NULL if not applicable. Interface names should be specified * by their DBus names (org.a11y.Atspi.Accessible, * org.a11y.Atspi.Component, etc). + * * @interfacematchtype: An #AtspiCollectionMatchType specifying how to * interpret @interfaces. + * * @roles: (element-type AtspiRole): A #GArray of roles to match, or NULL if * not applicable. + * * @rolematchtype: An #AtspiCollectionMatchType specifying how to * interpret @roles. - * @invert: Specifies whether results should be inverted. - * TODO: Document this parameter better. + * + * @invert: if #TRUE, the match rule should be denied (inverted); if #FALSE, + * it should not. For example, if the match rule defines that a match is + * an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, + * inverting it would match all objects that are not of ROLE_HEADING, + * focusable and clickable at the same time. + * + * Creates a new #AtspiMatchRule with specified @states, @attributes, + * @interfaces, and @roles. * * Returns: (transfer full): A new #AtspiMatchRule. - */ + **/ AtspiMatchRule * atspi_match_rule_new (AtspiStateSet *states, AtspiCollectionMatchType statematchtype, |