atk/atkversion.c

   1 /* ATK -  Accessibility Toolkit
   2  *
   3  * Copyright (C) 2012 Igalia, S.L.
   4  *
   5  * Author: Alejandro Piñeiro Iglesias <apinheiro@igalia.com>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #include "atk.h"
  24
  25 /**
  26  * SECTION:atkversion
  27  * @Short_description: Variables and functions to check the ATK version
  28  * @Title: Versioning macros
  29  *
  30  * ATK provides a set of macros and methods for checking the version
  31  * of the library at compile and run time.
  32  */
  33
  34 /**
  35  * atk_get_major_version:
  36  *
  37  * Returns the major version number of the ATK library.  (e.g. in ATK
  38  * version 2.7.4 this is 2.)
  39  *
  40  * This function is in the library, so it represents the ATK library
  41  * your code is running against. In contrast, the #ATK_MAJOR_VERSION
  42  * macro represents the major version of the ATK headers you have
  43  * included when compiling your code.
  44  *
  45  * Returns: the major version number of the ATK library
  46  *
  47  * Since: 2.8
  48  */
  49 guint
  50 atk_get_major_version (void)
  51 {
  52   return ATK_MAJOR_VERSION;
  53 }
  54
  55 /**
  56  * atk_get_minor_version:
  57  *
  58  * Returns the minor version number of the ATK library.  (e.g. in ATK
  59  * version 2.7.4 this is 7.)
  60  *
  61  * This function is in the library, so it represents the ATK library
  62  * your code is are running against. In contrast, the
  63  * #ATK_MINOR_VERSION macro represents the minor version of the ATK
  64  * headers you have included when compiling your code.
  65  *
  66  * Returns: the minor version number of the ATK library
  67  *
  68  * Since: 2.8
  69  */
  70 guint
  71 atk_get_minor_version (void)
  72 {
  73   return ATK_MINOR_VERSION;
  74 }
  75
  76 /**
  77  * atk_get_micro_version:
  78  *
  79  * Returns the micro version number of the ATK library.  (e.g. in ATK
  80  * version 2.7.4 this is 4.)
  81  *
  82  * This function is in the library, so it represents the ATK library
  83  * your code is are running against. In contrast, the
  84  * #ATK_MICRO_VERSION macro represents the micro version of the ATK
  85  * headers you have included when compiling your code.
  86  *
  87  * Returns: the micro version number of the ATK library
  88  *
  89  * Since: 2.8
  90  */
  91 guint
  92 atk_get_micro_version (void)
  93 {
  94   return ATK_MICRO_VERSION;
  95 }
  96
  97 /**
  98  * atk_get_binary_age:
  99  *
 100  * Returns the binary age as passed to libtool when building the ATK
 101  * library the process is running against.
 102  *
 103  * Returns: the binary age of the ATK library
 104  *
 105  * Since: 2.8
 106  */
 107 guint
 108 atk_get_binary_age (void)
 109 {
 110   return ATK_BINARY_AGE;
 111 }
 112
 113 /**
 114  * atk_get_interface_age:
 115  *
 116  * Returns the interface age as passed to libtool when building the
 117  * ATK library the process is running against.
 118  *
 119  * Returns: the interface age of the ATK library
 120  *
 121  * Since: 2.8
 122  */
 123 guint
 124 atk_get_interface_age (void)
 125 {
 126   return ATK_INTERFACE_AGE;
 127 }