home *** CD-ROM | disk | FTP | other *** search
/ PC Pro 2005 June (DVD) / DPPRO0605DVD.iso / Install / System32 / VCLJPG90.XML < prev    next >
Encoding:
Extensible Markup Language  |  2004-10-22  |  21.7 KB  |  236 lines
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <doc>
  3.    <assembly>vcljpg</assembly>
  4.    <members>
  5.       <member name="T:jpeg.TJPEGData">
  6.          <summary>
  7.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  8.                
  9.                <class namespace="jpeg">TJPEGData</class> encapsulates the compressed file that contains the data source for the original compressed jpeg image used by a TJPEGImage object.</para>
  10.          </summary>
  11.          <comments>
  12.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  13.                
  14.                <class namespace="jpeg">TJPEGData</class> is used for the internal implementation of TJPEGImage. <class namespace="jpeg">TJPEGData</class> is created automatically by the TJPEGImage object when that image object is created.</para>
  15.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  16.                
  17.                <class namespace="jpeg">TJPEGData</class> owns the file handle to the jpeg data source. Thus, <class namespace="jpeg">TJPEGData</class> implements how TJPEGImage does reference counting and handle sharing. When a jpeg image object is copied using the Assign method, those multiple instances of the image object refer to the same <class namespace="jpeg">TJPEGData</class> object.</para>
  18.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <class namespace="jpeg">TJPEGData</class> file itself is never modified. Each TJPEGImage instance that shares it has its own properties that determine how this data is decompressed into its own internal, local bitmap representation. However, if a TJPEGImage needs to modify the actual jpeg data, it breaks its link to that particular <class namespace="jpeg">TJPEGData</class> instance and creates a new one.</para>
  19.          </comments>
  20.       </member>
  21.       <member name="M:jpeg.jpeg.Destroy">
  22.          <summary>
  23.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  24.                      
  25.                <method namespace="jpeg" class="TJPEGData">Destroy</method>s of an instance of a jpeg data object.</para>
  26.          </summary>
  27.          <comments>
  28.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The jpeg data object is automatically destroyed by the jpeg image object that uses it. It is not necessary to call <method namespace="jpeg" class="TJPEGData">Destroy</method> or to directly access the jpeg data object. </para>
  29.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="jpeg" class="TJPEGData">Destroy</method> method of a jpeg data object handles the freeing of the data.</para>
  30.          </comments>
  31.       </member>
  32.       <member name="T:jpeg.TJPEGImage">
  33.          <summary>
  34.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  35.                
  36.                <class namespace="jpeg">TJPEGImage</class> encapsulates a jpeg graphic.</para>
  37.          </summary>
  38.          <comments>
  39.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="jpeg">TJPEGImage</class> to read and write jpeg compressed image data. <class namespace="jpeg">TJPEGImage</class> handles the digital compression and decompression of still images for use in computer systems. It uses the data from an instance of TJPEGData, which contains the actual jpeg data source and is never modified. Each jpeg image object may share its TJPEGData object with other instances of a jpeg image by creating copies using the Assign method. The jpeg data source handles reference counting for the jpeg image objects that are linked to it.</para>
  40.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  41.                
  42.                <class namespace="jpeg">TJPEGImage</class> has an internal bitmap that represents the jpeg image. This internal image and the original source of the jpeg image are read only. <class namespace="jpeg">TJPEGImage</class> has properties that determine how each instance will handle color conversion, compression, decompression, performance, and so on.</para>
  43.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The following are characteristics of this object. A <class namespace="jpeg">TJPEGImage</class> object:</para>
  44.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Has no canvas (so it cannot draw onto a canvas). However, <class namespace="jpeg">TJPEGImage</class> implements the protected Draw method introduced in TGraphic, so it can draw itself on the canvas of another object.</para>
  45.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides no access to the internal bitmap image that it creates for the JPEG image.</para>
  46.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Performs reference counting and handle sharing by means of the TJPEGData object. Multiple instances can refer to the same TJPEGData image. TJPEGData is the actual owner of the file handle to the jpeg data source.</para>
  47.          </comments>
  48.       </member>
  49.       <member name="M:jpeg.jpeg.Create">
  50.          <summary>
  51.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Instantiates a JPEG image object.</para>
  52.          </summary>
  53.          <comments>
  54.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="jpeg" class="TJPEGImage">Create</method> to instantiate a jpeg image object at runtime.</para>
  55.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  56.                      
  57.                <method namespace="jpeg" class="TJPEGImage">Create</method> allocates memory for a jpeg image object, and then initializes its properties.</para>
  58.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After the jpeg is loaded from a file, an internal bitmap is created of the image.</para>
  59.          </comments>
  60.       </member>
  61.       <member name="M:jpeg.jpeg.Compress">
  62.          <summary>
  63.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Forces the action of compression.</para>
  64.          </summary>
  65.          <comments>
  66.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="jpeg" class="TJPEGImage">Compress</method> to compress for optimization, such as before streaming out when assigning a bitmap to a jpeg. Changing properties like <method namespace="jpeg" class="TJPEGImage">Compress</method>ionQuality does not force compression. To force compression, call <method namespace="jpeg" class="TJPEGImage">Compress</method>.</para>
  67.          </comments>
  68.       </member>
  69.       <member name="M:jpeg.jpeg.DIBNeeded">
  70.          <summary>
  71.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Decompress the jpeg image into a bitmap.</para>
  72.          </summary>
  73.          <comments>
  74.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  75.                      
  76.                <method namespace="jpeg" class="TJPEGImage">DIBNeeded</method> is used when the jpeg image needs a bitmap representation of its image. Call <method namespace="jpeg" class="TJPEGImage">DIBNeeded</method> just before drawing rather than while drawing for optimization.</para>
  77.          </comments>
  78.       </member>
  79.       <member name="M:jpeg.jpeg.JPEGNeeded">
  80.          <summary>
  81.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a new TJPEGData object if the jpeg image only has a bitmap and a jpeg is needed.</para>
  82.          </summary>
  83.          <comments>
  84.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="jpeg" class="TJPEGImage">JPEGNeeded</method> to create a new jpeg data source when the jpeg image has thrown away the jpeg data and only has an internal bitmap. <method namespace="jpeg" class="TJPEGImage">JPEGNeeded</method> creates a new jpeg data source. The SaveToStream method uses <method namespace="jpeg" class="TJPEGImage">JPEGNeeded</method>.</para>
  85.          </comments>
  86.       </member>
  87.       <member name="M:jpeg.jpeg.Assign">
  88.          <summary>
  89.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the jpeg image object and creates a new reference to the internal data source object.</para>
  90.          </summary>
  91.          <comments>
  92.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  93.                      
  94.                <method namespace="jpeg" class="TJPEGImage">Assign</method> copies the jpeg image contained in Source to the jpeg image object. <method namespace="jpeg" class="TJPEGImage">Assign</method> then calls the inherited <method namespace="jpeg" class="TJPEGImage">Assign</method>. <method namespace="jpeg" class="TJPEGImage">Assign</method> creates a new link to the internal jpeg data source by which the jpeg image objects do reference counting and handle sharing.</para>
  95.             <tip xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  96.                      
  97.                <para>To draw on a jpeg image, <method namespace="jpeg" class="TJPEGImage">Assign</method> the jpeg image to a bitmap, and then draw on that.</para>
  98.                   
  99.             </tip>
  100.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  101.                      
  102.                <para>An object of one type can always be assigned to another object of the same type. Also, the Source can be of type TPicture if the Graphic property of the picture is a jpeg image or a bitmap.</para>
  103.                   
  104.             </note>
  105.          </comments>
  106.       </member>
  107.       <member name="M:jpeg.jpeg.LoadFromStream">
  108.          <summary>
  109.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Loads the jpeg image from a stream.</para>
  110.          </summary>
  111.          <comments>
  112.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="jpeg" class="TJPEGImage">LoadFromStream</method> by specifying the stream from which the jpeg image is loaded as the value of Stream. <method namespace="jpeg" class="TJPEGImage">LoadFromStream</method> reads a jpeg data source from a stream and replaces the current image with it.</para>
  113.          </comments>
  114.       </member>
  115.       <member name="M:jpeg.jpeg.SaveToStream">
  116.          <summary>
  117.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the jpeg data to a stream.</para>
  118.          </summary>
  119.          <comments>
  120.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="jpeg" class="TJPEGImage">SaveToStream</method> to save the jpeg data to the stream specified by the Stream parameter. <method namespace="jpeg" class="TJPEGImage">SaveToStream</method> expects jpeg image data and may incur overhead of a compression cycle if the source is a bitmap.</para>
  121.          </comments>
  122.       </member>
  123.       <member name="M:jpeg.jpeg.LoadFromClipboardFormat">
  124.          <summary>
  125.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads in a jpeg image from the Clipboard into the jpeg image object.</para>
  126.          </summary>
  127.          <comments>
  128.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  129.                      
  130.                <method namespace="jpeg" class="TJPEGImage">LoadFromClipboardFormat</method> is called if the jpeg image is registered with the TPicture object using the RegisterClipboardFormat method. <method namespace="jpeg" class="TJPEGImage">LoadFromClipboardFormat</method> can also recognize, and supports, a bitmap format on the Clipboard.</para>
  131.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  132.                      
  133.                <method namespace="jpeg" class="TJPEGImage">LoadFromClipboardFormat</method> replaces the current image with the data pointed to by the AData parameter. The palette for the jpeg image is specified by the APalette parameter.</para>
  134.          </comments>
  135.       </member>
  136.       <member name="M:jpeg.jpeg.SaveToClipboardFormat">
  137.          <summary>
  138.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes a jpeg image to a variable in Clipboard format.</para>
  139.          </summary>
  140.          <comments>
  141.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="jpeg" class="TJPEGImage">SaveToClipboardFormat</method> to save the jpeg image to a variable. The palette is returned as the APalette parameter, the format as the Aformat parameter, and the data as the AData parameter. Before the jpeg image can be saved, an application must have registered the format with the <method namespace="jpeg" class="TJPEGImage">TJPEGImage</method> object using the RegisterClipboardFormat method.</para>
  142.          </comments>
  143.       </member>
  144.       <member name="M:jpeg.jpeg.Destroy">
  145.          <summary>
  146.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  147.                      
  148.                <method namespace="jpeg" class="TJPEGImage">Destroy</method>s of an instance of a jpeg image object.</para>
  149.          </summary>
  150.          <comments>
  151.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="jpeg" class="TJPEGImage">Destroy</method> directly in an application. Instead, call Free. Free verifies that the <method namespace="jpeg" class="TJPEGImage">TJPEGImage</method> reference is not nil before it calls <method namespace="jpeg" class="TJPEGImage">Destroy</method>.</para>
  152.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  153.                      
  154.                <method namespace="jpeg" class="TJPEGImage">Destroy</method> handles the freeing of the internal bitmap image and decrements the reference count on the jpeg data source to which it was linked.</para>
  155.          </comments>
  156.       </member>
  157.       <member name="P:jpeg.jpeg.Grayscale">
  158.          <summary>
  159.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the image output of a JPEG image is black and white, or color.</para>
  160.          </summary>
  161.          <comments>
  162.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use GrayScale for reading in and writing out, that is, for decompressing and compressing, a jpeg image. This property affects how the image is displayed.</para>
  163.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">GrayScale is used for speed in output optimization. When GrayScale is set to true, the color is separated from luminosity. Color takes the most time to decompress, so for previewing the image, GrayScale can be set to true for speed. The output then contains 255 shades of gray.</para>
  164.          </comments>
  165.       </member>
  166.       <member name="P:jpeg.jpeg.ProgressiveEncoding">
  167.          <summary>
  168.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether an image can be progressively displayed when it is decompressed.</para>
  169.          </summary>
  170.          <comments>
  171.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="jpeg" class="TJPEGImage">ProgressiveEncoding</property> to compress an image when writing out files, so that it can be progressively displayed when it is decompressed. Setting the ProgressiveDisplay property to true has no effect if <property namespace="jpeg" class="TJPEGImage">ProgressiveEncoding</property> was not set to true when the image was compressed.</para>
  172.          </comments>
  173.       </member>
  174.       <member name="P:jpeg.jpeg.CompressionQuality">
  175.          <summary>
  176.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the trade-off ratio between the image quality and the file size.</para>
  177.          </summary>
  178.          <comments>
  179.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="jpeg" class="TJPEGImage">CompressionQuality</property> to set the compression quality of the JPEG image when writing out a jpeg image. Higher compression results in a poorer picture quality, but a smaller file size. This property is not used for reading in files. </para>
  180.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TJPEGQualityRange is the type of the <property namespace="jpeg" class="TJPEGImage">CompressionQuality</property> property. The higher the TJPEGQualityRange value (up to a maximum of 100), the better the image quality, but the larger the file size. The lower the TJPEGQualityRange value (to a minimum of 1), the smaller the resulting file size, but at the expense of picture quality.</para>
  181.          </comments>
  182.       </member>
  183.       <member name="P:jpeg.jpeg.PixelFormat">
  184.          <summary>
  185.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the JPEG image is displayed in 24 or 8-bit format.</para>
  186.          </summary>
  187.          <comments>
  188.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="jpeg" class="TJPEGImage">PixelFormat</property> to set the pixel format of the jpeg image to 8-bit for video drivers that cannot display 24-bit. The native format of a jpeg image is 24-bit. <property namespace="jpeg" class="TJPEGImage">PixelFormat</property> is used for decompression, that is, for reading in files. <property namespace="jpeg" class="TJPEGImage">PixelFormat</property> will also apply to a bitmap if the image is copied to it.</para>
  189.          </comments>
  190.       </member>
  191.       <member name="P:jpeg.jpeg.ProgressiveDisplay">
  192.          <summary>
  193.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Controls how the image is displayed when decompressing files.</para>
  194.          </summary>
  195.          <comments>
  196.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="jpeg" class="TJPEGImage">ProgressiveDisplay</property> to turn on or off the incremental display of an image when reading in files. For example, if the jpeg data source file is on the hard drive, progressively displaying it slows down the display time: in this case setting <property namespace="jpeg" class="TJPEGImage">ProgressiveDisplay</property> to false speeds up the displaying of the image. If the file must be downloaded, set <property namespace="jpeg" class="TJPEGImage">ProgressiveDisplay</property> to true if the downloading process will take as long as the progressive displaying of the image.</para>
  197.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  198.                      
  199.                <property namespace="jpeg" class="TJPEGImage">ProgressiveDisplay</property> is used only for decompression, but is affected by the manner in which the image was compressed. Images that were compressed with ProgressiveEncoding set to false cannot take advantage of <property namespace="jpeg" class="TJPEGImage">ProgressiveDisplay</property>. Setting <property namespace="jpeg" class="TJPEGImage">ProgressiveDisplay</property> to true for these images has no effect.</para>
  200.          </comments>
  201.       </member>
  202.       <member name="P:jpeg.jpeg.Performance">
  203.          <summary>
  204.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Controls the trade-off between color quality and speed of decompression.</para>
  205.          </summary>
  206.          <comments>
  207.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="jpeg" class="TJPEGImage">Performance</property> to set the performance of the jpeg image when reading, that is, for decompressing files. This property is not used for writing out files.</para>
  208.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  209.                      
  210.                <property namespace="jpeg" class="TJPEGImage">Performance</property> affects the display of the internal bitmap image. This image is a 256-color bitmap. Setting <property namespace="jpeg" class="TJPEGImage">Performance</property> to jpBestSpeed may cause some dithering in the bitmap image.</para>
  211.          </comments>
  212.       </member>
  213.       <member name="P:jpeg.jpeg.Scale">
  214.          <summary>
  215.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines the size of the JPEG image when it is displayed.</para>
  216.          </summary>
  217.          <comments>
  218.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="jpeg" class="TJPEGImage">Scale</property> to optimize performance for previewing an image. jsFullSize displays the image as maximum size, whereas jsEighth displays an eighth of the image size, but 8 times faster.</para>
  219.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TJPEG<property namespace="jpeg" class="TJPEGImage">Scale</property> is the type of the <property namespace="jpeg" class="TJPEGImage">Scale</property> property. </para>
  220.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  221.                      
  222.                <property namespace="jpeg" class="TJPEGImage">Scale</property> it used for reading in files, that is, for decompression.</para>
  223.          </comments>
  224.       </member>
  225.       <member name="P:jpeg.jpeg.Smoothing">
  226.          <summary>
  227.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the jpeg image displays in blocks or with blurred edges.</para>
  228.          </summary>
  229.          <comments>
  230.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  231.                      
  232.                <property namespace="jpeg" class="TJPEGImage">Smoothing</property> is used if ProgressiveDisplay is true, to determine whether the jpeg image is displayed in small blocks or with blurred edges. If <property namespace="jpeg" class="TJPEGImage">Smoothing</property> is true, the edges are blurred during progressive displaying of the image. If <property namespace="jpeg" class="TJPEGImage">Smoothing</property> is false, raw blocks of color are used to display the image.</para>
  233.          </comments>
  234.       </member>
  235.    </members>
  236. </doc>