adg/adg-enums.c

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009 Nicola Fontana <ntd at entidi.it>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 /**
  22  * SECTION:adg-enums
  23  * @Section_Id:enumerations
  24  * @title: Standard enumerations
  25  * @short_description: Public enumerated types used throughout ADG
  26  *
  27  * All the enumerations are available in GType notation, and so are
  28  * the standard type macros.
  29  **/
  30
  31
  32 /**
  33  * AdgThreeState:
  34  * @ADG_THREE_STATE_OFF: disabled, switched off, disactive
  35  * @ADG_THREE_STATE_ON: enabled, switched on, active
  36  * @ADG_THREE_STATE_UNKNOWN: unknown / indefinite / automatic state
  37  *
  38  * A generic three state flags to be used whenever needed. Could be
  39  * user when a boolean is requested but also an indefinite / default
  40  * state should be caught.
  41  **/
  42
  43 /**
  44  * AdgTransformationMode:
  45  * @ADG_TRANSFORM_NONE: do not apply any transformation
  46  * @ADG_TRANSFORM_BEFORE: apply the transformation before the matrix using
  47  *                        cairo_matrix_multiply(matrix, matrix, transformation)
  48  * @ADG_TRANSFORM_AFTER: apply the transformation after the matrix using
  49  *                       cairo_matrix_multiply(matrix, transformation, matrix)
  50  * @ADG_TRANSFORM_BEFORE_NORMALIZED: same as %ADG_TRANSFORM_BEFORE but
  51  *                                   normalizing the transformation with
  52  *                                   adg_matrix_normalize() before applying it
  53  * @ADG_TRANSFORM_AFTER_NORMALIZED: same as %ADG_TRANSFORM_AFTER but
  54  *                                  normalizing the transformation with
  55  *                                  adg_matrix_normalize() before applying it
  56  *
  57  * Specifies the mode a generic transformation should be applied on
  58  * a subject matrix. Although used in different places, the function
  59  * performing the dirty work is always adg_matrix_transform().
  60  **/