e9b0741187e417c40b1e69df11e80450096ed4e5
[scilab.git] / scilab / modules / graphics / includes / Axes.h
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2006 - INRIA - Jean-Baptiste Silvy
4  * Copyright (C) 2010-2012 - DIGITEO - Manuel Juliachs
5  * Copyright (C) 2010-2012 - Scilab Enterprises - Bruno JOFRET
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  */
17
18 /*======================================================================================*/
19 /* Copyrigth INRIA 2006                                                                 */
20 /* Desc   : Various functions to manipulate SubWindow objects                           */
21 /*======================================================================================*/
22
23 #ifndef __SCI_AXES_H__
24 #define __SCI_AXES_H__
25
26 #include "dynlib_graphics.h"
27 #include "BOOL.h"
28
29 /*-----------------------------------------------------------------------------*/
30
31 /* reinit the selected subwindow if the auto_clear property is set to on */
32 /* return TRUE if the window has been redrawn */
33 GRAPHICS_IMPEXP BOOL checkRedrawing(void);
34
35 /**
36  * Enumeration used to specify the title place relative to parent subwindow
37  * Matches the MVC Legend object's LegendLocation enum.
38  */
39 typedef enum
40 {
41     /** */
42     SCI_LEGEND_POSITION_UNSPECIFIED = -1,
43     /** */
44     SCI_LEGEND_IN_UPPER_RIGHT = 0,
45     /** */
46     SCI_LEGEND_IN_UPPER_LEFT = 1,
47     /** */
48     SCI_LEGEND_IN_LOWER_RIGHT = 2,
49     /** */
50     SCI_LEGEND_IN_LOWER_LEFT = 3,
51     /** */
52     SCI_LEGEND_OUT_UPPER_RIGHT = 4,
53     /** */
54     SCI_LEGEND_OUT_UPPER_LEFT = 5,
55     /** */
56     SCI_LEGEND_OUT_LOWER_RIGHT = 6,
57     /** */
58     SCI_LEGEND_OUT_LOWER_LEFT = 7,
59     /** */
60     SCI_LEGEND_UPPER_CAPTION = 8,
61     /** */
62     SCI_LEGEND_LOWER_CAPTION = 9,
63     /** */
64     SCI_LEGEND_BY_COORDINATES = 10
65 }  /** */
66 sciLegendPlace;
67
68 /**
69  * Convert property name into a sciLegendPlace
70  */
71 GRAPHICS_IMPEXP sciLegendPlace propertyNameToLegendPlace(const char * string);
72
73 /*
74  * Converts a boolean log flag to the character format
75  */
76 GRAPHICS_IMPEXP char getTextLogFlag(int logFlag);
77
78 /*
79  * Converts a character log flag to the equivalent boolean
80  */
81 GRAPHICS_IMPEXP int getBooleanLogFlag(char logFlag);
82
83 /*-----------------------------------------------------------------------------*/
84 #endif /*__SCI_AXES_H_*/