summaryrefslogtreecommitdiffstats
path: root/iphone/doc/ZBarSymbolSet.rst
diff options
context:
space:
mode:
Diffstat (limited to 'iphone/doc/ZBarSymbolSet.rst')
-rw-r--r--iphone/doc/ZBarSymbolSet.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/iphone/doc/ZBarSymbolSet.rst b/iphone/doc/ZBarSymbolSet.rst
new file mode 100644
index 0000000..7983869
--- /dev/null
+++ b/iphone/doc/ZBarSymbolSet.rst
@@ -0,0 +1,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.