Typedefs | |
| typedef _cpl_frameset_ | cpl_frameset |
| The frame set data type. More... | |
Functions | |
| cpl_frameset * | cpl_frameset_new (void) |
| Create a new, empty frame set. More... | |
| cpl_frameset * | cpl_frameset_copy (const cpl_frameset *set) |
| Create a copy of the given frame set. More... | |
| void | cpl_frameset_delete (cpl_frameset *set) |
| Destroy a frame set. More... | |
| long | cpl_frameset_get_size (const cpl_frameset *set) |
| Get the current size of a frame set. More... | |
| long | cpl_frameset_max_size (const cpl_frameset *set) |
| Get the maximum number of frame set entries possible. More... | |
| int | cpl_frameset_is_empty (const cpl_frameset *set) |
| Check whether a frame set is empty. More... | |
| long | cpl_frameset_count (const cpl_frameset *set, const char *tag) |
| Counts the frames stored in a frame set having the given tag. More... | |
| cpl_frame * | cpl_frameset_find (const cpl_frameset *set, const char *tag) |
| Find a frame with the given tag in a frame set. More... | |
| cpl_frame * | cpl_frameset_begin (const cpl_frameset *set) |
| Get the first frame in the given set. More... | |
| cpl_frame * | cpl_frameset_next (const cpl_frameset *set) |
| Get the next frame in the given set. More... | |
| int | cpl_frameset_insert (cpl_frameset *set, cpl_frame *frame) |
| Insert a frame into the given frame set. More... | |
| int | cpl_frameset_erase (cpl_frameset *set, const char *tag) |
| Erase all frames with the given tag from a frame set. More... | |
| int | cpl_frameset_erase_frame (cpl_frameset *set, cpl_frame *frame) |
| Erase the given frame from a frame set. More... | |
| cpl_frameset * | cpl_frameset_load (const char *name, cpl_frameset *set) |
| Create a new frame set from a set of frames file. More... | |
| int | cpl_frameset_save (const cpl_frameset *set, const char *name) |
| Write a frame set to a set of frames file. More... | |
#include <cpl_frameset.h>
|
|
The frame set data type.
This data type is opaque. |
|
|
Get the first frame in the given set.
NULL is returned. The function also updates the internal cache.
|
|
|
Create a copy of the given frame set.
|
|
||||||||||||
|
Counts the frames stored in a frame set having the given tag.
|
|
|
Destroy a frame set.
|
|
||||||||||||
|
Erase all frames with the given tag from a frame set.
|
|
||||||||||||
|
Erase the given frame from a frame set.
|
|
||||||||||||
|
Find a frame with the given tag in a frame set.
NULL as tag when calling this function repeatedly, since the most recent frame accessed is cached. This cache is reset whenever the provided tag is not NULL. If no frame with the tag tag is present in set or no more frames with this tag are found the function returns NULL. |
|
|
Get the current size of a frame set.
|
|
||||||||||||
|
Insert a frame into the given frame set.
|
|
|
Check whether a frame set is empty.
|
|
||||||||||||
|
Create a new frame set from a set of frames file.
NULL is passed for set, creates a new frame set from its contents, or updates set, if set points to an already existing frame set.
|
|
|
Get the maximum number of frame set entries possible.
|
|
|
Create a new, empty frame set.
|
|
|
Get the next frame in the given set.
NULL. The function uses the internal cache to determine the most recently accessed frame. This means that the function only works as expected if set has been initialised by a call to cpl_frameset_begin(), and if no function updating the internal cache was called between two subsequent calls to this function.
|
|
||||||||||||
|
Write a frame set to a set of frames file.
|
1.2.14 written by Dimitri van Heesch,
© 1997-2002