summaryrefslogtreecommitdiffstats
path: root/iphone/doc/ZBarSymbolSet.rst
blob: 7983869f39398106a6059e638160106b84c9d2cc (plain)
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
ZBarSymbolSet Class Reference
=============================

.. class:: ZBarSymbolSet

   :Inherits from: :class:`NSObject`
   :Conforms to: :class:`NSFastEnumeration`

   A symbol set is a simple container for the symbols scanned from an image.
   It supports :class:`NSFastEnumeration`, and not much else...  Use it to
   iterate through the :class:`ZBarSymbol` objects in a decode result set::

      ZBarSymbolSet *symbols = image.symbols;
      for(ZBarSymbol *symbol in symbols) {
          // process result
      }

   This class is a simple wrapper around a :type:`zbar_symbol_set_t` C object
   (q.v.)


Properties
----------

   .. member:: int count

      The number of symbols in the set. (read-only)

   .. member:: const zbar_symbol_set_t *zbarSymbolSet

      Retrieve the underlying C object instance. (read-only)


Instance Methods
----------------

   .. _`initWithSymbolSet:`:
   .. describe:: - (id) initWithSymbolSet:(const zbar_symbol_set_t*)set

      Initialize a symbol set wrapper, given the C object to wrap.

      :set: The C object to wrap.
      :Returns: The initialized symbol set, or nil if an error occurred.