diff options
author | Alejandro Piñeiro <apinheiro@igalia.com> | 2012-12-20 20:34:25 +0100 |
---|---|---|
committer | Alejandro Piñeiro <apinheiro@igalia.com> | 2012-12-21 12:46:03 +0100 |
commit | 8e6a0349f7e2b63f2c82ebbb26d38394cae67eae (patch) | |
tree | 18ead924ebb3a8aec4f82413cada499c21d04d4a | |
parent | 349c3b0d84584c3c91501bb5daaf2ee65a3f74aa (diff) | |
download | atk-8e6a0349f7e2b63f2c82ebbb26d38394cae67eae.tar.gz |
AtkWindow documentation
https://bugzilla.gnome.org/show_bug.cgi?id=656750
-rw-r--r-- | atk/atkwindow.c | 93 | ||||
-rw-r--r-- | docs/atk-docs.sgml | 2 | ||||
-rw-r--r-- | docs/atk-sections.txt | 15 | ||||
-rw-r--r-- | docs/atk.types | 1 |
4 files changed, 111 insertions, 0 deletions
diff --git a/atk/atkwindow.c b/atk/atkwindow.c index 60f2e8c..16366fa 100644 --- a/atk/atkwindow.c +++ b/atk/atkwindow.c @@ -20,6 +20,18 @@ #include "atkwindow.h" #include "atkmarshal.h" +/** + * SECTION:atkwindow + * @Short_description: The ATK Interface provided by UI components that represent a top-level window. + * @Title: AtkWindow + * @See_also: #AtkObject + * + * #AtkWindow should be implemented by the UI elements that represent + * a top-level window, such as the main window of an application or + * dialog. + * + */ + enum { ACTIVATE, CREATE, @@ -58,14 +70,95 @@ atk_window_default_init (AtkWindowIface *iface) if (!initialized) { + /** + * AtkWindow::activate: + * @object: the object which received the signal + * + * The signal #AtkWindow::activate is emitted when a window + * becomes the active window of the application or session. + * + * Since: 2.1.5 + */ atk_window_signals[ACTIVATE] = atk_window_add_signal ("activate"); + /** + * AtkWindow::create: + * @object: the object which received the signal + * + * The signal #AtkWindow::create is emitted when a new window + * is created. + * + * Since: 2.1.5 + */ atk_window_signals[CREATE] = atk_window_add_signal ("create"); + /** + * AtkWindow::deactivate: + * @object: the object which received the signal + * + * The signal #AtkWindow::deactivate is emitted when a window is + * no longer the active window of the application or session. + * + * Since: 2.1.5 + */ atk_window_signals[DEACTIVATE] = atk_window_add_signal ("deactivate"); + /** + * AtkWindow::destroy: + * @object: the object which received the signal + * + * The signal #AtkWindow::destroy is emitted when a window is + * destroyed. + * + * Since: 2.1.5 + */ atk_window_signals[DESTROY] = atk_window_add_signal ("destroy"); + /** + * AtkWindow::maximize: + * @object: the object which received the signal + * + * The signal #AtkWindow::maximize is emitted when a window + * is maximized. + * + * Since: 2.1.5 + */ atk_window_signals[MAXIMIZE] = atk_window_add_signal ("maximize"); + /** + * AtkWindow::minimize: + * @object: the object which received the signal + * + * The signal #AtkWindow::minimize is emitted when a window + * is minimized. + * + * Since: 2.1.5 + */ atk_window_signals[MINIMIZE] = atk_window_add_signal ("minimize"); + /** + * AtkWindow::move: + * @object: the object which received the signal + * + * The signal #AtkWindow::move is emitted when a window + * is moved. + * + * Since: 2.1.5 + */ atk_window_signals[MOVE] = atk_window_add_signal ("move"); + /** + * AtkWindow::resize: + * @object: the object which received the signal + * + * The signal #AtkWindow::resize is emitted when a window + * is resized. + * + * Since: 2.1.5 + */ atk_window_signals[RESIZE] = atk_window_add_signal ("resize"); + /** + * AtkWindow::restore: + * @object: the object which received the signal + * + * The signal #AtkWindow::restore is emitted when a window + * is restored. + * + * Since: 2.1.5 + */ atk_window_signals[RESTORE] = atk_window_add_signal ("restore"); initialized = TRUE; diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml index 1aad45c..71f0987 100644 --- a/docs/atk-docs.sgml +++ b/docs/atk-docs.sgml @@ -27,6 +27,7 @@ <!ENTITY atk-AtkText SYSTEM "xml/atktext.xml"> <!ENTITY atk-AtkUtil SYSTEM "xml/atkutil.xml"> <!ENTITY atk-AtkValue SYSTEM "xml/atkvalue.xml"> + <!ENTITY atk-AtkWindow SYSTEM "xml/atkwindow.xml"> <!ENTITY version SYSTEM "version.xml"> ]> @@ -65,6 +66,7 @@ &atk-AtkText; &atk-AtkUtil; &atk-AtkValue; + &atk-AtkWindow; </chapter> <index id="api-index-full"> diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt index a2b2ced..79f58b6 100644 --- a/docs/atk-sections.txt +++ b/docs/atk-sections.txt @@ -639,3 +639,18 @@ ATK_TYPE_SOCKET AtkSocketClass atk_socket_get_type </SECTION> + +<SECTION> +<FILE>atkwindow</FILE> +<TITLE>AtkWindow</TITLE> +AtkWindow +<SUBSECTION Standard> +ATK_IS_WINDOW +ATK_IS_WINDOW_CLASS +ATK_WINDOW +ATK_WINDOW_CLASS +ATK_WINDOW_GET_CLASS +ATK_TYPE_WINDOW +AtkWindowClass +atk_window_get_type +</SECTION> diff --git a/docs/atk.types b/docs/atk.types index a219397..ceb2f82 100644 --- a/docs/atk.types +++ b/docs/atk.types @@ -23,3 +23,4 @@ atk_table_get_type atk_text_get_type atk_util_get_type atk_value_get_type +atk_window_get_type
\ No newline at end of file |