Update Matplot doc to take into account image_type property
[scilab.git] / scilab / modules / graphics / src / c / getHandleProperty / get_image_type_property.c
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2013 - Scilab Enterprises - Calixte DENIZET
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10  *
11  */
12
13 /*------------------------------------------------------------------------*/
14 /* file: get_image_type_property.c                                         */
15 /* desc : function to get in Scilab the image_type field of             */
16 /*        a matplot handle                                                        */
17 /*------------------------------------------------------------------------*/
18
19 #include "setHandleProperty.h"
20 #include "SetProperty.h"
21 #include "getPropertyAssignedValue.h"
22 #include "Scierror.h"
23 #include "localization.h"
24 #include "SetPropertyStatus.h"
25
26 #include "getGraphicObjectProperty.h"
27 #include "graphicObjectProperties.h"
28
29 #include "Matplot.h"
30
31 /*------------------------------------------------------------------------*/
32 int get_image_type_property(void* _pvCtx, char* pobjUID)
33 {
34     int imagetype = 0;
35     int * piImagetype = &imagetype;
36     ImageType itype;
37
38     getGraphicObjectProperty(pobjUID, __GO_DATA_MODEL_MATPLOT_IMAGE_TYPE__, jni_int, (void **)&piImagetype);
39     if (piImagetype == NULL)
40     {
41         Scierror(999, _("'%s' property does not exist for this handle.\n"), "image_type");
42         return -1;
43     }
44
45     itype = (ImageType)imagetype;
46
47     switch (itype)
48     {
49         case MATPLOT_RGB :
50             return sciReturnString(_pvCtx, "rgb");
51         case MATPLOT_RGBA :
52             return sciReturnString(_pvCtx, "rgba");
53         case MATPLOT_GRAY :
54             return sciReturnString(_pvCtx, "gray");
55         case MATPLOT_INDEX :
56             return sciReturnString(_pvCtx, "index");
57         case MATPLOT_RED :
58             return sciReturnString(_pvCtx, "red");
59         case MATPLOT_GREEN :
60             return sciReturnString(_pvCtx, "green");
61         case MATPLOT_BLUE :
62             return sciReturnString(_pvCtx, "blue");
63         case MATPLOT_RGB_332 :
64             return sciReturnString(_pvCtx, "rgb332");
65         case MATPLOT_RGB_444 :
66             return sciReturnString(_pvCtx, "rgb444");
67         case MATPLOT_RGBA_4444 :
68             return sciReturnString(_pvCtx, "rgba444");
69         case MATPLOT_RGB_555 :
70             return sciReturnString(_pvCtx, "rgb555");
71         case MATPLOT_RGBA_5551 :
72             return sciReturnString(_pvCtx, "rgba5551");
73         default :
74             Scierror(999, _("Wrong value for '%s' property.\n"), "image_type");
75             return -1;
76     }
77 }
78 /*------------------------------------------------------------------------*/