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
|
//==============================================================================
// Lynkeos
// $Id: MyImageListEnumerator.h 570 2014-02-14 23:16:15Z j-etienne $
// Created by Jean-Etienne LAMIAUD on Tue Jul 27 2004.
//------------------------------------------------------------------------------
// Copyright (c) 2003-2014. Jean-Etienne LAMIAUD
//------------------------------------------------------------------------------
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
//------------------------------------------------------------------------------
/*!
* @header
* @abstract Definitions for the image enumerator
*/
#ifndef __MYIMAGELISTENUM_H
#define __MYIMAGELISTENUM_H
#import <Foundation/Foundation.h>
#include "MyImageListItem.h"
/*!
* @class MyImageListEnumerator
* @abstract Enumerator on MyImageList
* @discussion This enumerator scans all the MyImageListItem images in a
* MyImageList. When the list contains a container, it scans each items
* inside it.
* @ingroup Models
*/
@interface MyImageListEnumerator : NSEnumerator
{
NSArray* _itemList; //!< The list of items to enumerate
MyImageListItem *_firstItem; //!< Start item (saved for reset)
NSUInteger _listSize; //!< Number of first level items
NSUInteger _itemIndex; //!< Index of current first level item
MyImageListItem* _currentContainer; //!< Container being enumerated if any
NSUInteger _containerSize; //!< Number of items in the container
NSUInteger _itemIndexInContainer;//!< Index of current item in the container
int _step; //!< Sense of enumeration (1 or -1)
BOOL _skipUnselected; //!< Do not enumerate unselected items
NSRecursiveLock *_lock; //!< Lock for multithreads access
}
/*!
* @method initWithImageList:startAt:directSense:
* @abstract Base initializer
* @discussion It initializes a MyImageListEnumerator whith a custom starting
* point and a custom scanning direction.
* @param list The MyImageListItem array to scan
* @param item The item to start with. If nil, the first or last (if reverse
* enumerator) is taken
* @param direct Direct or reverse enumerator
* @param skip Whether to skip unselected images
*/
- (id) initWithImageList :(NSArray*)list startAt:(MyImageListItem*)item
directSense:(BOOL)direct skipUnselected:(BOOL)skip;
/*!
* @method initWithImageList:
* @discussion It initializes a direct enumerator for all items starting at the
* first item of the list.
* @abstract Simplified initializer
* @param list The MyImageListItem array to scan
*/
- (id) initWithImageList :(NSArray*)list ;
/*!
* @abstract Reset the enumerator to its starting point
*/
- (void) reset;
@end
#endif
|