1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
|
/*
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2006 - INRIA - Jean-Baptiste Silvy
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
*
*/
/*------------------------------------------------------------------------*/
/* file: WindowList.h */
/* desc : routines which modify subwindows scale */
/*------------------------------------------------------------------------*/
#ifndef _WINDOW_LIST_
#define _WINDOW_LIST_
#include "dynlib_graphics.h"
#include "BOOL.h"
#include "ObjectStructure.h"
#include "DoublyLinkedList.h"
/**
* List of all scilab figure
*/
typedef DoublyLinkedList FigureList;
/**
* to know if there are some opened graphic windows
*/
GRAPHICS_IMPEXP BOOL sciHasFigures( void ) ;
/**
* retrieve the scilab window list (The_List).
*/
GRAPHICS_IMPEXP FigureList * getScilabFigureList( void ) ;
/**
* get the fist BCG in the list
*/
GRAPHICS_IMPEXP sciPointObj * getFirstFigure( void ) ;
/**
* create a new element at the end of the scilab
* window List and return it's BCG.
*/
GRAPHICS_IMPEXP void addNewFigureToList(sciPointObj * figure);
/**
* remove a figure from the list.
* @return 0 if the item was removed successfully
* -1 if the item has not been find.
*/
GRAPHICS_IMPEXP void removeFigureFromList(sciPointObj * figure);
/**
* returns the graphic context of window i
* or NULL if this window does not exists
*/
GRAPHICS_IMPEXP sciPointObj * getFigureFromIndex(int figNum) ;
/**
* @return TRUE if the figure with index id exists
*/
GRAPHICS_IMPEXP BOOL sciIsExistingFigure(int figNum);
/**
* @return number of opened windows in Scilab.
*/
GRAPHICS_IMPEXP int sciGetNbFigure(void);
/**
* Fill the array Ids with all the figure ids currently used by Scilab.
* @param ids should be as long as there are figures.
*/
GRAPHICS_IMPEXP void sciGetFiguresId(int ids[]);
/**
* get the highest Id of Scilab figures.
* or -1 if no windows
*/
GRAPHICS_IMPEXP int sciGetFiguresMaxId( void ) ;
/**
* @return an unused index by graphic figures. Used when creating a new window.
*/
GRAPHICS_IMPEXP int getUnusedFigureIndex(void);
#endif /* _WINDOW_LIST */
|