diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2015-05-19 13:14:05 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2015-05-19 15:27:30 +0100 |
commit | c7bbe2a9f6ca0b86eb53f2824a7e1c9bc519d590 (patch) | |
tree | 5366ba6606b11c42cd274a64dfc1803100e186cf | |
parent | 6088437786b76bb3f3dc400ce6d57bedf33b1def (diff) | |
download | clutter-c7bbe2a9f6ca0b86eb53f2824a7e1c9bc519d590.tar.gz |
Remove the separate Cally API reference
-rw-r--r-- | .gitignore | 13 | ||||
-rw-r--r-- | configure.ac | 2 | ||||
-rw-r--r-- | doc/reference/cally/Makefile.am | 49 | ||||
-rw-r--r-- | doc/reference/cally/cally-docs.xml.in | 145 | ||||
-rw-r--r-- | doc/reference/cally/cally-overview.xml | 74 | ||||
-rw-r--r-- | doc/reference/cally/cally-sections.txt | 176 | ||||
-rw-r--r-- | doc/reference/cally/cally.types | 9 |
7 files changed, 0 insertions, 468 deletions
diff --git a/.gitignore b/.gitignore index 7f61f0f96..93406696e 100644 --- a/.gitignore +++ b/.gitignore @@ -61,19 +61,6 @@ doc/reference/clutter/*.stamp doc/reference/clutter/*.bak doc/reference/clutter/*.log doc/reference/clutter/gtkdoc-check.* -doc/reference/cally/cally-*.txt -!/doc/reference/cally/cally-sections.txt -doc/reference/cally/html -doc/reference/cally/tmpl -doc/reference/cally/xml -doc/reference/cally/cally.args -doc/reference/cally/cally.hierarchy -doc/reference/cally/cally.interfaces -doc/reference/cally/cally.prerequisites -doc/reference/cally/cally.signals -doc/reference/cally/cally-docs.xml -doc/reference/cally/*.stamp -doc/reference/cally/*.bak gtk-doc.make install-sh libtool diff --git a/configure.ac b/configure.ac index b7f0d1c39..66f59e25a 100644 --- a/configure.ac +++ b/configure.ac @@ -1199,8 +1199,6 @@ AC_CONFIG_FILES([ doc/reference/Makefile doc/reference/clutter/Makefile doc/reference/clutter/clutter-docs.xml - doc/reference/cally/Makefile - doc/reference/cally/cally-docs.xml doc/common/Makefile doc/cookbook/Makefile doc/cookbook/clutter-cookbook.xml diff --git a/doc/reference/cally/Makefile.am b/doc/reference/cally/Makefile.am deleted file mode 100644 index 3777e84d9..000000000 --- a/doc/reference/cally/Makefile.am +++ /dev/null @@ -1,49 +0,0 @@ -DOC_MODULE = cally -DOC_MAIN_SGML_FILE =$(DOC_MODULE)-docs.xml -DOC_SOURCE_DIR = $(top_srcdir)/clutter/cally $(top_builddir)/clutter/cally - -SCANGOBJ_OPTIONS = --type-init-func="clutter_base_init()" -SCAN_OPTIONS = -MKDB_OPTIONS = --output-format=xml --name-space=cally -MKTMPL_OPTIONS = -FIXXREF_OPTIONS = \ - --extra-dir=../clutter/html \ - --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \ - --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ - --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \ - --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango \ - --extra-dir=$(COGL_PREFIX)/share/gtk-doc/html/cogl - -HFILE_GLOB = $(top_srcdir)/clutter/cally/*.h -CFILE_GLOB = $(top_srcdir)/clutter/cally/*.c - -IGNORE_HFILES = \ - cally-actor-private.h \ - cally.h - -EXTRA_HFILES = - -HTML_IMAGES= - -content_files= \ - cally-overview.xml - -expand_content_files= \ - cally-overview.xml - -AM_CPPFLAGS = \ - -I$(top_srcdir) \ - -I$(top_srcdir)/clutter \ - -I$(top_builddir) \ - -I$(top_builddir)/clutter - -AM_CFLAGS = $(CLUTTER_CFLAGS) - -GTKDOC_LIBS = $(top_builddir)/clutter/libclutter-@CLUTTER_API_VERSION@.la $(CLUTTER_LIBS) - -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.make - -# Other files to distribute -# e.g. EXTRA_DIST += version.xml.in -#EXTRA_DIST += diff --git a/doc/reference/cally/cally-docs.xml.in b/doc/reference/cally/cally-docs.xml.in deleted file mode 100644 index 65f6a878e..000000000 --- a/doc/reference/cally/cally-docs.xml.in +++ /dev/null @@ -1,145 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY version "@VERSION@"> -]> - -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> - <bookinfo> - <title>Cally Reference Manual</title> - <releaseinfo>for Clutter &version;</releaseinfo> - - <copyright> - <year>2008</year> - <year>2009</year> - <year>2010</year> - <holder>Igalia S.L.</holder> - </copyright> - - <legalnotice> - <para> - Permission is granted to copy, distribute and/or modify this - document under the terms of the <citetitle>GNU Free - Documentation License</citetitle>, Version 1.1 or any later - version published by the Free Software Foundation with no - Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the <citetitle>GNU Free - Documentation License</citetitle> from the Free Software - Foundation by visiting <ulink type="http" - url="http://www.fsf.org">their Web site</ulink> or by writing - to: - - <address> - The Free Software Foundation, Inc., - <street>59 Temple Place</street> - Suite 330, - <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>, - <country>USA</country> - </address> - </para> - </legalnotice> - </bookinfo> - - <xi:include href="xml/cally-overview.xml"/> - - <part id="callybase"> - <title>Cally Reference</title> - - <chapter> - <title>Base Classes</title> - - <xi:include href="xml/cally-actor.xml"/> - <xi:include href="xml/cally-group.xml"/> - <xi:include href="xml/cally-stage.xml"/> - <xi:include href="xml/cally-texture.xml"/> - <xi:include href="xml/cally-rectangle.xml"/> - <xi:include href="xml/cally-text.xml"/> - <xi:include href="xml/cally-clone.xml"/> - </chapter> - - <chapter> - <title>Utility API</title> - - <xi:include href="xml/cally.xml"/> - <xi:include href="xml/cally-util.xml"/> - <xi:include href="xml/cally-root.xml"/> - - </chapter> - - </part> - - <part id="callyobjects"> - <title>Cally Actors and Objects</title> - - <chapter id="callyobjecthierarchy"> - <title>Object Hierarchy</title> - - <xi:include href="xml/tree_index.sgml"><xi:fallback /></xi:include> - </chapter> - - <chapter id="callyobjectindex"> - <title>Object Index</title> - - <xi:include href="xml/object_index.sgml"><xi:fallback /></xi:include> - </chapter> - - <chapter id="callyannotationglossary"> - <title>Annotations Glossary</title> - <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> - </chapter> - </part> - - <index> - <title>Index of all symbols</title> - <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> - </index> - - <index role="deprecated"> - <title>Index of deprecated symbols</title> - <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> - </index> - - <index role="1.4"> - <title>Index of new symbols in 1.4</title> - <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include> - </index> - - <index role="1.6"> - <title>Index of new symbols in 1.6</title> - <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include> - </index> - - <appendix id="license"> - <title>License</title> - - <para> - This library is free software; you can redistribute it and/or - modify it under the terms of the <citetitle>GNU Library General - Public License</citetitle> as published by the Free Software - Foundation; either version 2 of the License, or (at your option) - any later version. - </para> - - <para> - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - <citetitle>GNU Library General Public License</citetitle> for - more details. - </para> - - <para> - You may obtain a copy of the <citetitle>GNU Library General - Public License</citetitle> from the Free Software Foundation by - visiting <ulink type="http" url="http://www.fsf.org">their Web - site</ulink> or by writing to: - - <address> - Free Software Foundation, Inc. - <street>59 Temple Place</street> - Suite 330 - <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode> - <country>USA</country> - </address> - </para> - </appendix> - -</book> diff --git a/doc/reference/cally/cally-overview.xml b/doc/reference/cally/cally-overview.xml deleted file mode 100644 index 4be86fbab..000000000 --- a/doc/reference/cally/cally-overview.xml +++ /dev/null @@ -1,74 +0,0 @@ -<part id="clutter-overview"> - <partinfo> - <author> - <firstname>Alejandro</firstname> - <surname>PiƱeiro Iglesias</surname> - <affiliation> - <address> - <email>apinheiro@igalia.com</email> - </address> - </affiliation> - </author> - </partinfo> - - <title>Overview</title> - - <partintro> - - <para>Cally (Clutter Accessibility Implementation Library) is the - Clutter implementation of the ATK interfaces. You can see as the - Clutter equivalent of GAIL, which provides accessibility support - for GTK+ and other GNOME related libraries.</para> - - <para>This implementation expose Clutter actors to accessibility - tools like Orca. This allows not only writing accessible user - interfaces, but also allows testing and verification frameworks - based on accessibility technologies to inspect and test a Clutter - scene graph.</para> - - <para>This reference manual defines the different APIs defined in - Cally. Anyway take into account that the most common use of case - Cally is transparent to the user, as the different accessibility - tools are intended to use the abstract ATK interfaces, and *not - directly* Cally, so this tools can communicate with applications - using different toolkits, like GTK+, Java, Clutter, etc. </para> - - <para>The purpose of this reference is allow to extend Cally - functionality in any Clutter-based widget toolkit. Clutter is more - low-level that other toolkits like GTK+, and some toolkits have - started to appear based on Clutter: MX, Shell Toolkit, Candies, - Glitter, etc. This means that it is really likely that these - libraries will require extra accessibility support.</para> - - <para>GAIL used a different approach, being a almost-pure-opaque - implementation of the ATK interfaces. So you can't extend it - directly. You need to use GObject and ATK mechanisms, like - run-time anonymous inheritance, to extend it. Although valid to - some custom cases, it showed to be really problematic and hacky in - wider approaches, like HAIL(Hildon Accessibility Implementation - Library). As explained, Clutter is more likely to be extended, so - these issues would arise sooner.</para> - - <para>Part of the accessibility support is implemented on Clutter, - like the initialization code, and the method to obtain the - accessibility object for each Clutter object. In the same way, to - make it easier, and to allow access to Clutter object private - data, it would be really likely that the accessibility support - would be implemented directly on some Clutter objects</para> - - <para>Check the next clutter methods for more information:</para> - <variablelist> - <varlistentry> - <term>clutter_actor_get_accessible()</term> - <listitem>Virtual method to obtain the accessibility object of a - clutter actor</listitem> - </varlistentry> - <varlistentry> - <term>clutter_get_accessibility_enabled()</term> - <listitem>Method to check if accessibility is enabled.</listitem> - </varlistentry> - </variablelist> - - </partintro> - -</part> diff --git a/doc/reference/cally/cally-sections.txt b/doc/reference/cally/cally-sections.txt deleted file mode 100644 index 53624c011..000000000 --- a/doc/reference/cally/cally-sections.txt +++ /dev/null @@ -1,176 +0,0 @@ -<SECTION> -<FILE>cally-stage</FILE> -<TITLE>CallyStage</TITLE> -CallyStage -CallyStageClass -cally_stage_new -<SUBSECTION Standard> -CALLY_STAGE -CALLY_IS_STAGE -CALLY_TYPE_STAGE -CALLY_STAGE_CLASS -CALLY_IS_STAGE_CLASS -CALLY_STAGE_GET_CLASS -<SUBSECTION Private> -CallyStagePrivate -cally_stage_get_type -</SECTION> - -<SECTION> -<FILE>cally-clone</FILE> -<TITLE>CallyClone</TITLE> -CallyClone -CallyCloneClass -cally_clone_new -<SUBSECTION Standard> -CALLY_CLONE -CALLY_IS_CLONE -CALLY_TYPE_CLONE -CALLY_CLONE_CLASS -CALLY_IS_CLONE_CLASS -CALLY_CLONE_GET_CLASS -<SUBSECTION Private> -CallyClonePrivate -cally_clone_get_type -</SECTION> - -<SECTION> -<FILE>cally-actor</FILE> -<TITLE>CallyActor</TITLE> -CallyActor -CallyActorClass -CallyActionFunc -CallyActionCallback -cally_actor_new -cally_actor_add_action -cally_actor_add_action_full -cally_actor_remove_action -cally_actor_remove_action_by_name -<SUBSECTION Standard> -CALLY_ACTOR -CALLY_IS_ACTOR -CALLY_TYPE_ACTOR -CALLY_ACTOR_CLASS -CALLY_IS_ACTOR_CLASS -CALLY_ACTOR_GET_CLASS -<SUBSECTION Private> -CallyActorPrivate -cally_actor_get_type -</SECTION> - -<SECTION> -<FILE>cally-text</FILE> -<TITLE>CallyText</TITLE> -CallyText -CallyTextClass -cally_text_new -<SUBSECTION Standard> -CALLY_TEXT -CALLY_IS_TEXT -CALLY_TYPE_TEXT -CALLY_TEXT_CLASS -CALLY_IS_TEXT_CLASS -CALLY_TEXT_GET_CLASS -<SUBSECTION Private> -CallyTextPrivate -cally_text_get_type -</SECTION> - -<SECTION> -<FILE>cally-util</FILE> -<TITLE>CallyUtil</TITLE> -CallyUtil -CallyUtilClass -<SUBSECTION Standard> -CALLY_UTIL -CALLY_IS_UTIL -CALLY_TYPE_UTIL -CALLY_UTIL_CLASS -CALLY_IS_UTIL_CLASS -CALLY_UTIL_GET_CLASS -<SUBSECTION Private> -CallyUtilPrivate -cally_util_get_type -</SECTION> - -<SECTION> -<FILE>cally-texture</FILE> -<TITLE>CallyTexture</TITLE> -CallyTexture -CallyTextureClass -cally_texture_new -<SUBSECTION Standard> -CALLY_TEXTURE -CALLY_IS_TEXTURE -CALLY_TYPE_TEXTURE -CALLY_TEXTURE_CLASS -CALLY_IS_TEXTURE_CLASS -CALLY_TEXTURE_GET_CLASS -<SUBSECTION Private> -CallyTexturePrivate -cally_texture_get_type -</SECTION> - -<SECTION> -<FILE>cally-root</FILE> -<TITLE>CallyRoot</TITLE> -CallyRoot -CallyRootClass -cally_root_new -<SUBSECTION Standard> -CALLY_ROOT -CALLY_IS_ROOT -CALLY_TYPE_ROOT -CALLY_ROOT_CLASS -CALLY_IS_ROOT_CLASS -CALLY_ROOT_GET_CLASS -<SUBSECTION Private> -CallyRootPrivate -cally_root_get_type -</SECTION> - -<SECTION> -<FILE>cally-group</FILE> -<TITLE>CallyGroup</TITLE> -CallyGroup -CallyGroupClass -cally_group_new -<SUBSECTION Standard> -CALLY_GROUP -CALLY_IS_GROUP -CALLY_TYPE_GROUP -CALLY_GROUP_CLASS -CALLY_IS_GROUP_CLASS -CALLY_GROUP_GET_CLASS -<SUBSECTION Private> -CallyGroupPrivate -cally_group_get_type -</SECTION> - -<SECTION> -<FILE>cally-rectangle</FILE> -<TITLE>CallyRectangle</TITLE> -CallyRectangle -CallyRectangleClass -cally_rectangle_new -<SUBSECTION Standard> -CALLY_RECTANGLE -CALLY_IS_RECTANGLE -CALLY_TYPE_RECTANGLE -CALLY_RECTANGLE_CLASS -CALLY_IS_RECTANGLE_CLASS -CALLY_RECTANGLE_GET_CLASS -<SUBSECTION Private> -CallyRectanglePrivate -cally_rectangle_get_type -</SECTION> - -<SECTION> -<FILE>cally</FILE> -<TITLE>General API</TITLE> -cally_get_cally_initialized -cally_accessibility_init -<SUBSECTION> -CALLY_ACCESSIBLE_FACTORY -CALLY_ACTOR_SET_FACTORY -</SECTION> diff --git a/doc/reference/cally/cally.types b/doc/reference/cally/cally.types deleted file mode 100644 index 085efc2bb..000000000 --- a/doc/reference/cally/cally.types +++ /dev/null @@ -1,9 +0,0 @@ -cally_actor_get_type -cally_clone_get_type -cally_group_get_type -cally_rectangle_get_type -cally_root_get_type -cally_stage_get_type -cally_text_get_type -cally_texture_get_type -cally_util_get_type |