Typo fixes
[scilab.git] / scilab / modules / graphics / includes / Axes.h
index 296163e..1c63093 100644 (file)
+/*
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2006 - INRIA - Jean-Baptiste Silvy
+ * Copyright (C) 2010-2012 - DIGITEO - Manuel Juliachs
+ * Copyright (C) 2010-2012 - Scilab Enterprises - Bruno JOFRET
+ *
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+ *
+ */
+
 /*======================================================================================*/
-/* Copyrigth INRIA 2006                                                                 */
-/* File   : Axes.h                                                                      */
-/* Author : Jean-Baptiste Silvy INRIA                                                   */
+/* Copyright INRIA 2006                                                                 */
 /* Desc   : Various functions to manipulate SubWindow objects                           */
 /*======================================================================================*/
 
 #ifndef __SCI_AXES_H__
 #define __SCI_AXES_H__
 
-#include "ObjectStructure.h"
-
-/*--------------------------------------------------------------------------------------*/
-/* check if the graduation text foo is inside the old_rect */
-/* in this case it should not been displayed */
-BOOL CheckDisplay( double fact_h, double fact_w, char logflag, char *foo,int *posi,int *fontid,int *old_rect) ;
-
-/* The unit is the pixel */
-/* return 0 if the point is inside the rect */
-/* 1 if it is actually outside the rect */
-/* (rect[0],rect[1]) : upper left point of the bounding box  in pixel */
-/* (rect[2],rect[3]) : width and height in pixel */
-/* point[0] : x component */
-/* point[1] : y component */
-BOOL IsInsideRectangle(int * rect, int *point) ;
-
-/* get the bounding rectangle of a label of a ticks */
-/* similar to stringBoundingRect but only for ticks labels */
-void getTicksLabelBox( double   fact_h   ,
-                       double   fact_w   , 
-                       char   * label    ,
-                       int      pos[2]   ,
-                       int      fontId[2],
-                       char     logflag  ,
-                       int      bbox[4]  ,
-                       BOOL     changeFont ) ;
-
-/* remove the concealed ticks before display on the X and Y axis */
-BOOL checkXAxes2dTics( sciPointObj * psubwin  ,
-                       char          side     ,
-                       double        y        ,
-                       char        * cFormat  ,
-                       int           fontId[2],
-                       int           smallersize ) ;
-
-/* remove the concealed ticks before display on the X and Y axis */
-BOOL checkYAxes2dTics( sciPointObj * psubwin  ,
-                       char          side     ,
-                       double        x        ,
-                       char        * cFormat  ,
-                       int           fontId[2],
-                       int           smallersize ) ;
-
-
-void updateXaxesTics( sciPointObj * psubwin  ,
-                      char          side     ,
-                      double        y        ,
-                      int           fontId[2],
-                      int           smallersize ) ;
-
-void updateYaxesTics( sciPointObj * psubwin  ,
-                      char          side     ,
-                      double        x        ,
-                      int           fontId[2],
-                      int           smallersize ) ;
-
-/* remove in the ticks array the indices i such as removedTicks[i] */
-/* is true. The value nbtics is an in-out variable */
-void removeBadTicks( double * ticks, BOOL * removedTicks, int * nbTicks ) ;
+#include "dynlib_graphics.h"
+#include "BOOL.h"
 
-/* remove an element in the array from translating the next
-   elements on step backward */
-void removeIndex( double * changedArray, int size, int ind ) ;
-
-/* compute the needed formats to display the ticks of a subWin */
-void findFormat( sciPointObj * pSubWin, char formatX[5], char formatY[5] ) ;
-
-/*--------------------------------------------------------------------------------------*/
-
-/*--------------------------------------------------------------------------------------*/
-
-/* clear a subwindow from all of its children */
-void clearSubWin( sciPointObj * pSubWin ) ;
-
-/* reinit a subwindow (but don't change position) */
-void reinitSubWin( sciPointObj * pSubWin ) ;
-
-/* reinit the viewing angles of a subwindow */
-void initSubWinAngles( sciPointObj * pSubWin ) ;
-
-/* set the size and position of the subwindow to the default */
-void initSubWinSize( sciPointObj * pSubWin ) ;
-
-/* set the data_bounds of the axes to the default value */
-void initSubWinBounds( sciPointObj * pSubWin ) ;
+/*-----------------------------------------------------------------------------*/
 
 /* reinit the selected subwindow if the auto_clear property is set to on */
 /* return TRUE if the window has been redrawn */
-BOOL checkRedrawing( void ) ;
-
-/*--------------------------------------------------------------------------------------*/
-
+GRAPHICS_IMPEXP BOOL checkRedrawing(void);
+
+/**
+ * Enumeration used to specify the title place relative to parent subwindow
+ * Matches the MVC Legend object's LegendLocation enum.
+ */
+typedef enum
+{
+    /** */
+    SCI_LEGEND_POSITION_UNSPECIFIED = -1,
+    /** */
+    SCI_LEGEND_IN_UPPER_RIGHT = 0,
+    /** */
+    SCI_LEGEND_IN_UPPER_LEFT = 1,
+    /** */
+    SCI_LEGEND_IN_LOWER_RIGHT = 2,
+    /** */
+    SCI_LEGEND_IN_LOWER_LEFT = 3,
+    /** */
+    SCI_LEGEND_OUT_UPPER_RIGHT = 4,
+    /** */
+    SCI_LEGEND_OUT_UPPER_LEFT = 5,
+    /** */
+    SCI_LEGEND_OUT_LOWER_RIGHT = 6,
+    /** */
+    SCI_LEGEND_OUT_LOWER_LEFT = 7,
+    /** */
+    SCI_LEGEND_UPPER_CAPTION = 8,
+    /** */
+    SCI_LEGEND_LOWER_CAPTION = 9,
+    /** */
+    SCI_LEGEND_BY_COORDINATES = 10
+}  /** */
+sciLegendPlace;
+
+/**
+ * Convert property name into a sciLegendPlace
+ */
+GRAPHICS_IMPEXP sciLegendPlace propertyNameToLegendPlace(const char * string);
+
+/*
+ * Converts a boolean log flag to the character format
+ */
+GRAPHICS_IMPEXP char getTextLogFlag(int logFlag);
+
+/*
+ * Converts a character log flag to the equivalent boolean
+ */
+GRAPHICS_IMPEXP int getBooleanLogFlag(char logFlag);
+
+/*-----------------------------------------------------------------------------*/
 #endif /*__SCI_AXES_H_*/