autodoc.git / modref.xml

autodoc.git/modref.xml:1126:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='8.0::Crypto.CBC'>Crypto.CBC</classname></inherit>   </docgroup>   </class>   <class name='DHKeyExchange'>   <doc><text><p>Implements Diffie-Hellman key-exchange.</p>   <p> The following key exchange methods are implemented here: -  <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p> +  <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='p'><type><object resolved='7.8::SSL.Cipher.DHParameters'>DHParameters</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='DHParameters'>   <doc><text><p>Diffie-Hellman parameters.</p>
autodoc.git/modref.xml:1743:   <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable>   </docgroup>   <docgroup homogen-type='variable'><doc><text><p>Random cookies, sent and received with the hello-messages.</p>   </text></doc>   <variable name='client_random'><type><string/></type></variable>   <variable name='server_random'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text><p>Whether this is the server end of the connection or not.</p>   </text></group><group><param name='ctx'/><text><p>The context for the connection.</p>   </text></group><group><param name='min_version'/><text><p>Minimum version of SSL to support. -  Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p>   </text></group><group><param name='max_version'/><text><p>Maximum version of SSL to support.    Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>.</p>   </text></group></doc>   <method name='create'>   <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text><p>Do handshake processing. Type is one of HANDSHAKE_*, data is the    contents of the packet, and raw is the raw packet received (needed
autodoc.git/modref.xml:1910:   <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable>   </docgroup>   <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text><p>Sets the proper authentication method and cipher specification    for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>.</p>   </text></doc>   <method name='set_cipher_suite'>   <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </text></doc>   <method name='set_compression_method'>   <arguments><argument name='compr'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='sslfile'>   <doc><text><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/modref.xml:74016:   <ref resolved='predef::Image.load'>Image.load</ref>, <ref resolved='predef::Image.load_layers'>Image.load_layers</ref> - Loads and decodes data <br/>   <ref resolved='predef::Image.lay'>Image.lay</ref> - The base image layer compositing method <br/>   </p>   </text>      </doc>   <docgroup homogen-name='_decode' homogen-type='method'><doc><text><p>Attempts to decode <ref resolved='predef::Image._decode.data'>data</ref> as image data. The heuristics    has some limited ability to decode macbinary files as well.</p>   </text></doc>   <method name='_decode'> - <arguments><argument name='data'><type><string/></type></argument></arguments> + <arguments><argument name='data'><type><string/></type></argument><argument name='exif'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments>   <returntype><mapping/></returntype>   </method>   </docgroup>   <docgroup homogen-name='_load' homogen-type='method'><doc><text><p>Loads a file with <ref resolved='predef::Image.load_file'>load_file</ref> and decodes it with <ref resolved='predef::Image._decode'>_decode</ref>.</p>   </text></doc>   <method name='_load'>   <arguments><argument name='file'><type><or><void/><object resolved='predef::Image._load'/><string/></or></type></argument></arguments>   <returntype><mapping/></returntype>   </method>   </docgroup>
autodoc.git/modref.xml:74044:   </docgroup>   <docgroup homogen-name='decode_layers' homogen-type='method'><doc><text><p>Attempts to decode <ref resolved='predef::Image.decode_layers.data'>data</ref> as image layer data. Additional    arguments to the various formats decode_layers method can    be passed through <ref resolved='predef::Image.decode_layers.opt'>opt</ref>.</p>   </text></doc>   <method name='decode_layers'>   <arguments><argument name='data'><type><string/></type></argument><argument name='opt'><type><or><mapping/><void/></or></type></argument></arguments>   <returntype><array><valuetype><object resolved='predef::Image.Layer'>Image.Layer</object></valuetype></array></returntype>   </method>   </docgroup> + <docgroup homogen-name='exif_decode' homogen-type='method'><doc><text><p>Like <ref resolved='predef::Image._decode'>_decode()</ref> but decodes EXIF and applies the rotation.</p> + </text></doc> + <method name='exif_decode'> + <arguments><argument name='data'><type><string/></type></argument></arguments> + <returntype><mapping/></returntype> + </method> + </docgroup>   <docgroup homogen-type='method'><doc><text><p>Generates a filled circle of the    dimensions xd x yd (or d x d).    The Image is a white circle on black background; the layer    function defaults to a white circle (the background is transparent).</p>   </text></doc>   <method name='filled_circle'>   <arguments><argument name='d'><type><int/></type></argument></arguments>   <returntype><object resolved='predef::Image.Image'>Image.Image</object></returntype>   </method>   <method name='filled_circle'>
autodoc.git/modref.xml:76023:   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   </module>   <module name='Dims'>   <doc><text><p>Reads the dimensions of images of various image formats without    decoding the actual image.</p>   </text></doc> + <docgroup homogen-name='exif_get' homogen-type='method'><doc><text><p>Like <ref resolved='predef::Image.Dims.get'>get()</ref>, but returns the dimensions flipped if +  <ref resolved='predef::Image.JPEG.exif_decode'>Image.JPEG.exif_decode()</ref> would flip them</p> + </text></doc> + <method name='exif_get'> + <arguments><argument name='file'><type><or><string/><object resolved='predef::Stdio.File'>Stdio.File</object></or></type></argument></arguments> + <returntype><array><valuetype><int/></valuetype></array></returntype> + </method> + </docgroup> + <docgroup homogen-name='exif_get_JPEG' homogen-type='method'><doc><text><p>Like <ref resolved='predef::Image.Dims.get_JPEG'>get_JPEG()</ref>, but returns the dimensions flipped if +  <ref resolved='predef::Image.JPEG.exif_decode'>Image.JPEG.exif_decode()</ref> would flip them</p> + </text></doc> + <method name='exif_get_JPEG'> + <arguments><argument name='f'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments> + <returntype><array><valuetype><int/></valuetype></array></returntype> + </method> + </docgroup>   <docgroup homogen-name='get' homogen-type='method'><doc><text><p>Read dimensions from a JPEG, GIF, PNG, WebP, TIFF or PSD file and    return an array with width and height, or if the file isn't a    valid image, <expr>0</expr>. The argument <ref resolved='predef::Image.Dims.get.file'>file</ref> should be file object    or the data from a file. The offset pointer will be assumed to be    at the start of the file data and will be modified by the    function.</p>   </text><group><returns/><text><array><group><elem><type><int/></type><index>0</index></elem><text><p>Image width.</p>   </text></group><group><elem><type><int/></type><index>1</index></elem><text><p>Image height.</p>   </text></group><group><elem><type><string/></type><index>2</index></elem><text><p>Image type. Any of <expr>"gif"</expr>, <expr>"png"</expr>, <expr>"tiff"</expr>,    <expr>"jpeg"</expr>, <expr>"webp"</expr> and <expr>"psd"</expr>.</p>   </text></group></array>   </text></group></doc>   <method name='get'> - <arguments><argument name='file'><type><or><string/><object resolved='predef::Stdio.File'>Stdio.File</object></or></type></argument></arguments> + <arguments><argument name='file'><type><or><string/><object resolved='predef::Stdio.File'>Stdio.File</object></or></type></argument><argument name='exif'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments>   <returntype><array><valuetype><or><int/><string/></or></valuetype></array></returntype>   </method>   </docgroup>   <docgroup homogen-name='get_GIF' homogen-type='method'><doc><text><p>Reads the dimensions from a GIF file and returns an array with    width and height, or if the file isn't a valid image, 0.</p>   </text></doc>   <method name='get_GIF'>   <arguments><argument name='f'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments>   <returntype><array><valuetype><int/></valuetype></array></returntype>   </method>