iufFrameList.h

Go to the documentation of this file.

#ifndef IUFLIBRARY_IUFHLFRAMELIST_H
#define IUFLIBRARY_IUFHLFRAMELIST_H

#include <iufFrame.h>

// ADT
typedef struct IufFrameList IufFrameList;
typedef IufFrameList *iufl_t;
#define  IUFL_INVALID (iufl_t) NULL

/* \brief Creates a frameList of size \p numFrames
 * \return Returns the created empty frameList of size \p numFrames or IUFL_INVALID in case of an error.
 */
iufl_t iufFrameListCreate
(
    int numFrames             
);

/* \brief Deletes a frameList without deleting the frames.
 * \return Returns #IUF_E_OK when successful or #IUF_ERR_VALUE in case of an invalid argument.
 */
int iufFrameListDelete
(
    iufl_t frameList          
);

/* \brief Deletes a frameList including its the frames.
 * \return Returns #IUF_E_OK when successful or #IUF_ERR_VALUE in case of an error.
 */
int iufFrameListDeepDelete
(
    iufl_t frameList          
);

/* \brief Compares two frameLists with each other.
 * \return Returns #IUF_TRUE when the lists are equal and #IUF_FALSE otherwise.
 */
int iufFrameListCompare
(
    iufl_t reference,          
    iufl_t actual              
);

/* \brief Gets the number of #IufFrame objects in the list.
 * \return Returns the number of frames or -1 in case of an error.
 */
int iufFrameListGetSize
(
    iufl_t frameList           
);

/* \brief Gets the #IufFrame at \p index in the list.
 * \return Returns the #IufFrame or NULL in case of an error.
 */
iufr_t iufFrameListGet
(
    iufl_t frameList,          
    int index                  
);

/* \brief Sets the #IufFrame at \p index in the list.
 * \return Returns the #IUF_E_OK in case of success and #IUF_ERR_VALUE otherwise.
 */
int iufFrameListSet
(
    iufl_t frameList,         
    iufr_t member,            
    int index                 
);

#endif //IUFLIBRARY_IUFHLFRAMELIST_H