src/atk/State.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * duit 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
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with duit; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = atk-AtkState.html
  26  * outPack = atk
  27  * outFile = State
  28  * strct   =
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = State
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - atk_state_
  40  * omit structs:
  41  * omit prefixes:
  42  * omit code:
  43  * imports:
  44  *      - glib.Str
  45  * structWrap:
  46  * local aliases:
  47  */
  48
  49 module atk.State;
  50
  51 private import atk.atktypes;
  52
  53 private import lib.atk;
  54
  55 private import glib.Str;
  56
  57 /**
  58  * Description
  59  * An AtkState describes a component's particular state. The actual state of
  60  * an component is described by its AtkStateSet, which is a set of AtkStates.
  61  */
  62 public class State
  63 {
  64
  65         /**
  66          */
  67
  68
  69
  70         /**
  71          * Register a new object state.
  72          * name:
  73          *  a character string describing the new state.
  74          * Returns:
  75          *  an AtkState value for the new state.
  76          */
  77         public static AtkStateType typeRegister(char[] name)
  78         {
  79                 // AtkStateType atk_state_type_register (const gchar *name);
  80                 return atk_state_type_register(Str.toStringz(name));
  81         }
  82
  83         /**
  84          * Gets the description string describing the AtkStateType type.
  85          * type:
  86          *  The AtkStateType whose name is required
  87          * Returns:
  88          *  the string describing the AtkStateType
  89          */
  90         public static char[] typeGetName(AtkStateType type)
  91         {
  92                 // const gchar* atk_state_type_get_name (AtkStateType type);
  93                 return Str.toString(atk_state_type_get_name(type) );
  94         }
  95
  96         /**
  97          * Gets the AtkStateType corresponding to the description string name.
  98          * name:
  99          *  a character string state name
 100          * Returns:
 101          *  an AtkStateType corresponding to name
 102          */
 103         public static AtkStateType typeForName(char[] name)
 104         {
 105                 // AtkStateType atk_state_type_for_name (const gchar *name);
 106                 return atk_state_type_for_name(Str.toStringz(name));
 107         }
 108 }