src/cairoLib/Status.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  = cairo-Error-handling.html
  26  * outPack = cairoLib
  27  * outFile = Status
  28  * strct   = cairo_status_t
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = Status
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - cairo_status_t
  40  * omit structs:
  41  * omit prefixes:
  42  * omit code:
  43  * imports:
  44  *      - glib.Str
  45  * structWrap:
  46  * local aliases:
  47  */
  48
  49 module cairoLib.Status;
  50
  51 private import cairoLib.cairoLibtypes;
  52
  53 private import lib.cairoLib;
  54
  55 private import glib.Str;
  56
  57 /**
  58  * Description
  59  */
  60 public class Status
  61 {
  62
  63         /** the main Gtk struct */
  64         protected cairo_status_t* cairo_status;
  65
  66
  67         public cairo_status_t* getStatusStruct()
  68         {
  69                 return cairo_status;
  70         }
  71
  72
  73         /** the main Gtk struct as a void* */
  74         protected void* getStruct()
  75         {
  76                 return cast(void*)cairo_status;
  77         }
  78
  79         /**
  80          * Sets our main struct and passes it to the parent class
  81          */
  82         public this (cairo_status_t* cairo_status)
  83         {
  84                 this.cairo_status = cairo_status;
  85         }
  86
  87         /**
  88          */
  89
  90
  91         /**
  92          * Provides a human-readable description of a cairo_status_t.
  93          * status:
  94          *  a cairo status
  95          * Returns:
  96          * a string representation of the status
  97          */
  98         public static char[] oString(cairo_status_t status)
  99         {
 100                 // const char* cairo_status_to_string (cairo_status_t status);
 101                 return Str.toString(cairo_status_to_string(status) );
 102         }
 103
 104         /**
 105          * Resets all static data within cairo to its original state,
 106          * (ie. identical to the state at the time of program invocation). For
 107          * example, all caches within cairo will be flushed empty.
 108          * This function is intended to be useful when using memory-checking
 109          * tools such as valgrind. When valgrind's memcheck analyzes a
 110          * cairo-using program without a call to cairo_debug_reset_static_data,
 111          * it will report all data reachable via cairo's static objects as
 112          * "still reachable". Calling cairo_debug_reset_static_data just prior
 113          * to program termination will make it easier to get squeaky clean
 114          * reports from valgrind.
 115          * WARNING: It is only safe to call this function when there are no
 116          * active cairo objects remaining, (ie. the appropriate destroy
 117          * functions have been called as necessary). If there are active cairo
 118          * objects, this call is likely to cause a crash, (eg. an assertion
 119          * failure due to a hash table being destroyed when non-empty).
 120          */
 121         public static void cairoDebugResetStaticData()
 122         {
 123                 // void cairo_debug_reset_static_data (void);
 124                 cairo_debug_reset_static_data();
 125         }
 126 }