Try adding current javadoc to SVN
[zxing.git] / docs / javadoc / com / google / zxing / client / android / Intents.Scan.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.6.0_13) on Fri Jun 26 13:12:27 EDT 2009 -->
6 <TITLE>
7 Intents.Scan
8 </TITLE>
9
10 <META NAME="date" CONTENT="2009-06-26">
11
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14 <SCRIPT type="text/javascript">
15 function windowTitle()
16 {
17     if (location.href.indexOf('is-external=true') == -1) {
18         parent.document.title="Intents.Scan";
19     }
20 }
21 </SCRIPT>
22 <NOSCRIPT>
23 </NOSCRIPT>
24
25 </HEAD>
26
27 <BODY BGCOLOR="white" onload="windowTitle();">
28 <HR>
29
30
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <A NAME="navbar_top"><!-- --></A>
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35 <TR>
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37 <A NAME="navbar_top_firstrow"><!-- --></A>
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39   <TR ALIGN="center" VALIGN="top">
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47   </TR>
48 </TABLE>
49 </TD>
50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51 </EM>
52 </TD>
53 </TR>
54
55 <TR>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 &nbsp;<A HREF="../../../../../com/google/zxing/client/android/Intents.Encode.html" title="class in com.google.zxing.client.android"><B>PREV CLASS</B></A>&nbsp;
58 &nbsp;<A HREF="../../../../../com/google/zxing/client/android/Intents.SearchBookContents.html" title="class in com.google.zxing.client.android"><B>NEXT CLASS</B></A></FONT></TD>
59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60   <A HREF="../../../../../index.html?com/google/zxing/client/android/Intents.Scan.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61 &nbsp;<A HREF="Intents.Scan.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62 &nbsp;<SCRIPT type="text/javascript">
63   <!--
64   if(window==top) {
65     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66   }
67   //-->
68 </SCRIPT>
69 <NOSCRIPT>
70   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
71 </NOSCRIPT>
72
73
74 </FONT></TD>
75 </TR>
76 <TR>
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
81 </TR>
82 </TABLE>
83 <A NAME="skip-navbar_top"></A>
84 <!-- ========= END OF TOP NAVBAR ========= -->
85
86 <HR>
87 <!-- ======== START OF CLASS DATA ======== -->
88 <H2>
89 <FONT SIZE="-1">
90 com.google.zxing.client.android</FONT>
91 <BR>
92 Class Intents.Scan</H2>
93 <PRE>
94 java.lang.Object
95   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.client.android.Intents.Scan</B>
96 </PRE>
97 <DL>
98 <DT><B>Enclosing class:</B><DD><A HREF="../../../../../com/google/zxing/client/android/Intents.html" title="class in com.google.zxing.client.android">Intents</A></DD>
99 </DL>
100 <HR>
101 <DL>
102 <DT><PRE>public static final class <B>Intents.Scan</B><DT>extends java.lang.Object</DL>
103 </PRE>
104
105 <P>
106 <HR>
107
108 <P>
109 <!-- =========== FIELD SUMMARY =========== -->
110
111 <A NAME="field_summary"><!-- --></A>
112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
115 <B>Field Summary</B></FONT></TH>
116 </TR>
117 <TR BGCOLOR="white" CLASS="TableRowColor">
118 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
120 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#ACTION">ACTION</A></B></CODE>
121
122 <BR>
123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send this intent to open the Barcodes app in scanning mode, find a barcode, and return
124  the results.</TD>
125 </TR>
126 <TR BGCOLOR="white" CLASS="TableRowColor">
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
129 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#DEPRECATED_ACTION">DEPRECATED_ACTION</A></B></CODE>
130
131 <BR>
132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
133 </TR>
134 <TR BGCOLOR="white" CLASS="TableRowColor">
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
137 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#MODE">MODE</A></B></CODE>
138
139 <BR>
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;By default, sending Scan.ACTION will decode all barcodes that we understand.</TD>
141 </TR>
142 <TR BGCOLOR="white" CLASS="TableRowColor">
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
145 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#ONE_D_MODE">ONE_D_MODE</A></B></CODE>
146
147 <BR>
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode only 1D barcodes (currently UPC, EAN, Code 39, and Code 128).</TD>
149 </TR>
150 <TR BGCOLOR="white" CLASS="TableRowColor">
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
153 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#PRODUCT_MODE">PRODUCT_MODE</A></B></CODE>
154
155 <BR>
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode only UPC and EAN barcodes.</TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
161 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#QR_CODE_MODE">QR_CODE_MODE</A></B></CODE>
162
163 <BR>
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode only QR codes.</TD>
165 </TR>
166 <TR BGCOLOR="white" CLASS="TableRowColor">
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
169 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#RESULT">RESULT</A></B></CODE>
170
171 <BR>
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If a barcode is found, Barcodes returns RESULT_OK to onActivityResult() of the app which
173  requested the scan via startSubActivity().</TD>
174 </TR>
175 <TR BGCOLOR="white" CLASS="TableRowColor">
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
178 <TD><CODE><B><A HREF="../../../../../com/google/zxing/client/android/Intents.Scan.html#RESULT_FORMAT">RESULT_FORMAT</A></B></CODE>
179
180 <BR>
181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Call intent.getStringExtra(RESULT_FORMAT) to determine which barcode format was found.</TD>
182 </TR>
183 </TABLE>
184 &nbsp;
185 <!-- ========== METHOD SUMMARY =========== -->
186
187 <A NAME="method_summary"><!-- --></A>
188 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
189 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
190 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
191 <B>Method Summary</B></FONT></TH>
192 </TR>
193 </TABLE>
194 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
195 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
197 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
198 </TR>
199 <TR BGCOLOR="white" CLASS="TableRowColor">
200 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
201 </TR>
202 </TABLE>
203 &nbsp;
204 <P>
205
206 <!-- ============ FIELD DETAIL =========== -->
207
208 <A NAME="field_detail"><!-- --></A>
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
211 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
212 <B>Field Detail</B></FONT></TH>
213 </TR>
214 </TABLE>
215
216 <A NAME="ACTION"><!-- --></A><H3>
217 ACTION</H3>
218 <PRE>
219 public static final java.lang.String <B>ACTION</B></PRE>
220 <DL>
221 <DD>Send this intent to open the Barcodes app in scanning mode, find a barcode, and return
222  the results.
223 <P>
224 <DL>
225 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.ACTION">Constant Field Values</A></DL>
226 </DL>
227 <HR>
228
229 <A NAME="DEPRECATED_ACTION"><!-- --></A><H3>
230 DEPRECATED_ACTION</H3>
231 <PRE>
232 public static final java.lang.String <B>DEPRECATED_ACTION</B></PRE>
233 <DL>
234 <DL>
235 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.DEPRECATED_ACTION">Constant Field Values</A></DL>
236 </DL>
237 <HR>
238
239 <A NAME="MODE"><!-- --></A><H3>
240 MODE</H3>
241 <PRE>
242 public static final java.lang.String <B>MODE</B></PRE>
243 <DL>
244 <DD>By default, sending Scan.ACTION will decode all barcodes that we understand. However it
245  may be useful to limit scanning to certain formats. Use Intent.putExtra(MODE, value) with
246  one of the values below (optional).
247 <P>
248 <DL>
249 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.MODE">Constant Field Values</A></DL>
250 </DL>
251 <HR>
252
253 <A NAME="PRODUCT_MODE"><!-- --></A><H3>
254 PRODUCT_MODE</H3>
255 <PRE>
256 public static final java.lang.String <B>PRODUCT_MODE</B></PRE>
257 <DL>
258 <DD>Decode only UPC and EAN barcodes. This is the right choice for shopping apps which get
259  prices, reviews, etc. for products.
260 <P>
261 <DL>
262 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.PRODUCT_MODE">Constant Field Values</A></DL>
263 </DL>
264 <HR>
265
266 <A NAME="ONE_D_MODE"><!-- --></A><H3>
267 ONE_D_MODE</H3>
268 <PRE>
269 public static final java.lang.String <B>ONE_D_MODE</B></PRE>
270 <DL>
271 <DD>Decode only 1D barcodes (currently UPC, EAN, Code 39, and Code 128).
272 <P>
273 <DL>
274 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.ONE_D_MODE">Constant Field Values</A></DL>
275 </DL>
276 <HR>
277
278 <A NAME="QR_CODE_MODE"><!-- --></A><H3>
279 QR_CODE_MODE</H3>
280 <PRE>
281 public static final java.lang.String <B>QR_CODE_MODE</B></PRE>
282 <DL>
283 <DD>Decode only QR codes.
284 <P>
285 <DL>
286 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.QR_CODE_MODE">Constant Field Values</A></DL>
287 </DL>
288 <HR>
289
290 <A NAME="RESULT"><!-- --></A><H3>
291 RESULT</H3>
292 <PRE>
293 public static final java.lang.String <B>RESULT</B></PRE>
294 <DL>
295 <DD>If a barcode is found, Barcodes returns RESULT_OK to onActivityResult() of the app which
296  requested the scan via startSubActivity(). The barcodes contents can be retrieved with
297  intent.getStringExtra(RESULT). If the user presses Back, the result code will be
298  RESULT_CANCELED.
299 <P>
300 <DL>
301 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.RESULT">Constant Field Values</A></DL>
302 </DL>
303 <HR>
304
305 <A NAME="RESULT_FORMAT"><!-- --></A><H3>
306 RESULT_FORMAT</H3>
307 <PRE>
308 public static final java.lang.String <B>RESULT_FORMAT</B></PRE>
309 <DL>
310 <DD>Call intent.getStringExtra(RESULT_FORMAT) to determine which barcode format was found.
311  See Contents.Format for possible values.
312 <P>
313 <DL>
314 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.zxing.client.android.Intents.Scan.RESULT_FORMAT">Constant Field Values</A></DL>
315 </DL>
316 <!-- ========= END OF CLASS DATA ========= -->
317 <HR>
318
319
320 <!-- ======= START OF BOTTOM NAVBAR ====== -->
321 <A NAME="navbar_bottom"><!-- --></A>
322 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
323 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
324 <TR>
325 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
326 <A NAME="navbar_bottom_firstrow"><!-- --></A>
327 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
328   <TR ALIGN="center" VALIGN="top">
329   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
330   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
331   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
332   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
333   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
334   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
335   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
336   </TR>
337 </TABLE>
338 </TD>
339 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
340 <script type="text/javascript"> var gaJsHost = (("https:" == document.location.protocol) ?  "https://ssl." : "http://www."); document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var pageTracker = _gat._getTracker("UA-788492-5"); pageTracker._initData(); pageTracker._trackPageview(); </script></EM>
341 </TD>
342 </TR>
343
344 <TR>
345 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
346 &nbsp;<A HREF="../../../../../com/google/zxing/client/android/Intents.Encode.html" title="class in com.google.zxing.client.android"><B>PREV CLASS</B></A>&nbsp;
347 &nbsp;<A HREF="../../../../../com/google/zxing/client/android/Intents.SearchBookContents.html" title="class in com.google.zxing.client.android"><B>NEXT CLASS</B></A></FONT></TD>
348 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
349   <A HREF="../../../../../index.html?com/google/zxing/client/android/Intents.Scan.html" target="_top"><B>FRAMES</B></A>  &nbsp;
350 &nbsp;<A HREF="Intents.Scan.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
351 &nbsp;<SCRIPT type="text/javascript">
352   <!--
353   if(window==top) {
354     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
355   }
356   //-->
357 </SCRIPT>
358 <NOSCRIPT>
359   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
360 </NOSCRIPT>
361
362
363 </FONT></TD>
364 </TR>
365 <TR>
366 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
367   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
368 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
369 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
370 </TR>
371 </TABLE>
372 <A NAME="skip-navbar_bottom"></A>
373 <!-- ======== END OF BOTTOM NAVBAR ======= -->
374
375 <HR>
376
377 </BODY>
378 </HTML>