csharp/Writer.cs

   1 /*\r
   2 * Copyright 2008 ZXing authors\r
   3 *\r
   4 * Licensed under the Apache License, Version 2.0 (the "License");\r
   5 * you may not use this file except in compliance with the License.\r
   6 * You may obtain a copy of the License at\r
   7 *\r
   8 *      http://www.apache.org/licenses/LICENSE-2.0\r
   9 *\r
  10 * Unless required by applicable law or agreed to in writing, software\r
  11 * distributed under the License is distributed on an "AS IS" BASIS,\r
  12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13 * See the License for the specific language governing permissions and\r
  14 * limitations under the License.\r
  15 */\r
  16 using System;\r
  17 using ByteMatrix = com.google.zxing.common.ByteMatrix;\r
  18 namespace com.google.zxing\r
  19 {\r
  20         \r
  21         /// <summary> The base class for all objects which encode/generate a barcode image.\r
  22         /// \r
  23         /// </summary>\r
  24         /// <author>  dswitkin@google.com (Daniel Switkin)\r
  25         /// </author>\r
  26         /// <author>www.Redivivus.in (suraj.supekar@redivivus.in) - Ported from ZXING Java Source \r
  27         /// </author>\r
  28 \r
  29         public interface Writer\r
  30         {\r
  31                 \r
  32                 /// <summary> Encode a barcode using the default settings.\r
  33                 /// \r
  34                 /// </summary>\r
  35                 /// <param name="contents">The contents to encode in the barcode\r
  36                 /// </param>\r
  37                 /// <param name="format">The barcode format to generate\r
  38                 /// </param>\r
  39                 /// <param name="width">The preferred width in pixels\r
  40                 /// </param>\r
  41                 /// <param name="height">The preferred height in pixels\r
  42                 /// </param>\r
  43                 /// <returns> The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)\r
  44                 /// </returns>\r
  45                 ByteMatrix encode(System.String contents, BarcodeFormat format, int width, int height);\r
  46                 \r
  47                 /// <summary> </summary>\r
  48                 /// <param name="contents">The contents to encode in the barcode\r
  49                 /// </param>\r
  50                 /// <param name="format">The barcode format to generate\r
  51                 /// </param>\r
  52                 /// <param name="width">The preferred width in pixels\r
  53                 /// </param>\r
  54                 /// <param name="height">The preferred height in pixels\r
  55                 /// </param>\r
  56                 /// <param name="hints">Additional parameters to supply to the encoder\r
  57                 /// </param>\r
  58                 /// <returns> The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)\r
  59                 /// </returns>\r
  60                 ByteMatrix encode(System.String contents, BarcodeFormat format, int width, int height, System.Collections.Hashtable hints);\r
  61         }\r
  62 }