QImageIOHandler Class Reference · PyQt4 中文文檔

# QImageIOHandler Class Reference ## [[QtGui](index.htm) module] 該QImageIOHandler類定義Qt中的所有圖像格式的圖像常見的I / O接口。[More...](#details) ### Types * `enum ImageOption { Size, ClipRect, Description, ScaledClipRect, ..., BackgroundColor }` ### Methods * `__init__ (self)` * `bool canRead (self)` * `int currentImageNumber (self)` * `QRect currentImageRect (self)` * `QIODevice device (self)` * `QByteArray format (self)` * `int imageCount (self)` * `bool jumpToImage (self, int?imageNumber)` * `bool jumpToNextImage (self)` * `int loopCount (self)` * `QByteArray name (self)` * `int nextImageDelay (self)` * `QVariant option (self, ImageOption?option)` * `bool read (self, QImage?image)` * `setDevice (self, QIODevice?device)` * `setFormat (self, QByteArray?format)` * `setOption (self, ImageOption?option, QVariant?value)` * `bool supportsOption (self, ImageOption?option)` * `bool write (self, QImage?image)` * * * ## Detailed Description 該QImageIOHandler類定義Qt中的所有圖像格式的圖像常見的I / O接口。 Qt使用QImageIOHandler通過讀取和寫入圖像[QImageReader](qimagereader.html)和[QImageWriter](qimagewriter.html)。您也可以從這個類派生使用Qt的插件機制來編寫自己的圖像格式處理程序。 Call [setDevice](qimageiohandler.html#setDevice)（）到設備分配給處理程序，[setFormat](qimageiohandler.html#setFormat)（）的形式分配給它。一QImageIOHandler可以支持一個以上的圖像格式。[canRead](qimageiohandler.html#canRead)（）返回True，如果一個圖像可以從設備讀取，并[read](qimageiohandler.html#read)（）和[write](qimageiohandler.html#write)（）返回True，如果讀取或寫入圖像已成功完成。 QImageIOHandler也有動畫格式的支持，通過功能[loopCount](qimageiohandler.html#loopCount)（）[imageCount](qimageiohandler.html#imageCount)（）[nextImageDelay](qimageiohandler.html#nextImageDelay)（）和[currentImageNumber](qimageiohandler.html#currentImageNumber)（）。為了確定哪些選項的圖像處理程序支持， Qt會調用[supportsOption](qimageiohandler.html#supportsOption)（）和[setOption](qimageiohandler.html#setOption)（）。請務必重新實現這些功能，如果你能提供任何在該選項的支持[ImageOption](qimageiohandler.html#ImageOption-enum)枚舉。寫你自己的圖像處理程序，您必須至少重新實現[canRead](qimageiohandler.html#canRead)（）和[read](qimageiohandler.html#read)（）。然后創建一個[QImageIOPlugin](index.htm)它可以創建的處理程序。最后，安裝插件，[QImageReader](qimagereader.html)和[QImageWriter](qimagewriter.html)將自動加載該插件，并開始使用它。 * * * ## Type Documentation ``` QImageIOHandler.ImageOption ``` 這個枚舉變量描述了所支持的不同選擇[QImageIOHandler](qimageiohandler.html)。有些選項是用來查詢的圖像的性質，有些則是用來切換中的圖像應該寫入的方式。 | Constant | Value | Description | | --- | --- | --- | | `QImageIOHandler.Size` | `0` | 圖像的原始尺寸。支持此選項的處理程序，預計從圖像元數據讀取的圖像的大小，并從返回此尺寸[option](qimageiohandler.html#option)（），為[QSize](qsize.html)。 | | `QImageIOHandler.ClipRect` | `1` | 剪輯矩形，或ROI （感興趣區域）。支持此選項的處理程序，預計只能讀取提供[QRect](qrect.html)從原始圖像區域[read](qimageiohandler.html#read)（），任何其他應用轉換之前。 | | `QImageIOHandler.ScaledSize` | `4` | 圖像的縮放大小。支持此選項的處理程序，預計將圖像縮放到所提供的尺寸（[QSize](qsize.html)），應用任何剪輯矩形變換（ ClipRect ）之后。如果處理程序不支持此選項，[QImageReader](qimagereader.html)將執行縮放圖像已被讀取。 | | `QImageIOHandler.ScaledClipRect` | `3` | 縮放剪輯矩形的圖像（或ROI ，感興趣區域）。支持此選項的處理程序，預計申請所提供的剪輯矩形（一[QRect](qrect.html)），應用任何縮放（ ScaleSize ）或定期修剪（ ClipRect ）之后。如果處理程序不支持此選項，[QImageReader](qimagereader.html)將應用縮放剪輯矩形圖像已被讀取。 | | `QImageIOHandler.Description` | `2` | 形象的描述。一些圖像格式，如GIF和PNG ，可以使文字或意見嵌入到圖像數據（例如，用于存儲版權信息）。這是常見的文本存儲在鍵 - 值對的，但一些格式存儲所有的文字在一個連續的塊。[QImageIOHandler](qimageiohandler.html)返回文本為一體[QString](qstring.html)，其中鍵和值由分隔'：'和鍵 - 值對是由兩個換行符（ \ n \ n已）分隔。例如， “標題：日落\ N \ nAuthor ：吉姆·史密斯\ nSarah瓊斯\ n \ n已” 。存儲文本在一個單一的塊格式可以使用“描述”為重點。 | | `QImageIOHandler.CompressionRatio` | `5` | 的圖像數據的壓縮比。支持此選項的處理程序，預計在寫入時設置取決于此選項的值它的壓縮率（ int類型）。 | | `QImageIOHandler.Gamma` | `6` | 圖像的灰度級。支持此選項的處理程序，預計在寫入時設置取決于此選項的值圖像Gamma值（浮點數）。 | | `QImageIOHandler.Quality` | `7` | 的圖像的質量級別。支持此選項的處理程序，預計寫入時設置圖像質量水平取決于該選項的值（一個int ）。 | | `QImageIOHandler.Name` | `8` | 該圖像的名稱。支持此選項的處理程序，預計從圖像元數據讀取的名稱，并返回此作為[QString](qstring.html)或寫入預期要存儲在圖像的元數據的名稱的圖像時。 | | `QImageIOHandler.SubType` | `9` | 圖像的子類型。支持此選項的處理程序可以使用子類型值，以幫助閱讀和寫作的圖像時。例如， PPM處理程序可以具有“ PPM ”或“ ppmraw ”的子類型的值。 | | `QImageIOHandler.IncrementalReading` | `10` | 支持此選項的處理程序，預計讀取圖像中的幾次傳球，就好像它是一個動畫。[QImageReader](qimagereader.html)將把圖像作為動畫。 | | `QImageIOHandler.Endianness` | `11` | 圖像的字節序。某些圖像格式可以存儲為大尾端或LittleEndian 。支持字節序的處理程序使用此選項的值，以確定如何在圖像的存儲位置。 | | `QImageIOHandler.Animation` | `12` | 支持動畫返回True此值圖像格式[supportsOption](qimageiohandler.html#supportsOption)（），否則，則返回False。 | | `QImageIOHandler.BackgroundColor` | `13` | 某些圖像格式允許指定背景顏色。支持BACKGROUNDCOLOR處理程序初始化背景色為這個選項（一[QColor](qcolor.html)）讀取圖像時。 | | `QImageIOHandler.ImageFormat` | `14` | 由處理圖像的數據格式返回。這可以是任意的中列出的格式[QImage.Format](qimage.html#Format-enum)。 | * * * ## Method Documentation ``` QImageIOHandler.__init__ (self) ``` 構造一個[QImageIOHandler](qimageiohandler.html)對象。 ``` bool QImageIOHandler.canRead (self) ``` 這種方法是抽象的，應在任何子類中重新實現。返回True如果圖像可以從設備讀取（即圖像格式的支持，該設備可以讀取和初始頭信息表明，圖像可以被讀取），否則返回False 。當重新實現的CanRead （），請確保I / O設備（[device](qimageiohandler.html#device)（））被留在其原來的狀態（例如，通過使用PEEK（），而不是[read](qimageiohandler.html#read)（））。 **See also** [read](qimageiohandler.html#read)（）和[QIODevice.peek](qiodevice.html#peek)（）。 ``` int QImageIOHandler.currentImageNumber (self) ``` 對于支持動畫圖像格式，該函數返回當前圖像的動畫序列號。如果這個函數被調用任何圖像之前[read](qimageiohandler.html#read)（），則返回-1。序列中的第一圖像的數目是0。如果圖像格式不支持動畫，則返回0 。 **See also** [read](qimageiohandler.html#read)（）。 ``` QRect QImageIOHandler.currentImageRect (self) ``` [ 返回當前圖像的正確。如果沒有RECT定義為圖像，以及空查閱QRect （）返回。這個功能對于動畫，其中幀的唯一部件可以在同一時間進行更新是有用的。 ](qrect.html) ``` QIODevice QImageIOHandler.device (self) ``` [](qiodevice.html) [返回當前分配給該設備](qiodevice.html)[QImageIOHandler](qimageiohandler.html)。如果沒有設備已經被分配，則返回0 。 **See also** [setDevice](qimageiohandler.html#setDevice)（）。 ``` QByteArray QImageIOHandler.format (self) ``` [](qbytearray.html) [返回當前分配到的格式](qbytearray.html)[QImageIOHandler](qimageiohandler.html)。如果沒有指定格式已被分配，則返回一個空字符串。 **See also** [setFormat](qimageiohandler.html#setFormat)（）。 ``` int QImageIOHandler.imageCount (self) ``` 對于支持動畫圖像格式，該函數返回的動畫圖像的數量。如果圖像格式不支持動畫，或者如果它是無法確定的圖像的數量，則返回0 。默認實現返回1 ，如果[canRead](qimageiohandler.html#canRead)（）返回True，否則返回0。 ``` bool QImageIOHandler.jumpToImage (self, int?imageNumber) ``` 對于支持動畫圖像格式，該函數跳轉到的序列號是圖像_imageNumber_。到下一次調用[read](qimageiohandler.html#read)（）將嘗試讀取這個形象。默認實現不執行任何操作，并返回False 。 ``` bool QImageIOHandler.jumpToNextImage (self) ``` 對于支持動畫圖像格式，該功能跳轉到下一個圖像。默認實現不執行任何操作，并返回False 。 ``` int QImageIOHandler.loopCount (self) ``` 對于支持動畫圖像格式，該函數返回的時候動畫應該循環的次數。如果圖像格式不支持動畫，則返回0 。 ``` QByteArray QImageIOHandler.name (self) ``` [ ``` int QImageIOHandler.nextImageDelay (self) ``` 對于支持動畫圖像格式，該函數返回的毫秒數要等到讀取下一個圖像。如果圖像格式不支持動畫，則返回0 。 ``` QVariant QImageIOHandler.option (self, ImageOption?option) ``` ](qbytearray.html) [返回指定的值_option_作為](qbytearray.html)[QVariant](qvariant.html)。值的類型取決于選項。例如，選項（尺寸）返回一個[QSize](qsize.html)變體。 **See also** [setOption](qimageiohandler.html#setOption)（）和[supportsOption](qimageiohandler.html#supportsOption)（）。 ``` bool QImageIOHandler.read (self, QImage?image) ``` 這種方法是抽象的，應在任何子類中重新實現。從設備中讀取的圖像，并將其存儲在_image_。返回True如果圖像被成功讀取，否則返回False 。對于支持增量加載的圖像格式，并為動畫格式，圖像處理程序可以假設_image_指向前一幀。 **See also** [canRead](qimageiohandler.html#canRead)（）。 ``` QImageIOHandler.setDevice (self, QIODevice?device) ``` 設置的設備[QImageIOHandler](qimageiohandler.html)至_device_。讀取和寫入圖像時的圖像處理程序將使用該設備。該設備只能設置一次，并調用之前必須設置[canRead](qimageiohandler.html#canRead)（）[read](qimageiohandler.html#read)（）[write](qimageiohandler.html#write)（）等，如果你需要讀取多個文件，建立相應的多個實例[QImageIOHandler](qimageiohandler.html)子類。 **See also** [device](qimageiohandler.html#device)（）。 ``` QImageIOHandler.setFormat (self, QByteArray?format) ``` 設置的格式[QImageIOHandler](qimageiohandler.html)至_format_。該格式是支持多種格式的圖像處理程序非常有用。 **See also** [format](qimageiohandler.html#format)（）。 ``` QImageIOHandler.setOption (self, ImageOption?option, QVariant?value) ``` 設置選項_option_與該值_value_。 **See also** [option](qimageiohandler.html#option)（）和[ImageOption](qimageiohandler.html#ImageOption-enum)。 ``` bool QImageIOHandler.supportsOption (self, ImageOption?option) ``` 返回True如果[QImageIOHandler](qimageiohandler.html)支持選項_option_否則返回False 。例如，如果[QImageIOHandler](qimageiohandler.html)支持[Size](qimageiohandler.html#ImageOption-enum)選項， supportsOption （尺寸）必須返回True 。 **See also** [setOption](qimageiohandler.html#setOption)（）和[option](qimageiohandler.html#option)（）。 ``` bool QImageIOHandler.write (self, QImage?image) ``` 寫入圖像_image_到所分配的設備。成功時返回TRUE ，否則返回False 。默認實現不執行任何操作，并簡單地返回False 。