Diff of autodoc.git/onepage.xml (831ee595570e724467527dcba6946b3cb0bac79e » 5ca3e2761a00ed44a09b2736bc5e5c9c2710543a)

autodoc.git/onepage.xml:1: <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2015-08-22' version='Pike v8.1.2'> + <manual time-stamp='2020-01-20' version='Pike v8.1.2'> <dir name='./onepage'> <file name='./onepage/manual.html'> <chapter number='1' title='Control Structures'> In this chapter all the control structures in Pike will be explained. Control structures are used to control the flow of the program execution. Note that functions that make the program pause and simple function calls are not qualified as control structures. <section number='1' title='Conditions'>
autodoc.git/onepage.xml:2604: </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>Implements Diffie-Hellman key-exchange. 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>. + <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>. </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>Diffie-Hellman parameters.
autodoc.git/onepage.xml:3221: <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable> </docgroup> <docgroup homogen-type='variable'><doc><text>Random cookies, sent and received with the hello-messages. </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>Whether this is the server end of the connection or not. </text></group><group><param name='ctx'/><text>The context for the connection. </text></group><group><param name='min_version'/><text>Minimum version of SSL to support. - Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. + Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. </text></group><group><param name='max_version'/><text>Maximum version of SSL to support. Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>. </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>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/onepage.xml:5640: <module name='Types'> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>8.1::</classname></import> </docgroup> <docgroup homogen-name='pre' homogen-type='inherit'> <inherit name='pre'><classname resolved='predef::Standards.ASN1.Types'>Standards.ASN1.Types</classname></inherit> </docgroup> <class name='TeletexString'> <doc><text>This used to be a string encoded with the T.61 character coding, and has been obsolete since the early 1990:s. - </text><group><seealso/><text><ref resolved='predef::Standards.ASN1.Types.BrokenTeletexString'>BrokenTeletexString</ref> + </text><group><seealso/><text><ref>BrokenTeletexString</ref> </text></group></doc> <docgroup homogen-name='BrokenTeletexString' homogen-type='inherit'> - <inherit name='BrokenTeletexString'><classname resolved='predef::Standards.ASN1.Types.BrokenTeletexString'>BrokenTeletexString</classname></inherit> + <inherit name='BrokenTeletexString'><classname>BrokenTeletexString</classname></inherit> </docgroup> </class> </module> </module> <module name='PKCS'> <module name='Certificate'> <docgroup homogen-name='get_certificate_issuer' homogen-type='method'><doc><text>Return the certificate issuer RDN from a certificate string. </text><group><param name='cert'/><text>A string containing an X509 certificate. Note that the certificate usually must be decoded using <ref resolved='predef::Standards.PEM.simple_decode'>Standards.PEM.simple_decode()</ref>. </text></group><group><returns/><text>An Standards.ASN1.Sequence object containing the certificate issuer Distinguished Name (DN). </text></group><group><deprecated><name><ref resolved='predef::Standards.X509.decode_certificate'>Standards.X509.decode_certificate</ref></name></deprecated></group></doc> <method name='get_certificate_issuer'> <arguments><argument name='cert'><type><string/></type></argument></arguments> - <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> + <returntype><object>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='get_certificate_subject' homogen-type='method'><doc><text>Return the certificate subject RDN from a certificate string. </text><group><param name='cert'/><text>A string containing an X509 certificate. Note that the certificate usually must be decoded using <ref>PEM.simpe_decode()</ref>. </text></group><group><returns/><text>An Standards.ASN1.Sequence object containing the certificate subject Distinguished Name (DN). </text></group><group><deprecated><name><ref resolved='predef::Standards.X509.decode_certificate'>Standards.X509.decode_certificate</ref></name></deprecated></group></doc> <method name='get_certificate_subject'> <arguments><argument name='cert'><type><string/></type></argument></arguments> - <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> + <returntype><object>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>8.1::</classname></import> </docgroup> <docgroup homogen-name='Types' homogen-type='import'> <import name='Types'><classname resolved='predef::Standards.ASN1.Types'>Standards.ASN1.Types</classname></import> </docgroup> <docgroup homogen-name='Certificate' homogen-type='inherit'> <inherit name='Certificate'><classname resolved='predef::Standards.PKCS.Certificate'>Standards.PKCS.Certificate</classname></inherit> </docgroup> </module> <module name='RSA'> <doc><text>RSA operations and types as described in PKCS-1. </text></doc> <docgroup homogen-name='algorithm_identifier' homogen-type='method'><doc><text>Returns the AlgorithmIdentifier as defined in RFC5280 section 4.1.1.2. </text></doc> <method name='algorithm_identifier'> <arguments/> - <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> + <returntype><object>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='build_private_key' homogen-type='method'><doc><text>Creates a PrivateKeyInfo ASN.1 sequence for the given <ref resolved='8.0::Standards.PKCS.RSA.build_private_key.rsa'>rsa</ref> object. See RFC 5208 section 5. </text></doc> <method name='build_private_key'> <arguments><argument name='rsa'><type><object resolved='8.0::Crypto.RSA'>Crypto.RSA</object></type></argument></arguments> - <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> + <returntype><object>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='build_public_key' homogen-type='method'><doc><text>Creates a SubjectPublicKeyInfo ASN.1 sequence for the given <ref resolved='8.0::Standards.PKCS.RSA.build_public_key.rsa'>rsa</ref> object. See RFC 5280 section 4.1.2.7. </text></doc> <method name='build_public_key'> <arguments><argument name='rsa'><type><object resolved='8.0::Crypto.RSA'>Crypto.RSA</object></type></argument></arguments> - <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> + <returntype><object>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='8.0::'>8.0::</classname></import> </docgroup> <docgroup homogen-name='Types' homogen-type='import'> <import name='Types'><classname resolved='8.0::Standards.ASN1.Types'>Standards.ASN1.Types</classname></import> </docgroup> <docgroup homogen-name='parse_private_key' homogen-type='method'><doc><text>Decode a RSAPrivateKey structure </text><group><param name='key'/><text>RSAPrivateKey provided in ASN.1 format
autodoc.git/onepage.xml:5768: <arguments><argument name='rsa'><type><object resolved='8.0::Crypto.RSA'>Crypto.RSA</object></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='signature_algorithm_id' homogen-type='method'><doc><text>Returns the PKCS-1 algorithm identifier for RSA and the provided hash algorithm. One of <ref>MD2</ref>, <ref>MD5</ref>, <ref>SHA1</ref>, <ref>SHA256</ref>, <ref>SHA384</ref> or <ref>SHA512</ref>. </text></doc> <method name='signature_algorithm_id'> <arguments><argument name='hash'><type><object resolved='predef::Crypto.Hash'>Crypto.Hash</object></type></argument></arguments> - <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> + <returntype><object>Sequence</object></returntype> </method> </docgroup> </module> </module> </module> <module name='Thread'> <docgroup homogen-name='`()' homogen-type='method'><doc><text>Create a new thread. </text><group><deprecated><name><ref resolved='predef::Thread.Thread'>predef::Thread.Thread</ref></name></deprecated></group></doc> <method name='`()'><modifiers><optional/></modifiers> <arguments><argument name='f'><type><mixed/></type></argument><argument name='args'><type><varargs><mixed/></varargs></type></argument></arguments>
autodoc.git/onepage.xml:5947: </text></group><group><param name='rsa'/><text>RSA parameters for the issuer. </text></group><group><param name='subject'/><text>Distinguished name for the subject. </text></group><group><param name='public_key'/><text>DER-encoded integer. See <ref resolved='predef::Standards.PKCS.DSA.public_key'>Standards.PKCS.DSA.public_key()</ref>. </text></group><group><param name='serial'/><text>Serial number for this key and issuer. </text></group><group><param name='ttl'/><text>Validity time in seconds for this signature to be valid. </text></group><group><param name='extensions'/><text>Set of extensions. </text></group><group><returns/><text>Returns a DER-encoded certificate. </text></group></doc> <method name='dsa_sign_key'> - <arguments><argument name='issuer'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='dsa'><type><object resolved='predef::Crypto.DSA'>Crypto.DSA</object></type></argument><argument name='subject'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='public_key'><type><string/></type></argument><argument name='serial'><type><int/></type></argument><argument name='ttl'><type><int/></type></argument><argument name='extensions'><type><or><array/><void/></or></type></argument></arguments> + <arguments><argument name='issuer'><type><object>Sequence</object></type></argument><argument name='dsa'><type><object resolved='predef::Crypto.DSA'>Crypto.DSA</object></type></argument><argument name='subject'><type><object>Sequence</object></type></argument><argument name='public_key'><type><string/></type></argument><argument name='serial'><type><int/></type></argument><argument name='ttl'><type><int/></type></argument><argument name='extensions'><type><or><array/><void/></or></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='PKCS' homogen-type='import'> <import name='PKCS'><classname resolved='predef::Standards.PKCS'>Standards.PKCS</classname></import> </docgroup> <docgroup homogen-name='Types' homogen-type='import'>
autodoc.git/onepage.xml:5975: </docgroup> <docgroup homogen-name='make_selfsigned_rsa_certificate' homogen-type='method'> <method name='make_selfsigned_rsa_certificate'> <arguments><argument name='rsa'><type><object resolved='predef::Crypto.RSA'>Crypto.RSA</object></type></argument><argument name='ttl'><type><int/></type></argument><argument name='name'><type><array/></type></argument><argument name='extensions'><type><or><array/><void/></or></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='make_tbs' homogen-type='method'> <method name='make_tbs'> <arguments><argument name='issuer'><type><object resolved='8.0::Tools.X509.make_tbs'/></type></argument><argument name='algorithm'><type><object resolved='8.0::Tools.X509.make_tbs'/></type></argument><argument name='subject'><type><object resolved='8.0::Tools.X509.make_tbs'/></type></argument><argument name='keyinfo'><type><object resolved='8.0::Tools.X509.make_tbs'/></type></argument><argument name='serial'><type><object resolved='8.0::Tools.X509.make_tbs'/></type></argument><argument name='ttl'><type><int/></type></argument><argument name='extensions'><type><array/></type></argument></arguments> - <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> + <returntype><object>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='make_time' homogen-type='method'><doc><text>Creates a <ref resolved='predef::Standards.ASN1.Types.UTC'>Standards.ASN1.Types.UTC</ref> object from the posix time <ref resolved='8.0::Tools.X509.make_time.t'>t</ref>. </text></doc> <method name='make_time'> <arguments><argument name='t'><type><int/></type></argument></arguments> - <returntype><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></returntype> + <returntype><object>UTC</object></returntype> </method> </docgroup> <docgroup homogen-name='make_verifier' homogen-type='method'> <method name='make_verifier'> <arguments><argument name='_keyinfo'><type><object resolved='predef::Object'>Object</object></type></argument></arguments> <returntype><object>Verifier</object></returntype> </method> </docgroup> <docgroup homogen-name='parse_time' homogen-type='method'><doc><text>Returns a mapping similar to that returned by gmtime </text><group><returns/><text><mapping><group><member><type><int/></type><index>"year"</index></member><member><type><int/></type><index>"mon"</index></member><member><type><int/></type><index>"mday"</index></member><member><type><int/></type><index>"hour"</index></member><member><type><int/></type><index>"min"</index></member><member><type><int/></type><index>"sec"</index></member></group></mapping> </text></group></doc> <method name='parse_time'> - <arguments><argument name='asn1'><type><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></type></argument></arguments> + <arguments><argument name='asn1'><type><object>UTC</object></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype> </method> </docgroup> <docgroup homogen-name='rsa_sign_digest' homogen-type='method'> <method name='rsa_sign_digest'> <arguments><argument name='rsa'><type><object resolved='predef::Crypto.RSA'>Crypto.RSA</object></type></argument><argument name='digest_id'><type><object resolved='8.0::Tools.X509.rsa_sign_digest'/></type></argument><argument name='digest'><type><string/></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='rsa_sign_key' homogen-type='method'><doc><group><param name='issuer'/><text>Distinguished name for the issuer. </text></group><group><param name='rsa'/><text>RSA parameters for the issuer. </text></group><group><param name='subject'/><text>Distinguished name for the issuer. </text></group><group><param name='public_key'/><text>DER-encoded RSAPublicKey structure. See <ref resolved='predef::Standards.PKCS.RSA.public_key'>Standards.PKCS.RSA.public_key()</ref>. </text></group><group><param name='serial'/><text>Serial number for this key and subject. </text></group><group><param name='ttl'/><text>Validity time in seconds for this signature to be valid. </text></group><group><param name='extensions'/><text>Set of extensions. </text></group><group><returns/><text>Returns a DER-encoded certificate. </text></group></doc> <method name='rsa_sign_key'> - <arguments><argument name='issuer'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='rsa'><type><object resolved='predef::Crypto.RSA'>Crypto.RSA</object></type></argument><argument name='subject'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='public_key'><type><string/></type></argument><argument name='serial'><type><int/></type></argument><argument name='ttl'><type><int/></type></argument><argument name='extensions'><type><or><array/><void/></or></type></argument></arguments> + <arguments><argument name='issuer'><type><object>Sequence</object></type></argument><argument name='rsa'><type><object resolved='predef::Crypto.RSA'>Crypto.RSA</object></type></argument><argument name='subject'><type><object>Sequence</object></type></argument><argument name='public_key'><type><string/></type></argument><argument name='serial'><type><int/></type></argument><argument name='ttl'><type><int/></type></argument><argument name='extensions'><type><or><array/><void/></or></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='rsa_verify_digest' homogen-type='method'> <method name='rsa_verify_digest'> <arguments><argument name='rsa'><type><object resolved='predef::Crypto.RSA'>Crypto.RSA</object></type></argument><argument name='digest_id'><type><object resolved='8.0::Tools.X509.rsa_verify_digest'/></type></argument><argument name='digest'><type><string/></type></argument><argument name='s'><type><string/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='time_compare' homogen-type='method'><doc><text>Comparision function between two "date" mappings of the
autodoc.git/onepage.xml:6078: See <ref resolved='predef::Standards.PKCS.Certificate.get_dn_string'>Standards.PKCS.Certificate.get_dn_string</ref> for converting the RDN to an X500 style string. </text></group></doc> <method name='verify_certificate_chain'> <arguments><argument name='cert_chain'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='authorities'><type><mapping/></type></argument><argument name='require_trust'><type><or><int/><void/></or></type></argument></arguments> <returntype><mapping/></returntype> </method> </docgroup> <class name='TBSCertificate'> <docgroup homogen-name='algorithm' homogen-type='variable'> - <variable name='algorithm'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></variable> + <variable name='algorithm'><type><object>Sequence</object></type></variable> </docgroup> <docgroup homogen-name='der' homogen-type='variable'> <variable name='der'><type><string/></type></variable> </docgroup> <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> <variable name='extensions'><type><object resolved='8.0::Tools.X509.TBSCertificate'/></type></variable> </docgroup> <docgroup homogen-name='init' homogen-type='method'> <method name='init'> <arguments><argument name='asn1'><type><object resolved='predef::Object'>Object</object></type></argument></arguments> <returntype><object resolved='8.0::Tools.X509.TBSCertificate'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='issuer' homogen-type='variable'> - <variable name='issuer'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></variable> + <variable name='issuer'><type><object>Sequence</object></type></variable> </docgroup> <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> - <variable name='issuer_id'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable> + <variable name='issuer_id'><type><object>BitString</object></type></variable> </docgroup> <docgroup homogen-name='not_after' homogen-type='variable'> <variable name='not_after'><type><mapping/></type></variable> </docgroup> <docgroup homogen-name='not_before' homogen-type='variable'> <variable name='not_before'><type><mapping/></type></variable> </docgroup> <docgroup homogen-name='public_key' homogen-type='variable'> <variable name='public_key'><type><object>Verifier</object></type></variable> </docgroup> <docgroup homogen-name='serial' homogen-type='variable'> <variable name='serial'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></variable> </docgroup> <docgroup homogen-name='subject' homogen-type='variable'> - <variable name='subject'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></variable> + <variable name='subject'><type><object>Sequence</object></type></variable> </docgroup> <docgroup homogen-name='subject_id' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> - <variable name='subject_id'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable> + <variable name='subject_id'><type><object>BitString</object></type></variable> </docgroup> <docgroup homogen-name='version' homogen-type='variable'> <variable name='version'><type><int/></type></variable> </docgroup> </class> <class name='rsa_verifier'> <docgroup homogen-name='Verifier' homogen-type='inherit'> <inherit name='Verifier'><classname>Verifier</classname></inherit> </docgroup> <docgroup homogen-name='init' homogen-type='method'> <method name='init'> <arguments><argument name='key'><type><string/></type></argument></arguments> <returntype><object resolved='8.0::Tools.X509.rsa_verifier'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='verify' homogen-type='method'> <method name='verify'> - <arguments><argument name='algorithm'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='msg'><type><string/></type></argument><argument name='signature'><type><string/></type></argument></arguments> + <arguments><argument name='algorithm'><type><object>Sequence</object></type></argument><argument name='msg'><type><string/></type></argument><argument name='signature'><type><string/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> </class> </module> </module> </namespace> <namespace name='cpp'> <doc><text>Pike has a builtin C-style preprocessor. It works similar to the ANSI-C preprocessor but has a few extra features. These and the default set of preprocessor macros are described here. </text></doc> <docgroup homogen-name='#!' homogen-type='directive'><doc><text>All lines beginning with <ref resolved='cpp::'>#!</ref> will be regarded as comments, to enable shell integration. It is recommended that Pike applications begin with the line <tt>"#! /usr/bin/env pike"</tt> for maximum cross platform compatibility. </text></doc> <directive name='#!'/> </docgroup> - <docgroup homogen-name='#""' homogen-type='directive'><doc><text>If a string literal is opened with <tt>#"</tt> newlines in the + <docgroup homogen-name='#""' homogen-type='directive'><doc><text>If a string literal is opened with <tt>#"</tt> newlines in the string will end up in the string literal, instead of triggering a <tt>"newline in string"</tt> error. </text><group><note/><text>Newlines will be converted to <tt>\n</tt> characters in the string even if the newlines in the file are something else. This preprocessor directive may appear anywhere a string may appear. </text></group><group><seealso/><text><ref resolved='cpp::'>#string</ref> </text></group></doc> - <directive name='#""'/> + <directive name='#""'/> </docgroup> <docgroup homogen-type='directive'><doc><text>A hash character followed by a number or by the string <tt>"line"</tt> and a number will make the preprocessor line counter set this number as the line number for the next line and adjust the following lines accordingly. All error messages from Pike will use these line numbers. Optionally the number may be followed by a file name, e.g. <tt>#line 1 "/home/pike/program.pike.in"</tt>. Then this filename will be used instead of the current file for error messages.
autodoc.git/onepage.xml:9602: </text></group></dl>Unless something else is mentioned above, <ref resolved='predef::filter.fun'>fun</ref> is used as filter like this: <dl><group><item name='function'/><text><ref resolved='predef::filter.fun'>fun</ref> is called for each element. It gets the current element as the first argument and <ref resolved='predef::filter.extra'>extra</ref> as the rest. The element is kept if it returns true, otherwise it's filtered out. </text></group><group><item name='object'/><text>The object is used as a function like above, i.e. the <ref resolved='lfun::`()'>lfun::`()</ref> method in it is called. </text></group><group><item name='multiset'/><item name='mapping'/><text><ref resolved='predef::filter.fun'>fun</ref> is indexed with each element. The element is kept if the result is nonzero, otherwise it's filtered out. - </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::filter.extra'>extra</ref> as + </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::filter.extra'>extra</ref> as arguments. The element is kept if the result of the call is nonzero, otherwise it's filtered out. Elements that aren't callable are also filtered out. </text></group><group><item name='string'/><text>Each element is indexed with the given string. If the result of that is zero then the element is filtered out, otherwise the result is called with <ref resolved='predef::filter.extra'>extra</ref> as arguments. The element is kept if the return value is nonzero, otherwise it's filtered out. This is typically used when <ref resolved='predef::filter.arr'>arr</ref> is a collection of objects, and <ref resolved='predef::filter.fun'>fun</ref> is the name of some predicate function
autodoc.git/onepage.xml:10424: a multiset, in that order, which is then handled as described above. </text></group></dl><ref resolved='predef::map.fun'>fun</ref> is applied in different ways depending on its type: <dl><group><item name='function'/><text><ref resolved='predef::map.fun'>fun</ref> is called for each element. It gets the current element as the first argument and <ref resolved='predef::map.extra'>extra</ref> as the rest. The result of the call is collected. </text></group><group><item name='object'/><text><ref resolved='predef::map.fun'>fun</ref> is used as a function like above, i.e. the <ref resolved='lfun::`()'>lfun::`()</ref> method in it is called. </text></group><group><item name='multiset'/><item name='mapping'/><text><ref resolved='predef::map.fun'>fun</ref> is indexed with each element. The result of that is collected. - </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::map.extra'>extra</ref> as + </text></group><group><item name='"zero or left out"'/><text>Each element that is callable is called with <ref resolved='predef::map.extra'>extra</ref> as arguments. The result of the calls are collected. Elements that aren't callable gets zero as result. </text></group><group><item name='string'/><text>Each element is indexed with the given string. If the result of that is zero then a zero is collected, otherwise it's called with <ref resolved='predef::map.extra'>extra</ref> as arguments and the result of that call is collected. This is typically used when <ref resolved='predef::map.arr'>arr</ref> is a collection of objects, and <ref resolved='predef::map.fun'>fun</ref> is the name of some function in them. </text></group></dl> </text><group><note/><text>The function is never destructive on <ref resolved='predef::map.arr'>arr</ref>.
autodoc.git/onepage.xml:12386: tree[val] = idx; } foreach(tree; float|int key; mixed val) { // in here the keys will be reached in order 14.2, 80.4 and 99.9. } </text></code></text></group><group><example/><text><code><text>ADT.CritBit.FloatTree tree = ADT.CritBit.FloatTree(); array(float|int) a = ({ 80.4, 99.9, 14.2 }); foreach (a; int idx; float|int val) { tree[val] = idx; } - foreach(ADT.CritBit.FloatTree.Iterator(tree, -1); float|int key; mixed val) { + foreach(ADT.CritBit.FloatTree.Iterator (tree, -1); float|int key; mixed val) { // in here the keys will be reached in order 99.9, 80.4 and 14.2. } - </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.FloatTree.Iterator</ref> + </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.FloatTree.Iterator </ref> </text></group></doc> <docgroup homogen-name='_equal' homogen-type='method'> <method name='_equal'> <arguments><argument name='o'><type><mixed/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='_indices' homogen-type='method'><doc><text>Returns a sorted array of indices of the <ref resolved='predef::ADT.CritBit.FloatTree'>FloatTree</ref>. </text></doc> <method name='_indices'>
autodoc.git/onepage.xml:12612: tree[val] = idx; } foreach(tree; string key; mixed val) { // in here the keys will be reached in order "10.243.7.1", "127.0.0.1/8" and "172.16.5.2". } </text></code></text></group><group><example/><text><code><text>ADT.CritBit.IPv4Tree tree = ADT.CritBit.IPv4Tree(); array(string) a = ({ "10.243.7.1", "127.0.0.1/8", "172.16.5.2" }); foreach (a; int idx; string val) { tree[val] = idx; } - foreach(ADT.CritBit.IPv4Tree.Iterator(tree, -1); string key; mixed val) { + foreach(ADT.CritBit.IPv4Tree.Iterator (tree, -1); string key; mixed val) { // in here the keys will be reached in order "172.16.5.2", "127.0.0.1/8" and "10.243.7.1". } - </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.IPv4Tree.Iterator</ref> + </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.IPv4Tree.Iterator </ref> </text></group></doc> <docgroup homogen-name='_equal' homogen-type='method'> <method name='_equal'> <arguments><argument name='o'><type><mixed/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='_indices' homogen-type='method'><doc><text>Returns a sorted array of indices of the <ref resolved='predef::ADT.CritBit.IPv4Tree'>IPv4Tree</ref>. </text></doc> <method name='_indices'>
autodoc.git/onepage.xml:12846: tree[val] = idx; } foreach(tree; int key; mixed val) { // in here the keys will be reached in order 3, 1025 and 15000. } </text></code></text></group><group><example/><text><code><text>ADT.CritBit.IntTree tree = ADT.CritBit.IntTree(); array(int) a = ({ 1025, 15000, 3 }); foreach (a; int idx; int val) { tree[val] = idx; } - foreach(ADT.CritBit.IntTree.Iterator(tree, -1); int key; mixed val) { + foreach(ADT.CritBit.IntTree.Iterator (tree, -1); int key; mixed val) { // in here the keys will be reached in order 15000, 1025 and 3. } - </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.IntTree.Iterator</ref> + </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.IntTree.Iterator </ref> </text></group></doc> <docgroup homogen-name='_equal' homogen-type='method'> <method name='_equal'> <arguments><argument name='o'><type><mixed/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='_indices' homogen-type='method'><doc><text>Returns a sorted array of indices of the <ref resolved='predef::ADT.CritBit.IntTree'>IntTree</ref>. </text></doc> <method name='_indices'>
autodoc.git/onepage.xml:13095: tree[val] = idx; } foreach(tree; string key; mixed val) { // in here the keys will be reached in order "ahead", "bar" and "foo". } </text></code></text></group><group><example/><text><code><text>ADT.CritBit.StringTree tree = ADT.CritBit.StringTree(); array(string) a = ({ "fooo", "bar", "ahead" }); foreach (a; int idx; string val) { tree[val] = idx; } - foreach(ADT.CritBit.StringTree.Iterator(tree, -1); string key; mixed val) { + foreach(ADT.CritBit.StringTree.Iterator (tree, -1); string key; mixed val) { // in here the keys will be reached in order "foo", "bar" and "ahead". } - </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.StringTree.Iterator</ref> + </text></code></text></group><group><seealso/><text><ref>ADT.CritBit.StringTree.Iterator </ref> </text></group></doc> <docgroup homogen-name='_equal' homogen-type='method'> <method name='_equal'> <arguments><argument name='o'><type><mixed/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='_indices' homogen-type='method'><doc><text>Returns a sorted array of indices of the <ref resolved='predef::ADT.CritBit.StringTree'>StringTree</ref>. </text></doc> <method name='_indices'>
autodoc.git/onepage.xml:18084: <returntype><object resolved='predef::Calendar.Event.Event'>Event.Event</object></returntype> </method> <method name='`->'> <arguments><argument name='region'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Calendar.Event.Event'>Event.Event</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Calendar'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Calendar'>"."</classname></import> </docgroup> </module> <module name='Gregorian'> <doc><text>This is the standard conservative christian calendar, used regularly in some countries - USA, for instance - and which derivate - the <ref resolved='predef::Calendar.ISO'>ISO</ref> calendar - is used in most of Europe. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import>
autodoc.git/onepage.xml:21915: </docgroup> <docgroup homogen-name='get_default_module' homogen-type='method'><doc><text>Get the default module for the current compatibility level (ie typically the value returned by <ref resolved='predef::all_constants'>predef::all_constants()</ref>). The default implementation calls the corresponding function in the master object. </text><group><returns/><text><mixed><group><type><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></type><text>Constant table to use. </text></group><group><type><int><min>0</min><max>0</max></int></type><text>Use the builtin constant table. </text></group></mixed> </text></group><group><note/><text>This function is typically called by <ref>Pike_compiler()->get_default_module()</ref>. - </text></group><group><seealso/><text><ref resolved='predef::MasterObject.CompatResolver.get_default_module'>MasterObject()->get_default_module()</ref>. + </text></group><group><seealso/><text><ref resolved='predef::CompilationHandler.get_default_module'>MasterObject()->get_default_module()</ref>. </text></group></doc> <method name='get_default_module'> <arguments/> <returntype><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></returntype> </method> </docgroup> <docgroup homogen-name='handle_inherit' homogen-type='method'><doc><text>Look up an inherit <ref resolved='predef::CompilerEnvironment.handle_inherit.inh'>inh</ref>. The default implementation calls the corresponding function in the master object. </text><group><seealso/><text><ref resolved='predef::MasterObject.handle_inherit'>MasterObject()->handle_inherit()</ref>.
autodoc.git/onepage.xml:26442: <ref resolved='predef::Fuse.Operations'>Operations</ref> class, clone it and pass it to the <ref resolved='predef::Fuse.run'>run</ref> method. You do not need to implemnent all functions, but at least getattr, readdir and read are needed to make a useable filesystem. A tip: ERRNO constants are available in the System module, and if one is missing /usr/include/asm[-generic]/errno.h can be included in pike programs on Linux. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Fuse"' homogen-type='inherit'> - <inherit name='"___Fuse"'><classname>"___Fuse"</classname></inherit> + <docgroup homogen-name='"___Fuse"' homogen-type='inherit'> + <inherit name='"___Fuse"'><classname>"___Fuse"</classname></inherit> </docgroup> <docgroup homogen-name='run' homogen-type='method'><doc><text>Start fuse. Args is as in argv in main(). This function will not return. The first argument (argv[0], program name) is used as the filesystem name. The first non-flag argument after argv[0] is used as the mountpoint. Otherwise these arguments are supported: <pre> -d enable debug output (implies -f) -f foreground operation -s disable multithreaded operation
autodoc.git/onepage.xml:43465: <method name='set'> <arguments><argument name='xalign'><type><float/></type></argument><argument name='yalign'><type><float/></type></argument><argument name='xscale'><type><float/></type></argument><argument name='yscale'><type><float/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Alignment'>GTK1.Alignment</object></returntype> </method> </docgroup> </class> <class name='Arrow'> <doc><text>An arrow pointing in one of four directions. The 'etched' shadow types does not work. <expr> GTK1.Arrow(GTK1.ARROW_UP, GTK1.SHADOW_OUT)</expr> - <image file='predef.GTK1.Arrow.1.png' height='11' width='11'>../images/gtk1_arrow.png</image> + <image file='predef.GTK1.Arrow.1.png'>../images/gtk1_arrow.png</image> <expr> GTK1.Arrow(GTK1.ARROW_LEFT, GTK1.SHADOW_IN)</expr> - <image file='predef.GTK1.Arrow.2.png' height='11' width='11'>../images/gtk1_arrow_2.png</image> + <image file='predef.GTK1.Arrow.2.png'>../images/gtk1_arrow_2.png</image> <expr> GTK1.Arrow(GTK1.ARROW_RIGHT, GTK1.SHADOW_IN)</expr> - <image file='predef.GTK1.Arrow.3.png' height='11' width='11'>../images/gtk1_arrow_3.png</image> + <image file='predef.GTK1.Arrow.3.png'>../images/gtk1_arrow_3.png</image> <expr> GTK1.Arrow(GTK1.ARROW_DOWN, GTK1.SHADOW_OUT)</expr> - <image file='predef.GTK1.Arrow.4.png' height='11' width='11'>../images/gtk1_arrow_4.png</image> + <image file='predef.GTK1.Arrow.4.png'>../images/gtk1_arrow_4.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>First argument is one of <ref resolved='predef::GTK1.ARROW_DOWN'>ARROW_DOWN</ref>, <ref resolved='predef::GTK1.ARROW_LEFT'>ARROW_LEFT</ref>, <ref resolved='predef::GTK1.ARROW_RIGHT'>ARROW_RIGHT</ref> and <ref resolved='predef::GTK1.ARROW_UP'>ARROW_UP</ref>, second one of <ref resolved='predef::GTK1.SHADOW_ETCHED_IN'>SHADOW_ETCHED_IN</ref>, <ref resolved='predef::GTK1.SHADOW_ETCHED_OUT'>SHADOW_ETCHED_OUT</ref>, <ref resolved='predef::GTK1.SHADOW_IN'>SHADOW_IN</ref>, <ref resolved='predef::GTK1.SHADOW_NONE'>SHADOW_NONE</ref> and <ref resolved='predef::GTK1.SHADOW_OUT'>SHADOW_OUT</ref>. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='arrow_type'><type><int/></type></argument><argument name='shadow_type'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Arrow'>GTK1.Arrow</object></returntype> </method> </docgroup> <docgroup homogen-name='get_arrow_type' homogen-type='method'><doc><text>Return the arrow type. One of <ref resolved='predef::GTK1.ARROW_DOWN'>ARROW_DOWN</ref>, <ref resolved='predef::GTK1.ARROW_LEFT'>ARROW_LEFT</ref>, <ref resolved='predef::GTK1.ARROW_RIGHT'>ARROW_RIGHT</ref> and <ref resolved='predef::GTK1.ARROW_UP'>ARROW_UP</ref>. </text></doc>
autodoc.git/onepage.xml:43509: <method name='set'> <arguments><argument name='arrow_type'><type><int/></type></argument><argument name='shadow_type'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Arrow'>GTK1.Arrow</object></returntype> </method> </docgroup> </class> <class name='AspectFrame'> <doc><text>A W(Frame) widget that always maintain a specified ratio between width and height. width/height == ratio <expr> GTK1.AspectFrame("Title",0.5,0.5,0.4,0)->add( GTK1.Label("Wrong aspect"))->set_usize(200,200)</expr> - <image file='predef.GTK1.AspectFrame.1.png' height='32' width='219'>../images/gtk1_aspectframe.png</image> + <image file='predef.GTK1.AspectFrame.1.png'>../images/gtk1_aspectframe.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new frame. Arguments are label, xalign, yalign, ratio, obey_child xalign is floats between 0 and 1, 0.0 is upper (or leftmost), 1.0 is lower (or rightmost). If 'obey_child' is true, the frame will use the aspect ratio of it's (one and only) child widget instead of 'ratio'. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='label'><type><string/></type></argument><argument name='xalign'><type><float/></type></argument><argument name='yalign'><type><float/></type></argument><argument name='ratio'><type><float/></type></argument><argument name='obey_child'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.AspectFrame'>GTK1.AspectFrame</object></returntype> </method>
autodoc.git/onepage.xml:43637: <method name='set_spacing'> <arguments><argument name='spacing'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Box'>GTK1.Box</object></returntype> </method> </docgroup> </class> <class name='Button'> <doc><text>A container that can only contain one child, and accepts events. draws a bevelbox around itself. <expr> GTK1.Button("A button")</expr> - <image file='predef.GTK1.Button.1.png' height='19' width='48'>../images/gtk1_button.png</image> + <image file='predef.GTK1.Button.1.png'>../images/gtk1_button.png</image> <expr> GTK1.Button("A button\nwith multiple lines\nof text")</expr> - <image file='predef.GTK1.Button.2.png' height='45' width='97'>../images/gtk1_button_2.png</image> + <image file='predef.GTK1.Button.2.png'>../images/gtk1_button_2.png</image> <expr> GTK1.Button()->add(GTK1.Image(GDK1.Image(0)->set(Image.Image(100,40)->test())))</expr> - <image file='predef.GTK1.Button.3.png' height='32' width='219'>../images/gtk1_button_3.png</image> + <image file='predef.GTK1.Button.3.png'>../images/gtk1_button_3.png</image> Signals: clicked Called when the button is pressed, and then released enter Called when the mouse enters the button leave Called when the mouse leaves the button pressed Called when the button is pressed released
autodoc.git/onepage.xml:43892: </text></doc> <method name='get_parent'> <arguments/> <returntype><object resolved='predef::GTK1.CTreeNode'>GTK1.CTreeNode</object></returntype> </method> </docgroup> </class> <class name='Calendar'> <doc><text>A calendar widget. <expr> GTK1.Calendar();</expr> - <image file='predef.GTK1.Calendar.1.png' height='113' width='187'>../images/gtk1_calendar.png</image> + <image file='predef.GTK1.Calendar.1.png'>../images/gtk1_calendar.png</image> <expr> GTK1.Calendar()->select_day( 16 );</expr> - <image file='predef.GTK1.Calendar.2.png' height='113' width='187'>../images/gtk1_calendar_2.png</image> + <image file='predef.GTK1.Calendar.2.png'>../images/gtk1_calendar_2.png</image> Signals: day_selected day_selected_double_click month_changed next_month next_year prev_month prev_year </text></doc> <docgroup homogen-name='clear_marks' homogen-type='method'><doc><text>Remove all day markers
autodoc.git/onepage.xml:44072: </method> </docgroup> </class> <class name='CheckButton'> <doc><text>Check buttons inherent many properties and functions from the the toggle buttons, but look a little different. Rather than being buttons with text inside them, they are small squares with the text to the right of them. These are often used for toggling options on and off in applications. <expr> GTK1.CheckButton( "title" )</expr> - <image file='predef.GTK1.CheckButton.1.png' height='32' width='219'>../images/gtk1_checkbutton.png</image> + <image file='predef.GTK1.CheckButton.1.png'>../images/gtk1_checkbutton.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>The argument, if specified, is the label of the item. If no label is specified, use object->add() to add some other widget (such as an pixmap or image widget) </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='label'><type><or><string/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK1.CheckButton'>GTK1.CheckButton</object></returntype> </method> </docgroup> <docgroup homogen-name='ToggleButton' homogen-type='inherit'> <inherit name='ToggleButton'><classname resolved='predef::GTK1.ToggleButton'>GTK1.ToggleButton</classname></inherit> </docgroup> </class> <class name='CheckMenuItem'> <doc><text>A check menu item is more or less identical to a check button, but it should be used in menus. <expr> GTK1.CheckMenuItem("Hi there")</expr> - <image file='predef.GTK1.CheckMenuItem.1.png' height='17' width='50'>../images/gtk1_checkmenuitem.png</image> + <image file='predef.GTK1.CheckMenuItem.1.png'>../images/gtk1_checkmenuitem.png</image> <expr> GTK1.CheckMenuItem("Hi there")->set_active(1)</expr> - <image file='predef.GTK1.CheckMenuItem.2.png' height='17' width='50'>../images/gtk1_checkmenuitem_2.png</image> + <image file='predef.GTK1.CheckMenuItem.2.png'>../images/gtk1_checkmenuitem_2.png</image> Signals: toggled Called when the state of the menu item is changed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>The argument, if specified, is the label of the item. If no label is specified, use object->add() to add some other widget (such as an pixmap or image widget) </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='label'><type><or><string/><void/></or></type></argument></arguments>
autodoc.git/onepage.xml:44138: <returntype><object resolved='predef::GTK1.CheckMenuItem'>GTK1.CheckMenuItem</object></returntype> </method> </docgroup> </class> <class name='Clist'> <doc><text>The GtkCList widget is a multi-column list widget that is capable of handling literally thousands of rows of information. Each column can optionally have a title, which itself is optionally active, allowing us to bind a function to it's selection. <expr> GTK1.Clist(2)->set_column_title(0,"Col 1")->set_column_title(1,"Col 2")->column_titles_show()->set_column_width(0,50)->set_usize(150,70)</expr> - <image file='predef.GTK1.Clist.1.png' height='70' width='150'>../images/gtk1_clist.png</image> + <image file='predef.GTK1.Clist.1.png'>../images/gtk1_clist.png</image> Signals: abort_column_resize click_column Called when a column is clicked end_selection extend_selection resize_column Called when a column is resized scroll_horizontal scroll_vertical
autodoc.git/onepage.xml:44809: count up and count down modes. The clock widget could conceivably be used in such applications as an application's status bar, or as the basis for a panel applet, etc. Three modes of operation are supported. These are realtime - which displays the current time, count-up/increasing - which counts up from an initial value (like a stopwatch), and count-down/decreasing - which counts down from an initial value. Note, however, that the accuracy of the gtkclock widget is limited to 1 second. <expr> GTK1.Clock( GTK1.ClockRealtime );</expr> - <image file='predef.GTK1.Clock.1.png' height='13' width='26'>../images/gtk1_clock.png</image> + <image file='predef.GTK1.Clock.1.png'>../images/gtk1_clock.png</image> <expr> GTK1.Clock( GTK1.ClockDecreasing )->set_seconds(10000)->start();</expr> - <image file='predef.GTK1.Clock.2.png' height='13' width='40'>../images/gtk1_clock_2.png</image> + <image file='predef.GTK1.Clock.2.png'>../images/gtk1_clock_2.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>type is one of <ref resolved='predef::GTK1.CLOCK_DECREASING'>CLOCK_DECREASING</ref>, <ref resolved='predef::GTK1.CLOCK_INCREASING'>CLOCK_INCREASING</ref> and <ref resolved='predef::GTK1.CLOCK_REALTIME'>CLOCK_REALTIME</ref>; </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='type'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Clock'>GTK1.Clock</object></returntype> </method> </docgroup> <docgroup homogen-name='Label' homogen-type='inherit'> <inherit name='Label'><classname resolved='predef::GTK1.Label'>GTK1.Label</classname></inherit>
autodoc.git/onepage.xml:44888: user select a color by manipulating RGB (Red, Green, Blue) and HSV (Hue, Saturation, Value) triples. This is done either by adjusting single values with sliders or entries, or by picking the desired color from a hue-saturation wheel/value bar. Optionally, the opacity of the color can also be set. The color selection widget currently emits only one signal, "color_changed", which is emitted whenever the current color in the widget changes, either when the user changes it or if it's set explicitly through set_color(). <expr> GTK1.ColorSelection()</expr> - <image file='predef.GTK1.ColorSelection.1.png' height='183' width='416'>../images/gtk1_colorselection.png</image> + <image file='predef.GTK1.ColorSelection.1.png'>../images/gtk1_colorselection.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new color selection. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.ColorSelection'>GTK1.ColorSelection</object></returntype> </method> </docgroup> <docgroup homogen-name='get_color' homogen-type='method'><doc><text>When you need to query the current color, typically when you've received a "color_changed" signal, you use this function. The
autodoc.git/onepage.xml:44940: <arguments><argument name='policy'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.ColorSelection'>GTK1.ColorSelection</object></returntype> </method> </docgroup> </class> <class name='ColorSelectionDialog'> <doc><text>The color selection dialog widget is, not surprisingly, a color selection widget in a dialog window. Use the subwidget functions below to access the different subwidgets directly. <expr> GTK1.ColorSelectionDialog("Select color")</expr> - <image file='predef.GTK1.ColorSelectionDialog.1.png' height='227' width='420'>../images/gtk1_colorselectiondialog.png</image> + <image file='predef.GTK1.ColorSelectionDialog.1.png'>../images/gtk1_colorselectiondialog.png</image> Signals: color_changed Called when the color is changed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new color selection dialog with the specified title. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='title'><type><string/></type></argument></arguments> <returntype><object resolved='predef::GTK1.ColorSelectionDialog'>GTK1.ColorSelectionDialog</object></returntype> </method>
autodoc.git/onepage.xml:44994: <class name='Combo'> <doc><text>Thee combo box is another fairly simple widget that is really just a collection of other widgets. From the user's point of view, the widget consists of a text entry box and a pull down menu from which the user can select one of a set of predefined entries. Alternatively, the user can type a different option directly into the text box. The combo box has two principal parts that you as the programmer really care about: The W(entry) and the W(list). <expr> GTK1.Combo()</expr> - <image file='predef.GTK1.Combo.1.png' height='19' width='175'>../images/gtk1_combo.png</image> + <image file='predef.GTK1.Combo.1.png'>../images/gtk1_combo.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new combo box </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Combo'>GTK1.Combo</object></returntype> </method> </docgroup> <docgroup homogen-name='disable_activate' homogen-type='method'><doc><text>This will disable the 'activate' signal for the entry widget in the combo box.
autodoc.git/onepage.xml:45663: <docgroup homogen-name='unselect_recursive' homogen-type='method'><doc><text>Unselect a node and it's children. </text></doc> <method name='unselect_recursive'> <arguments><argument name='node'><type><object resolved='predef::GTK1.CTreeNode'>GTK1.CTreeNode</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.Ctree'>GTK1.Ctree</object></returntype> </method> </docgroup> </class> <class name='Curve'> <doc><text><expr> GTK1.Curve()</expr> - <image file='predef.GTK1.Curve.1.png' height='8' width='8'>../images/gtk1_curve.png</image> + <image file='predef.GTK1.Curve.1.png'>../images/gtk1_curve.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Curve'>GTK1.Curve</object></returntype> </method> </docgroup> <docgroup homogen-name='get_vector' homogen-type='method'> <method name='get_vector'> <arguments><argument name='num_points'><type><int/></type></argument></arguments>
autodoc.git/onepage.xml:45729: </docgroup> </class> <class name='Databox'> <doc><text>GtkDatabox is designed to display large amounts of numerical data fast and easy. Thousands of data points (X and Y coordinate) may be displayed without any problems, zooming and scrolling as well as optional rulers are already included. The widget may be used as display for oscilloscopes or other applications that need to display fast changes in their data. <expr> GTK1.Databox x=GTK1.Databox(); x->data_add_x_y(3, ({ 1.0, 0.5, 0.0 }), ({1.0, -1.0, 0.0}),GDK1.Color(Image.Color.red), GTK1.DataboxLines,2); x->rescale(); x->set_usize(300,300); return x;</expr> - <image file='predef.GTK1.Databox.1.png' height='32' width='219'>../images/gtk1_databox.png</image> + <image file='predef.GTK1.Databox.1.png'>../images/gtk1_databox.png</image> Signals: marked selection_canceled selection_changed selection_started selection_stopped zoomed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new databox widget </text></doc>
autodoc.git/onepage.xml:45878: <arguments/> <returntype><object resolved='predef::GTK1.Databox'>GTK1.Databox</object></returntype> </method> </docgroup> </class> <class name='Dial'> <doc><text>This widget provides an analog dial widget, similar to, for example, a physical volume control on a stereo. Dial values can be changable or read-only for value reporting. <expr> GTK1.Dial( GTK1.Adjustment() );</expr> - <image file='predef.GTK1.Dial.1.png' height='75' width='75'>../images/gtk1_dial.png</image> + <image file='predef.GTK1.Dial.1.png'>../images/gtk1_dial.png</image> <expr> GTK1.Dial( GTK1.Adjustment(10.0) )->set_percentage(0.4);</expr> - <image file='predef.GTK1.Dial.2.png' height='75' width='75'>../images/gtk1_dial_2.png</image> + <image file='predef.GTK1.Dial.2.png'>../images/gtk1_dial_2.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='adjustment'><type><object resolved='predef::GTK1.Adjustment'>GTK1.Adjustment</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.Dial'>GTK1.Dial</object></returntype> </method> </docgroup> <docgroup homogen-name='get_adjustment' homogen-type='method'> <method name='get_adjustment'> <arguments/>
autodoc.git/onepage.xml:46009: <docgroup homogen-name='Window' homogen-type='inherit'> <inherit name='Window'><classname resolved='predef::GTK1.Window'>GTK1.Window</classname></inherit> </docgroup> </class> <class name='DrawingArea'> <doc><text>The drawing area is a window you can draw in. Please note that you must handle refresh and resize events on your own. Use W(pDrawingArea) for a drawingarea with automatic refresh/resize handling. <expr> GTK1.DrawingArea()->set_usize(100,100)</expr> - <image file='predef.GTK1.DrawingArea.1.png' height='100' width='100'>../images/gtk1_drawingarea.png</image> + <image file='predef.GTK1.DrawingArea.1.png'>../images/gtk1_drawingarea.png</image> </text></doc> <docgroup homogen-name='clear' homogen-type='method'><doc><text>Either clears the rectangle defined by the arguments, of if no arguments are specified, the whole drawable. </text></doc> <method name='clear'> <arguments><argument name='x'><type><or><int/><void/></or></type></argument><argument name='y'><type><or><int/><void/></or></type></argument><argument name='width'><type><or><int/><void/></or></type></argument><argument name='height'><type><or><int/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK1.DrawingArea'>GTK1.DrawingArea</object></returntype> </method> </docgroup> <docgroup homogen-name='copy_area' homogen-type='method'><doc><text>Copies the rectangle defined by xsource,ysource and width,height
autodoc.git/onepage.xml:46295: </text></doc> <method name='set_position'> <arguments><argument name='pos'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Editable'>GTK1.Editable</object></returntype> </method> </docgroup> </class> <class name='Entry'> <doc><text>Use this widget when you want the user to input a single line of text. <expr> GTK1.Entry()->set_text("Hello world")->set_editable(1)</expr> - <image file='predef.GTK1.Entry.1.png' height='19' width='158'>../images/gtk1_entry.png</image> + <image file='predef.GTK1.Entry.1.png'>../images/gtk1_entry.png</image> </text></doc> <docgroup homogen-name='append_text' homogen-type='method'><doc><text>Append the specified string at the end of the entry </text></doc> <method name='append_text'> <arguments><argument name='text'><type><string/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Entry'>GTK1.Entry</object></returntype> </method> </docgroup> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers>
autodoc.git/onepage.xml:46369: have an associated X window. Not having an X window saves memory and improves performance, but also has some drawbacks. A widget without an X window cannot receive events, and does not perform any clipping on it's contents. Although the name EventBox emphasizes the event-handling function, the widget can also be used for clipping. The primary use for this widget is when you want to receive events for a widget without a window. Examples of such widgets are labels and images. <expr> GTK1.EventBox()->set_usize(100,100)</expr> - <image file='predef.GTK1.EventBox.1.png' height='100' width='100'>../images/gtk1_eventbox.png</image> + <image file='predef.GTK1.EventBox.1.png'>../images/gtk1_eventbox.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new event box widget </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.EventBox'>GTK1.EventBox</object></returntype> </method> </docgroup> <docgroup homogen-name='Bin' homogen-type='inherit'> <inherit name='Bin'><classname resolved='predef::GTK1.Bin'>GTK1.Bin</classname></inherit>
autodoc.git/onepage.xml:46400: The default filename can be set using set_filename() and the selected filename retrieved using get_filename(). Use complete() to display files that match a given pattern. This can be used for example, to show only *.txt files, or only files beginning with gtk*. Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using hide_fileop_buttons() and shown again using show_fileop_buttons(). <expr> GTK1.FileSelection("File selector")</expr> - <image file='predef.GTK1.FileSelection.1.png' height='356' width='421'>../images/gtk1_fileselection.png</image> + <image file='predef.GTK1.FileSelection.1.png'>../images/gtk1_fileselection.png</image> </text></doc> <docgroup homogen-name='complete' homogen-type='method'><doc><text>Will attempt to match pattern to a valid filename in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog. If a partial match can be made, the "Files" list will contain those file names which have been partially matched. </text></doc> <method name='complete'> <arguments><argument name='pattern'><type><string/></type></argument></arguments> <returntype><object resolved='predef::GTK1.FileSelection'>GTK1.FileSelection</object></returntype>
autodoc.git/onepage.xml:46529: <arguments/> <returntype><object resolved='predef::GTK1.FileSelection'>GTK1.FileSelection</object></returntype> </method> </docgroup> </class> <class name='Fixed'> <doc><text>A fixed container is a container that keeps it's children at fixed locations and give them fixed sizes, both given in pixels. Example: <expr> GTK1.Fixed()->put(GTK1.Label("100,100"), 100, 100)->put(GTK1.Label("0,0"), 0, 0)->set_usize(150,115)</expr> - <image file='predef.GTK1.Fixed.1.png' height='115' width='150'>../images/gtk1_fixed.png</image> + <image file='predef.GTK1.Fixed.1.png'>../images/gtk1_fixed.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new fixed widget </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Fixed'>GTK1.Fixed</object></returntype> </method> </docgroup> <docgroup homogen-name='Container' homogen-type='inherit'> <inherit name='Container'><classname resolved='predef::GTK1.Container'>GTK1.Container</classname></inherit>
autodoc.git/onepage.xml:46558: <docgroup homogen-name='put' homogen-type='method'><doc><text>Place the widget at xpos,ypos. </text></doc> <method name='put'> <arguments><argument name='widget'><type><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></type></argument><argument name='x'><type><int/></type></argument><argument name='y'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Fixed'>GTK1.Fixed</object></returntype> </method> </docgroup> </class> <class name='FontSelection'> <doc><text><expr> GTK1.FontSelection()</expr> - <image file='predef.GTK1.FontSelection.1.png' height='319' width='452'>../images/gtk1_fontselection.png</image> + <image file='predef.GTK1.FontSelection.1.png'>../images/gtk1_fontselection.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.FontSelection'>GTK1.FontSelection</object></returntype> </method> </docgroup> <docgroup homogen-name='get_font' homogen-type='method'> <method name='get_font'> <arguments/>
autodoc.git/onepage.xml:46621: Filters can be used to limit the fonts shown. There are 2 filters in the GtkFontSelectionDialog - a base filter and a user filter. The base filter can not be changed by the user, so this can be used when the user must choose from the restricted set of fonts (e.g. for a terminal-type application you may want to force the user to select a fixed-width font). The user filter can be changed or reset by the user, by using the 'Reset Filter' button or changing the options on the 'Filter' page of the dialog. <expr> GTK1.FontSelectionDialog("Select a font")</expr> - <image file='predef.GTK1.FontSelectionDialog.1.png' height='353' width='452'>../images/gtk1_fontselectiondialog.png</image> + <image file='predef.GTK1.FontSelectionDialog.1.png'>../images/gtk1_fontselectiondialog.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new font selection dialog with the specified window title </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='title'><type><string/></type></argument></arguments> <returntype><object resolved='predef::GTK1.FontSelectionDialog'>GTK1.FontSelectionDialog</object></returntype> </method> </docgroup> <docgroup homogen-name='get_apply_button' homogen-type='method'><doc><text>The apply button </text></doc>
autodoc.git/onepage.xml:46669: <inherit name='Window'><classname resolved='predef::GTK1.Window'>GTK1.Window</classname></inherit> </docgroup> </class> <class name='Frame'> <doc><text>The frame widget is a Bin that surrounds its child with a decorative frame and an optional label. If present, the label is drawn in a gap in the top side of the frame. The position of the label can be controlled with set_label_align(). Used to visually group objects. <expr> GTK1.Frame("Title")->add(GTK1.Label("Contents"))</expr> - <image file='predef.GTK1.Frame.1.png' height='27' width='48'>../images/gtk1_frame.png</image> + <image file='predef.GTK1.Frame.1.png'>../images/gtk1_frame.png</image> <expr> GTK1.Frame()->add(GTK1.Label("Contents"))</expr> - <image file='predef.GTK1.Frame.2.png' height='17' width='48'>../images/gtk1_frame_2.png</image> + <image file='predef.GTK1.Frame.2.png'>../images/gtk1_frame_2.png</image> <expr> GTK1.Frame()->add(GTK1.Label("Contents"))->set_shadow_type(GTK1.SHADOW_IN)</expr> - <image file='predef.GTK1.Frame.3.png' height='17' width='48'>../images/gtk1_frame_3.png</image> + <image file='predef.GTK1.Frame.3.png'>../images/gtk1_frame_3.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new W(Frame) widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='label_text'><type><or><string/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK1.Frame'>GTK1.Frame</object></returntype> </method> </docgroup> <docgroup homogen-name='Container' homogen-type='inherit'> <inherit name='Container'><classname resolved='predef::GTK1.Container'>GTK1.Container</classname></inherit>
autodoc.git/onepage.xml:46754: </class> <class name='GammaCurve'> <doc><text>A gamma curve widget.. Rather complex. Lets the user edit a gamma curve (a one-to-one mapping usually used to adjust the intensity of an image to the physical characteristics of the output device). You can set the minimum and maximum values for input and output. You can set the initial vector as well. You are guaranteed that every input value will have a (not necessarily unique) output value specified. <expr> GTK1.GammaCurve()->set_usize(210,130)</expr> - <image file='predef.GTK1.GammaCurve.1.png' height='130' width='210'>../images/gtk1_gammacurve.png</image> + <image file='predef.GTK1.GammaCurve.1.png'>../images/gtk1_gammacurve.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new gamma curve </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.GammaCurve'>GTK1.GammaCurve</object></returntype> </method> </docgroup> <docgroup homogen-name='get_curve' homogen-type='method'><doc><text>The actual curve </text></doc>
autodoc.git/onepage.xml:46888: <method name='signal_autoconnect_new'> <arguments><argument name='callbacks'><type><mapping/></type></argument><argument name='data'><type><mixed/></type></argument></arguments> <returntype><object resolved='predef::GTK1.GladeXML'>GTK1.GladeXML</object></returntype> </method> </docgroup> </class> <class name='HandleBox'> <doc><text>The contents of a handle box can be 'dragged' out of the box by the user. The contents will then be placed in a separate window. <expr> GTK1.HandleBox()->add(GTK1.Label("The contents"))</expr> - <image file='predef.GTK1.HandleBox.1.png' height='13' width='75'>../images/gtk1_handlebox.png</image> + <image file='predef.GTK1.HandleBox.1.png'>../images/gtk1_handlebox.png</image> Signals: child_attached Called when a new child is added to the box child_detached Called when a child is removed from the box </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new handle box widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/>
autodoc.git/onepage.xml:46984: </docgroup> </class> <class name='Hbox'> <doc><text>Most packing is done by creating boxes. These are invisible widget containers that we can pack our widgets into which come in two forms, a horizontal box, and a vertical box. This is the horizontal one. When packing widgets into a horizontal box, the objects are inserted horizontally from left to right or right to left depending on the call used. <expr> GTK1.Hbox(0,0)->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->pack_end_defaults(GTK1.Button("From right"))->pack_start_defaults(GTK1.Button("From left"))</expr> - <image file='predef.GTK1.Hbox.1.png' height='19' width='175'>../images/gtk1_hbox.png</image> + <image file='predef.GTK1.Hbox.1.png'>../images/gtk1_hbox.png</image> <expr> GTK1.Hbox(1,0)->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->pack_end_defaults(GTK1.Button("From right"))->pack_start_defaults(GTK1.Button("From left"))</expr> - <image file='predef.GTK1.Hbox.2.png' height='19' width='232'>../images/gtk1_hbox_2.png</image> + <image file='predef.GTK1.Hbox.2.png'>../images/gtk1_hbox_2.png</image> <expr> GTK1.Hbox(1,40)->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->pack_end_defaults(GTK1.Button("From right"))->pack_start_defaults(GTK1.Button("From left"))</expr> - <image file='predef.GTK1.Hbox.3.png' height='19' width='352'>../images/gtk1_hbox_3.png</image> + <image file='predef.GTK1.Hbox.3.png'>../images/gtk1_hbox_3.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new horizontal box widget. If all_same_size is true, all widgets will have exactly the same size. hpadding is added to the left and right of the children. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='all_same_size'><type><int/></type></argument><argument name='hpadding'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Hbox'>GTK1.Hbox</object></returntype> </method> </docgroup> <docgroup homogen-name='Box' homogen-type='inherit'> <inherit name='Box'><classname resolved='predef::GTK1.Box'>GTK1.Box</classname></inherit> </docgroup> </class> <class name='HbuttonBox'> <doc><text>A HbuttonBox is very similar to a Hbox. The major diffference is that the button box is made to pack buttons in, and has a few convenience function for normal button layouts. <expr> GTK1.HbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_usize(400,30)</expr> - <image file='predef.GTK1.HbuttonBox.1.png' height='30' width='400'>../images/gtk1_hbuttonbox.png</image> + <image file='predef.GTK1.HbuttonBox.1.png'>../images/gtk1_hbuttonbox.png</image> <expr> GTK1.HbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_SPREAD)->set_usize(400,30)</expr> - <image file='predef.GTK1.HbuttonBox.2.png' height='30' width='400'>../images/gtk1_hbuttonbox_2.png</image> + <image file='predef.GTK1.HbuttonBox.2.png'>../images/gtk1_hbuttonbox_2.png</image> <expr> GTK1.HbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_EDGE)->set_usize(400,30)</expr> - <image file='predef.GTK1.HbuttonBox.3.png' height='30' width='400'>../images/gtk1_hbuttonbox_3.png</image> + <image file='predef.GTK1.HbuttonBox.3.png'>../images/gtk1_hbuttonbox_3.png</image> <expr> GTK1.HbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_START)->set_usize(400,30)</expr> - <image file='predef.GTK1.HbuttonBox.4.png' height='30' width='400'>../images/gtk1_hbuttonbox_4.png</image> + <image file='predef.GTK1.HbuttonBox.4.png'>../images/gtk1_hbuttonbox_4.png</image> <expr> GTK1.HbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_END)->set_usize(400,30)</expr> - <image file='predef.GTK1.HbuttonBox.5.png' height='30' width='400'>../images/gtk1_hbuttonbox_5.png</image> + <image file='predef.GTK1.HbuttonBox.5.png'>../images/gtk1_hbuttonbox_5.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new horizontal button box </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.HbuttonBox'>GTK1.HbuttonBox</object></returntype> </method> </docgroup> <docgroup homogen-name='ButtonBox' homogen-type='inherit'> <inherit name='ButtonBox'><classname resolved='predef::GTK1.ButtonBox'>GTK1.ButtonBox</classname></inherit> </docgroup> </class> <class name='Hpaned'> <doc><text>The paned window widgets are useful when you want to divide an area into two parts, with the relative size of the two parts controlled by the user. A groove is drawn between the two portions with a handle that the user can drag to change the ratio. This widgets makes a horizontal division See W(Paned) for details. <expr> GTK1.Hpaned()->add1(GTK1.Label("Left\nSide\nOf\nPane"))->add2(GTK1.Label("Right\nSide\nOf\nPane"))->set_usize(100,100)</expr> - <image file='predef.GTK1.Hpaned.1.png' height='100' width='100'>../images/gtk1_hpaned.png</image> + <image file='predef.GTK1.Hpaned.1.png'>../images/gtk1_hpaned.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Hpaned'>GTK1.Hpaned</object></returntype> </method> </docgroup> <docgroup homogen-name='Paned' homogen-type='inherit'> <inherit name='Paned'><classname resolved='predef::GTK1.Paned'>GTK1.Paned</classname></inherit> </docgroup> </class> <class name='Hruler'> <doc><text>Ruler widgets are used to indicate the location of the mouse pointer in a given window. A window can have a vertical ruler spanning across the width and a horizontal ruler spanning down the height. A small triangular indicator on the ruler shows the exact location of the pointer relative to the ruler. <expr> GTK1.Hruler()->set_metric(GTK1.PIXELS)->set_range(0.0,100.0,50.0,100.0)->draw_ticks()->draw_pos()->set_usize(300,30)</expr> - <image file='predef.GTK1.Hruler.1.png' height='30' width='300'>../images/gtk1_hruler.png</image> + <image file='predef.GTK1.Hruler.1.png'>../images/gtk1_hruler.png</image> <expr> GTK1.Hruler()->set_metric(GTK1.CENTIMETERS)->set_range(0.0,100.0,50.0,100.0)->draw_ticks()->draw_pos()->set_usize(300,30)</expr> - <image file='predef.GTK1.Hruler.2.png' height='30' width='300'>../images/gtk1_hruler_2.png</image> + <image file='predef.GTK1.Hruler.2.png'>../images/gtk1_hruler_2.png</image> <expr> GTK1.Hruler()->set_usize(300,30)</expr> - <image file='predef.GTK1.Hruler.3.png' height='30' width='300'>../images/gtk1_hruler_3.png</image> + <image file='predef.GTK1.Hruler.3.png'>../images/gtk1_hruler_3.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new hruler widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Hruler'>GTK1.Hruler</object></returntype> </method> </docgroup> <docgroup homogen-name='Ruler' homogen-type='inherit'> <inherit name='Ruler'><classname resolved='predef::GTK1.Ruler'>GTK1.Ruler</classname></inherit>
autodoc.git/onepage.xml:47084: <class name='Hscale'> <doc><text>The GTK1.HScale widget is used to allow the user to select a value using a horizontal slider. A GTK1.Adjustment is used to set the initial value, the lower and upper bounds, and the step and page increments. See W(Scale) for details The position to show the current value, and the number of decimal places shown can be set using the parent W(Scale) class's functions. <expr> GTK1.Hscale(GTK1.Adjustment())->set_usize(300,30)</expr> - <image file='predef.GTK1.Hscale.1.png' height='30' width='300'>../images/gtk1_hscale.png</image> + <image file='predef.GTK1.Hscale.1.png'>../images/gtk1_hscale.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new hscale widget. The adjustment argument can either be an existing W(Adjustment), or 0, in which case one will be created for you. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='settings'><type><object resolved='predef::GTK1.Adjustment'>GTK1.Adjustment</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.Hscale'>GTK1.Hscale</object></returntype> </method> </docgroup> <docgroup homogen-name='Scale' homogen-type='inherit'> <inherit name='Scale'><classname resolved='predef::GTK1.Scale'>GTK1.Scale</classname></inherit> </docgroup> </class> <class name='Hscrollbar'> <doc><text>A horizontal scrollbar. General documentation: See W(Scrollbar) <expr> GTK1.Hscrollbar(GTK1.Adjustment())->set_usize(300,15)</expr> - <image file='predef.GTK1.Hscrollbar.1.png' height='15' width='300'>../images/gtk1_hscrollbar.png</image> + <image file='predef.GTK1.Hscrollbar.1.png'>../images/gtk1_hscrollbar.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new vscale widget. The adjustment argument can either be an existing W(Adjustment), or 0, in which case one will be created for you. Specifying 0 might actually be useful in this case, if you wish to pass the newly automatically created adjustment to the constructor function of some other widget which will configure it for you, such as a text widget. </text></doc> <method name='create'><modifiers><protected/></modifiers>
autodoc.git/onepage.xml:47125: <returntype><object resolved='predef::GTK1.Hscrollbar'>GTK1.Hscrollbar</object></returntype> </method> </docgroup> <docgroup homogen-name='Scrollbar' homogen-type='inherit'> <inherit name='Scrollbar'><classname resolved='predef::GTK1.Scrollbar'>GTK1.Scrollbar</classname></inherit> </docgroup> </class> <class name='Hseparator'> <doc><text>Simply creates a horizontal separator. No bells or whistles. <expr> GTK1.Hseparator()->set_usize(300,3)</expr> - <image file='predef.GTK1.Hseparator.1.png' height='3' width='300'>../images/gtk1_hseparator.png</image> + <image file='predef.GTK1.Hseparator.1.png'>../images/gtk1_hseparator.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new hseparator widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Hseparator'>GTK1.Hseparator</object></returntype> </method> </docgroup> <docgroup homogen-name='Separator' homogen-type='inherit'> <inherit name='Separator'><classname resolved='predef::GTK1.Separator'>GTK1.Separator</classname></inherit> </docgroup> </class> <class name='Image'> <doc><text>An image is a image object stored in client, not X server, memory. A pixmap, on the other hand, is a image object stored in the X-server. See GDK1.Image and GDK1.Pixmap. <expr> GTK1.Image( GDK1.Image(0)->set(Image.Image(200,200)->test() ) );</expr> - <image file='predef.GTK1.Image.1.png' height='200' width='200'>../images/gtk1_image.png</image> + <image file='predef.GTK1.Image.1.png'>../images/gtk1_image.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>You can skip the mask. The mask is used to mask the drawing of the image on it's background. It will not make the container transparent, though. Use shape_combine_mask on the container with the mask for that. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='image'><type><object resolved='predef::GDK1.Image'>GDK1.Image</object></type></argument><argument name='mask'><type><object resolved='predef::GDK1.Bitmap'>GDK1.Bitmap</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.Image'>GTK1.Image</object></returntype> </method> </docgroup>
autodoc.git/onepage.xml:47202: inputd = GTK1.InputDialog(); inputd-&gt;close_button()-&gt;signal_connect("clicked",inputd-&gt;hide, 0); inputd-&gt;save_button()-&gt;hide(); inputd-&gt;show(); } else inputd-&gt;show(); } </pre> <expr> GTK1.InputDialog()</expr> - <image file='predef.GTK1.InputDialog.1.png' height='75' width='113'>../images/gtk1_inputdialog.png</image> + <image file='predef.GTK1.InputDialog.1.png'>../images/gtk1_inputdialog.png</image> Signals: disable_device his signal is emitted when the user changes the mode of a device from a GDK_MODE_SCREEN or GDK_MODE_WINDOW to GDK_MODE_ENABLED enable_device This signal is emitted when the user changes the mode of a device from GDK_MODE_DISABLED to a GDK_MODE_SCREEN or GDK_MODE_WINDOW. </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new input dialog window. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/>
autodoc.git/onepage.xml:47283: </text></doc> <method name='toggle'> <arguments/> <returntype><object resolved='predef::GTK1.Item'>GTK1.Item</object></returntype> </method> </docgroup> </class> <class name='Label'> <doc><text>A simple text label. <expr> GTK1.Label("A simple text label")</expr> - <image file='predef.GTK1.Label.1.png' height='13' width='92'>../images/gtk1_label.png</image> + <image file='predef.GTK1.Label.1.png'>../images/gtk1_label.png</image> <expr> GTK1.Label("Multi\nline text\nlabel here")</expr> - <image file='predef.GTK1.Label.2.png' height='39' width='50'>../images/gtk1_label_2.png</image> + <image file='predef.GTK1.Label.2.png'>../images/gtk1_label_2.png</image> <expr> GTK1.Label("Multi\nline text\nlabel here")->set_justify(GTK1.JUSTIFY_LEFT)</expr> - <image file='predef.GTK1.Label.3.png' height='39' width='50'>../images/gtk1_label_3.png</image> + <image file='predef.GTK1.Label.3.png'>../images/gtk1_label_3.png</image> <expr> GTK1.Label("Multi\nline text\nlabel here")->set_justify(GTK1.JUSTIFY_RIGHT)</expr> - <image file='predef.GTK1.Label.4.png' height='39' width='50'>../images/gtk1_label_4.png</image> + <image file='predef.GTK1.Label.4.png'>../images/gtk1_label_4.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new label. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='text'><type><string/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Label'>GTK1.Label</object></returntype> </method> </docgroup> <docgroup homogen-name='Misc' homogen-type='inherit'> <inherit name='Misc'><classname resolved='predef::GTK1.Misc'>GTK1.Misc</classname></inherit>
autodoc.git/onepage.xml:47599: <returntype><object resolved='predef::GTK1.Menu'>GTK1.Menu</object></returntype> </method> </docgroup> </class> <class name='MenuBar'> <doc><text>Basically a horizontal W(Menu). The menu image cannot be grabbed automatically, but this is how you would create a menu all in one line. This is not the recommended coding style. <expr> GTK1.MenuBar()->add(GTK1.MenuItem("Menu")->set_submenu(GTK1.Menu()->add(GTK1.MenuItem("Sub")))->select()->activate())->add(GTK1.MenuItem("Bar"))</expr> - <image file='predef.GTK1.MenuBar.1.png' height='32' width='219'>../images/gtk1_menubar.png</image> + <image file='predef.GTK1.MenuBar.1.png'>../images/gtk1_menubar.png</image> </text></doc> <docgroup homogen-name='append' homogen-type='method'> <method name='append'> <arguments><argument name='menu'><type><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.MenuBar'>GTK1.MenuBar</object></returntype> </method> </docgroup> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments/>
autodoc.git/onepage.xml:47855: itself, but is used to derive subclasses which have alignment and padding attributes. The horizontal and vertical padding attributes allows extra space to be added around the widget. The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. Note that if the widget is added to a container in such a way that it expands automatically to fill its allocated area, the alignment settings will not alter the widgets position. <expr> GTK1.Vbox(0,0)->add(GTK1.Label("Label"))->set_usize(100,20)</expr> - <image file='predef.GTK1.Misc.1.png' height='20' width='100'>../images/gtk1_misc.png</image> + <image file='predef.GTK1.Misc.1.png'>../images/gtk1_misc.png</image> <expr> GTK1.Vbox(0,0)->add(GTK1.Label("Label")->set_alignment(1.0,0.0))->set_usize(100,20)</expr> - <image file='predef.GTK1.Misc.2.png' height='20' width='100'>../images/gtk1_misc_2.png</image> + <image file='predef.GTK1.Misc.2.png'>../images/gtk1_misc_2.png</image> <expr> GTK1.Vbox(0,0)->add(GTK1.Label("Label")->set_alignment(0.0,0.0))->set_usize(100,20)</expr> - <image file='predef.GTK1.Misc.3.png' height='20' width='100'>../images/gtk1_misc_3.png</image> + <image file='predef.GTK1.Misc.3.png'>../images/gtk1_misc_3.png</image> </text></doc> <docgroup homogen-name='get_xalign' homogen-type='method'><doc><text>The horizontal alignment, from 0 (left) to 1 (right). </text></doc> <method name='get_xalign'> <arguments/> <returntype><float/></returntype> </method> </docgroup> <docgroup homogen-name='get_xpad' homogen-type='method'><doc><text>The amount of space to add on the left and right of the widget, in pixels. </text></doc>
autodoc.git/onepage.xml:47916: </method> </docgroup> </class> <class name='Notebook'> <doc><text>The NoteBook Widget is a collection of 'pages' that overlap each other, each page contains different information. This widget has become more common lately in GUI programming, and it is a good way to show blocks similar information that warrant separation in their display. <expr> GTK1.Notebook( )->set_tab_pos( GTK1.POS_LEFT )->append_page( GTK1.Label("Page 1\nContents"), GTK1.Label("Page 1"))->append_page( GTK1.Label(""), GTK1.Label("Page 2"))->append_page(GTK1.Label("Page 3 contents\nare here!"), GTK1.Label("Page 3"))</expr> - <image file='predef.GTK1.Notebook.1.png' height='71' width='126'>../images/gtk1_notebook.png</image> + <image file='predef.GTK1.Notebook.1.png'>../images/gtk1_notebook.png</image> <expr> GTK1.Notebook( )->set_tab_pos( GTK1.POS_TOP )->append_page( GTK1.Label("Page 1\nContents"), GTK1.Label("Page 1"))->append_page( GTK1.Label(""), GTK1.Label("Page 2"))->append_page(GTK1.Label("Page 3 contents\nare here!"), GTK1.Label("Page 3"))</expr> - <image file='predef.GTK1.Notebook.2.png' height='53' width='131'>../images/gtk1_notebook_2.png</image> + <image file='predef.GTK1.Notebook.2.png'>../images/gtk1_notebook_2.png</image> <expr> GTK1.Notebook( )->set_tab_pos( GTK1.POS_RIGHT )->append_page( GTK1.Label("Page 1\nContents"), GTK1.Label("Page 1"))->append_page( GTK1.Label(""), GTK1.Label("Page 2"))->append_page(GTK1.Label("Page 3 contents\nare here!"), GTK1.Label("Page 3"))->next_page()->next_page()</expr> - <image file='predef.GTK1.Notebook.3.png' height='71' width='126'>../images/gtk1_notebook_3.png</image> + <image file='predef.GTK1.Notebook.3.png'>../images/gtk1_notebook_3.png</image> Signals: switch_page Called when a different page is selected </text></doc> <docgroup homogen-name='append_page' homogen-type='method'><doc><text>Add a new 'page' to the notebook. The first argument is the contents of the page, the second argument is the label. </text></doc> <method name='append_page'> <arguments><argument name='contents'><type><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></type></argument><argument name='label'><type><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.Notebook'>GTK1.Notebook</object></returntype>
autodoc.git/onepage.xml:48254: <returntype><object resolved='predef::GTK1.Object'>GTK1.Object</object></returntype> </method> </docgroup> </class> <class name='OptionMenu'> <doc><text>A OptionMenu is a widget that allows the user to choose from a list of valid choices. The OptionMenu displays the selected choice. When activated the OptionMenu displays a popup W(Menu) which allows the user to make a new choice. <expr> GTK1.OptionMenu()->set_menu(GTK1.Menu()->add( GTK1.MenuItem("Option 1") ));</expr> - <image file='predef.GTK1.OptionMenu.1.png' height='32' width='219'>../images/gtk1_optionmenu.png</image> + <image file='predef.GTK1.OptionMenu.1.png'>../images/gtk1_optionmenu.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new option menu widget </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.OptionMenu'>GTK1.OptionMenu</object></returntype> </method> </docgroup> <docgroup homogen-name='get_menu' homogen-type='method'><doc><text>Returns the W(Menu) associated with the OptionMenu. </text></doc>
autodoc.git/onepage.xml:48535: can be used in various places, but most visibly as icons on the X-Windows desktop, or as cursors. A bitmap is a 2-color pixmap. To use pixmaps in GTK, you must first build a GDK1.Pixmap object using GDK1.Pixmap. The pixels in a GTK1.Pixmap cannot be manipulated by the application after creation, since under the X Window system the pixel data is stored on the X server and so is not available to the client application. If you want to create graphical images which can be manipulated by the application, look at W(Image). <expr> GTK1.Pixmap( GDK1.Pixmap( Image.Image(100,100)->test()) )</expr> - <image file='predef.GTK1.Pixmap.1.png' height='100' width='100'>../images/gtk1_pixmap.png</image> + <image file='predef.GTK1.Pixmap.1.png'>../images/gtk1_pixmap.png</image> <expr> GTK1.Pixmap( GDK1.Pixmap( Image.Image(100,100)->test()), GDK1.Bitmap(Image.Image(100,100,255,255,255)->box(10,10,80,80, 0,0,0) ))</expr> - <image file='predef.GTK1.Pixmap.2.png' height='100' width='100'>../images/gtk1_pixmap_2.png</image> + <image file='predef.GTK1.Pixmap.2.png'>../images/gtk1_pixmap_2.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new pixmap object, and sets the image and the mask. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='pixmap'><type><object resolved='predef::GDK1.Pixmap'>GDK1.Pixmap</object></type></argument><argument name='mask'><type><object resolved='predef::GDK1.Bitmap'>GDK1.Bitmap</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.Pixmap'>GTK1.Pixmap</object></returntype> </method> </docgroup> <docgroup homogen-name='get' homogen-type='method'><doc><text>Returns ([ "pixmap":pixmap,
autodoc.git/onepage.xml:48802: <method name='set_value'> <arguments><argument name='value'><type><float/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Progress'>GTK1.Progress</object></returntype> </method> </docgroup> </class> <class name='ProgressBar'> <doc><text>A simple progress bar. Useful when you are doing things that take a long time. Try to always have an 'abort' button whenever it makes sence. <expr> GTK1.ProgressBar()->update(0.1)</expr> - <image file='predef.GTK1.ProgressBar.1.png' height='20' width='150'>../images/gtk1_progressbar.png</image> + <image file='predef.GTK1.ProgressBar.1.png'>../images/gtk1_progressbar.png</image> <expr> GTK1.ProgressBar()->set_show_text(1)->update(0.3)</expr> - <image file='predef.GTK1.ProgressBar.2.png' height='20' width='150'>../images/gtk1_progressbar_2.png</image> + <image file='predef.GTK1.ProgressBar.2.png'>../images/gtk1_progressbar_2.png</image> <expr> GTK1.ProgressBar()->update(0.6)</expr> - <image file='predef.GTK1.ProgressBar.3.png' height='20' width='150'>../images/gtk1_progressbar_3.png</image> + <image file='predef.GTK1.ProgressBar.3.png'>../images/gtk1_progressbar_3.png</image> <expr> GTK1.ProgressBar()->update(1.0)</expr> - <image file='predef.GTK1.ProgressBar.4.png' height='20' width='150'>../images/gtk1_progressbar_4.png</image> + <image file='predef.GTK1.ProgressBar.4.png'>../images/gtk1_progressbar_4.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new progress bar. The default values are: Min 0.0, max 1.0, current 0.0 </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.ProgressBar'>GTK1.ProgressBar</object></returntype> </method> </docgroup>
autodoc.git/onepage.xml:48929: </docgroup> </class> <class name='RadioButton'> <doc><text>Radio buttons are similar to check buttons except they are grouped so that only one may be selected/depressed at a time. This is good for places in your application where you need to select from a short list of options. To connect the buttons, use another button in the desired group as the second argument to GTK1.RadioButton(). <expr> GTK1.RadioButton("Button");</expr> - <image file='predef.GTK1.RadioButton.1.png' height='32' width='219'>../images/gtk1_radiobutton.png</image> + <image file='predef.GTK1.RadioButton.1.png'>../images/gtk1_radiobutton.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Normal creation: object GTK1.RadioButton(string title) - First button (with label) object GTK1.RadioButton()->add(widget) - First button (with widget) object GTK1.RadioButton(title, another_radio_button) - Second to n:th button (with title) object GTK1.RadioButton(0,another_radio_button)->add(widget) - Second to n:th button (with widget) </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='title'><type><or><string/><void/></or></type></argument><argument name='groupmember'><type><object resolved='predef::GTK1.RadioButton'>GTK1.RadioButton</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.RadioButton'>GTK1.RadioButton</object></returntype>
autodoc.git/onepage.xml:48959: </text></doc> <method name='set_group'> <arguments><argument name='groupmember'><type><object resolved='predef::GTK1.RadioButton'>GTK1.RadioButton</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.RadioButton'>GTK1.RadioButton</object></returntype> </method> </docgroup> </class> <class name='RadioMenuItem'> <doc><text>Exactly like W(RadioButton), but it is an menu item. <expr> GTK1.RadioMenuItem("Menu item")</expr> - <image file='predef.GTK1.RadioMenuItem.1.png' height='17' width='62'>../images/gtk1_radiomenuitem.png</image> + <image file='predef.GTK1.RadioMenuItem.1.png'>../images/gtk1_radiomenuitem.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>object GTK1.RadioMenuItem(string title) - First button (with label) object GTK1.RadioMenuItem()->add(widget) - First button (with widget) object GTK1.RadioMenuItem(title, another_radio_button) - Second to n:th button (with title) object GTK1.RadioMenuItem(0,another_radio_button)->add(widget) - Second to n:th button (with widget) </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='title'><type><or><string/><void/></or></type></argument><argument name='groupmember'><type><object resolved='predef::GTK1.RadioMenuItem'>GTK1.RadioMenuItem</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.RadioMenuItem'>GTK1.RadioMenuItem</object></returntype> </method>
autodoc.git/onepage.xml:49303: <docgroup homogen-name='Range' homogen-type='inherit'> <inherit name='Range'><classname resolved='predef::GTK1.Range'>GTK1.Range</classname></inherit> </docgroup> </class> <class name='ScrolledWindow'> <doc><text>Scrolled windows are used to create a scrollable area with another widget inside it. You may insert any type of widget into a scrolled window, and it will be accessible regardless of the size by using the scrollbars. <expr> GTK1.ScrolledWindow(GTK1.Adjustment(),GTK1.Adjustment())->add(GTK1.Label("A small label"))->set_usize(100,80)->set_policy(GTK1.POLICY_AUTOMATIC,GTK1.POLICY_AUTOMATIC)</expr> - <image file='predef.GTK1.ScrolledWindow.1.png' height='80' width='100'>../images/gtk1_scrolledwindow.png</image> + <image file='predef.GTK1.ScrolledWindow.1.png'>../images/gtk1_scrolledwindow.png</image> <expr> GTK1.ScrolledWindow(GTK1.Adjustment(),GTK1.Adjustment())->add(GTK1.Label("A small label"))->set_usize(70,80)->set_policy(GTK1.POLICY_AUTOMATIC,GTK1.POLICY_AUTOMATIC)</expr> - <image file='predef.GTK1.ScrolledWindow.2.png' height='80' width='70'>../images/gtk1_scrolledwindow_2.png</image> + <image file='predef.GTK1.ScrolledWindow.2.png'>../images/gtk1_scrolledwindow_2.png</image> <expr> GTK1.ScrolledWindow(GTK1.Adjustment(),GTK1.Adjustment())->add(GTK1.Label("A small label"))->set_usize(80,80)</expr> - <image file='predef.GTK1.ScrolledWindow.3.png' height='80' width='80'>../images/gtk1_scrolledwindow_3.png</image> + <image file='predef.GTK1.ScrolledWindow.3.png'>../images/gtk1_scrolledwindow_3.png</image> <expr> GTK1.ScrolledWindow(GTK1.Adjustment(),GTK1.Adjustment())->add(GTK1.Label("A very huge label")->set_usize(700,700))->set_usize(80,80)</expr> - <image file='predef.GTK1.ScrolledWindow.4.png' height='80' width='80'>../images/gtk1_scrolledwindow_4.png</image> + <image file='predef.GTK1.ScrolledWindow.4.png'>../images/gtk1_scrolledwindow_4.png</image> </text></doc> <docgroup homogen-name='add' homogen-type='method'><doc><text>Add a widget to this container. This is equivalent to the C-GTK function gtk_scrolled_window_add_with_viewport or gtk_container_add, depeneding on whether or not the child supports the set_scroll_adjustments signal. What this means in practice is that you do not have to care about this at all, it's all handled automatically. </text></doc> <method name='add'>
autodoc.git/onepage.xml:49580: <ul><li>value: initial value for the Spin Button</li> <li>lower: lower range value</li> <li>upper: upper range value</li> <li>step_increment: value to increment/decrement when pressing mouse button 1 on a button</li> <li>page_increment: value to increment/decrement when pressing mouse button 2 on a button</li> <li>page_size: unused</li> </ul> The argument order for the W(Adjustment) constructor is: value, lower, upper, step_increment, page_increment, page_size <expr> GTK1.SpinButton( GTK1.Adjustment(),0.1, 1 )->set_usize(60,20)</expr> - <image file='predef.GTK1.SpinButton.1.png' height='20' width='60'>../images/gtk1_spinbutton.png</image> + <image file='predef.GTK1.SpinButton.1.png'>../images/gtk1_spinbutton.png</image> </text></doc> <docgroup homogen-name='configure' homogen-type='method'><doc><text>Adjustment (with the lower/upper/increse values), climb_rate and digits </text></doc> <method name='configure'> <arguments><argument name='range'><type><object resolved='predef::GTK1.Adjustment'>GTK1.Adjustment</object></type></argument><argument name='climb_rate'><type><float/></type></argument><argument name='precision'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.SpinButton'>GTK1.SpinButton</object></returntype> </method> </docgroup> <docgroup homogen-name='create' homogen-type='method'><doc><text>The climb_rate argument take a value between 0.0 and 1.0 and indicates the amount of acceleration that the Spin Button has. The
autodoc.git/onepage.xml:49772: <doc><text>Statusbars are simple widgets used to display a text message. They keep a stack of the messages pushed onto them, so that popping the current message will re-display the previous text message. In order to allow different parts of an application to use the same statusbar to display messages, the statusbar widget issues Context Identifiers which are used to identify different 'users'. The message on top of the stack is the one displayed, no matter what context it is in. Messages are stacked in last-in-first-out order, not context identifier order. <expr> lambda() {object sb = GTK1.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");return sb;}()</expr> - <image file='predef.GTK1.Statusbar.1.png' height='17' width='90'>../images/gtk1_statusbar.png</image> + <image file='predef.GTK1.Statusbar.1.png'>../images/gtk1_statusbar.png</image> <expr> lambda() {object sb = GTK1.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");sb->pop(id);return sb;}()</expr> - <image file='predef.GTK1.Statusbar.2.png' height='17' width='57'>../images/gtk1_statusbar_2.png</image> + <image file='predef.GTK1.Statusbar.2.png'>../images/gtk1_statusbar_2.png</image> Signals: text_poped text_pushed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new statusbar widget </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Statusbar'>GTK1.Statusbar</object></returntype> </method>
autodoc.git/onepage.xml:49990: <arguments/> <returntype><object resolved='predef::GDK1.GC'>GDK1.GC</object></returntype> </method> </docgroup> </class> <class name='Table'> <doc><text>The Gtk.Table allow the programmer to arrange widgets in rows and columns, making it easy to align many widgets next to each other, horizontally and vertically. <expr> GTK1.Table(2,2,0)->attach_defaults( GTK1.Label("0,0"), 0, 1, 0, 1)->attach_defaults( GTK1.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK1.Label("1,0"), 1, 2, 0, 1)->attach_defaults( GTK1.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)</expr> - <image file='predef.GTK1.Table.1.png' height='36' width='38'>../images/gtk1_table.png</image> + <image file='predef.GTK1.Table.1.png'>../images/gtk1_table.png</image> <expr> GTK1.Table(2,2,0)->attach_defaults( GTK1.Label("0,0-1,0"), 0, 2, 0, 1)->attach_defaults( GTK1.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK1.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)</expr> - <image file='predef.GTK1.Table.2.png' height='36' width='38'>../images/gtk1_table_2.png</image> + <image file='predef.GTK1.Table.2.png'>../images/gtk1_table_2.png</image> </text></doc> <docgroup homogen-name='attach' homogen-type='method'><doc><text>The left and right attach arguments specify where to place the widget, and how many boxes to use. If you want a button in the lower right table entry of our 2x2 table, and want it to fill that entry ONLY. left_attach would be = 1, right_attach = 2, top_attach = 1, bottom_attach = 2. Now, if you wanted a widget to take up the whole top row of our 2x2 table, you'd use left_attach = 0, right_attach = 2, top_attach = 0, bottom_attach = 1. The xoptions and yoptions are used to specify packing options and
autodoc.git/onepage.xml:50145: tear off and reattach its menu. When its menu is shown normally, the GTK1.TearoffMenuItem is drawn as a dotted line indicating that the menu can be torn off. Activating it causes its menu to be torn off and displayed in its own window as a tearoff menu. When its menu is shown as a tearoff menu, the GTK1.TearoffMenuItem is drawn as a dotted line which has a left pointing arrow graphic indicating that the tearoff menu can be reattached. Activating it will erase the tearoff menu window. <expr> GTK1.TearoffMenuItem()->set_usize( 100,0 )</expr> - <image file='predef.GTK1.TearoffMenuItem.1.png' height='6' width='100'>../images/gtk1_tearoffmenuitem.png</image> + <image file='predef.GTK1.TearoffMenuItem.1.png'>../images/gtk1_tearoffmenuitem.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new tear of menu item </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.TearoffMenuItem'>GTK1.TearoffMenuItem</object></returntype> </method> </docgroup> <docgroup homogen-name='get_torn_off' homogen-type='method'><doc><text>Return 1 if the menu the menu item is connected to is currently torn off.
autodoc.git/onepage.xml:50179: allowing them to be mixed in any way we wish. It also has a wide set of key based text editing commands, which are compatible with Emacs. The text widget supports full cut-and-paste facilities, including the use of double- and triple-click to select a word and a whole line, respectively. Bugs:<ul> <li> You cannot add text to the widget before it is realized.</li> </ul> <expr> GTK1.Text(GTK1.Adjustment(),GTK1.Adjustment())</expr> - <image file='predef.GTK1.Text.1.png' height='116' width='126'>../images/gtk1_text.png</image> + <image file='predef.GTK1.Text.1.png'>../images/gtk1_text.png</image> <expr> function_object(call_out(GTK1.Text(GTK1.Adjustment(),GTK1.Adjustment())->set_text, 0, "Some text")[0])</expr> - <image file='predef.GTK1.Text.2.png' height='116' width='126'>../images/gtk1_text_2.png</image> + <image file='predef.GTK1.Text.2.png'>../images/gtk1_text_2.png</image> <expr> function_object(call_out(GTK1.Text(GTK1.Adjustment(),GTK1.Adjustment())->insert, 0, "Some text", 0, GDK1.Color(255,255,0), GDK1.Color(0,0,0))[0])</expr> - <image file='predef.GTK1.Text.3.png' height='116' width='126'>../images/gtk1_text_3.png</image> + <image file='predef.GTK1.Text.3.png'>../images/gtk1_text_3.png</image> </text></doc> <docgroup homogen-name='backward_delete' homogen-type='method'><doc><text>Delete n characters backwards from the cursor position </text></doc> <method name='backward_delete'> <arguments><argument name='nchars'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Text'>GTK1.Text</object></returntype> </method> </docgroup> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new GTK1.Text widget, initialized with the given Gtk.Adjustments. These pointers can be used to track the viewing
autodoc.git/onepage.xml:50383: </method> </docgroup> </class> <class name='ToggleButton'> <doc><text>Toggle buttons are derived from normal buttons and are very similar, except they will always be in one of two states, alternated by a click. They may be depressed, and when you click again, they will pop back up. Click again, and they will pop back down. <expr> GTK1.ToggleButton("Toggle button")</expr> - <image file='predef.GTK1.ToggleButton.1.png' height='19' width='75'>../images/gtk1_togglebutton.png</image> + <image file='predef.GTK1.ToggleButton.1.png'>../images/gtk1_togglebutton.png</image> <expr> GTK1.ToggleButton("Toggle button")->set_active( 1 )</expr> - <image file='predef.GTK1.ToggleButton.2.png' height='19' width='75'>../images/gtk1_togglebutton_2.png</image> + <image file='predef.GTK1.ToggleButton.2.png'>../images/gtk1_togglebutton_2.png</image> Signals: toggled </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>If you supply a string, a label will be created and inserted in the button. Otherwise, use -&gt;add(widget) to create the contents of the button. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='label'><type><or><string/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK1.ToggleButton'>GTK1.ToggleButton</object></returntype> </method>
autodoc.git/onepage.xml:50438: </class> <class name='Toolbar'> <doc><text>Toolbars are usually used to group some number of widgets in order to simplify customization of their look and layout. Typically a toolbar consists of buttons with icons, labels and tooltips, but any other widget can also be put inside a toolbar. Finally, items can be arranged horizontally or vertically and buttons can be displayed with icons, labels, or both. Examples: <expr> lambda(){object t=GTK1.Toolbar( GTK1.ORIENTATION_HORIZONTAL, GTK1.TOOLBAR_TEXT );t->append_item( "Button 1", "Tooltip 1", "", GTK1.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 2", "Tooltip 2", "", GTK1.Frame(), lambda(){},0);t->append_item( "Button 3", "Tooltip 3", "", GTK1.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 4", "Tooltip 4", "", GTK1.Frame(), lambda(){},0);t->append_item( "Button 5", "Tooltip 5", "", GTK1.Frame(), lambda(){},0);return t;}()</expr> - <image file='predef.GTK1.Toolbar.1.png' height='19' width='245'>../images/gtk1_toolbar.png</image> + <image file='predef.GTK1.Toolbar.1.png'>../images/gtk1_toolbar.png</image> <expr> lambda(){object t=GTK1.Toolbar( GTK1.ORIENTATION_VERTICAL, GTK1.TOOLBAR_TEXT );t->append_item( "Button 1", "Tooltip 1", "", GTK1.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 2", "Tooltip 2", "", GTK1.Frame(), lambda(){},0);t->append_item( "Button 3", "Tooltip 3", "", GTK1.Frame(), lambda(){},0);t->append_space();t->append_item( "Button 4", "Tooltip 4", "", GTK1.Frame(), lambda(){},0);t->append_item( "Button 5", "Tooltip 5", "", GTK1.Frame(), lambda(){},0);return t;}()</expr> - <image file='predef.GTK1.Toolbar.2.png' height='105' width='47'>../images/gtk1_toolbar_2.png</image> + <image file='predef.GTK1.Toolbar.2.png'>../images/gtk1_toolbar_2.png</image> <expr> lambda(){object i=GDK1.Image()->set(Image.Image(20,20)->test());object t=GTK1.Toolbar( GTK1.ORIENTATION_HORIZONTAL, GTK1.TOOLBAR_BOTH );t->append_item( "Button 1", "Tooltip 1", "", GTK1.Image(i), lambda(){},0);t->append_space();t->append_item( "Button 2", "Tooltip 2", "", GTK1.Image(i), lambda(){},0);t->append_item( "Button 3", "Tooltip 3", "", GTK1.Image(i), lambda(){},0);t->append_space();t->append_item( "Button 4", "Tooltip 4", "", GTK1.Image(i), lambda(){},0);t->append_item( "Button 5", "Tooltip 5", "", GTK1.Image(i), lambda(){},0);return t;}()</expr> - <image file='predef.GTK1.Toolbar.3.png' height='39' width='245'>../images/gtk1_toolbar_3.png</image> + <image file='predef.GTK1.Toolbar.3.png'>../images/gtk1_toolbar_3.png</image> Signals: orientation_changed style_changed </text></doc> <docgroup homogen-name='append_item' homogen-type='method'><doc><text>Adds a new button to the start of the toolbar. </text></doc> <method name='append_item'> <arguments><argument name='label'><type><string/></type></argument><argument name='tooltip'><type><string/></type></argument><argument name='prv'><type><string/></type></argument><argument name='icon'><type><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></type></argument><argument name='clicked_cb'><type><function/></type></argument><argument name='clicked_arg'><type><mixed/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Toolbar'>GTK1.Toolbar</object></returntype> </method>
autodoc.git/onepage.xml:50652: </docgroup> </class> <class name='Vbox'> <doc><text>Most packing is done by creating boxes. These are invisible widget containers that we can pack our widgets into which come in two forms, a horizontal box, and a vertical box. This is the vertical one. When packing widgets into a vertical box, the objects are inserted horizontally from top to bottom or bottom to top depending on the call used. <expr> GTK1.Vbox(0,0)->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->pack_end_defaults(GTK1.Button("From right"))->pack_start_defaults(GTK1.Button("From left"))</expr> - <image file='predef.GTK1.Vbox.1.png' height='76' width='58'>../images/gtk1_vbox.png</image> + <image file='predef.GTK1.Vbox.1.png'>../images/gtk1_vbox.png</image> <expr> GTK1.Vbox(1,0)->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->pack_end_defaults(GTK1.Button("From right"))->pack_start_defaults(GTK1.Button("From left"))</expr> - <image file='predef.GTK1.Vbox.2.png' height='76' width='58'>../images/gtk1_vbox_2.png</image> + <image file='predef.GTK1.Vbox.2.png'>../images/gtk1_vbox_2.png</image> <expr> GTK1.Vbox(1,40)->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->pack_end_defaults(GTK1.Button("From right"))->pack_start_defaults(GTK1.Button("From left"))</expr> - <image file='predef.GTK1.Vbox.3.png' height='196' width='58'>../images/gtk1_vbox_3.png</image> + <image file='predef.GTK1.Vbox.3.png'>../images/gtk1_vbox_3.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new horizontal box widget. If all_same_size is true, all widgets will have exactly the same size. padding is added to the top and bottom of the children. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='uniformp'><type><int/></type></argument><argument name='padding'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Vbox'>GTK1.Vbox</object></returntype> </method> </docgroup> <docgroup homogen-name='Box' homogen-type='inherit'> <inherit name='Box'><classname resolved='predef::GTK1.Box'>GTK1.Box</classname></inherit> </docgroup> </class> <class name='VbuttonBox'> <doc><text>A Vbutton_box is very similar to a Vbox. The major diffference is that the button box is made to pack buttons in, and has a few convenience function for normal button layouts. <expr> GTK1.VbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_usize(100,300)</expr> - <image file='predef.GTK1.VbuttonBox.1.png' height='300' width='100'>../images/gtk1_vbuttonbox.png</image> + <image file='predef.GTK1.VbuttonBox.1.png'>../images/gtk1_vbuttonbox.png</image> <expr> GTK1.VbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_SPREAD)->set_usize(100,300)</expr> - <image file='predef.GTK1.VbuttonBox.2.png' height='300' width='100'>../images/gtk1_vbuttonbox_2.png</image> + <image file='predef.GTK1.VbuttonBox.2.png'>../images/gtk1_vbuttonbox_2.png</image> <expr> GTK1.VbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_EDGE)->set_usize(100,300)</expr> - <image file='predef.GTK1.VbuttonBox.3.png' height='300' width='100'>../images/gtk1_vbuttonbox_3.png</image> + <image file='predef.GTK1.VbuttonBox.3.png'>../images/gtk1_vbuttonbox_3.png</image> <expr> GTK1.VbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_START)->set_usize(100,300)</expr> - <image file='predef.GTK1.VbuttonBox.4.png' height='300' width='100'>../images/gtk1_vbuttonbox_4.png</image> + <image file='predef.GTK1.VbuttonBox.4.png'>../images/gtk1_vbuttonbox_4.png</image> <expr> GTK1.VbuttonBox()->add(GTK1.Button("Hello"))->add(GTK1.Button("World"))->set_layout(GTK1.BUTTONBOX_END)->set_usize(100,300)</expr> - <image file='predef.GTK1.VbuttonBox.5.png' height='300' width='100'>../images/gtk1_vbuttonbox_5.png</image> + <image file='predef.GTK1.VbuttonBox.5.png'>../images/gtk1_vbuttonbox_5.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new vertical button box </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.VbuttonBox'>GTK1.VbuttonBox</object></returntype> </method> </docgroup> <docgroup homogen-name='ButtonBox' homogen-type='inherit'> <inherit name='ButtonBox'><classname resolved='predef::GTK1.ButtonBox'>GTK1.ButtonBox</classname></inherit> </docgroup> </class> <class name='Viewport'> <doc><text>This is a container that can be scrolled around, but it has no scrollbars. You can connect scrollbars to it using the adjustment objects. <expr> GTK1.Viewport(GTK1.Adjustment(),GTK1.Adjustment())->set_usize(100,100)</expr> - <image file='predef.GTK1.Viewport.1.png' height='100' width='100'>../images/gtk1_viewport.png</image> + <image file='predef.GTK1.Viewport.1.png'>../images/gtk1_viewport.png</image> <expr> GTK1.Viewport(GTK1.Adjustment(),GTK1.Adjustment())->set_usize(100,100)->set_shadow_type(GTK1.SHADOW_ETCHED_IN)</expr> - <image file='predef.GTK1.Viewport.2.png' height='100' width='100'>../images/gtk1_viewport_2.png</image> + <image file='predef.GTK1.Viewport.2.png'>../images/gtk1_viewport_2.png</image> <expr> GTK1.Viewport(GTK1.Adjustment(),GTK1.Adjustment())->set_usize(100,100)->add(GTK1.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK1.SHADOW_ETCHED_IN)</expr> - <image file='predef.GTK1.Viewport.3.png' height='100' width='100'>../images/gtk1_viewport_3.png</image> + <image file='predef.GTK1.Viewport.3.png'>../images/gtk1_viewport_3.png</image> <expr> lambda(){ object a1;object v = GTK1.Viewport(a1=GTK1.Adjustment(),GTK1.Adjustment())->set_usize(100,100)->add(GTK1.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK1.SHADOW_ETCHED_IN);call_out(a1->set_value,0,100.0);return v;}()</expr> - <image file='predef.GTK1.Viewport.4.png' height='100' width='100'>../images/gtk1_viewport_4.png</image> + <image file='predef.GTK1.Viewport.4.png'>../images/gtk1_viewport_4.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new viewport. The adjustments are used to select what part of the viewport to view to the user. They are normally connected to a scrollbar or something similar. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='xscroll'><type><object resolved='predef::GTK1.Adjustment'>GTK1.Adjustment</object></type></argument><argument name='yscroll'><type><object resolved='predef::GTK1.Adjustment'>GTK1.Adjustment</object></type></argument></arguments> <returntype><object resolved='predef::GTK1.Viewport'>GTK1.Viewport</object></returntype> </method> </docgroup>
autodoc.git/onepage.xml:50765: </method> </docgroup> </class> <class name='Vpaned'> <doc><text>The paned window widgets are useful when you want to divide an area into two parts, with the relative size of the two parts controlled by the user. A groove is drawn between the two portions with a handle that the user can drag to change the ratio. This widgets makes a vertical division <expr> GTK1.Vpaned()->add1(GTK1.Label("Top Side Of Pane"))->add2(GTK1.Label("Bottom"))->set_usize(100,100)</expr> - <image file='predef.GTK1.Vpaned.1.png' height='100' width='100'>../images/gtk1_vpaned.png</image> + <image file='predef.GTK1.Vpaned.1.png'>../images/gtk1_vpaned.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Vpaned'>GTK1.Vpaned</object></returntype> </method> </docgroup> <docgroup homogen-name='Paned' homogen-type='inherit'> <inherit name='Paned'><classname resolved='predef::GTK1.Paned'>GTK1.Paned</classname></inherit> </docgroup> </class> <class name='Vruler'> <doc><text>Ruler widgets are used to indicate the location of the mouse pointer in a given window. A window can have a vertical ruler spanning across the width and a horizontal ruler spanning down the height. A small triangular indicator on the ruler shows the exact location of the pointer relative to the ruler. <expr> GTK1.Vruler()->set_metric(GTK1.PIXELS)->set_range(0.0,100.0,50.0,100.0)->draw_ticks()->draw_pos()->set_usize(30,50)</expr> - <image file='predef.GTK1.Vruler.1.png' height='50' width='30'>../images/gtk1_vruler.png</image> + <image file='predef.GTK1.Vruler.1.png'>../images/gtk1_vruler.png</image> <expr> GTK1.Vruler()->set_metric(GTK1.CENTIMETERS)->set_range(0.0,100.0,50.0,100.0)->draw_ticks()->draw_pos()->set_usize(30,50)</expr> - <image file='predef.GTK1.Vruler.2.png' height='50' width='30'>../images/gtk1_vruler_2.png</image> + <image file='predef.GTK1.Vruler.2.png'>../images/gtk1_vruler_2.png</image> <expr> GTK1.Vruler()->set_usize(30,50)</expr> - <image file='predef.GTK1.Vruler.3.png' height='50' width='30'>../images/gtk1_vruler_3.png</image> + <image file='predef.GTK1.Vruler.3.png'>../images/gtk1_vruler_3.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new vruler widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Vruler'>GTK1.Vruler</object></returntype> </method> </docgroup> <docgroup homogen-name='Ruler' homogen-type='inherit'> <inherit name='Ruler'><classname resolved='predef::GTK1.Ruler'>GTK1.Ruler</classname></inherit>
autodoc.git/onepage.xml:50810: </class> <class name='Vscale'> <doc><text>The GTK1.VScale widget is used to allow the user to select a value using a vertical slider. A GtkAdjustment is used to set the initial value, the lower and upper bounds, and the step and page increments. The position to show the current value, and the number of decimal places shown can be set using the parent W(Scale) class's functions. <expr> GTK1.Vscale(GTK1.Adjustment())->set_usize(30,100)</expr> - <image file='predef.GTK1.Vscale.1.png' height='100' width='30'>../images/gtk1_vscale.png</image> + <image file='predef.GTK1.Vscale.1.png'>../images/gtk1_vscale.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new vscale widget. The adjustment argument can either be an existing W(Adjustment), or 0, in which case one will be created for you. Specifying 0 might actually be useful in this case, if you wish to pass the newly automatically created adjustment to the constructor function of some other widget which will configure it for you, such as a text widget. </text></doc> <method name='create'><modifiers><protected/></modifiers>
autodoc.git/onepage.xml:50832: <returntype><object resolved='predef::GTK1.Vscale'>GTK1.Vscale</object></returntype> </method> </docgroup> <docgroup homogen-name='Scale' homogen-type='inherit'> <inherit name='Scale'><classname resolved='predef::GTK1.Scale'>GTK1.Scale</classname></inherit> </docgroup> </class> <class name='Vscrollbar'> <doc><text>General documentation: See W(Scrollbar) <expr> GTK1.Vscrollbar(GTK1.Adjustment())->set_usize(15,60)</expr> - <image file='predef.GTK1.Vscrollbar.1.png' height='60' width='15'>../images/gtk1_vscrollbar.png</image> + <image file='predef.GTK1.Vscrollbar.1.png'>../images/gtk1_vscrollbar.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new vscrollbar widget. The adjustment argument can either be an existing W(Adjustment), or 0, in which case one will be created for you. Specifying 0 might actually be useful in this case, if you wish to pass the newly automatically created adjustment to the constructor function of some other widget which will configure it for you, such as a text widget. </text></doc> <method name='create'><modifiers><protected/></modifiers>
autodoc.git/onepage.xml:50854: <returntype><object resolved='predef::GTK1.Vscrollbar'>GTK1.Vscrollbar</object></returntype> </method> </docgroup> <docgroup homogen-name='Scrollbar' homogen-type='inherit'> <inherit name='Scrollbar'><classname resolved='predef::GTK1.Scrollbar'>GTK1.Scrollbar</classname></inherit> </docgroup> </class> <class name='Vseparator'> <doc><text>Simply creates a vertical separator. No bells or whistles. <expr> GTK1.Vseparator()->set_usize(3,50)</expr> - <image file='predef.GTK1.Vseparator.1.png' height='50' width='3'>../images/gtk1_vseparator.png</image> + <image file='predef.GTK1.Vseparator.1.png'>../images/gtk1_vseparator.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new vseparator widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::GTK1.Vseparator'>GTK1.Vseparator</object></returntype> </method> </docgroup> <docgroup homogen-name='Separator' homogen-type='inherit'> <inherit name='Separator'><classname resolved='predef::GTK1.Separator'>GTK1.Separator</classname></inherit>
autodoc.git/onepage.xml:51624: </text></doc> <method name='set_usize'> <arguments><argument name='xsize'><type><int/></type></argument><argument name='ysize'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></returntype> </method> </docgroup> <docgroup homogen-name='shape_combine_mask' homogen-type='method'><doc><text>Set the shape of the widget, or, rather, its window, to that of the supplied bitmap. Notice how the window behind the example window can be seen because of the rather odd shape the example window has. <expr> GTK1.Window( GTK1.WINDOW_TOPLEVEL )->add(GTK1.Label("A rather Oddly shaped\n" "Window\n" "Indeed\n" "Or what do you\nthink?\n" "This text\n" "should\n" "be long enough"))->shape_combine_mask( GDK1.Bitmap(Image.Image(100,100,255,255,255)->rotate(10,0,0,0) ), 20,20)</expr> - <image file='predef.GTK1.Widget.shape_combine_mask.1.png' height='104' width='112'>../images/gtk1_widget_shape_combine_mask.png</image> + <image file='predef.GTK1.Widget.shape_combine_mask.1.png'>../images/gtk1_widget_shape_combine_mask.png</image> NOTE: The widget must be realized before this function can be used </text></doc> <method name='shape_combine_mask'> <arguments><argument name='shape'><type><object resolved='predef::GDK1.Bitmap'>GDK1.Bitmap</object></type></argument><argument name='xoffset'><type><int/></type></argument><argument name='yoffset'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></returntype> </method> </docgroup> <docgroup homogen-name='show' homogen-type='method'><doc><text>Show the widget. Most (almost all) widgets must be shown to be visible on the screen. </text></doc>
autodoc.git/onepage.xml:56921: </class> <class name='Allocation'> <docgroup homogen-name='Rectangle' homogen-type='inherit'> <inherit name='Rectangle'><classname>GDK2.Rectangle</classname></inherit> </docgroup> </class> <class name='Arrow'> <doc><text>An arrow pointing in one of four directions. The 'etched' shadow types does not work. <expr> GTK2.Arrow(GTK2.ARROW_UP, GTK2.SHADOW_OUT)</expr> - <image file='predef.GTK2.Arrow.1.png' height='15' width='15'>../images/gtk2_arrow.png</image> + <image file='predef.GTK2.Arrow.1.png'>../images/gtk2_arrow.png</image> <expr> GTK2.Arrow(GTK2.ARROW_LEFT, GTK2.SHADOW_IN)</expr> - <image file='predef.GTK2.Arrow.2.png' height='15' width='15'>../images/gtk2_arrow_2.png</image> + <image file='predef.GTK2.Arrow.2.png'>../images/gtk2_arrow_2.png</image> <expr> GTK2.Arrow(GTK2.ARROW_RIGHT, GTK2.SHADOW_IN)</expr> - <image file='predef.GTK2.Arrow.3.png' height='15' width='15'>../images/gtk2_arrow_3.png</image> + <image file='predef.GTK2.Arrow.3.png'>../images/gtk2_arrow_3.png</image> <expr> GTK2.Arrow(GTK2.ARROW_DOWN, GTK2.SHADOW_OUT)</expr> - <image file='predef.GTK2.Arrow.4.png' height='15' width='15'>../images/gtk2_arrow_4.png</image> + <image file='predef.GTK2.Arrow.4.png'>../images/gtk2_arrow_4.png</image> Properties: int arrow-type <ref resolved='predef::GTK2.ARROW_DOWN'>ARROW_DOWN</ref>, <ref resolved='predef::GTK2.ARROW_LEFT'>ARROW_LEFT</ref>, <ref resolved='predef::GTK2.ARROW_RIGHT'>ARROW_RIGHT</ref> and <ref resolved='predef::GTK2.ARROW_UP'>ARROW_UP</ref> int shadow-type <ref resolved='predef::GTK2.SHADOW_ETCHED_IN'>SHADOW_ETCHED_IN</ref>, <ref resolved='predef::GTK2.SHADOW_ETCHED_OUT'>SHADOW_ETCHED_OUT</ref>, <ref resolved='predef::GTK2.SHADOW_IN'>SHADOW_IN</ref>, <ref resolved='predef::GTK2.SHADOW_NONE'>SHADOW_NONE</ref> and <ref resolved='predef::GTK2.SHADOW_OUT'>SHADOW_OUT</ref> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>First argument is one of <ref resolved='predef::GTK2.ARROW_DOWN'>ARROW_DOWN</ref>, <ref resolved='predef::GTK2.ARROW_LEFT'>ARROW_LEFT</ref>, <ref resolved='predef::GTK2.ARROW_RIGHT'>ARROW_RIGHT</ref> and <ref resolved='predef::GTK2.ARROW_UP'>ARROW_UP</ref>, second one of <ref resolved='predef::GTK2.SHADOW_ETCHED_IN'>SHADOW_ETCHED_IN</ref>, <ref resolved='predef::GTK2.SHADOW_ETCHED_OUT'>SHADOW_ETCHED_OUT</ref>, <ref resolved='predef::GTK2.SHADOW_IN'>SHADOW_IN</ref>, <ref resolved='predef::GTK2.SHADOW_NONE'>SHADOW_NONE</ref> and <ref resolved='predef::GTK2.SHADOW_OUT'>SHADOW_OUT</ref>. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='arrow_type_or_props'><type><or><int/><mapping/></or></type></argument><argument name='shadow_type'><type><or><int/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Arrow'>GTK2.Arrow</object></returntype> </method>
autodoc.git/onepage.xml:56954: <method name='set'> <arguments><argument name='arrow_type'><type><int/></type></argument><argument name='shadow_type'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK2.Arrow'>GTK2.Arrow</object></returntype> </method> </docgroup> </class> <class name='AspectFrame'> <doc><text>A W(Frame) widget that always maintain a specified ratio between width and height. width/height == ratio <expr> GTK2.AspectFrame("Title",0.5,0.5,0.4,0)->add( GTK2.Label("Wrong aspect"))->set_size_request(200,200)</expr> - <image file='predef.GTK2.AspectFrame.1.png' height='200' width='200'>../images/gtk2_aspectframe.png</image> + <image file='predef.GTK2.AspectFrame.1.png'>../images/gtk2_aspectframe.png</image> Properties: int obey-child float ratio float xalign float yalign </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new frame. Arguments are label, xalign, yalign, ratio, obey_child xalign is floats between 0 and 1, 0.0 is upper (or leftmost), 1.0 is lower (or rightmost). If 'obey_child' is true, the frame will use the aspect ratio of it's (one and only) child widget instead of 'ratio'.
autodoc.git/onepage.xml:57299: <method name='set_spacing'> <arguments><argument name='spacing'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK2.Box'>GTK2.Box</object></returntype> </method> </docgroup> </class> <class name='Button'> <doc><text>A container that can only contain one child, and accepts events. draws a bevelbox around itself. <expr> GTK2.Button("A button")</expr> - <image file='predef.GTK2.Button.1.png' height='27' width='65'>../images/gtk2_button.png</image> + <image file='predef.GTK2.Button.1.png'>../images/gtk2_button.png</image> <expr> GTK2.Button("A button\nwith multiple lines\nof text")</expr> - <image file='predef.GTK2.Button.2.png' height='61' width='123'>../images/gtk2_button_2.png</image> + <image file='predef.GTK2.Button.2.png'>../images/gtk2_button_2.png</image> <expr> GTK2.Button()->add(GTK2.Image(GTK2.GdkImage(0)->set(Image.Image(100,40)->test())))</expr> - <image file='predef.GTK2.Button.3.png' height='50' width='110'>../images/gtk2_button_3.png</image> + <image file='predef.GTK2.Button.3.png'>../images/gtk2_button_3.png</image> Properties: int focus-on-click GTK2.Widget image int image-position string label int relief int use-stock int use-underline float xalign float yalign
autodoc.git/onepage.xml:57550: </text></doc> <method name='set_layout'> <arguments><argument name='layout'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK2.ButtonBox'>GTK2.ButtonBox</object></returntype> </method> </docgroup> </class> <class name='Calendar'> <doc><text>A calendar widget. <expr> GTK2.Calendar();</expr> - <image file='predef.GTK2.Calendar.1.png' height='188' width='229'>../images/gtk2_calendar.png</image> + <image file='predef.GTK2.Calendar.1.png'>../images/gtk2_calendar.png</image> <expr> GTK2.Calendar()->select_day( 16 );</expr> - <image file='predef.GTK2.Calendar.2.png' height='188' width='229'>../images/gtk2_calendar_2.png</image> + <image file='predef.GTK2.Calendar.2.png'>../images/gtk2_calendar_2.png</image> Properties: int day int month int no-month-change int show-day-names int show-heading int show-week-numbers int year Signals: day_selected
autodoc.git/onepage.xml:58149: </method> </docgroup> </class> <class name='CheckButton'> <doc><text>Check buttons inherent many properties and functions from the the toggle buttons, but look a little different. Rather than being buttons with text inside them, they are small squares with the text to the right of them. These are often used for toggling options on and off in applications. <expr> GTK2.CheckButton( "title" )</expr> - <image file='predef.GTK2.CheckButton.1.png' height='21' width='46'>../images/gtk2_checkbutton.png</image> + <image file='predef.GTK2.CheckButton.1.png'>../images/gtk2_checkbutton.png</image> Style properties: int indicator-size int indicator-spacing </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>The argument, if specified, is the label of the item. If no label is specified, use object->add() to add some other widget (such as an pixmap or image widget) </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='label_or_props'><type><or><string/><mapping/></or></type></argument><argument name='mnemonic'><type><or><int/><void/></or></type></argument></arguments>
autodoc.git/onepage.xml:58171: </method> </docgroup> <docgroup homogen-name='ToggleButton' homogen-type='inherit'> <inherit name='ToggleButton'><classname resolved='predef::GTK2.ToggleButton'>GTK2.ToggleButton</classname></inherit> </docgroup> </class> <class name='CheckMenuItem'> <doc><text>A check menu item is more or less identical to a check button, but it should be used in menus. <expr> GTK2.CheckMenuItem("Hi there")</expr> - <image file='predef.GTK2.CheckMenuItem.1.png' height='21' width='61'>../images/gtk2_checkmenuitem.png</image> + <image file='predef.GTK2.CheckMenuItem.1.png'>../images/gtk2_checkmenuitem.png</image> <expr> GTK2.CheckMenuItem("Hi there")->set_active(1)</expr> - <image file='predef.GTK2.CheckMenuItem.2.png' height='21' width='61'>../images/gtk2_checkmenuitem_2.png</image> + <image file='predef.GTK2.CheckMenuItem.2.png'>../images/gtk2_checkmenuitem_2.png</image> Properties: int active int draw-as-radio int inconsistent Style properties: int indicator-size Signals: toggled Called when the state of the menu item is changed </text></doc>
autodoc.git/onepage.xml:58434: user select a color by manipulating RGB (Red, Green, Blue) and HSV (Hue, Saturation, Value) triples. This is done either by adjusting single values with sliders or entries, or by picking the desired color from a hue-saturation wheel/value bar. Optionally, the opacity of the color can also be set. The color selection widget currently emits only one signal, "color_changed", which is emitted whenever the current color in the widget changes, either when the user changes it or if it's set explicitly through set_color(). <expr> GTK2.ColorSelection()</expr> - <image file='predef.GTK2.ColorSelection.1.png' height='212' width='452'>../images/gtk2_colorselection.png</image> + <image file='predef.GTK2.ColorSelection.1.png'>../images/gtk2_colorselection.png</image> Properties: int current-alpha GDK2.Color current-color int has-opacity-control int has-palette Signals: color_changed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new color selection. </text></doc>
autodoc.git/onepage.xml:59055: </docgroup> </class> <class name='Databox'> <doc><text>GtkDatabox is designed to display large amounts of numerical data fast and easy. Thousands of data points (X and Y coordinate) may be displayed without any problems, zooming and scrolling as well as optional rulers are already included. The widget may be used as display for oscilloscopes or other applications that need to display fast changes in their data. <expr> GTK2.Databox x=GTK2.Databox(); x->data_add_x_y(3, ({ 1.0, 0.5, 0.0 }), ({1.0, -1.0, 0.0}),GTK2.GdkColor(Image.Color.red), GTK2.DataboxLines,2); x->rescale(); x->set_size_request(300,300); return x;</expr> - <image file='predef.GTK2.Databox.1.png' height='300' width='300'>../images/gtk2_databox.png</image> + <image file='predef.GTK2.Databox.1.png'>../images/gtk2_databox.png</image> Signals: marked selection_canceled selection_changed selection_started selection_stopped zoomed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new databox widget </text></doc>
autodoc.git/onepage.xml:59393: <returntype><object resolved='predef::GTK2.Dialog'>GTK2.Dialog</object></returntype> </method> </docgroup> </class> <class name='DrawingArea'> <doc><text>The drawing area is a window you can draw in. Please note that you must handle refresh and resize events on your own. Use W(pDrawingArea) for a drawingarea with automatic refresh/resize handling. <expr> GTK2.DrawingArea()->set_size_request(100,100)</expr> - <image file='predef.GTK2.DrawingArea.1.png' height='100' width='100'>../images/gtk2_drawingarea.png</image> + <image file='predef.GTK2.DrawingArea.1.png'>../images/gtk2_drawingarea.png</image> </text></doc> <docgroup homogen-name='clear' homogen-type='method'><doc><text>Either clears the rectangle defined by the arguments, of if no arguments are specified, the whole drawable. </text></doc> <method name='clear'> <arguments><argument name='x'><type><or><int/><void/></or></type></argument><argument name='y'><type><or><int/><void/></or></type></argument><argument name='width'><type><or><int/><void/></or></type></argument><argument name='height'><type><or><int/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.DrawingArea'>GTK2.DrawingArea</object></returntype> </method> </docgroup> <docgroup homogen-name='copy_area' homogen-type='method'><doc><text>Copies the rectangle defined by xsource,ysource and width,height
autodoc.git/onepage.xml:59629: </text></doc> <method name='set_position'> <arguments><argument name='pos'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK2.Editable'>GTK2.Editable</object></returntype> </method> </docgroup> </class> <class name='Entry'> <doc><text>Use this widget when you want the user to input a single line of text. <expr> GTK2.Entry()->set_text("Hello world")->set_editable(1)</expr> - <image file='predef.GTK2.Entry.1.png' height='25' width='158'>../images/gtk2_entry.png</image> + <image file='predef.GTK2.Entry.1.png'>../images/gtk2_entry.png</image> Properties: int activates-default int cursor-position int editable int has-frame int inner-border int invisible-char int max-length int scroll-offset int selection-bound
autodoc.git/onepage.xml:60137: have an associated X window. Not having an X window saves memory and improves performance, but also has some drawbacks. A widget without an X window cannot receive events, and does not perform any clipping on it's contents. Although the name EventBox emphasizes the event-handling function, the widget can also be used for clipping. The primary use for this widget is when you want to receive events for a widget without a window. Examples of such widgets are labels and images. <expr> GTK2.EventBox()->set_size_request(100,100)</expr> - <image file='predef.GTK2.EventBox.1.png' height='100' width='100'>../images/gtk2_eventbox.png</image> + <image file='predef.GTK2.EventBox.1.png'>../images/gtk2_eventbox.png</image> Properties: int above-child int visible-window </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new event box widget </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.EventBox'>GTK2.EventBox</object></returntype> </method>
autodoc.git/onepage.xml:60802: The default filename can be set using set_filename() and the selected filename retrieved using get_filename(). Use complete() to display files that match a given pattern. This can be used for example, to show only *.txt files, or only files beginning with gtk*. Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using hide_fileop_buttons() and shown again using show_fileop_buttons(). <expr> GTK2.FileChooserDialog("File selector", 0, GTK2.FILE_CHOOSER_ACTION_OPEN, ({(["text":"Transmogrify", "id":17]), (["text":"Never mind", "id":42])}))</expr> - <image file='predef.GTK2.FileChooserDialog.1.png' height='384' width='584'>../images/gtk2_filechooserdialog.png</image> + <image file='predef.GTK2.FileChooserDialog.1.png'>../images/gtk2_filechooserdialog.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new file selection dialog box. By default it will list the files in the current working directory. Operation buttons allowing the user to create a directory, delete files, and rename files will also be present by default. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='title'><type><string/></type></argument><argument name='parent'><type><object resolved='predef::GTK2.Window'>GTK2.Window</object></type></argument><argument name='mode'><type><int/></type></argument><argument name='buttons'><type><array/></type></argument></arguments> <returntype><object resolved='predef::GTK2.FileChooserDialog'>GTK2.FileChooserDialog</object></returntype> </method>
autodoc.git/onepage.xml:60824: <docgroup homogen-name='Dialog' homogen-type='inherit'> <inherit name='Dialog'><classname resolved='predef::GTK2.Dialog'>GTK2.Dialog</classname></inherit> </docgroup> <docgroup homogen-name='FileChooser' homogen-type='inherit'> <inherit name='FileChooser'><classname resolved='predef::GTK2.FileChooser'>GTK2.FileChooser</classname></inherit> </docgroup> </class> <class name='FileChooserWidget'> <doc><text>File chooser widget that can be embedded in other widgets. <expr> GTK2.FileChooserWidget(GTK2.FILE_CHOOSER_ACTION_OPEN);</expr> - <image file='predef.GTK2.FileChooserWidget.1.png' height='97' width='383'>../images/gtk2_filechooserwidget.png</image> + <image file='predef.GTK2.FileChooserWidget.1.png'>../images/gtk2_filechooserwidget.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new file chooser widget. action is one of <ref resolved='predef::GTK2.FILE_CHOOSER_ACTION_CREATE_FOLDER'>FILE_CHOOSER_ACTION_CREATE_FOLDER</ref>, <ref resolved='predef::GTK2.FILE_CHOOSER_ACTION_OPEN'>FILE_CHOOSER_ACTION_OPEN</ref>, <ref resolved='predef::GTK2.FILE_CHOOSER_ACTION_SAVE'>FILE_CHOOSER_ACTION_SAVE</ref> and <ref resolved='predef::GTK2.FILE_CHOOSER_ACTION_SELECT_FOLDER'>FILE_CHOOSER_ACTION_SELECT_FOLDER</ref> </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='action_or_props'><type><or><int/><mapping/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.FileChooserWidget'>GTK2.FileChooserWidget</object></returntype> </method> </docgroup> <docgroup homogen-name='FileChooser' homogen-type='inherit'>
autodoc.git/onepage.xml:60913: The default filename can be set using set_filename() and the selected filename retrieved using get_filename(). Use complete() to display files that match a given pattern. This can be used for example, to show only *.txt files, or only files beginning with gtk*. Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using hide_fileop_buttons() and shown again using show_fileop_buttons(). <expr> GTK2.FileSelection("File selector")</expr> - <image file='predef.GTK2.FileSelection.1.png' height='372' width='523'>../images/gtk2_fileselection.png</image> + <image file='predef.GTK2.FileSelection.1.png'>../images/gtk2_fileselection.png</image> Properties: string filename int select-multiple int show-fileops </text></doc> <docgroup homogen-name='complete' homogen-type='method'><doc><text>Will attempt to match pattern to a valid filename in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog. If a partial match can be made, the "Files" list will contain those file names which have been partially matched.
autodoc.git/onepage.xml:61074: <arguments/> <returntype><object resolved='predef::GTK2.FileSelection'>GTK2.FileSelection</object></returntype> </method> </docgroup> </class> <class name='Fixed'> <doc><text>A fixed container is a container that keeps it's children at fixed locations and give them fixed sizes, both given in pixels. Example: <expr> GTK2.Fixed()->put(GTK2.Label("100,100"), 100, 100)->put(GTK2.Label("0,0"), 0, 0)->set_size_request(150,115)</expr> - <image file='predef.GTK2.Fixed.1.png' height='115' width='150'>../images/gtk2_fixed.png</image> + <image file='predef.GTK2.Fixed.1.png'>../images/gtk2_fixed.png</image> Child properties: int x int y </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new fixed widget </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Fixed'>GTK2.Fixed</object></returntype> </method>
autodoc.git/onepage.xml:61239: <method name='set_use_size'> <arguments><argument name='setting'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK2.FontButton'>GTK2.FontButton</object></returntype> </method> </docgroup> </class> <class name='FontSelection'> <doc><text>The W(FontSelection) widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in W(FontSelectionDialog). <expr> GTK2.FontSelection();</expr> - <image file='predef.GTK2.FontSelection.1.png' height='249' width='421'>../images/gtk2_fontselection.png</image> + <image file='predef.GTK2.FontSelection.1.png'>../images/gtk2_fontselection.png</image> Properties: string font-name string preview-text </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new GTK2.FontSelection widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.FontSelection'>GTK2.FontSelection</object></returntype> </method>
autodoc.git/onepage.xml:61290: </method> </docgroup> </class> <class name='FontSelectionDialog'> <doc><text>The GtkFontSelectionDialog widget is a dialog box for selecting a font. To set the font which is initially selected, use set_font_name(). To get the selected font use get_font_name(). To change the text which is shown in the preview area, use set_preview_text(). <expr> GTK2.FontSelectionDialog("Select a font")</expr> - <image file='predef.GTK2.FontSelectionDialog.1.png' height='303' width='433'>../images/gtk2_fontselectiondialog.png</image> + <image file='predef.GTK2.FontSelectionDialog.1.png'>../images/gtk2_fontselectiondialog.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new font selection dialog with the specified window title </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='title'><type><string/></type></argument></arguments> <returntype><object resolved='predef::GTK2.FontSelectionDialog'>GTK2.FontSelectionDialog</object></returntype> </method> </docgroup> <docgroup homogen-name='get_apply_button' homogen-type='method'><doc><text>The apply button </text></doc>
autodoc.git/onepage.xml:61359: </method> </docgroup> </class> <class name='Frame'> <doc><text>The frame widget is a Bin that surrounds its child with a decorative frame and an optional label. If present, the label is drawn in a gap in the top side of the frame. The position of the label can be controlled with set_label_align(). Used to visually group objects. <expr> GTK2.Frame("Title")->add(GTK2.Label("Contents"))</expr> - <image file='predef.GTK2.Frame.1.png' height='36' width='62'>../images/gtk2_frame.png</image> + <image file='predef.GTK2.Frame.1.png'>../images/gtk2_frame.png</image> <expr> GTK2.Frame()->add(GTK2.Label("Contents"))</expr> - <image file='predef.GTK2.Frame.2.png' height='21' width='62'>../images/gtk2_frame_2.png</image> + <image file='predef.GTK2.Frame.2.png'>../images/gtk2_frame_2.png</image> <expr> GTK2.Frame()->add(GTK2.Label("Contents"))->set_shadow_type(GTK2.SHADOW_IN)</expr> - <image file='predef.GTK2.Frame.3.png' height='21' width='62'>../images/gtk2_frame_3.png</image> + <image file='predef.GTK2.Frame.3.png'>../images/gtk2_frame_3.png</image> Properties: string label GTK2.Widget label-widget float label-xalign float label-yalign int shadow int shadow-type </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new W(Frame) widget. </text></doc>
autodoc.git/onepage.xml:63802: <arguments><argument name='toolbar'><type><object resolved='predef::GTK2.Toolbar'>GTK2.Toolbar</object></type></argument></arguments> <returntype><object>Gnome2.App</object></returntype> </method> </docgroup> </class> <class name='Gnome2Appbar'> <doc><text>A bar that GNOME applications put on the bottom of the windows to display status, progress, hints for menu items or a minibuffer for getting some sort of response. It has a stack for status messages <expr> GTK2.Gnome2Appbar( 1, 1, GTK2.GNOME_PREFERENCES_USER )->set_progress_percentage( 0.4 );</expr> - <image file='predef.GTK2.Gnome2Appbar.1.png' height='21' width='159'>../images/gnome2_appbar.png</image> + <image file='predef.GTK2.Gnome2Appbar.1.png'>../images/gnome2_appbar.png</image> Properties: int has-progress int has-status int interactivity Signals: clear_prompt Emitted when the prompt is cleared. mixed user_data user_response Emitted when the user hits enter after a prompt.
autodoc.git/onepage.xml:64622: <method name='set_shutdown_command'> <arguments><argument name='argv'><type><array/></type></argument></arguments> <returntype><object>Gnome2.Client</object></returntype> </method> </docgroup> </class> <class name='Gnome2DateEdit'> <doc><text>The GnomeDateEdit widget provides a way to enter dates and times with a helper calendar to let the user select the date. <expr> GTK2.Gnome2DateEdit(time(),1,1);</expr> - <image file='predef.GTK2.Gnome2DateEdit.1.png' height='27' width='331'>../images/gnome2_dateedit.png</image> + <image file='predef.GTK2.Gnome2DateEdit.1.png'>../images/gnome2_dateedit.png</image> <expr> GTK2.Gnome2DateEdit(time(),0,1);</expr> - <image file='predef.GTK2.Gnome2DateEdit.2.png' height='25' width='115'>../images/gnome2_dateedit_2.png</image> + <image file='predef.GTK2.Gnome2DateEdit.2.png'>../images/gnome2_dateedit_2.png</image> Properties: int dateedit-flags int initial-time int lower-hour int time int upper-hour Signals: date_changed time_changed </text></doc>
autodoc.git/onepage.xml:65041: <method name='set_top_watermark'> <arguments><argument name='watermark'><type><object resolved='predef::GTK2.GdkPixbuf'>GTK2.GdkPixbuf</object></type></argument></arguments> <returntype><object>Gnome2.DruidPageStandard</object></returntype> </method> </docgroup> </class> <class name='Gnome2Href'> <doc><text>This widget is a GtkButton button that contains a URL. When clicked it invokes the configured browser for the URL you provided. <expr> GTK2.Gnome2Href( "http://www.gnome.org", "GNOME Web Site" )</expr> - <image file='predef.GTK2.Gnome2Href.1.png' height='27' width='119'>../images/gnome2_href.png</image> + <image file='predef.GTK2.Gnome2Href.1.png'>../images/gnome2_href.png</image> <expr> GTK2.Gnome2Href( "http://www.gnome.org" )</expr> - <image file='predef.GTK2.Gnome2Href.2.png' height='27' width='10'>../images/gnome2_href_2.png</image> + <image file='predef.GTK2.Gnome2Href.2.png'>../images/gnome2_href_2.png</image> Properties: string text string url Style properties: GDK.Color link-color </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Created a GNOME href object, a label widget with a clickable action and an associated URL. If label is set to 0, url is used as the label. </text></doc>
autodoc.git/onepage.xml:65249: <method name='stop_loading'> <arguments/> <returntype><object>Gnome2.IconSelection</object></returntype> </method> </docgroup> </class> <class name='HScrollbar'> <doc><text>A horizontal scrollbar. General documentation: See W(Scrollbar) <expr> GTK2.HScrollbar(GTK2.Adjustment())->set_size_request(300,15)</expr> - <image file='predef.GTK2.HScrollbar.1.png' height='15' width='300'>../images/gtk2_hscrollbar.png</image> + <image file='predef.GTK2.HScrollbar.1.png'>../images/gtk2_hscrollbar.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new hscrollbar widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='adjustment_or_props'><type><object resolved='predef::GTK2.Adjustment'>GTK2.Adjustment</object></type></argument></arguments> <returntype><object resolved='predef::GTK2.HScrollbar'>GTK2.HScrollbar</object></returntype> </method> </docgroup> <docgroup homogen-name='Scrollbar' homogen-type='inherit'> <inherit name='Scrollbar'><classname resolved='predef::GTK2.Scrollbar'>GTK2.Scrollbar</classname></inherit> </docgroup> </class> <class name='HandleBox'> <doc><text>The contents of a handle box can be 'dragged' out of the box by the user. The contents will then be placed in a separate window. <expr> GTK2.HandleBox()->add(GTK2.Label("The contents"))</expr> - <image file='predef.GTK2.HandleBox.1.png' height='17' width='93'>../images/gtk2_handlebox.png</image> + <image file='predef.GTK2.HandleBox.1.png'>../images/gtk2_handlebox.png</image> Properties: int handle-position int shadow int shadow-type int snap-edge int snap-edge-set Signals: child_attached Called when a new child is added to the box child_detached
autodoc.git/onepage.xml:65340: </docgroup> </class> <class name='Hbox'> <doc><text>Most packing is done by creating boxes. These are invisible widget containers that we can pack our widgets into which come in two forms, a horizontal box, and a vertical box. This is the horizontal one. When packing widgets into a horizontal box, the objects are inserted horizontally from left to right or right to left depending on the call used. <expr> GTK2.Hbox(0,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))</expr> - <image file='predef.GTK2.Hbox.1.png' height='27' width='42'>../images/gtk2_hbox.png</image> + <image file='predef.GTK2.Hbox.1.png'>../images/gtk2_hbox.png</image> <expr> GTK2.Hbox(1,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))</expr> - <image file='predef.GTK2.Hbox.2.png' height='27' width='42'>../images/gtk2_hbox_2.png</image> + <image file='predef.GTK2.Hbox.2.png'>../images/gtk2_hbox_2.png</image> <expr> GTK2.Hbox(1,40)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))</expr> - <image file='predef.GTK2.Hbox.3.png' height='27' width='42'>../images/gtk2_hbox_3.png</image> + <image file='predef.GTK2.Hbox.3.png'>../images/gtk2_hbox_3.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new horizontal box widget. If all_same_size is true, all widgets will have exactly the same size. hpadding is added to the left and right of the children. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='uniformp_or_props'><type><or><int/><mapping/></or></type></argument><argument name='hpadding'><type><or><int/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Hbox'>GTK2.Hbox</object></returntype> </method> </docgroup> <docgroup homogen-name='Box' homogen-type='inherit'> <inherit name='Box'><classname resolved='predef::GTK2.Box'>GTK2.Box</classname></inherit> </docgroup> </class> <class name='HbuttonBox'> <doc><text>A HbuttonBox is very similar to a Hbox. The major diffference is that the button box is made to pack buttons in, and has a few convenience function for normal button layouts. <expr> GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_size_request(400,30)</expr> - <image file='predef.GTK2.HbuttonBox.1.png' height='30' width='400'>../images/gtk2_hbuttonbox.png</image> + <image file='predef.GTK2.HbuttonBox.1.png'>../images/gtk2_hbuttonbox.png</image> <expr> GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_SPREAD)->set_size_request(400,30)</expr> - <image file='predef.GTK2.HbuttonBox.2.png' height='30' width='400'>../images/gtk2_hbuttonbox_2.png</image> + <image file='predef.GTK2.HbuttonBox.2.png'>../images/gtk2_hbuttonbox_2.png</image> <expr> GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_EDGE)->set_size_request(400,30)</expr> - <image file='predef.GTK2.HbuttonBox.3.png' height='30' width='400'>../images/gtk2_hbuttonbox_3.png</image> + <image file='predef.GTK2.HbuttonBox.3.png'>../images/gtk2_hbuttonbox_3.png</image> <expr> GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_START)->set_size_request(400,30)</expr> - <image file='predef.GTK2.HbuttonBox.4.png' height='30' width='400'>../images/gtk2_hbuttonbox_4.png</image> + <image file='predef.GTK2.HbuttonBox.4.png'>../images/gtk2_hbuttonbox_4.png</image> <expr> GTK2.HbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_END)->set_size_request(400,30)</expr> - <image file='predef.GTK2.HbuttonBox.5.png' height='30' width='400'>../images/gtk2_hbuttonbox_5.png</image> + <image file='predef.GTK2.HbuttonBox.5.png'>../images/gtk2_hbuttonbox_5.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new horizontal button box </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.HbuttonBox'>GTK2.HbuttonBox</object></returntype> </method> </docgroup> <docgroup homogen-name='ButtonBox' homogen-type='inherit'> <inherit name='ButtonBox'><classname resolved='predef::GTK2.ButtonBox'>GTK2.ButtonBox</classname></inherit> </docgroup> </class> <class name='Hpaned'> <doc><text>The paned window widgets are useful when you want to divide an area into two parts, with the relative size of the two parts controlled by the user. A groove is drawn between the two portions with a handle that the user can drag to change the ratio. This widgets makes a horizontal division See W(Paned) for details. <expr> GTK2.Hpaned()->add1(GTK2.Label("Left\nSide\nOf\nPane"))->add2(GTK2.Label("Right\nSide\nOf\nPane"))->set_size_request(100,100)</expr> - <image file='predef.GTK2.Hpaned.1.png' height='100' width='100'>../images/gtk2_hpaned.png</image> + <image file='predef.GTK2.Hpaned.1.png'>../images/gtk2_hpaned.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new W(Hpaned) widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Hpaned'>GTK2.Hpaned</object></returntype> </method> </docgroup> <docgroup homogen-name='Paned' homogen-type='inherit'> <inherit name='Paned'><classname resolved='predef::GTK2.Paned'>GTK2.Paned</classname></inherit>
autodoc.git/onepage.xml:65417: <class name='Hscale'> <doc><text>The GTK2.HScale widget is used to allow the user to select a value using a horizontal slider. A GTK2.Adjustment is used to set the initial value, the lower and upper bounds, and the step and page increments. See W(Scale) for details The position to show the current value, and the number of decimal places shown can be set using the parent W(Scale) class's functions. <expr> GTK2.Hscale(GTK2.Adjustment())->set_size_request(300,30)</expr> - <image file='predef.GTK2.Hscale.1.png' height='30' width='300'>../images/gtk2_hscale.png</image> + <image file='predef.GTK2.Hscale.1.png'>../images/gtk2_hscale.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new hscale widget. Either pass an W(Adjustment), or three floats representing min, max, and step values. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='settings_or_min_props'><type><object resolved='predef::GTK2.Adjustment'>GTK2.Adjustment</object></type></argument><argument name='max'><type><or><float/><void/></or></type></argument><argument name='step'><type><or><float/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Hscale'>GTK2.Hscale</object></returntype> </method> </docgroup> <docgroup homogen-name='Scale' homogen-type='inherit'> <inherit name='Scale'><classname resolved='predef::GTK2.Scale'>GTK2.Scale</classname></inherit> </docgroup> </class> <class name='Hseparator'> <doc><text>Simply creates a horizontal separator. No bells or whistles. <expr> GTK2.Hseparator()->set_size_request(300,3)</expr> - <image file='predef.GTK2.Hseparator.1.png' height='3' width='300'>../images/gtk2_hseparator.png</image> + <image file='predef.GTK2.Hseparator.1.png'>../images/gtk2_hseparator.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new hseparator widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Hseparator'>GTK2.Hseparator</object></returntype> </method> </docgroup> <docgroup homogen-name='Separator' homogen-type='inherit'> <inherit name='Separator'><classname resolved='predef::GTK2.Separator'>GTK2.Separator</classname></inherit>
autodoc.git/onepage.xml:66338: <arguments><argument name='path'><type><object resolved='predef::GTK2.TreePath'>GTK2.TreePath</object></type></argument></arguments> <returntype><object resolved='predef::GTK2.IconView'>GTK2.IconView</object></returntype> </method> </docgroup> </class> <class name='Image'> <doc><text>An image is a image object stored in client, not X server, memory. A pixmap, on the other hand, is a image object stored in the X-server. See GDK2.Image and GDK2.Pixmap. <expr> GTK2.Image("tornado_nguyen_big.jpg");</expr> - <image file='predef.GTK2.Image.1.png' height='20' width='20'>../images/gtk2_image.png</image> + <image file='predef.GTK2.Image.1.png'>../images/gtk2_image.png</image> Properties: string file string icon-name icon-set int icon-size GDK2.Image image GDK2.Pixmap mask GDK2.Pixbuf pixbuf GDK2.PixbufAnimation pixbuf-animation int pixel-size
autodoc.git/onepage.xml:66604: <returntype><object resolved='predef::GTK2.KeywordListTag'>GTK2.KeywordListTag</object></returntype> </method> </docgroup> <docgroup homogen-name='SourceTag' homogen-type='inherit'> <inherit name='SourceTag'><classname resolved='predef::GTK2.SourceTag'>GTK2.SourceTag</classname></inherit> </docgroup> </class> <class name='Label'> <doc><text>A simple text label. <expr> GTK2.Label("A simple text label")</expr> - <image file='predef.GTK2.Label.1.png' height='17' width='118'>../images/gtk2_label.png</image> + <image file='predef.GTK2.Label.1.png'>../images/gtk2_label.png</image> <expr> GTK2.Label("Multi\nline text\nlabel here")</expr> - <image file='predef.GTK2.Label.2.png' height='51' width='63'>../images/gtk2_label_2.png</image> + <image file='predef.GTK2.Label.2.png'>../images/gtk2_label_2.png</image> <expr> GTK2.Label("Multi\nline text\nlabel here")->set_justify(GTK2.JUSTIFY_LEFT)</expr> - <image file='predef.GTK2.Label.3.png' height='51' width='63'>../images/gtk2_label_3.png</image> + <image file='predef.GTK2.Label.3.png'>../images/gtk2_label_3.png</image> <expr> GTK2.Label("Multi\nline text\nlabel here")->set_justify(GTK2.JUSTIFY_RIGHT)</expr> - <image file='predef.GTK2.Label.4.png' height='51' width='63'>../images/gtk2_label_4.png</image> + <image file='predef.GTK2.Label.4.png'>../images/gtk2_label_4.png</image> Properties: float angle Pango.AttrList attributes int cursor-position int ellipsize <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_END'>PANGO_ELLIPSIZE_END</ref>, <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_MIDDLE'>PANGO_ELLIPSIZE_MIDDLE</ref>, <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_NONE'>PANGO_ELLIPSIZE_NONE</ref> and <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_START'>PANGO_ELLIPSIZE_START</ref> int justfy <ref resolved='predef::GTK2.JUSTIFY_CENTER'>JUSTIFY_CENTER</ref>, <ref resolved='predef::GTK2.JUSTIFY_FILL'>JUSTIFY_FILL</ref>, <ref resolved='predef::GTK2.JUSTIFY_LEFT'>JUSTIFY_LEFT</ref> and <ref resolved='predef::GTK2.JUSTIFY_RIGHT'>JUSTIFY_RIGHT</ref> string label int max-width-chars int mnemonic-keyval int mnemonic-widget
autodoc.git/onepage.xml:67401: <returntype><object resolved='predef::GTK2.Menu'>GTK2.Menu</object></returntype> </method> </docgroup> </class> <class name='MenuBar'> <doc><text>Basically a horizontal W(Menu). The menu image cannot be grabbed automatically, but this is how you would create a menu all in one line. This is not the recommended coding style. <expr> GTK2.MenuBar()->add(GTK2.MenuItem("Menu")->set_submenu(GTK2.Menu()->add(GTK2.MenuItem("Sub")))->select()->activate())->add(GTK2.MenuItem("Bar"))</expr> - <image file='predef.GTK2.MenuBar.1.png' height='27' width='91'>../images/gtk2_menubar.png</image> + <image file='predef.GTK2.MenuBar.1.png'>../images/gtk2_menubar.png</image> Properties: int child-pack-direction int pack-direction Style properties: int internal-padding int shadow-type </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new menu bar. </text></doc> <method name='create'><modifiers><protected/></modifiers>
autodoc.git/onepage.xml:67789: itself, but is used to derive subclasses which have alignment and padding attributes. The horizontal and vertical padding attributes allows extra space to be added around the widget. The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. Note that if the widget is added to a container in such a way that it expands automatically to fill its allocated area, the alignment settings will not alter the widgets position. <expr> GTK2.Vbox(0,0)->add(GTK2.Label("Label"))->set_size_request(100,20)</expr> - <image file='predef.GTK2.Misc.1.png' height='20' width='100'>../images/gtk2_misc.png</image> + <image file='predef.GTK2.Misc.1.png'>../images/gtk2_misc.png</image> <expr> GTK2.Vbox(0,0)->add(GTK2.Label("Label")->set_alignment(1.0,0.0))->set_size_request(100,20)</expr> - <image file='predef.GTK2.Misc.2.png' height='20' width='100'>../images/gtk2_misc_2.png</image> + <image file='predef.GTK2.Misc.2.png'>../images/gtk2_misc_2.png</image> <expr> GTK2.Vbox(0,0)->add(GTK2.Label("Label")->set_alignment(0.0,0.0))->set_size_request(100,20)</expr> - <image file='predef.GTK2.Misc.3.png' height='20' width='100'>../images/gtk2_misc_3.png</image> + <image file='predef.GTK2.Misc.3.png'>../images/gtk2_misc_3.png</image> Properties: float xalign The horizontal alignment, from 0 (left) to 1 (right). int xpad The amount of space to add on the left and right of the widget, in pixels. float yalign The vertical alignment, from 0 (top) to 1 (bottom). int ypad The amount of space to add on the top and bottom of the widget, in
autodoc.git/onepage.xml:67847: </method> </docgroup> </class> <class name='Notebook'> <doc><text>The NoteBook Widget is a collection of 'pages' that overlap each other, each page contains different information. This widget has become more common lately in GUI programming, and it is a good way to show blocks similar information that warrant separation in their display. <expr> GTK2.Notebook()->set_tab_pos(GTK2.POS_LEFT)->append_page(GTK2.Label("Page 1\nContents"),GTK2.Label("Page 1"))->append_page(GTK2.Label(""),GTK2.Label("Page 2"))->append_page(GTK2.Label("Page 3 contents\nare here!"),GTK2.Label("Page 3"))</expr> - <image file='predef.GTK2.Notebook.1.png' height='38' width='116'>../images/gtk2_notebook.png</image> + <image file='predef.GTK2.Notebook.1.png'>../images/gtk2_notebook.png</image> <expr> GTK2.Notebook()->set_tab_pos(GTK2.POS_TOP)->append_page(GTK2.Label("Page 1\nContents"),GTK2.Label("Page 1"))->append_page(GTK2.Label(""),GTK2.Label("Page 2"))->append_page(GTK2.Label("Page 3 contents\nare here!"),GTK2.Label("Page 3"))</expr> - <image file='predef.GTK2.Notebook.2.png' height='65' width='62'>../images/gtk2_notebook_2.png</image> + <image file='predef.GTK2.Notebook.2.png'>../images/gtk2_notebook_2.png</image> <expr> GTK2.Notebook()->set_tab_pos(GTK2.POS_RIGHT)->append_page(GTK2.Label("Page 1\nContents"),GTK2.Label("Page 1"))->append_page(GTK2.Label(""),GTK2.Label("Page 2"))->append_page(GTK2.Label("Page 3 contents\nare here!"),GTK2.Label("Page 3"))->next_page()->next_page()</expr> - <image file='predef.GTK2.Notebook.3.png' height='38' width='116'>../images/gtk2_notebook_3.png</image> + <image file='predef.GTK2.Notebook.3.png'>../images/gtk2_notebook_3.png</image> Properties: int enable-popup int homogeneous int page int scrollable int show-border int show-tabs int tab-border int tab-hborder int tab-pos
autodoc.git/onepage.xml:69416: float text-yalign </text></doc> <docgroup homogen-name='Widget' homogen-type='inherit'> <inherit name='Widget'><classname resolved='predef::GTK2.Widget'>GTK2.Widget</classname></inherit> </docgroup> </class> <class name='ProgressBar'> <doc><text>A simple progress bar. Useful when you are doing things that take a long time. Try to always have an 'abort' button whenever it makes sence. <expr> GTK2.ProgressBar()->set_fraction(0.1)</expr> - <image file='predef.GTK2.ProgressBar.1.png' height='20' width='150'>../images/gtk2_progressbar.png</image> + <image file='predef.GTK2.ProgressBar.1.png'>../images/gtk2_progressbar.png</image> <expr> GTK2.ProgressBar()->set_property("show_text", 1)->set_fraction(0.3)</expr> - <image file='predef.GTK2.ProgressBar.2.png' height='28' width='150'>../images/gtk2_progressbar_2.png</image> + <image file='predef.GTK2.ProgressBar.2.png'>../images/gtk2_progressbar_2.png</image> <expr> GTK2.ProgressBar()->set_fraction(0.6)</expr> - <image file='predef.GTK2.ProgressBar.3.png' height='20' width='150'>../images/gtk2_progressbar_3.png</image> + <image file='predef.GTK2.ProgressBar.3.png'>../images/gtk2_progressbar_3.png</image> <expr> GTK2.ProgressBar()->set_fraction(1.0)</expr> - <image file='predef.GTK2.ProgressBar.4.png' height='20' width='150'>../images/gtk2_progressbar_4.png</image> + <image file='predef.GTK2.ProgressBar.4.png'>../images/gtk2_progressbar_4.png</image> Properties: int discrete-blocks int ellipsize <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_END'>PANGO_ELLIPSIZE_END</ref>, <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_MIDDLE'>PANGO_ELLIPSIZE_MIDDLE</ref>, <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_NONE'>PANGO_ELLIPSIZE_NONE</ref> and <ref resolved='predef::GTK2.PANGO_ELLIPSIZE_START'>PANGO_ELLIPSIZE_START</ref> float fraction int orientation <ref resolved='predef::GTK2.PROGRESS_BOTTOM_TO_TOP'>PROGRESS_BOTTOM_TO_TOP</ref>, <ref resolved='predef::GTK2.PROGRESS_CONTINUOUS'>PROGRESS_CONTINUOUS</ref>, <ref resolved='predef::GTK2.PROGRESS_DISCRETE'>PROGRESS_DISCRETE</ref>, <ref resolved='predef::GTK2.PROGRESS_LEFT_TO_RIGHT'>PROGRESS_LEFT_TO_RIGHT</ref>, <ref resolved='predef::GTK2.PROGRESS_RIGHT_TO_LEFT'>PROGRESS_RIGHT_TO_LEFT</ref> and <ref resolved='predef::GTK2.PROGRESS_TOP_TO_BOTTOM'>PROGRESS_TOP_TO_BOTTOM</ref> float pulse-step string text </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new progress bar. The default values are:
autodoc.git/onepage.xml:69586: </docgroup> </class> <class name='RadioButton'> <doc><text>Radio buttons are similar to check buttons except they are grouped so that only one may be selected/depressed at a time. This is good for places in your application where you need to select from a short list of options. To connect the buttons, use another button in the desired group as the second argument to GTK2.RadioButton(). <expr> GTK2.RadioButton("Button");</expr> - <image file='predef.GTK2.RadioButton.1.png' height='21' width='65'>../images/gtk2_radiobutton.png</image> + <image file='predef.GTK2.RadioButton.1.png'>../images/gtk2_radiobutton.png</image> Properties: GTK2.RadioButton group Signals: group_changed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Normal creation: object GTK2.RadioButton(string title) - First button (with label) object GTK2.RadioButton()->add(widget) - First button (with widget) object GTK2.RadioButton(title, another_radio_button) - Second to n:th button (with title) object GTK2.RadioButton(0,another_radio_button)->add(widget) - Second to n:th button (with widget)
autodoc.git/onepage.xml:69627: </text></doc> <method name='set_group'> <arguments><argument name='groupmember'><type><object resolved='predef::GTK2.RadioButton'>GTK2.RadioButton</object></type></argument></arguments> <returntype><object resolved='predef::GTK2.RadioButton'>GTK2.RadioButton</object></returntype> </method> </docgroup> </class> <class name='RadioMenuItem'> <doc><text>Exactly like W(RadioButton), but it is an menu item. <expr> GTK2.RadioMenuItem("Menu item")</expr> - <image file='predef.GTK2.RadioMenuItem.1.png' height='21' width='78'>../images/gtk2_radiomenuitem.png</image> + <image file='predef.GTK2.RadioMenuItem.1.png'>../images/gtk2_radiomenuitem.png</image> Properties: GTK2.RadioMenuItem group Signals: group_changed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>object GTK2.RadioMenuItem(string title) - First button (with label) object GTK2.RadioMenuItem()->add(widget) - First button (with widget) object GTK2.RadioMenuItem(title, another_radio_button) - Second to n:th button (with title) object GTK2.RadioMenuItem(0,another_radio_button)->add(widget) - Second to n:th button (with widget) </text></doc>
autodoc.git/onepage.xml:70811: <docgroup homogen-name='Range' homogen-type='inherit'> <inherit name='Range'><classname resolved='predef::GTK2.Range'>GTK2.Range</classname></inherit> </docgroup> </class> <class name='ScrolledWindow'> <doc><text>Scrolled windows are used to create a scrollable area with another widget inside it. You may insert any type of widget into a scrolled window, and it will be accessible regardless of its size by using the scrollbars. <expr> GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("A small label"))->set_policy(GTK2.POLICY_AUTOMATIC,GTK2.POLICY_AUTOMATIC)</expr> - <image file='predef.GTK2.ScrolledWindow.1.png' height='57' width='40'>../images/gtk2_scrolledwindow.png</image> + <image file='predef.GTK2.ScrolledWindow.1.png'>../images/gtk2_scrolledwindow.png</image> <expr> GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("A small label"))->set_policy(GTK2.POLICY_AUTOMATIC,GTK2.POLICY_AUTOMATIC)</expr> - <image file='predef.GTK2.ScrolledWindow.2.png' height='57' width='40'>../images/gtk2_scrolledwindow_2.png</image> + <image file='predef.GTK2.ScrolledWindow.2.png'>../images/gtk2_scrolledwindow_2.png</image> <expr> GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("A small label"))</expr> - <image file='predef.GTK2.ScrolledWindow.3.png' height='57' width='57'>../images/gtk2_scrolledwindow_3.png</image> + <image file='predef.GTK2.ScrolledWindow.3.png'>../images/gtk2_scrolledwindow_3.png</image> <expr> GTK2.ScrolledWindow(GTK2.Adjustment(),GTK2.Adjustment())->add(GTK2.Label("a very huge label"))</expr> - <image file='predef.GTK2.ScrolledWindow.4.png' height='57' width='57'>../images/gtk2_scrolledwindow_4.png</image> + <image file='predef.GTK2.ScrolledWindow.4.png'>../images/gtk2_scrolledwindow_4.png</image> Properties: GTK2.Adjustment hadjustment int hscrollbar-policy int shadow-type GTK2.Adjustment vadjustment int vscrollbar-policy int window-placement Style properties: int scrollbar-spacing int scrollbars-within-bevel
autodoc.git/onepage.xml:71890: <ul><li>value: initial value for the Spin Button</li> <li>lower: lower range value</li> <li>upper: upper range value</li> <li>step_increment: value to increment/decrement when pressing mouse button 1 on a button</li> <li>page_increment: value to increment/decrement when pressing mouse button 2 on a button</li> <li>page_size: unused</li> </ul> The argument order for the W(Adjustment) constructor is: value, lower, upper, step_increment, page_increment, page_size <expr> GTK2.SpinButton(GTK2.Adjustment(),0.1, 1 )->set_size_request(60,20)</expr> - <image file='predef.GTK2.SpinButton.1.png' height='20' width='60'>../images/gtk2_spinbutton.png</image> + <image file='predef.GTK2.SpinButton.1.png'>../images/gtk2_spinbutton.png</image> Properties: GTK2.Adjustment adjustment float climb-rate int digits int numeric int snap-to-ticks int update-policy float value int wrap Style properties:
autodoc.git/onepage.xml:72312: <doc><text>Statusbars are simple widgets used to display a text message. They keep a stack of the messages pushed onto them, so that popping the current message will re-display the previous text message. In order to allow different parts of an application to use the same statusbar to display messages, the statusbar widget issues Context Identifiers which are used to identify different 'users'. The message on top of the stack is the one displayed, no matter what context it is in. Messages are stacked in last-in-first-out order, not context identifier order. <expr> lambda() {object sb = GTK2.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");return sb;}()</expr> - <image file='predef.GTK2.Statusbar.1.png' height='21' width='28'>../images/gtk2_statusbar.png</image> + <image file='predef.GTK2.Statusbar.1.png'>../images/gtk2_statusbar.png</image> <expr> lambda() {object sb = GTK2.Statusbar();int id = sb->get_context_id("test");sb->push(id,"A message");sb->push(id,"Another message");sb->pop(id);return sb;}()</expr> - <image file='predef.GTK2.Statusbar.2.png' height='21' width='28'>../images/gtk2_statusbar_2.png</image> + <image file='predef.GTK2.Statusbar.2.png'>../images/gtk2_statusbar_2.png</image> Properties: int has-resize-grip Style properties: int shadow-type Signals: text_popped text_pushed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new statusbar widget </text></doc>
autodoc.git/onepage.xml:72616: </docgroup> <docgroup homogen-name='SourceTag' homogen-type='inherit'> <inherit name='SourceTag'><classname resolved='predef::GTK2.SourceTag'>GTK2.SourceTag</classname></inherit> </docgroup> </class> <class name='Table'> <doc><text>The GTK2.Table allows the programmer to arrange widgets in rows and columns, making it easy to align many widgets next to each other, horizontally and vertically. <expr> GTK2.Table(2,2,0)->attach_defaults( GTK2.Label("0,0"), 0, 1, 0, 1)->attach_defaults( GTK2.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK2.Label("1,0"), 1, 2, 0, 1)->attach_defaults( GTK2.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)</expr> - <image file='predef.GTK2.Table.1.png' height='27' width='30'>../images/gtk2_table.png</image> + <image file='predef.GTK2.Table.1.png'>../images/gtk2_table.png</image> <expr> GTK2.Table(2,2,0)->attach_defaults( GTK2.Label("0,0-1,0"), 0, 2, 0, 1)->attach_defaults( GTK2.Label("0,1"), 0, 1, 1, 2)->attach_defaults( GTK2.Label("1,1"), 1, 2, 1, 2)->set_col_spacings(10)->set_row_spacings(10)</expr> - <image file='predef.GTK2.Table.2.png' height='27' width='30'>../images/gtk2_table_2.png</image> + <image file='predef.GTK2.Table.2.png'>../images/gtk2_table_2.png</image> Properties: int column-spacing int homogeneous int n-columns int n-rows int row-spacing Child properties: int bottom-attach int left-attach int right-attach
autodoc.git/onepage.xml:72787: tear off and reattach its menu. When its menu is shown normally, the GTK2.TearoffMenuItem is drawn as a dotted line indicating that the menu can be torn off. Activating it causes its menu to be torn off and displayed in its own window as a tearoff menu. When its menu is shown as a tearoff menu, the GTK2.TearoffMenuItem is drawn as a dotted line which has a left pointing arrow graphic indicating that the tearoff menu can be reattached. Activating it will erase the tearoff menu window. <expr> GTK2.TearoffMenuItem()->set_size_request(100,0)</expr> - <image file='predef.GTK2.TearoffMenuItem.1.png' height='1' width='100'>../images/gtk2_tearoffmenuitem.png</image> + <image file='predef.GTK2.TearoffMenuItem.1.png'>../images/gtk2_tearoffmenuitem.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new tearoff menu item </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.TearoffMenuItem'>GTK2.TearoffMenuItem</object></returntype> </method> </docgroup> <docgroup homogen-name='Activatable' homogen-type='inherit'> <inherit name='Activatable'><classname resolved='predef::GTK2.Activatable'>GTK2.Activatable</classname></inherit>
autodoc.git/onepage.xml:74984: </method> </docgroup> </class> <class name='ToggleButton'> <doc><text>Toggle buttons are derived from normal buttons and are very similar, except they will always be in one of two states, alternated by a click. They may be depressed, and when you click again, they will pop back up. Click again, and they will pop back down. <expr> GTK2.ToggleButton("Toggle button")</expr> - <image file='predef.GTK2.ToggleButton.1.png' height='27' width='98'>../images/gtk2_togglebutton.png</image> + <image file='predef.GTK2.ToggleButton.1.png'>../images/gtk2_togglebutton.png</image> <expr> GTK2.ToggleButton("Toggle button")->set_active( 1 )</expr> - <image file='predef.GTK2.ToggleButton.2.png' height='27' width='98'>../images/gtk2_togglebutton_2.png</image> + <image file='predef.GTK2.ToggleButton.2.png'>../images/gtk2_togglebutton_2.png</image> Properties: int active int draw-indicator int inconsistent Signals: toggled </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>If you supply a string, a label will be created and inserted in the button. Otherwise, use -&gt;add(widget) to create the contents of the button. </text></doc>
autodoc.git/onepage.xml:75419: </class> <class name='Toolbar'> <doc><text>Toolbars are usually used to group some number of widgets in order to simplify customization of their look and layout. Typically a toolbar consists of buttons with icons, labels and tooltips, but any other widget can also be put inside a toolbar. Finally, items can be arranged horizontally or vertically and buttons can be displayed with icons, labels, or both. Examples: <expr> GTK2.Toolbar()->insert(GTK2.ToolItem()->add(GTK2.Button("Button 1")),-1)->insert(GTK2.ToolItem()->add(GTK2.Label(" ")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 2")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 3")),-1)</expr> - <image file='predef.GTK2.Toolbar.1.png' height='31' width='31'>../images/gtk2_toolbar.png</image> + <image file='predef.GTK2.Toolbar.1.png'>../images/gtk2_toolbar.png</image> <expr> GTK2.Toolbar((["orientation":GTK2.ORIENTATION_VERTICAL]))->insert(GTK2.ToolItem()->add(GTK2.Button("Button 1")),-1)->insert(GTK2.ToolItem()->add(GTK2.Label(" ")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 2")),-1)->insert(GTK2.ToolItem()->add(GTK2.Button("Button 3")),-1)</expr> - <image file='predef.GTK2.Toolbar.2.png' height='31' width='71'>../images/gtk2_toolbar_2.png</image> + <image file='predef.GTK2.Toolbar.2.png'>../images/gtk2_toolbar_2.png</image> Properties: int icon-size int icon-size-set int orientation int show-arrow int toolbar-style int tooltips Child properties: int expand int homogeneous
autodoc.git/onepage.xml:77773: </text></doc> <method name='set_add_tearoffs'> <arguments><argument name='setting'><type><int/></type></argument></arguments> <returntype><object resolved='predef::GTK2.UiManager'>GTK2.UiManager</object></returntype> </method> </docgroup> </class> <class name='VScrollbar'> <doc><text>General documentation: See W(Scrollbar) <expr> GTK2.VScrollbar(GTK2.Adjustment())->set_size_request(15,60)</expr> - <image file='predef.GTK2.VScrollbar.1.png' height='60' width='15'>../images/gtk2_vscrollbar.png</image> + <image file='predef.GTK2.VScrollbar.1.png'>../images/gtk2_vscrollbar.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new vscrollbar widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='pos_or_props'><type><object resolved='predef::GTK2.Adjustment'>GTK2.Adjustment</object></type></argument></arguments> <returntype><object resolved='predef::GTK2.VScrollbar'>GTK2.VScrollbar</object></returntype> </method> </docgroup> <docgroup homogen-name='Scrollbar' homogen-type='inherit'> <inherit name='Scrollbar'><classname resolved='predef::GTK2.Scrollbar'>GTK2.Scrollbar</classname></inherit> </docgroup> </class> <class name='Vbox'> <doc><text>Most packing is done by creating boxes. These are invisible widget containers that we can pack our widgets into which come in two forms, a horizontal box, and a vertical box. This is the vertical one. When packing widgets into a vertical box, the objects are inserted horizontally from top to bottom or bottom to top depending on the call used. <expr> GTK2.Vbox(0,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))</expr> - <image file='predef.GTK2.Vbox.1.png' height='27' width='42'>../images/gtk2_vbox.png</image> + <image file='predef.GTK2.Vbox.1.png'>../images/gtk2_vbox.png</image> <expr> GTK2.Vbox(1,0)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))</expr> - <image file='predef.GTK2.Vbox.2.png' height='27' width='42'>../images/gtk2_vbox_2.png</image> + <image file='predef.GTK2.Vbox.2.png'>../images/gtk2_vbox_2.png</image> <expr> GTK2.Vbox(1,40)->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->pack_end_defaults(GTK2.Button("From right"))->pack_start_defaults(GTK2.Button("From left"))</expr> - <image file='predef.GTK2.Vbox.3.png' height='27' width='42'>../images/gtk2_vbox_3.png</image> + <image file='predef.GTK2.Vbox.3.png'>../images/gtk2_vbox_3.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new vertical box widget. If all_same_size is true, all widgets will have exactly the same size. padding is added to the top and bottom of the children. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='uniformp_or_props'><type><or><int/><mapping/></or></type></argument><argument name='padding'><type><or><int/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Vbox'>GTK2.Vbox</object></returntype> </method> </docgroup> <docgroup homogen-name='Box' homogen-type='inherit'> <inherit name='Box'><classname resolved='predef::GTK2.Box'>GTK2.Box</classname></inherit> </docgroup> </class> <class name='VbuttonBox'> <doc><text>A Vbutton_box is very similar to a Vbox. The major diffference is that the button box is made to pack buttons in, and has a few convenience function for normal button layouts. <expr> GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_size_request(100,300)</expr> - <image file='predef.GTK2.VbuttonBox.1.png' height='300' width='100'>../images/gtk2_vbuttonbox.png</image> + <image file='predef.GTK2.VbuttonBox.1.png'>../images/gtk2_vbuttonbox.png</image> <expr> GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_SPREAD)->set_size_request(100,300)</expr> - <image file='predef.GTK2.VbuttonBox.2.png' height='300' width='100'>../images/gtk2_vbuttonbox_2.png</image> + <image file='predef.GTK2.VbuttonBox.2.png'>../images/gtk2_vbuttonbox_2.png</image> <expr> GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_EDGE)->set_size_request(100,300)</expr> - <image file='predef.GTK2.VbuttonBox.3.png' height='300' width='100'>../images/gtk2_vbuttonbox_3.png</image> + <image file='predef.GTK2.VbuttonBox.3.png'>../images/gtk2_vbuttonbox_3.png</image> <expr> GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_START)->set_size_request(100,300)</expr> - <image file='predef.GTK2.VbuttonBox.4.png' height='300' width='100'>../images/gtk2_vbuttonbox_4.png</image> + <image file='predef.GTK2.VbuttonBox.4.png'>../images/gtk2_vbuttonbox_4.png</image> <expr> GTK2.VbuttonBox()->add(GTK2.Button("Hello"))->add(GTK2.Button("World"))->set_layout(GTK2.BUTTONBOX_END)->set_size_request(100,300)</expr> - <image file='predef.GTK2.VbuttonBox.5.png' height='300' width='100'>../images/gtk2_vbuttonbox_5.png</image> + <image file='predef.GTK2.VbuttonBox.5.png'>../images/gtk2_vbuttonbox_5.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new vertical button box </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.VbuttonBox'>GTK2.VbuttonBox</object></returntype> </method> </docgroup> <docgroup homogen-name='ButtonBox' homogen-type='inherit'> <inherit name='ButtonBox'><classname resolved='predef::GTK2.ButtonBox'>GTK2.ButtonBox</classname></inherit> </docgroup> </class> <class name='Viewport'> <doc><text>This is a container that can be scrolled around, but it has no scrollbars. You can connect scrollbars to it using the adjustment objects. <expr> GTK2.Viewport(GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)</expr> - <image file='predef.GTK2.Viewport.1.png' height='100' width='100'>../images/gtk2_viewport.png</image> + <image file='predef.GTK2.Viewport.1.png'>../images/gtk2_viewport.png</image> <expr> GTK2.Viewport(GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)->set_shadow_type(GTK2.SHADOW_ETCHED_IN)</expr> - <image file='predef.GTK2.Viewport.2.png' height='100' width='100'>../images/gtk2_viewport_2.png</image> + <image file='predef.GTK2.Viewport.2.png'>../images/gtk2_viewport_2.png</image> <expr> GTK2.Viewport(GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)->add(GTK2.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK2.SHADOW_ETCHED_IN)</expr> - <image file='predef.GTK2.Viewport.3.png' height='100' width='100'>../images/gtk2_viewport_3.png</image> + <image file='predef.GTK2.Viewport.3.png'>../images/gtk2_viewport_3.png</image> <expr> lambda(){ object a1;object v = GTK2.Viewport(a1=GTK2.Adjustment(),GTK2.Adjustment())->set_size_request(100,100)->add(GTK2.Label("A label with a very long text on it, it will not fit"))->set_shadow_type(GTK2.SHADOW_ETCHED_IN);call_out(a1->set_value,0,100.0);return v;}()</expr> - <image file='predef.GTK2.Viewport.4.png' height='100' width='100'>../images/gtk2_viewport_4.png</image> + <image file='predef.GTK2.Viewport.4.png'>../images/gtk2_viewport_4.png</image> Properties: GTK2.Adjustment hadjustment int shadow-type GTK2.Adjustment vadjustment Signals: set_scroll_adjustments </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new viewport. The adjustments are used to select what part of the viewport to view to the user. They are normally connected to a scrollbar or something similar.
autodoc.git/onepage.xml:77934: <inherit name='ScaleButton'><classname resolved='predef::GTK2.ScaleButton'>GTK2.ScaleButton</classname></inherit> </docgroup> </class> <class name='Vpaned'> <doc><text>The paned window widgets are useful when you want to divide an area into two parts, with the relative size of the two parts controlled by the user. A groove is drawn between the two portions with a handle that the user can drag to change the ratio. This widgets makes a vertical division <expr> GTK2.Vpaned()->add1(GTK2.Label("Top Side Of Pane"))->add2(GTK2.Label("Bottom"))->set_size_request(100,100)</expr> - <image file='predef.GTK2.Vpaned.1.png' height='100' width='100'>../images/gtk2_vpaned.png</image> + <image file='predef.GTK2.Vpaned.1.png'>../images/gtk2_vpaned.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new W(Vpaned) widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Vpaned'>GTK2.Vpaned</object></returntype> </method> </docgroup> <docgroup homogen-name='Paned' homogen-type='inherit'> <inherit name='Paned'><classname resolved='predef::GTK2.Paned'>GTK2.Paned</classname></inherit>
autodoc.git/onepage.xml:77957: <class name='Vscale'> <doc><text>The GTK2.HScale widget is used to allow the user to select a value using a horizontal slider. A GTK2.Adjustment is used to set the initial value, the lower and upper bounds, and the step and page increments. See W(Scale) for details The position to show the current value, and the number of decimal places shown can be set using the parent W(Scale) class's functions. <expr> GTK2.Vscale(GTK2.Adjustment())->set_size_request(300,30)</expr> - <image file='predef.GTK2.Vscale.1.png' height='30' width='300'>../images/gtk2_vscale.png</image> + <image file='predef.GTK2.Vscale.1.png'>../images/gtk2_vscale.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new hscale widget. Either pass an W(Adjustment), or three floats representing min, max, and step values. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='settings_or_min_props'><type><object resolved='predef::GTK2.Adjustment'>GTK2.Adjustment</object></type></argument><argument name='max'><type><or><float/><void/></or></type></argument><argument name='step'><type><or><float/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Vscale'>GTK2.Vscale</object></returntype> </method> </docgroup> <docgroup homogen-name='Scale' homogen-type='inherit'> <inherit name='Scale'><classname resolved='predef::GTK2.Scale'>GTK2.Scale</classname></inherit> </docgroup> </class> <class name='Vseparator'> <doc><text>Simply creates a vertical separator. No bells or whistles. <expr> GTK2.Vseparator()->set_size_request(3,50)</expr> - <image file='predef.GTK2.Vseparator.1.png' height='50' width='3'>../images/gtk2_vseparator.png</image> + <image file='predef.GTK2.Vseparator.1.png'>../images/gtk2_vseparator.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Used to create a new vseparator widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='props'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><object resolved='predef::GTK2.Vseparator'>GTK2.Vseparator</object></returntype> </method> </docgroup> <docgroup homogen-name='Separator' homogen-type='inherit'> <inherit name='Separator'><classname resolved='predef::GTK2.Separator'>GTK2.Separator</classname></inherit>
autodoc.git/onepage.xml:82221: <docgroup homogen-name='GTK1' homogen-type='import'> <import name='GTK1'><classname resolved='predef::GTK1'>GTK1</classname></import> </docgroup> <class name='About'> <doc><text>A standard way of providing a small about box for your application. You provide the name of your application, version, copyright, a list of authors and some comments about your application. It also allows the programmer to provide a logo to be displayed. <expr> Gnome.About( "Example", "1.0", "(c) Roxen IS 2000\n(c) IDA, LiU 2002", ({"Per Hedbor"}), "Some nice documentation\nabout this example" );</expr> - <image file='predef.Gnome.About.1.png' height='228' width='180'>../images/gnome_about.png</image> + <image file='predef.Gnome.About.1.png'>../images/gnome_about.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new GNOME About dialog. title, version, copyright, and authors are displayed first, in that order. comments is typically the location for multiple lines of text, if necessary. (Separate with "\n".) logo is the filename of a optional pixmap to be displayed in the dialog, typically a product or company logo of some sort; omit this argument if no logo file is available. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='title'><type><string/></type></argument><argument name='version'><type><string/></type></argument><argument name='copyright'><type><string/></type></argument><argument name='authors'><type><array/></type></argument><argument name='comment'><type><string/></type></argument><argument name='logo'><type><or><string/><void/></or></type></argument></arguments>
autodoc.git/onepage.xml:82486: <arguments><argument name='percent'><type><float/></type></argument></arguments> <returntype><object resolved='predef::Gnome.AppProgressKey'>Gnome.AppProgressKey</object></returntype> </method> </docgroup> </class> <class name='Appbar'> <doc><text>A bar that GNOME applications put on the bottom of the windows to display status, progress, hints for menu items or a minibuffer for getting some sort of response. It has a stack for status messages <expr> Gnome.Appbar( 1, 1, Gnome.PreferencesUser )->set_progress( 0.4 );</expr> - <image file='predef.Gnome.Appbar.1.png' height='20' width='159'>../images/gnome_appbar.png</image> + <image file='predef.Gnome.Appbar.1.png'>../images/gnome_appbar.png</image> Signals: clear_prompt Emitted when the prompt is cleared user_response Emitted when the user hits enter after a prompt </text></doc> <docgroup homogen-name='clear_prompt' homogen-type='method'><doc><text>Remove any prompt. </text></doc> <method name='clear_prompt'> <arguments/>
autodoc.git/onepage.xml:82880: </method> </docgroup> </class> <class name='Calculator'> <doc><text>This widget provides a simple calculator that you can embed in your applications for doing quick computations. The widget consists of a fully functional calculator including standard arithmetic functions as well as trigonometric capabilities, exponents, factorials, nested equations, and others. <expr> Gnome.Calculator()</expr> - <image file='predef.Gnome.Calculator.1.png' height='214' width='260'>../images/gnome_calculator.png</image> + <image file='predef.Gnome.Calculator.1.png'>../images/gnome_calculator.png</image> Signals: result_changed This signal is emited by the widget when the result has been changed. </text></doc> <docgroup homogen-name='clear' homogen-type='method'><doc><text>Resets the calculator back to zero. If reset is TRUE, results stored in memory and the calculator mode are cleared also. </text></doc> <method name='clear'> <arguments><argument name='reset'><type><int/></type></argument></arguments> <returntype><object resolved='predef::Gnome.Calculator'>Gnome.Calculator</object></returntype>
autodoc.git/onepage.xml:82930: <doc><text>This widget provides color selection facilities to your application. The widget appears as a button which contains a "color swatch" of the currently selected color. When the button is pressed, the widget presents the user with a color selection dialog where the color can be selected. You can select the color to be displayed in a number of ways: floating point values for the red, green and blue channels, integers in the range 0 to 65,535, or integers in the range 0 to 255, depending on your needs. <expr> Gnome.ColorPicker();</expr> - <image file='predef.Gnome.ColorPicker.1.png' height='24' width='32'>../images/gnome_colorpicker.png</image> + <image file='predef.Gnome.ColorPicker.1.png'>../images/gnome_colorpicker.png</image> Signals: color_set This signal is emitted when the user changes the color on the color selector. The values passed to this signal are the red, green, blue and alpha channels selected in integer form in the range 0 to 65535. </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new GNOME color picker widget. This returns a widget in the form of a small button containing a swatch representing the current selected color. When the button is clicked, a
autodoc.git/onepage.xml:83012: <method name='set_use_alpha'> <arguments><argument name='use_alpha'><type><int/></type></argument></arguments> <returntype><object resolved='predef::Gnome.ColorPicker'>Gnome.ColorPicker</object></returntype> </method> </docgroup> </class> <class name='DateEdit'> <doc><text>The GnomeDateEdit widget provides a way to enter dates and times with a helper calendar to let the user select the date. <expr> Gnome.DateEdit(time(),1,1);</expr> - <image file='predef.Gnome.DateEdit.1.png' height='20' width='277'>../images/gnome_dateedit.png</image> + <image file='predef.Gnome.DateEdit.1.png'>../images/gnome_dateedit.png</image> <expr> Gnome.DateEdit(time(),0,1);</expr> - <image file='predef.Gnome.DateEdit.2.png' height='19' width='107'>../images/gnome_dateedit_2.png</image> + <image file='predef.Gnome.DateEdit.2.png'>../images/gnome_dateedit_2.png</image> Signals: date_changed time_changed </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new GnomeDateEdit widget which can be used to provide an easy to use way for entering dates and times. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='the_time'><type><int/></type></argument><argument name='show_time'><type><int/></type></argument><argument name='use_24_format'><type><int/></type></argument></arguments> <returntype><object resolved='predef::Gnome.DateEdit'>Gnome.DateEdit</object></returntype>
autodoc.git/onepage.xml:83841: </method> </docgroup> </class> <class name='Entry'> <doc><text>This widget is a wrapper around the GtkEntry widget, but it provides a history mechanism for all the input entered into the widget. The way this works is that a special identifier is provided when creating the GnomeEntry widget, and this identifier is used to load and save the history of the text. <expr> Gnome.Entry( "history" )</expr> - <image file='predef.Gnome.Entry.1.png' height='19' width='175'>../images/gnome_entry.png</image> + <image file='predef.Gnome.Entry.1.png'>../images/gnome_entry.png</image> </text></doc> <docgroup homogen-name='append_history' homogen-type='method'><doc><text>Adds a history item of the given text to the tail of the history list inside gentry. If save is TRUE, the history item will be saved in the config file (assuming that gentry's history id is not 0). </text></doc> <method name='append_history'> <arguments><argument name='save'><type><int/></type></argument><argument name='text'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Gnome.Entry'>Gnome.Entry</object></returntype> </method> </docgroup>
autodoc.git/onepage.xml:83913: <returntype><object resolved='predef::Gnome.Entry'>Gnome.Entry</object></returntype> </method> </docgroup> </class> <class name='FileEntry'> <doc><text>This widget provides an entry box with history (a W(GnomeEntry)) and a button which can pop up a file selector dialog box W(GtkFileSelection). It also accepts DND drops from the filemanager and other sources. <expr> Gnome.FileEntry("","")</expr> - <image file='predef.Gnome.FileEntry.1.png' height='19' width='228'>../images/gnome_fileentry.png</image> + <image file='predef.Gnome.FileEntry.1.png'>../images/gnome_fileentry.png</image> Signals: browse_clicked Signal emitted when the "browse" button is clicked. This is so that you can add stuff to the file selector or to override this method. </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new Gnome.FileEntry widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='history_id'><type><string/></type></argument><argument name='browse_dialog_title'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Gnome.FileEntry'>Gnome.FileEntry</object></returntype>
autodoc.git/onepage.xml:83997: </text></doc> <method name='set_title'> <arguments><argument name='browse_dialog_title'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Gnome.FileEntry'>Gnome.FileEntry</object></returntype> </method> </docgroup> </class> <class name='FontPicker'> <doc><text>GnomeFontPicker - Button that displays current font; click to select new font. <expr> Gnome.FontPicker();</expr> - <image file='predef.Gnome.FontPicker.1.png' height='30' width='30'>../images/gnome_fontpicker.png</image> + <image file='predef.Gnome.FontPicker.1.png'>../images/gnome_fontpicker.png</image> <expr> Gnome.FontPicker()->set_mode( Gnome.FontPickerModeFontInfo );</expr> - <image file='predef.Gnome.FontPicker.2.png' height='19' width='70'>../images/gnome_fontpicker_2.png</image> + <image file='predef.Gnome.FontPicker.2.png'>../images/gnome_fontpicker_2.png</image> Signals: font_set </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Create a new font pick button </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::Gnome.FontPicker'>Gnome.FontPicker</object></returntype> </method> </docgroup>
autodoc.git/onepage.xml:84102: <method name='uw_set_widget'> <arguments><argument name='widget'><type><object resolved='predef::GTK1.Widget'>GTK1.Widget</object></type></argument></arguments> <returntype><object resolved='predef::Gnome.FontPicker'>Gnome.FontPicker</object></returntype> </method> </docgroup> </class> <class name='Href'> <doc><text>This widget is a GtkButton button that contains a URL. When clicked it invokes the configured browser for the URL you provided. <expr> Gnome.Href( "http://www.gnome.org", "GNOME Web Site" )</expr> - <image file='predef.Gnome.Href.1.png' height='21' width='90'>../images/gnome_href.png</image> + <image file='predef.Gnome.Href.1.png'>../images/gnome_href.png</image> <expr> Gnome.Href( "http://www.gnome.org" )</expr> - <image file='predef.Gnome.Href.2.png' height='23' width='119'>../images/gnome_href_2.png</image> + <image file='predef.Gnome.Href.2.png'>../images/gnome_href_2.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Created a GNOME href object, a label widget with a clickable action and an associated URL. If label is set to 0, url is used as the label. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='url'><type><string/></type></argument><argument name='label'><type><or><string/><void/></or></type></argument></arguments> <returntype><object resolved='predef::Gnome.Href'>Gnome.Href</object></returntype> </method> </docgroup>
autodoc.git/onepage.xml:84510: </method> </docgroup> </class> <class name='Less'> <doc><text>This widget implements a graphical "more" command. It allows the user to view a text file. There are various possible ways to specify the contents to display: loading the data from a file (by providing a filename) or by loading it from an open file data stream or from the output of a Unix command. <expr> Gnome.Less()->show_string("Example string\nshown in this\nwidget")</expr> - <image file='predef.Gnome.Less.1.png' height='116' width='315'>../images/gnome_less.png</image> + <image file='predef.Gnome.Less.1.png'>../images/gnome_less.png</image> <expr> Gnome.Less()->show_file("/usr/dict/words" );</expr> - <image file='predef.Gnome.Less.2.png' height='116' width='315'>../images/gnome_less_2.png</image> + <image file='predef.Gnome.Less.2.png'>../images/gnome_less_2.png</image> <expr> Gnome.Less()->show_command( "psrinfo -v" )</expr> - <image file='predef.Gnome.Less.3.png' height='116' width='315'>../images/gnome_less_3.png</image> + <image file='predef.Gnome.Less.3.png'>../images/gnome_less_3.png</image> </text></doc> <docgroup homogen-name='clear' homogen-type='method'><doc><text>Clears all the text </text></doc> <method name='clear'> <arguments/> <returntype><object resolved='predef::Gnome.Less'>Gnome.Less</object></returntype> </method> </docgroup> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new GnomeLess widget. </text></doc>
autodoc.git/onepage.xml:84624: GnomeDialog) that contain a severity level (indicated by an icon and a title), a message to be displayed and a list of buttons that will be in the dialog. The programmer will use strings desired for each button. If the strings are any of the GNOME_STOCK macros, then instead of creating a button with the text, the button will be a GNOME stock button with a stock icon. The list of known types for message boxes are: <ref resolved='predef::GTK1.GNOME_MESSAGE_BOX_ERROR'>GNOME_MESSAGE_BOX_ERROR</ref>, <ref resolved='predef::GTK1.GNOME_MESSAGE_BOX_GENERIC'>GNOME_MESSAGE_BOX_GENERIC</ref>, <ref resolved='predef::GTK1.GNOME_MESSAGE_BOX_INFO'>GNOME_MESSAGE_BOX_INFO</ref>, <ref resolved='predef::GTK1.GNOME_MESSAGE_BOX_QUESTION'>GNOME_MESSAGE_BOX_QUESTION</ref> and <ref resolved='predef::GTK1.GNOME_MESSAGE_BOX_WARNING'>GNOME_MESSAGE_BOX_WARNING</ref>. <expr> Gnome.MessageBox( "This is a nice message", Gnome.MessageBoxInfo, Gnome.StockButtonOk, Gnome.StockButtonCancel );</expr> - <image file='predef.Gnome.MessageBox.1.png' height='32' width='219'>../images/gnome_messagebox.png</image> + <image file='predef.Gnome.MessageBox.1.png'>../images/gnome_messagebox.png</image> <expr> Gnome.MessageBox( "This is another not so nice message", Gnome.MessageBoxError, Gnome.StockButtonClose, Gnome.StockButtonCancel );</expr> - <image file='predef.Gnome.MessageBox.2.png' height='32' width='219'>../images/gnome_messagebox_2.png</image> + <image file='predef.Gnome.MessageBox.2.png'>../images/gnome_messagebox_2.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a dialog box of type message_box_type with message. A number of buttons are inserted on it. You can use the GNOME stock identifiers to create gnome stock buttons. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='message'><type><string/></type></argument><argument name='messagebox_type'><type><string/></type></argument><argument name='buttons'><type><varargs><string/></varargs></type></argument></arguments> <returntype><object resolved='predef::Gnome.MessageBox'>Gnome.MessageBox</object></returntype> </method> </docgroup> <docgroup homogen-name='Dialog' homogen-type='inherit'> <inherit name='Dialog'><classname resolved='predef::Gnome.Dialog'>Gnome.Dialog</classname></inherit> </docgroup> </class> <class name='NumberEntry'> <doc><text>Provides an entry line for numbers. This routine does not attempt to do any validation on the valid number ranges, but provides a button that will let the user bring up a calculator to fill in the value of the entry widget. <expr> Gnome.NumberEntry("", "Select a number...");</expr> - <image file='predef.Gnome.NumberEntry.1.png' height='19' width='243'>../images/gnome_numberentry.png</image> + <image file='predef.Gnome.NumberEntry.1.png'>../images/gnome_numberentry.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new number entry widget, with a history id and title for the calculator dialog. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='history_id'><type><string/></type></argument><argument name='calc_dialog_title'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Gnome.NumberEntry'>Gnome.NumberEntry</object></returntype> </method> </docgroup> <docgroup homogen-name='get_number' homogen-type='method'><doc><text>Get the current number from the entry
autodoc.git/onepage.xml:84694: effect the next time the calculator button is pressed. </text></doc> <method name='set_title'> <arguments><argument name='title'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Gnome.NumberEntry'>Gnome.NumberEntry</object></returntype> </method> </docgroup> </class> <class name='PaperSelector'> <doc><text><expr> Gnome.PaperSelector()</expr> - <image file='predef.Gnome.PaperSelector.1.png' height='117' width='290'>../images/gnome_paperselector.png</image> + <image file='predef.Gnome.PaperSelector.1.png'>../images/gnome_paperselector.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments/> <returntype><object resolved='predef::Gnome.PaperSelector'>Gnome.PaperSelector</object></returntype> </method> </docgroup> <docgroup homogen-name='get_bottom_margin' homogen-type='method'> <method name='get_bottom_margin'> <arguments/>
autodoc.git/onepage.xml:84755: <inherit name='Vbox'><classname resolved='predef::GTK1.Vbox'>GTK1.Vbox</classname></inherit> </docgroup> </class> <class name='PixmapEntry'> <doc><text>Entry for large images with a preview. Unlike GnomeIconEntry, it does not scale the images to a specific size and shows them 1:1. This is perfect for selection of backgrounds and such. It also allows DND to be performed on the preview box. It also provides all the GnomeEntry functionality as well. <expr> Gnome.PixmapEntry("","browse...",1);</expr> - <image file='predef.Gnome.PixmapEntry.1.png' height='123' width='228'>../images/gnome_pixmapentry.png</image> + <image file='predef.Gnome.PixmapEntry.1.png'>../images/gnome_pixmapentry.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new pixmap entry widget, if do_preview is false, the preview is hidden but the files are still loaded so that it's easy to show it. For a pixmap entry without preview, use the W(GnomeFileEntry) widget. </text></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='history_id'><type><string/></type></argument><argument name='browse_dialog_title'><type><string/></type></argument><argument name='do_preview'><type><int/></type></argument></arguments> <returntype><object resolved='predef::Gnome.PixmapEntry'>Gnome.PixmapEntry</object></returntype> </method>
autodoc.git/onepage.xml:84885: <method name='set_state'> <arguments><argument name='state'><type><int/></type></argument></arguments> <returntype><object resolved='predef::Gnome.PropertyBox'>Gnome.PropertyBox</object></returntype> </method> </docgroup> </class> <class name='Scores'> <doc><text>This is a high-scores dialog box. The GNOME libraries also handle loading/saving systemwide high scores in a secure way. <expr> Gnome.Scores( 17, ({ "per" })*17, map((array(float))indices(allocate(17)),`*,42), map(indices(allocate(17)), `*, 10 ), 1 )</expr> - <image file='predef.Gnome.Scores.1.png' height='402' width='250'>../images/gnome_scores.png</image> + <image file='predef.Gnome.Scores.1.png'>../images/gnome_scores.png</image> </text></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='n_scores'><type><int/></type></argument><argument name='names'><type><array/></type></argument><argument name='scores'><type><array/></type></argument><argument name='times'><type><array/></type></argument><argument name='clear'><type><int/></type></argument></arguments> <returntype><object resolved='predef::Gnome.Scores'>Gnome.Scores</object></returntype> </method> </docgroup> <docgroup homogen-name='Dialog' homogen-type='inherit'> <inherit name='Dialog'><classname resolved='predef::Gnome.Dialog'>Gnome.Dialog</classname></inherit> </docgroup>
autodoc.git/onepage.xml:85266: <docgroup homogen-name='crc32' homogen-type='method'><doc><text>This function calculates the standard ISO3309 Cyclic Redundancy Check. </text></doc> <method name='crc32'> <arguments><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument><argument name='start_value'><type><or><void/><int/></or></type></argument></arguments> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Gz"' homogen-type='inherit'> - <inherit name='"___Gz"'><classname>"___Gz"</classname></inherit> + <docgroup homogen-name='"___Gz"' homogen-type='inherit'> + <inherit name='"___Gz"'><classname>"___Gz"</classname></inherit> </docgroup> <docgroup homogen-name='uncompress' homogen-type='method'><doc><text>Uncompresses the <ref resolved='predef::Gz.uncompress.data'>data</ref> and returns it. The <ref resolved='predef::Gz.uncompress.raw'>raw</ref> parameter tells the decoder that the indata lacks the data header and footer defined in <rfc>1950</rfc>. </text></doc> <method name='uncompress'> <arguments><argument name='data'><type><or><string><min>0</min><max>255</max></string><object resolved='predef::String.Buffer'>String.Buffer</object><object resolved='predef::System.Memory'>System.Memory</object><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></or></type></argument><argument name='raw'><type><or><void/><int><min>0</min><max>1</max></int></or></type></argument></arguments> <returntype><string><min>0</min><max>255</max></string></returntype> </method> </docgroup>
autodoc.git/onepage.xml:85593: in RFC 7541 appendix B. </text><group><param name='str'/><text>String to encode. </text></group><group><returns/><text>Returns the encoded string. </text></group><group><seealso/><text><ref resolved='predef::HPack.huffman_decode'>huffman_decode()</ref>. </text></group></doc> <method name='huffman_encode'> <arguments><argument name='str'><type><string><min>0</min><max>255</max></string></type></argument></arguments> <returntype><string><min>0</min><max>255</max></string></returntype> </method> </docgroup> - <docgroup homogen-name='"___HPack"' homogen-type='inherit'> - <inherit name='"___HPack"'><classname>"___HPack"</classname></inherit> + <docgroup homogen-name='"___HPack"' homogen-type='inherit'> + <inherit name='"___HPack"'><classname>"___HPack"</classname></inherit> </docgroup> <docgroup homogen-name='static_header_tab' homogen-type='constant'><doc><text>Table of static headers. <rfc>7541</rfc> Appendix A, Table 1. <array><group><elem><type><array/></type><minindex>0</minindex><maxindex>60</maxindex></elem><text><array><group><elem><type><string><min>0</min><max>255</max></string></type><index>0</index></elem><text>Header name. </text></group><group><elem><type><string><min>0</min><max>255</max></string></type><index>1</index></elem><text>Default value. </text></group></array></text></group></array> </text><group><note/><text>Note that this table is indexed starting on <expr>0</expr> (zero), while the corresponding table in <rfc>7541</rfc> starts on <expr>1</expr> (one). </text></group></doc> <constant name='static_header_tab'/>
autodoc.git/onepage.xml:86477: representation, but in floats; hue is in degree range (0..360), and saturation and value is given in percent. This is not the same as returned or given to the <ref resolved='predef::Image.Color.hsv'>hsv</ref>() methods! This table lists all the different named colors available in Image.Color. The first column shows the actual color while the five following columns demonstrates the modifiers neon, light, dark, bright and dull. The color begind the name of the color is produced by calling neon()->dark()->dark()->dark() from the color object itself, i.e. Image.Color.mintcream->neon()->dark()->dark()->dark(). - <image file='predef.Image.Color.1.png' height='120' width='348'>colors.c.0.png</image> - <image file='predef.Image.Color.2.png' height='120' width='348'>colors.c.1.png</image> - <image file='predef.Image.Color.3.png' height='120' width='348'>colors.c.2.png</image> - <image file='predef.Image.Color.4.png' height='120' width='348'>colors.c.3.png</image> - <image file='predef.Image.Color.5.png' height='120' width='348'>colors.c.4.png</image> - <image file='predef.Image.Color.6.png' height='120' width='348'>colors.c.5.png</image> - <image file='predef.Image.Color.7.png' height='120' width='348'>colors.c.6.png</image> - <image file='predef.Image.Color.8.png' height='120' width='348'>colors.c.7.png</image> - <image file='predef.Image.Color.9.png' height='120' width='348'>colors.c.8.png</image> - <image file='predef.Image.Color.10.png' height='120' width='348'>colors.c.9.png</image> - <image file='predef.Image.Color.11.png' height='120' width='348'>colors.c.10.png</image> - <image file='predef.Image.Color.12.png' height='120' width='348'>colors.c.11.png</image> - <image file='predef.Image.Color.13.png' height='120' width='348'>colors.c.12.png</image> - <image file='predef.Image.Color.14.png' height='120' width='348'>colors.c.13.png</image> - <image file='predef.Image.Color.15.png' height='120' width='348'>colors.c.14.png</image> - <image file='predef.Image.Color.16.png' height='120' width='348'>colors.c.15.png</image> - <image file='predef.Image.Color.17.png' height='120' width='348'>colors.c.16.png</image> - <image file='predef.Image.Color.18.png' height='120' width='348'>colors.c.17.png</image> - <image file='predef.Image.Color.19.png' height='120' width='348'>colors.c.18.png</image> - <image file='predef.Image.Color.20.png' height='120' width='348'>colors.c.19.png</image> - <image file='predef.Image.Color.21.png' height='120' width='348'>colors.c.20.png</image> - <image file='predef.Image.Color.22.png' height='120' width='348'>colors.c.21.png</image> - <image file='predef.Image.Color.23.png' height='120' width='348'>colors.c.22.png</image> - <image file='predef.Image.Color.24.png' height='120' width='348'>colors.c.23.png</image> - <image file='predef.Image.Color.25.png' height='120' width='348'>colors.c.24.png</image> - <image file='predef.Image.Color.26.png' height='120' width='348'>colors.c.25.png</image> - <image file='predef.Image.Color.27.png' height='120' width='348'>colors.c.26.png</image> - <image file='predef.Image.Color.28.png' height='120' width='348'>colors.c.27.png</image> - <image file='predef.Image.Color.29.png' height='120' width='348'>colors.c.28.png</image> - <image file='predef.Image.Color.30.png' height='120' width='348'>colors.c.29.png</image> - <image file='predef.Image.Color.31.png' height='120' width='348'>colors.c.30.png</image> - <image file='predef.Image.Color.32.png' height='120' width='348'>colors.c.31.png</image> - <image file='predef.Image.Color.33.png' height='120' width='348'>colors.c.32.png</image> - <image file='predef.Image.Color.34.png' height='120' width='348'>colors.c.33.png</image> - <image file='predef.Image.Color.35.png' height='120' width='348'>colors.c.34.png</image> - <image file='predef.Image.Color.36.png' height='120' width='348'>colors.c.35.png</image> - <image file='predef.Image.Color.37.png' height='120' width='348'>colors.c.36.png</image> - <image file='predef.Image.Color.38.png' height='120' width='348'>colors.c.37.png</image> - <image file='predef.Image.Color.39.png' height='120' width='348'>colors.c.38.png</image> - <image file='predef.Image.Color.40.png' height='120' width='348'>colors.c.39.png</image> - <image file='predef.Image.Color.41.png' height='120' width='348'>colors.c.40.png</image> - <image file='predef.Image.Color.42.png' height='120' width='348'>colors.c.41.png</image> - <image file='predef.Image.Color.43.png' height='120' width='348'>colors.c.42.png</image> - <image file='predef.Image.Color.44.png' height='120' width='348'>colors.c.43.png</image> - <image file='predef.Image.Color.45.png' height='120' width='348'>colors.c.44.png</image> - <image file='predef.Image.Color.46.png' height='120' width='348'>colors.c.45.png</image> - <image file='predef.Image.Color.47.png' height='120' width='348'>colors.c.46.png</image> - <image file='predef.Image.Color.48.png' height='120' width='348'>colors.c.47.png</image> - <image file='predef.Image.Color.49.png' height='120' width='348'>colors.c.48.png</image> - <image file='predef.Image.Color.50.png' height='120' width='348'>colors.c.49.png</image> - <image file='predef.Image.Color.51.png' height='120' width='348'>colors.c.50.png</image> - <image file='predef.Image.Color.52.png' height='120' width='348'>colors.c.51.png</image> - <image file='predef.Image.Color.53.png' height='120' width='348'>colors.c.52.png</image> - <image file='predef.Image.Color.54.png' height='120' width='348'>colors.c.53.png</image> - <image file='predef.Image.Color.55.png' height='120' width='348'>colors.c.54.png</image> - <image file='predef.Image.Color.56.png' height='120' width='348'>colors.c.55.png</image> - <image file='predef.Image.Color.57.png' height='120' width='348'>colors.c.56.png</image> + <image file='predef.Image.Color.1.png'>colors.c.0.png</image> + <image file='predef.Image.Color.2.png'>colors.c.1.png</image> + <image file='predef.Image.Color.3.png'>colors.c.2.png</image> + <image file='predef.Image.Color.4.png'>colors.c.3.png</image> + <image file='predef.Image.Color.5.png'>colors.c.4.png</image> + <image file='predef.Image.Color.6.png'>colors.c.5.png</image> + <image file='predef.Image.Color.7.png'>colors.c.6.png</image> + <image file='predef.Image.Color.8.png'>colors.c.7.png</image> + <image file='predef.Image.Color.9.png'>colors.c.8.png</image> + <image file='predef.Image.Color.10.png'>colors.c.9.png</image> + <image file='predef.Image.Color.11.png'>colors.c.10.png</image> + <image file='predef.Image.Color.12.png'>colors.c.11.png</image> + <image file='predef.Image.Color.13.png'>colors.c.12.png</image> + <image file='predef.Image.Color.14.png'>colors.c.13.png</image> + <image file='predef.Image.Color.15.png'>colors.c.14.png</image> + <image file='predef.Image.Color.16.png'>colors.c.15.png</image> + <image file='predef.Image.Color.17.png'>colors.c.16.png</image> + <image file='predef.Image.Color.18.png'>colors.c.17.png</image> + <image file='predef.Image.Color.19.png'>colors.c.18.png</image> + <image file='predef.Image.Color.20.png'>colors.c.19.png</image> + <image file='predef.Image.Color.21.png'>colors.c.20.png</image> + <image file='predef.Image.Color.22.png'>colors.c.21.png</image> + <image file='predef.Image.Color.23.png'>colors.c.22.png</image> + <image file='predef.Image.Color.24.png'>colors.c.23.png</image> + <image file='predef.Image.Color.25.png'>colors.c.24.png</image> + <image file='predef.Image.Color.26.png'>colors.c.25.png</image> + <image file='predef.Image.Color.27.png'>colors.c.26.png</image> + <image file='predef.Image.Color.28.png'>colors.c.27.png</image> + <image file='predef.Image.Color.29.png'>colors.c.28.png</image> + <image file='predef.Image.Color.30.png'>colors.c.29.png</image> + <image file='predef.Image.Color.31.png'>colors.c.30.png</image> + <image file='predef.Image.Color.32.png'>colors.c.31.png</image> + <image file='predef.Image.Color.33.png'>colors.c.32.png</image> + <image file='predef.Image.Color.34.png'>colors.c.33.png</image> + <image file='predef.Image.Color.35.png'>colors.c.34.png</image> + <image file='predef.Image.Color.36.png'>colors.c.35.png</image> + <image file='predef.Image.Color.37.png'>colors.c.36.png</image> + <image file='predef.Image.Color.38.png'>colors.c.37.png</image> + <image file='predef.Image.Color.39.png'>colors.c.38.png</image> + <image file='predef.Image.Color.40.png'>colors.c.39.png</image> + <image file='predef.Image.Color.41.png'>colors.c.40.png</image> + <image file='predef.Image.Color.42.png'>colors.c.41.png</image> + <image file='predef.Image.Color.43.png'>colors.c.42.png</image> + <image file='predef.Image.Color.44.png'>colors.c.43.png</image> + <image file='predef.Image.Color.45.png'>colors.c.44.png</image> + <image file='predef.Image.Color.46.png'>colors.c.45.png</image> + <image file='predef.Image.Color.47.png'>colors.c.46.png</image> + <image file='predef.Image.Color.48.png'>colors.c.47.png</image> + <image file='predef.Image.Color.49.png'>colors.c.48.png</image> + <image file='predef.Image.Color.50.png'>colors.c.49.png</image> + <image file='predef.Image.Color.51.png'>colors.c.50.png</image> + <image file='predef.Image.Color.52.png'>colors.c.51.png</image> + <image file='predef.Image.Color.53.png'>colors.c.52.png</image> + <image file='predef.Image.Color.54.png'>colors.c.53.png</image> + <image file='predef.Image.Color.55.png'>colors.c.54.png</image> + <image file='predef.Image.Color.56.png'>colors.c.55.png</image> + <image file='predef.Image.Color.57.png'>colors.c.56.png</image> </text> <group><note/><text> <tt>Image.Color["something"]</tt> will never(!) generate an error, but a zero_type 0, if the color is unknown. This is enough to give the error "not present in module", if used
autodoc.git/onepage.xml:86790: <arguments> </arguments> </method><doc> <text> Color modification methods. These returns a new color. <table> <tr><th>method</th><th width='50%'>effect</th> <th>h</th><th>s</th><th>v</th><th>as</th></tr> <tr><td>light </td><td>raise light level</td><td>±0</td><td> ±0</td><td>+50</td> - <td><image file='predef.Image.Color.Color.light.1.png' height='20' width='20'>colors.c57.png</image> - <image file='predef.Image.Color.Color.light.2.png' height='20' width='20'>colors.c58.png</image> - <image file='predef.Image.Color.Color.light.3.png' height='20' width='20'>colors.c59.png</image> - <image file='predef.Image.Color.Color.light.4.png' height='20' width='20'>colors.c60.png</image></td></tr> + <td><image file='predef.Image.Color.Color.light.1.png'>colors.c57.png</image> + <image file='predef.Image.Color.Color.light.2.png'>colors.c58.png</image> + <image file='predef.Image.Color.Color.light.3.png'>colors.c59.png</image> + <image file='predef.Image.Color.Color.light.4.png'>colors.c60.png</image></td></tr> <tr><td>dark </td><td>lower light level</td><td>±0</td><td> ±0</td><td>-50</td> - <td><image file='predef.Image.Color.Color.light.5.png' height='20' width='20'>colors.c61.png</image> - <image file='predef.Image.Color.Color.light.6.png' height='20' width='20'>colors.c62.png</image> - <image file='predef.Image.Color.Color.light.7.png' height='20' width='20'>colors.c63.png</image> - <image file='predef.Image.Color.Color.light.8.png' height='20' width='20'>colors.c64.png</image></td></tr> + <td><image file='predef.Image.Color.Color.light.5.png'>colors.c61.png</image> + <image file='predef.Image.Color.Color.light.6.png'>colors.c62.png</image> + <image file='predef.Image.Color.Color.light.7.png'>colors.c63.png</image> + <image file='predef.Image.Color.Color.light.8.png'>colors.c64.png</image></td></tr> <tr><td>bright</td><td>brighter color </td><td>±0</td><td>+50</td><td>+50</td> - <td><image file='predef.Image.Color.Color.light.9.png' height='20' width='20'>colors.c65.png</image> - <image file='predef.Image.Color.Color.light.10.png' height='20' width='20'>colors.c66.png</image> - <image file='predef.Image.Color.Color.light.11.png' height='20' width='20'>colors.c67.png</image> - <image file='predef.Image.Color.Color.light.12.png' height='20' width='20'>colors.c68.png</image></td></tr> + <td><image file='predef.Image.Color.Color.light.9.png'>colors.c65.png</image> + <image file='predef.Image.Color.Color.light.10.png'>colors.c66.png</image> + <image file='predef.Image.Color.Color.light.11.png'>colors.c67.png</image> + <image file='predef.Image.Color.Color.light.12.png'>colors.c68.png</image></td></tr> <tr><td>dull </td><td>greyer color </td><td>±0</td><td>-50</td><td>-50</td> - <td><image file='predef.Image.Color.Color.light.13.png' height='20' width='20'>colors.c69.png</image> - <image file='predef.Image.Color.Color.light.14.png' height='20' width='20'>colors.c70.png</image> - <image file='predef.Image.Color.Color.light.15.png' height='20' width='20'>colors.c71.png</image> - <image file='predef.Image.Color.Color.light.16.png' height='20' width='20'>colors.c72.png</image></td></tr> + <td><image file='predef.Image.Color.Color.light.13.png'>colors.c69.png</image> + <image file='predef.Image.Color.Color.light.14.png'>colors.c70.png</image> + <image file='predef.Image.Color.Color.light.15.png'>colors.c71.png</image> + <image file='predef.Image.Color.Color.light.16.png'>colors.c72.png</image></td></tr> <tr><td>neon </td><td>set to extreme </td><td>±0</td><td>max</td><td>max</td> - <td><image file='predef.Image.Color.Color.light.17.png' height='20' width='20'>colors.c73.png</image> - <image file='predef.Image.Color.Color.light.18.png' height='20' width='20'>colors.c74.png</image></td></tr> + <td><image file='predef.Image.Color.Color.light.17.png'>colors.c73.png</image> + <image file='predef.Image.Color.Color.light.18.png'>colors.c74.png</image></td></tr> </table> <ref resolved='predef::Image.Color.Color.light'>light</ref> and <ref resolved='predef::Image.Color.Color.dark'>dark</ref> lower/highers saturation when value is min-/maximised respective. </text> <group><returns/><text> the new color object </text></group>
autodoc.git/onepage.xml:87084: </arguments> </method><doc> <text> Map colors in an image object to the colors in the colortable, and creates a new image with the closest colors. <table><tr valign='center'> <td/> - <td><image file='predef.Image.Colortable.map.1.png' height='115' width='80'>colortable.c6.png</image></td> - <td><image file='predef.Image.Colortable.map.2.png' height='115' width='80'>colortable.c7.png</image></td> - <td><image file='predef.Image.Colortable.map.3.png' height='115' width='80'>colortable.c8.png</image></td> - <td><image file='predef.Image.Colortable.map.4.png' height='115' width='80'>colortable.c9.png</image></td> - <td><image file='predef.Image.Colortable.map.5.png' height='115' width='80'>colortable.c10.png</image></td> + <td><image file='predef.Image.Colortable.map.1.png'>colortable.c6.png</image></td> + <td><image file='predef.Image.Colortable.map.2.png'>colortable.c7.png</image></td> + <td><image file='predef.Image.Colortable.map.3.png'>colortable.c8.png</image></td> + <td><image file='predef.Image.Colortable.map.4.png'>colortable.c9.png</image></td> + <td><image file='predef.Image.Colortable.map.5.png'>colortable.c10.png</image></td> <td>no dither</td> </tr><tr valign='center'> <td/> - <td><image file='predef.Image.Colortable.map.6.png' height='115' width='80'>colortable.c11.png</image></td> - <td><image file='predef.Image.Colortable.map.7.png' height='115' width='80'>colortable.c12.png</image></td> - <td><image file='predef.Image.Colortable.map.8.png' height='115' width='80'>colortable.c13.png</image></td> - <td><image file='predef.Image.Colortable.map.9.png' height='115' width='80'>colortable.c14.png</image></td> - <td><image file='predef.Image.Colortable.map.10.png' height='115' width='80'>colortable.c15.png</image></td> + <td><image file='predef.Image.Colortable.map.6.png'>colortable.c11.png</image></td> + <td><image file='predef.Image.Colortable.map.7.png'>colortable.c12.png</image></td> + <td><image file='predef.Image.Colortable.map.8.png'>colortable.c13.png</image></td> + <td><image file='predef.Image.Colortable.map.9.png'>colortable.c14.png</image></td> + <td><image file='predef.Image.Colortable.map.10.png'>colortable.c15.png</image></td> <td><ref resolved='predef::Image.Colortable.floyd_steinberg'>floyd_steinberg</ref> dither</td> </tr><tr valign='center'> <td/> - <td><image file='predef.Image.Colortable.map.11.png' height='115' width='80'>colortable.c16.png</image></td> - <td><image file='predef.Image.Colortable.map.12.png' height='115' width='80'>colortable.c17.png</image></td> - <td><image file='predef.Image.Colortable.map.13.png' height='115' width='80'>colortable.c18.png</image></td> - <td><image file='predef.Image.Colortable.map.14.png' height='115' width='80'>colortable.c19.png</image></td> - <td><image file='predef.Image.Colortable.map.15.png' height='115' width='80'>colortable.c20.png</image></td> + <td><image file='predef.Image.Colortable.map.11.png'>colortable.c16.png</image></td> + <td><image file='predef.Image.Colortable.map.12.png'>colortable.c17.png</image></td> + <td><image file='predef.Image.Colortable.map.13.png'>colortable.c18.png</image></td> + <td><image file='predef.Image.Colortable.map.14.png'>colortable.c19.png</image></td> + <td><image file='predef.Image.Colortable.map.15.png'>colortable.c20.png</image></td> <td><ref resolved='predef::Image.Colortable.ordered'>ordered</ref> dither</td> </tr><tr valign='center'> - <td><image file='predef.Image.Colortable.map.16.png' height='115' width='80'>colortable.c21.png</image></td> - <td><image file='predef.Image.Colortable.map.17.png' height='115' width='80'>colortable.c22.png</image></td> - <td><image file='predef.Image.Colortable.map.18.png' height='115' width='80'>colortable.c23.png</image></td> - <td><image file='predef.Image.Colortable.map.19.png' height='115' width='80'>colortable.c24.png</image></td> - <td><image file='predef.Image.Colortable.map.20.png' height='115' width='80'>colortable.c25.png</image></td> - <td><image file='predef.Image.Colortable.map.21.png' height='115' width='80'>colortable.c26.png</image></td> + <td><image file='predef.Image.Colortable.map.16.png'>colortable.c21.png</image></td> + <td><image file='predef.Image.Colortable.map.17.png'>colortable.c22.png</image></td> + <td><image file='predef.Image.Colortable.map.18.png'>colortable.c23.png</image></td> + <td><image file='predef.Image.Colortable.map.19.png'>colortable.c24.png</image></td> + <td><image file='predef.Image.Colortable.map.20.png'>colortable.c25.png</image></td> + <td><image file='predef.Image.Colortable.map.21.png'>colortable.c26.png</image></td> <td><ref resolved='predef::Image.Colortable.randomcube'>randomcube</ref> dither</td> </tr><tr valign='center'> <td>original</td> <td>2</td> <td>4</td> <td>8</td> <td>16</td> <td>32 colors</td> </tr></table> 
autodoc.git/onepage.xml:87456: <pre> image size setup 100×100 cubicles(4,5,4) (default) 1000×1000 cubicles(12,12,12) (factor 2 faster than default) </pre> In some cases, the <ref resolved='predef::Image.Colortable.full'>full</ref> method is faster. <table><tr valign='center'> - <td><image file='predef.Image.Colortable.cubicles.1.png' height='115' width='80'>colortable.c0.png</image></td> - <td><image file='predef.Image.Colortable.cubicles.2.png' height='115' width='80'>colortable.c1.png</image></td> - <td><image file='predef.Image.Colortable.cubicles.3.png' height='115' width='80'>colortable.c2.png</image></td> + <td><image file='predef.Image.Colortable.cubicles.1.png'>colortable.c0.png</image></td> + <td><image file='predef.Image.Colortable.cubicles.2.png'>colortable.c1.png</image></td> + <td><image file='predef.Image.Colortable.cubicles.3.png'>colortable.c2.png</image></td> </tr><tr valign='center'> <td>original</td> <td>default cubicles, 16 colors</td> <td>accuracy=200</td> </tr></table> </text> <group> <param name='r'/> <param name='g'/>
autodoc.git/onepage.xml:87526: </arguments> </method><doc> <text> Set dithering method to floyd_steinberg. The arguments to this method is for fine-tuning of the algorithm (for computer graphics wizards). <table><tr valign='center'> - <td><image file='predef.Image.Colortable.floyd_steinberg.1.png' height='115' width='80'>colortable.c3.png</image></td> - <td><image file='predef.Image.Colortable.floyd_steinberg.2.png' height='115' width='80'>colortable.c4.png</image></td> - <td><image file='predef.Image.Colortable.floyd_steinberg.3.png' height='115' width='80'>colortable.c5.png</image></td> + <td><image file='predef.Image.Colortable.floyd_steinberg.1.png'>colortable.c3.png</image></td> + <td><image file='predef.Image.Colortable.floyd_steinberg.2.png'>colortable.c4.png</image></td> + <td><image file='predef.Image.Colortable.floyd_steinberg.3.png'>colortable.c5.png</image></td> </tr><tr valign='center'> <td>original</td> <td>floyd_steinberg to a 4×4×4 colorcube</td> <td>floyd_steinberg to 16 chosen colors</td> </tr></table> </text> <group> <param name='bidir'/> <text>Set algorithm direction of forward.
autodoc.git/onepage.xml:87694: <argument name='bx'><type><int/></type></argument> <argument name='by'><type><int/></type></argument> </arguments> </method><doc> <text> Set ordered dithering, which gives a position-dependent error added to the pixel values. <table><tr valign='center'> - <td><image file='predef.Image.Colortable.ordered.1.png' height='115' width='80'>colortable.c27.png</image></td> - <td><image file='predef.Image.Colortable.ordered.2.png' height='115' width='80'>colortable.c28.png</image></td> - <td><image file='predef.Image.Colortable.ordered.3.png' height='115' width='80'>colortable.c29.png</image></td> - <td><image file='predef.Image.Colortable.ordered.4.png' height='115' width='80'>colortable.c30.png</image></td> + <td><image file='predef.Image.Colortable.ordered.1.png'>colortable.c27.png</image></td> + <td><image file='predef.Image.Colortable.ordered.2.png'>colortable.c28.png</image></td> + <td><image file='predef.Image.Colortable.ordered.3.png'>colortable.c29.png</image></td> + <td><image file='predef.Image.Colortable.ordered.4.png'>colortable.c30.png</image></td> </tr><tr valign='top'> <td>original</td> <td colspan='2'>mapped to <tt>Image.Colortable(6,6,6)-></tt></td> </tr><tr valign='top'> <td/> <td><tt>ordered (42,42,42,2,2)</tt></td> <td><tt>ordered()</tt></td> <td><tt>ordered (42,42,42, 8,8, 0,0, 0,1, 1,0)</tt></td> </tr><tr valign='top'> - <td><image file='predef.Image.Colortable.ordered.5.png' height='115' width='80'>colortable.c31.png</image></td> - <td><image file='predef.Image.Colortable.ordered.6.png' height='115' width='80'>colortable.c32.png</image></td> - <td><image file='predef.Image.Colortable.ordered.7.png' height='115' width='80'>colortable.c33.png</image></td> - <td><image file='predef.Image.Colortable.ordered.8.png' height='115' width='80'>colortable.c34.png</image></td> + <td><image file='predef.Image.Colortable.ordered.5.png'>colortable.c31.png</image></td> + <td><image file='predef.Image.Colortable.ordered.6.png'>colortable.c32.png</image></td> + <td><image file='predef.Image.Colortable.ordered.7.png'>colortable.c33.png</image></td> + <td><image file='predef.Image.Colortable.ordered.8.png'>colortable.c34.png</image></td> </tr></table> </text> <group> <param name='r'/> <param name='g'/> <param name='b'/> <text>The maximum error. Default is 32, or colorcube steps (256/size). </text></group> <group>
autodoc.git/onepage.xml:87782: </method><doc> <text> Set random cube dithering. Color choosen is the closest one to color in picture plus (flat) random error; <tt>color±random(error)</tt>. The randomgrey method uses the same random error on red, green and blue and the randomcube method has three random errors. <table><tr valign='center'> - <td><image file='predef.Image.Colortable.randomcube.1.png' height='115' width='80'>colortable.c35.png</image></td> - <td><image file='predef.Image.Colortable.randomcube.2.png' height='115' width='80'>colortable.c36.png</image></td> - <td><image file='predef.Image.Colortable.randomcube.3.png' height='115' width='80'>colortable.c37.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.1.png'>colortable.c35.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.2.png'>colortable.c36.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.3.png'>colortable.c37.png</image></td> </tr><tr valign='top'> <td>original</td> <td colspan='2'>mapped to <tt>Image.Colortable(4,4,4)-></tt></td> </tr><tr valign='top'> <td/> <td>randomcube()</td> <td>randomgrey()</td> </tr><tr valign='top'> - <td><image file='predef.Image.Colortable.randomcube.4.png' height='115' width='80'>colortable.c38.png</image></td> - <td><image file='predef.Image.Colortable.randomcube.5.png' height='115' width='80'>colortable.c39.png</image></td> - <td><image file='predef.Image.Colortable.randomcube.6.png' height='115' width='80'>colortable.c40.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.4.png'>colortable.c38.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.5.png'>colortable.c39.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.6.png'>colortable.c40.png</image></td> </tr></table> </text> <group> <param name='r'/> <param name='g'/> <param name='b'/> <param name='err'/> <text>The maximum error. Default is 32, or colorcube step. </text></group>
autodoc.git/onepage.xml:90158: base is given by r,g,b and is normally black. <table><tr><td rowspan='2'> blur (ie a 2d gauss function): <pre> ({({1,2,1}), ({2,5,2}), ({1,2,1})}) </pre> </td><td> - <image file='predef.Image.Image.apply_matrix.1.png' height='115' width='80'>image.c0.png</image> + <image file='predef.Image.Image.apply_matrix.1.png'>image.c0.png</image> </td><td> - <image file='predef.Image.Image.apply_matrix.2.png' height='115' width='80'>image.c1.png</image> + <image file='predef.Image.Image.apply_matrix.2.png'>image.c1.png</image> </td></tr> <tr><td/><td>original</td></tr> <tr><td> sharpen (k>8, preferably 12 or 16): <pre> ({({-1,-1,-1}), ({-1, k,-1}), ({-1,-1,-1})}) </pre> </td><td> - <image file='predef.Image.Image.apply_matrix.3.png' height='115' width='80'>image.c2.png</image> + <image file='predef.Image.Image.apply_matrix.3.png'>image.c2.png</image> </td></tr> <tr><td> edge detect: <pre> ({({1, 1,1}), ({1,-8,1}), ({1, 1,1})}) </pre> </td><td> - <image file='predef.Image.Image.apply_matrix.4.png' height='115' width='80'>image.c3.png</image> + <image file='predef.Image.Image.apply_matrix.4.png'>image.c3.png</image> </td></tr> <tr><td> horisontal edge detect (get the idea): <pre> ({({0, 0,0}), ({1,-2,1}), ({0, 0,0})}) </pre> </td><td> - <image file='predef.Image.Image.apply_matrix.5.png' height='115' width='80'>image.c4.png</image> + <image file='predef.Image.Image.apply_matrix.5.png'>image.c4.png</image> </td></tr> <tr><td rowspan='2'> emboss (might prefer to begin with a <ref resolved='predef::Image.Image.grey'>grey</ref> image): <pre> ({({2, 1, 0}), ({1, 0,-1}), ({0,-1,-2})}), 128,128,128, 3 </pre> </td><td> - <image file='predef.Image.Image.apply_matrix.6.png' height='115' width='80'>image.c5.png</image> + <image file='predef.Image.Image.apply_matrix.6.png'>image.c5.png</image> </td><td> - <image file='predef.Image.Image.apply_matrix.7.png' height='115' width='80'>image.c6.png</image> + <image file='predef.Image.Image.apply_matrix.7.png'>image.c6.png</image> </td></tr> <tr><td/><td>greyed</td></tr></table> This function is not very fast. </text> <group> <param name='array'/> <text>the matrix; innermost is a value or an array with red, green, blue values for red, green, blue separation.</text></group>
autodoc.git/onepage.xml:90459: <argument name='yfactor'><type><float/></type></argument> </arguments> </method><doc> <text> scales the image with a factor, without smoothing. This routine is faster than scale, but gives less correct results <table><tr valign='center'> - <td><image file='predef.Image.Image.bitscale.1.png' height='115' width='80'>image.c7.png</image></td> - <td><image file='predef.Image.Image.bitscale.2.png' height='86' width='60'>image.c8.png</image></td> - <td><image file='predef.Image.Image.bitscale.3.png' height='86' width='60'>image.c9.png</image></td> + <td><image file='predef.Image.Image.bitscale.1.png'>image.c7.png</image></td> + <td><image file='predef.Image.Image.bitscale.2.png'>image.c8.png</image></td> + <td><image file='predef.Image.Image.bitscale.3.png'>image.c9.png</image></td> </tr><tr> <td>original</td> <td>bitscale(0.75)</td> <td>scale(0.75)</td> </tr></table> </text> <group> <param name='factor'/> <text>factor to use for both x and y</text></group>
autodoc.git/onepage.xml:90537: <arguments><argument name='no_pass'><type><int/></type></argument> </arguments> </method><doc> <text> A special case of apply_matrix that creates a blur effect. About four times faster than the generic apply_matrix. @[no_pass] is the number of times the blur matrix is applied. <table><tr valign='center'> - <td><image file='predef.Image.Image.blur.1.png' height='115' width='80'>image.c10.png</image></td> - <td><image file='predef.Image.Image.blur.2.png' height='115' width='80'>image.c11.png</image></td> - <td><image file='predef.Image.Image.blur.3.png' height='115' width='80'>image.c12.png</image></td> + <td><image file='predef.Image.Image.blur.1.png'>image.c10.png</image></td> + <td><image file='predef.Image.Image.blur.2.png'>image.c11.png</image></td> + <td><image file='predef.Image.Image.blur.3.png'>image.c12.png</image></td> </tr><tr> <td>original</td> <td>blur(1)</td> <td>blur(5)</td> </tr></table> </text> <group><seealso/><text> <ref resolved='predef::Image.Image.apply_matrix'>apply_matrix</ref>, <ref resolved='predef::Image.Image.grey_blur'>grey_blur</ref></text></group>
autodoc.git/onepage.xml:90592: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> <argument name='alpha'><type><int/></type></argument> </arguments> </method><doc> <text> Draws a filled rectangle on the image. <table><tr valign='center'> - <td><image file='predef.Image.Image.box.1.png' height='115' width='80'>image.c13.png</image></td> - <td><image file='predef.Image.Image.box.2.png' height='115' width='80'>image.c14.png</image></td> - <td><image file='predef.Image.Image.box.3.png' height='115' width='80'>image.c15.png</image></td> + <td><image file='predef.Image.Image.box.1.png'>image.c13.png</image></td> + <td><image file='predef.Image.Image.box.2.png'>image.c14.png</image></td> + <td><image file='predef.Image.Image.box.3.png'>image.c15.png</image></td> </tr><tr> <td>original</td> <td>->box (40,10, 10,80, 0,255,0)</td> <td>->box (40,10, 10,80, 255,0,0,75)</td> </tr></table> </text> <group> <param name='x1'/> <param name='y1'/>
autodoc.git/onepage.xml:90722: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> <argument name='alpha'><type><int/></type></argument> </arguments> </method><doc> <text> Draws a circle on the image. The circle is not antialiased. <table><tr valign='center'> - <td><image file='predef.Image.Image.circle.1.png' height='115' width='80'>image.c16.png</image></td> - <td><image file='predef.Image.Image.circle.2.png' height='115' width='80'>image.c17.png</image></td> + <td><image file='predef.Image.Image.circle.1.png'>image.c16.png</image></td> + <td><image file='predef.Image.Image.circle.2.png'>image.c17.png</image></td> </tr><tr> <td>original</td> <td>->circle (50,50, 30,50, 0,255,255)</td> </tr></table> </text> <group> <param name='x'/> <param name='y'/> <text>circle center</text></group>
autodoc.git/onepage.xml:90780: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> <argument name='alpha'><type><int/></type></argument> </arguments> </method><doc> <text> gives a new, cleared image with the same size of drawing area <table><tr valign='center'> - <td><image file='predef.Image.Image.clear.1.png' height='115' width='80'>image.c18.png</image></td> - <td><image file='predef.Image.Image.clear.2.png' height='115' width='80'>image.c19.png</image></td> + <td><image file='predef.Image.Image.clear.1.png'>image.c18.png</image></td> + <td><image file='predef.Image.Image.clear.2.png'>image.c19.png</image></td> </tr><tr> <td>original</td> <td>->clear (0,128,255)</td> </tr></table> </text> <group> <param name='r'/> <param name='g'/> <param name='b'/>
autodoc.git/onepage.xml:90840: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> <argument name='alpha'><type><int/></type></argument> </arguments> </method><doc> <text> Copies to or initialize a new image object. <table><tr valign='center'> - <td><image file='predef.Image.Image.clone.1.png' height='115' width='80'>image.c20.png</image></td> - <td><image file='predef.Image.Image.clone.2.png' height='115' width='80'>image.c21.png</image></td> - <td><image file='predef.Image.Image.clone.3.png' height='50' width='50'>image.c22.png</image></td> + <td><image file='predef.Image.Image.clone.1.png'>image.c20.png</image></td> + <td><image file='predef.Image.Image.clone.2.png'>image.c21.png</image></td> + <td><image file='predef.Image.Image.clone.3.png'>image.c22.png</image></td> </tr><tr> <td>original</td> <td>clone</td> <td>clone(50,50)</td> </tr></table> </text> <group> <param name='xsize'/> <param name='ysize'/>
autodoc.git/onepage.xml:90913: Colorize an image. The red, green and blue values of the pixels are multiplied with the given value(s). This works best on a grey image... The result is divided by 255, giving correct pixel values. If no arguments are given, the current color is used as factors. <table><tr valign='center'> - <td><image file='predef.Image.Image.color.1.png' height='115' width='80'>image.c23.png</image></td> - <td><image file='predef.Image.Image.color.2.png' height='115' width='80'>image.c24.png</image></td> + <td><image file='predef.Image.Image.color.1.png'>image.c23.png</image></td> + <td><image file='predef.Image.Image.color.2.png'>image.c24.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->color(128,128,255);</td> </tr></table> </text> <group> <param name='r'/> <param name='g'/> <param name='b'/>
autodoc.git/onepage.xml:90988: <argument name='alpha'><type><int/></type></argument> </arguments> </method><doc> <text> Copies this part of the image. The requested area can be smaller, giving a cropped image, or bigger - the new area will be filled with the given or current color. <table><tr valign='center'> - <td><image file='predef.Image.Image.copy.1.png' height='115' width='80'>image.c25.png</image></td> - <td><image file='predef.Image.Image.copy.2.png' height='105' width='70'>image.c26.png</image></td> - <td><image file='predef.Image.Image.copy.3.png' height='125' width='90'>image.c27.png</image></td> + <td><image file='predef.Image.Image.copy.1.png'>image.c25.png</image></td> + <td><image file='predef.Image.Image.copy.2.png'>image.c26.png</image></td> + <td><image file='predef.Image.Image.copy.3.png'>image.c27.png</image></td> </tr><tr> <td>original</td> <td>->copy (5,5, XSIZE-6,YSIZE-6)</td> <td>->copy (-5,-5, XSIZE+4,YSIZE+4, 10,75,10)</td> </tr></table> </text> <group> <param name='x1'/> <param name='y1'/>
autodoc.git/onepage.xml:91090: <argument name='method'><type><string/></type></argument> <argument name='...'><type> <object resolved='predef::Image.Image.create.method'>method</object></type></argument> </arguments> </method><doc> <text> Initializes a new image object. <table><tr valign='center'> - <td><image file='predef.Image.Image.create.1.png' height='115' width='80'>image.c28.png</image></td> - <td><image file='predef.Image.Image.create.2.png' height='115' width='80'>image.c29.png</image></td> + <td><image file='predef.Image.Image.create.1.png'>image.c28.png</image></td> + <td><image file='predef.Image.Image.create.2.png'>image.c29.png</image></td> </tr><tr> <td>Image.Image (XSIZE,YSIZE)</td> <td>Image.Image (XSIZE,YSIZE,255,128,0)</td> </tr></table> The image can also be calculated from some special methods, for convinience: <pre> channel modes; followed by a number of 1-char-per-pixel strings
autodoc.git/onepage.xml:91227: <pre> p = pixel color o = given color d = destination pixel d.red=d.blue=d.green= ((o.red-p.red)²+(o.green-p.green)²+(o.blue-p.blue)²)>>8 </pre> <table><tr valign='center'> - <td><image file='predef.Image.Image.distancesq.1.png' height='115' width='80'>image.c30.png</image></td> - <td><image file='predef.Image.Image.distancesq.2.png' height='115' width='80'>image.c31.png</image></td> - <td><image file='predef.Image.Image.distancesq.3.png' height='115' width='80'>image.c32.png</image></td> - <td><image file='predef.Image.Image.distancesq.4.png' height='115' width='80'>image.c33.png</image></td> + <td><image file='predef.Image.Image.distancesq.1.png'>image.c30.png</image></td> + <td><image file='predef.Image.Image.distancesq.2.png'>image.c31.png</image></td> + <td><image file='predef.Image.Image.distancesq.3.png'>image.c32.png</image></td> + <td><image file='predef.Image.Image.distancesq.4.png'>image.c33.png</image></td> </tr><tr valign='center'> <td>original</td> <td>distance² to cyan</td> <td>...to purple</td> <td>...to yellow</td> </tr></table> </text> <group>
autodoc.git/onepage.xml:91385: <array><valuetype><int/></valuetype></array></type></argument> <argument name='...'><type> <object resolved='predef::Image.Image.gradients'/></type></argument> <argument name='floatgrad'><type> <object resolved='predef::Image.Image.gradients'/></type></argument> </arguments> </method><doc> <text> <table><tr valign='center'> - <td><image file='predef.Image.Image.gradients.1.png' height='115' width='80'>image.c34.png</image></td> - <td><image file='predef.Image.Image.gradients.2.png' height='115' width='80'>image.c35.png</image></td> - <td><image file='predef.Image.Image.gradients.3.png' height='115' width='80'>image.c36.png</image></td> - <td><image file='predef.Image.Image.gradients.4.png' height='115' width='80'>image.c37.png</image></td> - <td><image file='predef.Image.Image.gradients.5.png' height='115' width='80'>image.c38.png</image></td> - <td><image file='predef.Image.Image.gradients.6.png' height='115' width='80'>image.c39.png</image></td> + <td><image file='predef.Image.Image.gradients.1.png'>image.c34.png</image></td> + <td><image file='predef.Image.Image.gradients.2.png'>image.c35.png</image></td> + <td><image file='predef.Image.Image.gradients.3.png'>image.c36.png</image></td> + <td><image file='predef.Image.Image.gradients.4.png'>image.c37.png</image></td> + <td><image file='predef.Image.Image.gradients.5.png'>image.c38.png</image></td> + <td><image file='predef.Image.Image.gradients.6.png'>image.c39.png</image></td> </tr><tr> <td>original</td> <td>2 color gradient</td> <td>10 color gradient</td> <td>3 colors, grad=4.0</td> <td>3 colors, grad=1.0</td> <td>3 colors, grad=0.25</td> </tr></table> </text>
autodoc.git/onepage.xml:91426: <arguments><argument name='r'><type><int/></type></argument> <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> </arguments> </method><doc> <text> Makes a grey-scale image (with weighted values). <table><tr valign='center'> - <td><image file='predef.Image.Image.grey.1.png' height='115' width='80'>image.c40.png</image></td> - <td><image file='predef.Image.Image.grey.2.png' height='115' width='80'>image.c41.png</image></td> - <td><image file='predef.Image.Image.grey.3.png' height='115' width='80'>image.c42.png</image></td> + <td><image file='predef.Image.Image.grey.1.png'>image.c40.png</image></td> + <td><image file='predef.Image.Image.grey.2.png'>image.c41.png</image></td> + <td><image file='predef.Image.Image.grey.3.png'>image.c42.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->grey();</td> <td>->grey(0,0,255);</td> </tr></table> </text> <group> <param name='r'/> <param name='g'/>
autodoc.git/onepage.xml:91465: <arguments><argument name='no_pass'><type><int/></type></argument> </arguments> </method><doc> <text> Works like blur, but only operates on the r color channel. A faster alternative to blur for grey scale images. @[no_pass] is the number of times the blur matrix is applied. <table><tr valign='center'> - <td><image file='predef.Image.Image.grey_blur.1.png' height='115' width='80'>image.c43.png</image></td> - <td><image file='predef.Image.Image.grey_blur.2.png' height='115' width='80'>image.c44.png</image></td> - <td><image file='predef.Image.Image.grey_blur.3.png' height='115' width='80'>image.c45.png</image></td> + <td><image file='predef.Image.Image.grey_blur.1.png'>image.c43.png</image></td> + <td><image file='predef.Image.Image.grey_blur.2.png'>image.c44.png</image></td> + <td><image file='predef.Image.Image.grey_blur.3.png'>image.c45.png</image></td> </tr><tr> <td>original</td> <td>grey_blur(1)</td> <td>grey_blur(5)</td> </tr></table> </text> <group><seealso/><text> <ref resolved='predef::Image.Image.blur'>blur</ref></text></group>
autodoc.git/onepage.xml:91501: </method><doc> <text> Converts RGB data to HSV data, or the other way around. When converting to HSV, the resulting data is stored like this: pixel.r = h; pixel.g = s; pixel.b = v; When converting to RGB, the input data is asumed to be placed in the pixels as above. <table><tr valign='center'> - <td><image file='predef.Image.Image.rgb_to_hsv.1.png' height='115' width='80'>image.c46.png</image></td> - <td><image file='predef.Image.Image.rgb_to_hsv.2.png' height='115' width='80'>image.c47.png</image></td> - <td><image file='predef.Image.Image.rgb_to_hsv.3.png' height='115' width='80'>image.c48.png</image></td> + <td><image file='predef.Image.Image.rgb_to_hsv.1.png'>image.c46.png</image></td> + <td><image file='predef.Image.Image.rgb_to_hsv.2.png'>image.c47.png</image></td> + <td><image file='predef.Image.Image.rgb_to_hsv.3.png'>image.c48.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->hsv_to_rgb();</td> <td>->rgb_to_hsv();</td> </tr><tr valign='center'> - <td><image file='predef.Image.Image.rgb_to_hsv.4.png' height='67' width='67'>image.c49.png</image></td> - <td><image file='predef.Image.Image.rgb_to_hsv.5.png' height='67' width='67'>image.c50.png</image></td> - <td><image file='predef.Image.Image.rgb_to_hsv.6.png' height='67' width='67'>image.c51.png</image></td> + <td><image file='predef.Image.Image.rgb_to_hsv.4.png'>image.c49.png</image></td> + <td><image file='predef.Image.Image.rgb_to_hsv.5.png'>image.c50.png</image></td> + <td><image file='predef.Image.Image.rgb_to_hsv.6.png'>image.c51.png</image></td> </tr><tr valign='center'> <td>tuned box (below)</td> <td>the rainbow (below)</td> <td>same, but rgb_to_hsv()</td> </tr></table> HSV to RGB calculation: <pre> in = input pixel
autodoc.git/onepage.xml:91560: <returntype> <object>object </object></returntype> <arguments> </arguments> </method><doc> <text> Invert an image. Each pixel value gets to be 255-x, where x is the old value. <table><tr valign='center'> - <td><image file='predef.Image.Image.invert.1.png' height='115' width='80'>image.c52.png</image></td> - <td><image file='predef.Image.Image.invert.2.png' height='115' width='80'>image.c53.png</image></td> - <td><image file='predef.Image.Image.invert.3.png' height='115' width='80'>image.c54.png</image></td> + <td><image file='predef.Image.Image.invert.1.png'>image.c52.png</image></td> + <td><image file='predef.Image.Image.invert.2.png'>image.c53.png</image></td> + <td><image file='predef.Image.Image.invert.3.png'>image.c54.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->invert();</td> <td>->rgb_to_hsv()->invert()->hsv_to_rgb();</td> </tr></table> </text> <group><returns/><text> the new image object </text></group>
autodoc.git/onepage.xml:91616: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> <argument name='alpha'><type><int/></type></argument> </arguments> </method><doc> <text> Draws a line on the image. The line is not antialiased. <table><tr valign='center'> - <td><image file='predef.Image.Image.line.1.png' height='115' width='80'>image.c55.png</image></td> - <td><image file='predef.Image.Image.line.2.png' height='115' width='80'>image.c56.png</image></td> + <td><image file='predef.Image.Image.line.1.png'>image.c55.png</image></td> + <td><image file='predef.Image.Image.line.2.png'>image.c56.png</image></td> </tr><tr> <td>original</td> <td>->line (50,10, 10,50, 255,0,0)</td> </tr></table> </text> <group> <param name='x1'/> <param name='y1'/> <param name='x2'/>
autodoc.git/onepage.xml:91808: <docgroup homogen-name='mirrorx' homogen-type='method'> <method name='mirrorx'> <returntype> <object>object </object></returntype> <arguments> </arguments> </method><doc> <text> mirrors an image: <table><tr valign='center'> - <td><image file='predef.Image.Image.mirrorx.1.png' height='115' width='80'>matrix.c0.png</image></td> - <td><image file='predef.Image.Image.mirrorx.2.png' height='115' width='80'>matrix.c1.png</image></td> + <td><image file='predef.Image.Image.mirrorx.1.png'>matrix.c0.png</image></td> + <td><image file='predef.Image.Image.mirrorx.2.png'>matrix.c1.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->mirrorx();</td> </tr></table> </text> <group><returns/><text> the new image object </text></group> </doc>
autodoc.git/onepage.xml:91831: <docgroup homogen-name='mirrory' homogen-type='method'> <method name='mirrory'> <returntype> <object>object </object></returntype> <arguments> </arguments> </method><doc> <text> mirrors an image: <table><tr valign='center'> - <td><image file='predef.Image.Image.mirrory.1.png' height='115' width='80'>matrix.c2.png</image></td> - <td><image file='predef.Image.Image.mirrory.2.png' height='115' width='80'>matrix.c3.png</image></td> + <td><image file='predef.Image.Image.mirrory.1.png'>matrix.c2.png</image></td> + <td><image file='predef.Image.Image.mirrory.2.png'>matrix.c3.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->mirrory();</td> </tr></table> </text> </doc> </docgroup> <docgroup homogen-name='modify_by_intensity' homogen-type='method'>
autodoc.git/onepage.xml:91865: Recolor an image from intensity values. For each color an intensity is calculated, from r, g and b factors (see <ref resolved='predef::Image.Image.grey'>grey</ref>), this gives a value between 0 and max. The color is then calculated from the values given, v1 representing the intensity value of 0, vn representing max, and colors between representing intensity values between, linear. <table><tr valign='center'> - <td><image file='predef.Image.Image.modify_by_intensity.1.png' height='115' width='80'>image.c57.png</image></td> - <td><image file='predef.Image.Image.modify_by_intensity.2.png' height='115' width='80'>image.c58.png</image></td> + <td><image file='predef.Image.Image.modify_by_intensity.1.png'>image.c57.png</image></td> + <td><image file='predef.Image.Image.modify_by_intensity.2.png'>image.c58.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->grey()->modify_by_intensity(1,0,0, 0,({255,0,0}),({0,255,0}));</td> </tr></table> </text> <group> <param name='r'/> <param name='g'/> <param name='b'/>
autodoc.git/onepage.xml:91921: </arguments> </method><doc> <text> Gives a new image with the old image's size, filled width a 'noise' pattern. The random seed may be different with each instance of pike. Example: <tt>->noise( ({0,({255,0,0}), 0.3,({0,255,0}), 0.6,({0,0,255}), 0.8,({255,255,0})}), 0.2,0.0,0.0,1.0 );</tt> - <image file='predef.Image.Image.noise.1.png' height='100' width='200'>pattern.c0.png</image> + <image file='predef.Image.Image.noise.1.png'>pattern.c0.png</image> </text> <group> <param name='colorrange'/> <text>colorrange table</text></group> <group> <param name='scale'/> <text>default value is 0.1</text></group> <group> <param name='xdiff'/>
autodoc.git/onepage.xml:92094: Default is to paint above, below, to the left and the right of these pixels. You can also run your own outline mask. The outline_mask function gives the calculated outline as an alpha channel image of white and black instead. <table><tr valign='center'> - <td><image file='predef.Image.Image.outline.1.png' height='115' width='80'>image.c59.png</image></td> - <td><image file='predef.Image.Image.outline.2.png' height='115' width='80'>image.c60.png</image></td> - <td><image file='predef.Image.Image.outline.3.png' height='115' width='80'>image.c61.png</image></td> + <td><image file='predef.Image.Image.outline.1.png'>image.c59.png</image></td> + <td><image file='predef.Image.Image.outline.2.png'>image.c60.png</image></td> + <td><image file='predef.Image.Image.outline.3.png'>image.c61.png</image></td> </tr><tr> <td>original</td> <td>masked through threshold</td> <td>...and outlined with red</td> </tr></table> </text> <group> <param name='mask'/>
autodoc.git/onepage.xml:92393: if it is rising or falling. This is done for the every red, green and blue part of the image. Phase images can be used to create ugly effects or to find meta-information in the orginal image. <table border='0'> <tr> - <td><image file='predef.Image.Image.phaseh.1.png' height='115' width='80'>search.c0.png</image></td> - <td><image file='predef.Image.Image.phaseh.2.png' height='115' width='80'>search.c1.png</image></td> - <td><image file='predef.Image.Image.phaseh.3.png' height='115' width='80'>search.c2.png</image></td> - <td><image file='predef.Image.Image.phaseh.4.png' height='115' width='80'>search.c3.png</image></td> - <td><image file='predef.Image.Image.phaseh.5.png' height='115' width='80'>search.c4.png</image></td> + <td><image file='predef.Image.Image.phaseh.1.png'>search.c0.png</image></td> + <td><image file='predef.Image.Image.phaseh.2.png'>search.c1.png</image></td> + <td><image file='predef.Image.Image.phaseh.3.png'>search.c2.png</image></td> + <td><image file='predef.Image.Image.phaseh.4.png'>search.c3.png</image></td> + <td><image file='predef.Image.Image.phaseh.5.png'>search.c4.png</image></td> </tr> <tr> <td>original </td> <td>phaseh() </td> <td>phasev() </td> <td>phasevh()</td> <td>phasehv()</td> </tr> </table> 
autodoc.git/onepage.xml:92448: <text> curve(s), <tt>({x1,y1,x2,y2,...,xn,yn})</tt>, automatically closed. If any given curve is inside another, it will make a hole. <pre> Image.Image(100,100)->setcolor(255,0,0,128)-> polyfill( ({ 20,20, 80,20, 80,80 }) ); </pre> - <image file='predef.Image.Image.polyfill.1.png' height='100' width='100'>polyfill.c0.png</image> + <image file='predef.Image.Image.polyfill.1.png'>polyfill.c0.png</image> </text></group> <group><returns/><text> the current object </text></group> <group><note/><text> Lines in the polygon may not be crossed without the crossing coordinate specified in both lines. </text></group>
autodoc.git/onepage.xml:92496: <returntype> <object>object </object></returntype> <arguments><argument name='seed'><type> <object>greyint</object></type></argument> </arguments> </method><doc> <text> Gives a randomized image; <table><tr valign='center'> - <td><image file='predef.Image.Image.random.1.png' height='115' width='80'>pattern.c1.png</image></td> - <td><image file='predef.Image.Image.random.2.png' height='115' width='80'>pattern.c2.png</image></td> - <td><image file='predef.Image.Image.random.3.png' height='115' width='80'>pattern.c3.png</image></td> - <td><image file='predef.Image.Image.random.4.png' height='115' width='80'>pattern.c4.png</image></td> - <td><image file='predef.Image.Image.random.5.png' height='115' width='80'>pattern.c5.png</image></td> - <td><image file='predef.Image.Image.random.6.png' height='115' width='80'>pattern.c6.png</image></td> + <td><image file='predef.Image.Image.random.1.png'>pattern.c1.png</image></td> + <td><image file='predef.Image.Image.random.2.png'>pattern.c2.png</image></td> + <td><image file='predef.Image.Image.random.3.png'>pattern.c3.png</image></td> + <td><image file='predef.Image.Image.random.4.png'>pattern.c4.png</image></td> + <td><image file='predef.Image.Image.random.5.png'>pattern.c5.png</image></td> + <td><image file='predef.Image.Image.random.6.png'>pattern.c6.png</image></td> </tr><tr> <td>original</td> <td>->random()</td> <td>->random(17)</td> <td>greyed (same again)</td> <td>color(red) (same again)</td> <td>...red channel </td> </tr></table> Use with -><ref resolved='predef::Image.Image.grey'>grey</ref>() or -><ref resolved='predef::Image.Image.color'>color</ref>()
autodoc.git/onepage.xml:92586: </method><doc> <text> Converts RGB data to YUV (YCrCb) data, or the other way around. When converting to YUV, the resulting data is stored like this: pixel.r = v (cr); pixel.g = y; pixel.b = u (cb); When converting to RGB, the input data is asumed to be placed in the pixels as above. <table><tr valign='center'> - <td><image file='predef.Image.Image.rgb_to_yuv.1.png' height='115' width='80'>image.c62.png</image></td> - <td><image file='predef.Image.Image.rgb_to_yuv.2.png' height='115' width='80'>image.c63.png</image></td> - <td><image file='predef.Image.Image.rgb_to_yuv.3.png' height='115' width='80'>image.c64.png</image></td> + <td><image file='predef.Image.Image.rgb_to_yuv.1.png'>image.c62.png</image></td> + <td><image file='predef.Image.Image.rgb_to_yuv.2.png'>image.c63.png</image></td> + <td><image file='predef.Image.Image.rgb_to_yuv.3.png'>image.c64.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->yuv_to_rgb();</td> <td>->rgb_to_yuv();</td> </tr><tr valign='center'> - <td><image file='predef.Image.Image.rgb_to_yuv.4.png' height='67' width='67'>image.c65.png</image></td> - <td><image file='predef.Image.Image.rgb_to_yuv.5.png' height='67' width='67'>image.c66.png</image></td> - <td><image file='predef.Image.Image.rgb_to_yuv.6.png' height='67' width='67'>image.c67.png</image></td> + <td><image file='predef.Image.Image.rgb_to_yuv.4.png'>image.c65.png</image></td> + <td><image file='predef.Image.Image.rgb_to_yuv.5.png'>image.c66.png</image></td> + <td><image file='predef.Image.Image.rgb_to_yuv.6.png'>image.c67.png</image></td> </tr><tr valign='center'> <td>tuned box (below)</td> <td>the rainbow (below)</td> <td>same, but rgb_to_yuv()</td> </tr></table> RGB to YUB calculation (this follows CCIR.601): <pre> in = input pixel
autodoc.git/onepage.xml:92672: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> </arguments> </method><doc> <text> Rotates an image a certain amount of degrees (360° is a complete rotation) counter-clockwise: <table><tr valign='center'> - <td><image file='predef.Image.Image.rotate.1.png' height='115' width='80'>matrix.c4.png</image></td> - <td><image file='predef.Image.Image.rotate.2.png' height='141' width='113'>matrix.c5.png</image></td> - <td><image file='predef.Image.Image.rotate.3.png' height='141' width='113'>matrix.c6.png</image></td> + <td><image file='predef.Image.Image.rotate.1.png'>matrix.c4.png</image></td> + <td><image file='predef.Image.Image.rotate.2.png'>matrix.c5.png</image></td> + <td><image file='predef.Image.Image.rotate.3.png'>matrix.c6.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->rotate(15,255,0,0);</td> <td>->rotate_expand(15);</td> </tr></table> The "expand" variant of functions stretches the image border pixels rather then filling with the given or current color.
autodoc.git/onepage.xml:92712: <method name='rotate_ccw'> <returntype> <object>object </object></returntype> <arguments> </arguments> </method><doc> <text> rotates an image counter-clockwise, 90 degrees. <table><tr valign='center'> - <td><image file='predef.Image.Image.rotate_ccw.1.png' height='115' width='80'>matrix.c7.png</image></td> - <td><image file='predef.Image.Image.rotate_ccw.2.png' height='80' width='115'>matrix.c8.png</image></td> + <td><image file='predef.Image.Image.rotate_ccw.1.png'>matrix.c7.png</image></td> + <td><image file='predef.Image.Image.rotate_ccw.2.png'>matrix.c8.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->rotate_ccw();</td> </tr></table> </text> <group><returns/><text> the new image object </text></group>
autodoc.git/onepage.xml:92737: <method name='rotate_cw'> <returntype> <object>object </object></returntype> <arguments> </arguments> </method><doc> <text> rotates an image clockwise, 90 degrees. <table><tr valign='center'> - <td><image file='predef.Image.Image.rotate_cw.1.png' height='115' width='80'>matrix.c9.png</image></td> - <td><image file='predef.Image.Image.rotate_cw.2.png' height='80' width='115'>matrix.c10.png</image></td> + <td><image file='predef.Image.Image.rotate_cw.1.png'>matrix.c9.png</image></td> + <td><image file='predef.Image.Image.rotate_cw.2.png'>matrix.c10.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->rotate_cw();</td> </tr></table> </text> <group><returns/><text> the new image object </text></group> </doc>
autodoc.git/onepage.xml:92861: filled with 255 if the color is the same, or 255 minus distance in the colorcube, squared, rightshifted 8 steps (see <ref resolved='predef::Image.Image.distancesq'>distancesq</ref>). When the edge distance is reached, the scan is stopped. Default edge value is 30. This value is squared and compared with the square of the distance above. <table><tr valign='center'> - <td><image file='predef.Image.Image.select_from.1.png' height='115' width='80'>image.c68.png</image></td> - <td><image file='predef.Image.Image.select_from.2.png' height='115' width='80'>image.c69.png</image></td> - <td><image file='predef.Image.Image.select_from.3.png' height='115' width='80'>image.c70.png</image></td> - <td><image file='predef.Image.Image.select_from.4.png' height='115' width='80'>image.c71.png</image></td> - <td><image file='predef.Image.Image.select_from.5.png' height='115' width='80'>image.c72.png</image></td> - <td><image file='predef.Image.Image.select_from.6.png' height='115' width='80'>image.c73.png</image></td> - <td><image file='predef.Image.Image.select_from.7.png' height='115' width='80'>image.c74.png</image></td> + <td><image file='predef.Image.Image.select_from.1.png'>image.c68.png</image></td> + <td><image file='predef.Image.Image.select_from.2.png'>image.c69.png</image></td> + <td><image file='predef.Image.Image.select_from.3.png'>image.c70.png</image></td> + <td><image file='predef.Image.Image.select_from.4.png'>image.c71.png</image></td> + <td><image file='predef.Image.Image.select_from.5.png'>image.c72.png</image></td> + <td><image file='predef.Image.Image.select_from.6.png'>image.c73.png</image></td> + <td><image file='predef.Image.Image.select_from.7.png'>image.c74.png</image></td> </tr><tr> <td>35, 35, 16</td> <td>35, 35, 32</td> <td>35, 35, 64</td> <td>35, 35, 96</td> <td>35, 35, 128</td> <td>35, 35, 192</td> <td>35, 35, 256</td> </tr></table> <table><tr valign='center'> - <td><image file='predef.Image.Image.select_from.8.png' height='115' width='80'>image.c75.png</image></td> - <td><image file='predef.Image.Image.select_from.9.png' height='115' width='80'>image.c76.png</image></td> + <td><image file='predef.Image.Image.select_from.8.png'>image.c75.png</image></td> + <td><image file='predef.Image.Image.select_from.9.png'>image.c76.png</image></td> </tr><tr> <td>original</td> <td>original * select_from(35,35,200)</td> </tr></table> </text> <group> <param name='x'/> <param name='y'/> <text>originating pixel in the image
autodoc.git/onepage.xml:92978: <argument name='y'><type><int/></type></argument> <argument name='r'><type><int/></type></argument> <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> <argument name='alpha'><type><int/></type></argument> </arguments> </method><doc> <text> <table><tr valign='center'> - <td><image file='predef.Image.Image.setpixel.1.png' height='115' width='80'>image.c77.png</image></td> - <td><image file='predef.Image.Image.setpixel.2.png' height='115' width='80'>image.c78.png</image></td> + <td><image file='predef.Image.Image.setpixel.1.png'>image.c77.png</image></td> + <td><image file='predef.Image.Image.setpixel.2.png'>image.c78.png</image></td> </tr><tr> <td>original</td> <td>->setpixel (10,10, 255,0,0)</td> </tr></table> </text> <group> <param name='x'/> <param name='y'/> <text>position of the pixel</text></group>
autodoc.git/onepage.xml:93071: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> </arguments> </method><doc> <text> Skews an image an amount of pixels or a factor; a skew-x is a transformation: <table><tr valign='center'> - <td><image file='predef.Image.Image.skewx.1.png' height='115' width='80'>matrix.c11.png</image></td> - <td><image file='predef.Image.Image.skewx.2.png' height='115' width='95'>matrix.c12.png</image></td> - <td><image file='predef.Image.Image.skewx.3.png' height='115' width='95'>matrix.c13.png</image></td> + <td><image file='predef.Image.Image.skewx.1.png'>matrix.c11.png</image></td> + <td><image file='predef.Image.Image.skewx.2.png'>matrix.c12.png</image></td> + <td><image file='predef.Image.Image.skewx.3.png'>matrix.c13.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->skewx(15,255,0,0);</td> <td>->skewx_expand(15);</td> </tr></table> </text> <group> <param name='x'/> <text>the number of pixels
autodoc.git/onepage.xml:93168: <argument name='g'><type><int/></type></argument> <argument name='b'><type><int/></type></argument> </arguments> </method><doc> <text> Skews an image an amount of pixels or a factor; a skew-y is a transformation: <table><tr valign='center'> - <td><image file='predef.Image.Image.skewy.1.png' height='115' width='80'>matrix.c14.png</image></td> - <td><image file='predef.Image.Image.skewy.2.png' height='130' width='80'>matrix.c15.png</image></td> - <td><image file='predef.Image.Image.skewy.3.png' height='130' width='80'>matrix.c16.png</image></td> + <td><image file='predef.Image.Image.skewy.1.png'>matrix.c14.png</image></td> + <td><image file='predef.Image.Image.skewy.2.png'>matrix.c15.png</image></td> + <td><image file='predef.Image.Image.skewy.3.png'>matrix.c16.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->skewy(15,255,0,0);</td> <td>->skewy_expand(15);</td> </tr></table> The "expand" variant of functions stretches the image border pixels rather then filling with the given or current color. </text>
autodoc.git/onepage.xml:93215: <returntype> <object>object </object></returntype> <arguments><argument name='seed'><type><int/></type></argument> </arguments> </method><doc> <text> Generates a test image, currently random gradients. <table><tr valign='center'> - <td><image file='predef.Image.Image.test.1.png' height='115' width='80'>image.c79.png</image></td> - <td><image file='predef.Image.Image.test.2.png' height='115' width='80'>image.c80.png</image></td> - <td><image file='predef.Image.Image.test.3.png' height='115' width='80'>image.c81.png</image></td> + <td><image file='predef.Image.Image.test.1.png'>image.c79.png</image></td> + <td><image file='predef.Image.Image.test.2.png'>image.c80.png</image></td> + <td><image file='predef.Image.Image.test.3.png'>image.c81.png</image></td> </tr><tr> <td>original</td> <td>->test()</td> <td>...and again</td> </tr></table> </text> <group><returns/><text> the new image </text></group>
autodoc.git/onepage.xml:93278: If any of red, green, blue parts of a pixel is larger then the given value, the pixel will become white, else black. This method works fine with the grey method. If no arguments are given, it will paint all non-black pixels white. (Ie, default is 0,0,0.) <table><tr valign='center'> - <td><image file='predef.Image.Image.threshold.1.png' height='115' width='80'>image.c82.png</image></td> - <td><image file='predef.Image.Image.threshold.2.png' height='115' width='80'>image.c83.png</image></td> - <td><image file='predef.Image.Image.threshold.3.png' height='115' width='80'>image.c84.png</image></td> + <td><image file='predef.Image.Image.threshold.1.png'>image.c82.png</image></td> + <td><image file='predef.Image.Image.threshold.2.png'>image.c83.png</image></td> + <td><image file='predef.Image.Image.threshold.3.png'>image.c84.png</image></td> </tr><tr valign='center'> <td>original</td> <td>->threshold(100);</td> <td>->threshold(0,100,0);</td> </tr></table> </text> <group><returns/><text> the new image object </text></group>
autodoc.git/onepage.xml:93324: </method><doc> <text> Draws a filled rectangle with colors (and alpha values) tuned between the corners. Tuning function is (1.0-x/xw)*(1.0-y/yw) where x and y is the distance to the corner and xw and yw are the sides of the rectangle. <table><tr valign='center'> - <td><image file='predef.Image.Image.tuned_box.1.png' height='115' width='80'>image.c85.png</image></td> - <td><image file='predef.Image.Image.tuned_box.2.png' height='115' width='80'>image.c86.png</image></td> - <td><image file='predef.Image.Image.tuned_box.3.png' height='115' width='80'>image.c87.png</image></td> - <td><image file='predef.Image.Image.tuned_box.4.png' height='115' width='80'>image.c88.png</image></td> + <td><image file='predef.Image.Image.tuned_box.1.png'>image.c85.png</image></td> + <td><image file='predef.Image.Image.tuned_box.2.png'>image.c86.png</image></td> + <td><image file='predef.Image.Image.tuned_box.3.png'>image.c87.png</image></td> + <td><image file='predef.Image.Image.tuned_box.4.png'>image.c88.png</image></td> </tr><tr valign='center'> <td>original</td> <td>tuned box</td> <td>solid tuning (blue,red,green,yellow)</td> <td>tuning transparency (as left + 255,128,128,0)</td> </tr></table> </text> <group> <param name='x1'/>
autodoc.git/onepage.xml:93390: </arguments> </method><doc> <text> gives a new image with the old image's size, filled width a 'turbulence' pattern The random seed may be different with each instance of pike. Example: <tt>->turbulence( ({0,({229,204,204}), 0.9,({229,20,20}), 0.9,Color.black}) );</tt> - <image file='predef.Image.Image.turbulence.1.png' height='100' width='200'>pattern.c7.png</image> + <image file='predef.Image.Image.turbulence.1.png'>pattern.c7.png</image> </text> <group> <param name='colorrange'/> <text>colorrange table</text></group> <group> <param name='octaves'/> <text>default value is 3</text></group> <group> <param name='scale'/> <text>default value is 0.1</text></group>
autodoc.git/onepage.xml:93600: <expr>"error"</expr>. </text></doc> <method name='exif_decode'> <arguments><argument name='data'><type><string/></type></argument><argument name='options'><type><or><mapping/><void/></or></type></argument></arguments> <returntype><mapping/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"____Image_JPEG"' homogen-type='inherit'> - <inherit name='"____Image_JPEG"'><classname>"____Image_JPEG"</classname></inherit> + <docgroup homogen-name='"____Image_JPEG"' homogen-type='inherit'> + <inherit name='"____Image_JPEG"'><classname>"____Image_JPEG"</classname></inherit> </docgroup> <docgroup homogen-name='quant_tables' homogen-type='method'><doc><group><fixme/><text>Document this function </text></group></doc> <method name='quant_tables'> <arguments><argument name='a'><type><or><int/><void/></or></type></argument></arguments> <returntype><mapping><indextype><int/></indextype><valuetype><array><valuetype><array><valuetype><int/></valuetype></array></valuetype></array></valuetype></mapping></returntype> </method> </docgroup> <class name='Marker'> <docgroup homogen-name='APP0' homogen-type='constant'>
autodoc.git/onepage.xml:95321: </text></group><group><member><type><int/></type><index>"NewSubfileType"</index></member><member><type><string/></type><index>"BitsPerSample"</index></member><member><type><int/></type><index>"Compression"</index></member><member><type><int/></type><index>"PhotometricInterpretation"</index></member><member><type><string/></type><index>"Make"</index></member><member><type><string/></type><index>"Model"</index></member><member><type><int/></type><index>"SamplesPerPixel"</index></member><member><type><int/></type><index>"ResolutionUnit"</index></member><member><type><string/></type><index>"Software"</index></member><member><type><string/></type><index>"DateTime"</index></member><member><type><int/></type><index>"Predictor"</index></member><member><type><string/></type><index>"XMP"</index></member></group></mapping> </text></doc> <method name='decode_header'><modifiers><public/></modifiers> <arguments><argument name='data'><type><string/></type></argument></arguments> <returntype><mapping/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"____Image_TIFF"' homogen-type='inherit'> - <inherit name='"____Image_TIFF"'><classname>"____Image_TIFF"</classname></inherit> + <docgroup homogen-name='"____Image_TIFF"' homogen-type='inherit'> + <inherit name='"____Image_TIFF"'><classname>"____Image_TIFF"</classname></inherit> </docgroup> </module> <module name='TIM'> <doc> <text> Handle decoding of TIM images. TIM is the framebuffer format of the PSX game system. It is a simple, uncompressed, truecolor or CLUT format
autodoc.git/onepage.xml:97221: </docgroup> <docgroup homogen-name='JString' homogen-type='method'> <method name='JString'> <arguments><argument name='s'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Java.jobject'>jobject</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Java"' homogen-type='inherit'> - <inherit name='"___Java"'><classname>"___Java"</classname></inherit> + <docgroup homogen-name='"___Java"' homogen-type='inherit'> + <inherit name='"___Java"'><classname>"___Java"</classname></inherit> </docgroup> <docgroup homogen-name='pkg' homogen-type='variable'><doc><text>Singleton 'package' object. Usage: object cls = Java.pkg.java.lang.String; or: object cls = Java.pkg["java/lang/String"]; cls is a jclass object; call it to create a jobject, which will have all the methods of the Java class. Example: Java.pkg.FooClass()->getResult(); </text></doc> <variable name='pkg'><type><object resolved='predef::Java'/></type></variable> </docgroup> <class name='jclass'>
autodoc.git/onepage.xml:97903: <returntype><string/></returntype> </method> </docgroup> </class> <module name='cat'> <doc><text>Catalan language locale. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='ces'> <doc><text>Czech language locale by Jan Petrous 16.10.1997, based on Slovenian language module by Iztok Umek. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='deu'> <doc><text>German language locale by Tvns Böker. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='eng'> <doc><text>English language locale. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='fin'> <doc><text>Finnish language locale created by Janne Edelman, Turku Unix Users Group ry, Turku, Finland </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='fra'> <doc><text>French language locale by Patrick Kremer. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='hrv'> <doc><text>Croatian language locale by Klara Makovac 1997/07/02 </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='hun'> <doc><text>Hungarian language locale by Zsolt Varga. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='ita'> <doc><text>Italian language locale by Francesco Chemolli </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='jpn'> <doc><text>Japanese language locale. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='mri'> <doc><text>Maaori (New Zealand) language locale by Jason Rumney </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='nld'> <doc><text>Dutch language locale by Stephen R. van den Berg </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='nor'> <doc><text>Norwegian language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='pol'> <doc><text>Polish language locale by Piotr Klaban <makler@man.torun.pl>. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='por'> <doc><text>Portuguese language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='rus'> <doc><text>Russian language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='slv'> <doc><text>Slovenian language locale by Iztok Umek 7. 8. 1997 </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='spa'> <doc><text>Spanish language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='srp'> <doc><text>Serbian language locale by Goran Opacic 1996/12/11 </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> <module name='swe'> <doc><text>Swedish language locale </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"abstract"' homogen-type='inherit'> - <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> + <docgroup homogen-name='"abstract"' homogen-type='inherit'> + <inherit name='"abstract"'><classname resolved='predef::Locale.Language.abstract'>"abstract"</classname></inherit> </docgroup> </module> </module> <class name='LanguageListObject'> <modifiers><protected/></modifiers> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='languages'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> <returntype><void/></returntype> </method>
autodoc.git/onepage.xml:100072: <returntype><array><valuetype><int/></valuetype></array></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='inf' homogen-type='constant'><doc><text>Floating point infinity. </text></doc> <constant name='inf'/> </docgroup> - <docgroup homogen-name='"___Math"' homogen-type='inherit'> - <inherit name='"___Math"'><classname>"___Math"</classname></inherit> + <docgroup homogen-name='"___Math"' homogen-type='inherit'> + <inherit name='"___Math"'><classname>"___Math"</classname></inherit> </docgroup> <docgroup homogen-name='log10' homogen-type='method'><doc><text>The 10-logarithm of <ref resolved='predef::Math.log10.x'>x</ref>. </text></doc> <method name='log10'> <arguments><argument name='x'><type><or><int/><float/></or></type></argument></arguments> <returntype><float/></returntype> </method> </docgroup> <docgroup homogen-name='log2' homogen-type='method'><doc><text>The 2-logarithm of <ref resolved='predef::Math.log2.x'>x</ref>. </text></doc>
autodoc.git/onepage.xml:105213: </method> </docgroup> <class name='odbc'> <doc><text>Low-level connection to an ODBC or DSN database. </text><group><note/><text>You typically don't want to access this module directly, but instead use the <ref resolved='predef::Sql.odbc'>Sql.odbc</ref> or <ref>Sql.dsn</ref> created by <ref resolved='predef::Sql.Sql'>Sql.Sql()</ref>. </text></group><group><seealso/><text><ref resolved='predef::Sql.odbc'>Sql.odbc</ref>, <ref>Sql.dsn</ref> </text></group></doc> </class> </module> + <module name='Oracle'> + <doc><text>Pike interface to Oracle databases. + </text><group><thanks/><text>Original design by Marcus Comstedt. + Re-written for Oracle 8.x and later by Fredrik Hubinette. + Re-structured into a CMOD by Henrik Grubbström. + </text></group></doc> + <class name='oracle'> + <doc><text>Connection to an Oracle database server. + </text><group><note/><text>You probably don't want to access this class directly, but + rather via <ref resolved='predef::Sql.Sql'>Sql.Sql</ref>. + </text></group><group><seealso/><text><ref resolved='predef::Sql.Sql'>Sql.Sql</ref>, <ref>Sql.oracle</ref> + </text></group></doc> + <docgroup homogen-name='Connection' homogen-type='inherit'> + <inherit name='Connection'><classname>__builtin.Sql.Connection</classname></inherit> + </docgroup> + + <class name='LOB'> + <doc><text>Large OBject. + </text></doc> + </class> + <class name='NULL'> + <docgroup homogen-name='Null' homogen-type='inherit'> + <inherit name='Null'><classname resolved='predef::Val.Null'>Val.Null</classname></inherit> + </docgroup> + <docgroup homogen-name='is_oracle_null' homogen-type='constant'> + <constant name='is_oracle_null'/> + </docgroup> + </class> + <class name='compile_query'> + <class name='TypedResult'> + <docgroup homogen-name='Result' homogen-type='inherit'> + <inherit name='Result'><classname>__builtin.Sql.Result</classname></inherit> + </docgroup> + </class> + + </class> + </class> + </module> <module name='PDF'> <docgroup homogen-type='constant'> <constant name='a0_width'/> <constant name='a0_height'/> <constant name='a1_width'/> <constant name='a1_height'/> <constant name='a2_width'/> <constant name='a2_height'/> <constant name='a3_width'/> <constant name='a3_height'/>
autodoc.git/onepage.xml:106880: </text></doc> <docgroup homogen-type='constant'><constant name='NOTICE'/> <constant name='WARNING'/> <constant name='ERROR'/> </docgroup> </enum> </module> <module name='Pike'> <doc><text>This module parses and tokenizes Pike source code. </text></doc> - <docgroup homogen-name='"C.pmod"' homogen-type='inherit'> - <inherit name='"C.pmod"'><classname resolved='predef::Parser.C'>"C.pmod"</classname></inherit> + <docgroup homogen-name='"C.pmod"' homogen-type='inherit'> + <inherit name='"C.pmod"'><classname resolved='predef::Parser.C'>"C.pmod"</classname></inherit> </docgroup> </module> <module name='Python'> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='split' homogen-type='method'><doc><text>Returns the provided string with Python code as an array with tokens. </text></doc> <method name='split'>
autodoc.git/onepage.xml:110621: statement ("<expr>/bin/sh -c <ref resolved='predef::Process.spawn.command'>command</ref></expr>" for Unix, "<expr>cmd /c <ref resolved='predef::Process.spawn.command'>command</ref></expr>" for Windows). </text><group><param name='stdin'/><param name='stdout'/><param name='stderr'/><text>Stream objects to use as standard input, standard output and standard error, respectively, for the created process. The corresponding streams for this process are used for those that are left out. </text></group><group><returns/><text>Returns a <ref resolved='predef::Process.Process'>Process.Process</ref> object for the created process. </text></group><group><seealso/><text><ref resolved='predef::Process.system'>system</ref>, <ref resolved='predef::Process.popen'>popen</ref> </text></group></doc> <method name='spawn'> - <arguments><argument name='command'><type><string/></type></argument><argument name='stdin'><type><or><void/><object resolved='predef::Stdio.Stream'>Stdio.Stream</object></or></type></argument><argument name='stdout'><type><or><void/><object resolved='predef::Stdio.Stream'>Stdio.Stream</object></or></type></argument><argument name='stderr'><type><or><void/><object resolved='predef::Stdio.Stream'>Stdio.Stream</object></or></type></argument><argument><value/></argument></arguments> + <arguments><argument name='command'><type><string/></type></argument><argument name='stdin'><type><or><void/><object resolved='predef::Stdio.Stream'>Stdio.Stream</object></or></type></argument><argument name='stdout'><type><or><void/><object resolved='predef::Stdio.Stream'>Stdio.Stream</object></or></type></argument><argument name='stderr'><type><or><void/><object resolved='predef::Stdio.Stream'>Stdio.Stream</object></or></type></argument></arguments> <returntype><object resolved='predef::Process.Process'>Process</object></returntype> </method> </docgroup> <docgroup homogen-name='spawn_pike' homogen-type='method'><doc><text>Spawn a new pike process similar to the current. </text><group><param name='argv'/><text>Arguments for the new process. </text></group><group><param name='options'/><text>Process creation options. See <ref resolved='predef::Process.Process'>Process.Process</ref> for details. May also specify "add_predefines", "add_program_path", or "add_include_path" in order to include these components in command path (module path is included by default.) </text></group><group><param name='launcher'/><text>Optional launcher prefix command used to spawn the pike binary.
autodoc.git/onepage.xml:110983: <constant name='limit_value'/> </docgroup> <docgroup homogen-name='pid' homogen-type='method'><doc><text>Returns the process identifier of the process. </text></doc> <method name='pid'> <arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='set_priority' homogen-type='method'><doc><text>Sets the priority of the process. <ref resolved='predef::Process.create_process.set_priority.priority'>priority</ref> is one of the strings - <dl><group><item name='"realtime"'/><item name='"highest"'/><item name='"higher"'/><item name='"high"'/><item name='"normal"'/><item name='"low"'/><item name='"lowest"'/></group></dl></text></doc> + <dl><group><item name='"realtime"'/><item name='"highest"'/><item name='"higher"'/><item name='"high"'/><item name='"normal"'/><item name='"low"'/><item name='"lowest"'/></group></dl></text></doc> <method name='set_priority'> <arguments><argument name='priority'><type><string/></type></argument></arguments> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='status' homogen-type='method'><doc><text>Returns the status of the process: <int><group><value>-1</value><text>Unknown </text></group><group><value>0</value><text>Running </text></group><group><value>1</value><text>Stopped </text></group><group><value>2</value><text>Exited
autodoc.git/onepage.xml:113378: <ref resolved='predef::Stdio.Port.bind'>Stdio.Port.bind</ref> for more information </text></group></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='callback'><type><function><argtype><object resolved='predef::Protocols.HTTP.Server.Request'>Request</object></argtype><returntype><void/></returntype></function></type></argument><argument name='port'><type><or><void/><int/></or></type></argument><argument name='interface'><type><or><void/><string/></or></type></argument><argument name='key'><type><or><void/><string/><object>Crypto.Sign.State</object></or></type></argument><argument name='certificate'><type><or><void/><string/><array><valuetype><string/></valuetype></array></or></type></argument><argument name='share'><type><or><void/><int/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.HTTP.Server'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.HTTP.Server'>"."</classname></import> </docgroup> <docgroup homogen-name='Port' homogen-type='inherit'> <inherit name='Port'><classname resolved='predef::SSL.Port'>SSL.Port</classname></inherit> </docgroup> <docgroup homogen-name='new_connection' homogen-type='method'><doc><text>The port accept callback </text></doc> <method name='new_connection'><modifiers><protected/></modifiers> <arguments/> <returntype><void/></returntype> </method>
autodoc.git/onepage.xml:113852: </text></group></mapping> </text></group></doc> <method name='create'> <arguments><argument name='server'><type><or><string/><object resolved='predef::Protocols.IRC.Client.create'/></or></type></argument><argument name='options'><type><or><void/><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.IRC'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.IRC'>"."</classname></import> </docgroup> </class> <class name='Person'> <doc><text>Abstract class for a person. </text></doc> <docgroup homogen-name='ip' homogen-type='variable'><doc><text>User domain, e.g. <expr>"mistel.idonex.se"</expr>. </text></doc> <variable name='ip'><type><string/></type></variable> </docgroup> <docgroup homogen-name='last_action' homogen-type='variable'><doc><text>Time of last action, represented as posix time.
autodoc.git/onepage.xml:114271: name is returned. </text></doc> <method name='get_constant_name'> <arguments><argument name='val'><type><mixed/></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols'>"."</classname></import> </docgroup> <docgroup homogen-name='ldap_decode_string' homogen-type='method'><doc><text>Decodes all <expr>\xx</expr> escapes in <ref resolved='predef::Protocols.LDAP.ldap_decode_string.str'>str</ref>. </text><group><seealso/><text><ref resolved='predef::Protocols.LDAP.ldap_encode_string'>ldap_encode_string</ref> </text></group></doc> <method name='ldap_decode_string'> <arguments><argument name='str'><type><string/></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='ldap_encode_string' homogen-type='method'><doc><text>Quote characters in the given string as necessary for use as a
autodoc.git/onepage.xml:114674: </text><group><seealso/><text><ref resolved='predef::Protocols.LDAP.client.search'>search</ref> </text></group></doc> <method name='get_supported_controls'> <arguments/> <returntype><multiset><indextype><string/></indextype></multiset></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.LDAP'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.LDAP'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>SSL.Constants</classname></import> </docgroup> <docgroup homogen-name='Types' homogen-type='import'> <import name='Types'><classname resolved='predef::Standards.ASN1.Types'>Standards.ASN1.Types</classname></import> </docgroup> <docgroup homogen-name='info' homogen-type='variable'><doc><text>Several information about code itself and about active connection too </text></doc> <variable name='info'><type><mapping/></type></variable>
autodoc.git/onepage.xml:115457: <returntype><void/></returntype> </method> <method name='create'> <arguments><argument name='server'><type><string/></type></argument><argument name='options'><type><mapping/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> </docgroup> <docgroup homogen-type='variable'><doc><text>Description of the connected server. </text></doc> <variable name='protocol_level'><type><int/></type></variable> <variable name='session_software'><type><string/></type></variable> <variable name='software_version'><type><string/></type></variable> </docgroup> </class> <module name='ProtocolTypes'> <doc><text>Data types as defined by the LysKOM protocol specification.
autodoc.git/onepage.xml:115649: <returntype><object resolved='predef::Protocols.LysKOM.Session.create_text'/></returntype> </method> <method name='create_text'> <arguments><argument name='subject'><type><string/></type></argument><argument name='body'><type><string/></type></argument><argument name='options'><type><mapping/></type></argument><argument name='callback'><type><function/></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments> <returntype><object resolved='predef::Protocols.LysKOM.Session.create_text'/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.LysKOM'>"."</classname></import> </docgroup> <docgroup homogen-name='login' homogen-type='method'><doc><text>Performs a login. Throws a lyskom error if unsuccessful. </text><group><returns/><text>The session object logged in. </text></group></doc> <method name='login'> <arguments><argument name='user_no'><type><int/></type></argument><argument name='password'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Protocols.LysKOM.Session.login'/></returntype> </method> <method name='login'> <arguments><argument name='user_no'><type><int/></type></argument><argument name='password'><type><string/></type></argument><argument name='invisible'><type><int/></type></argument></arguments>
autodoc.git/onepage.xml:116855: </text></group><group><returns/><text>the function associated with oid, if any </text></group></doc> <method name='get_set_oid_callback'> <arguments><argument name='oid'><type><string/></type></argument></arguments> <returntype><or><void/><function/></or></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"protocol"' homogen-type='inherit'> - <inherit name='"protocol"'><classname resolved='predef::Protocols.SNMP.protocol'>"protocol"</classname></inherit> + <docgroup homogen-name='"protocol"' homogen-type='inherit'> + <inherit name='"protocol"'><classname resolved='predef::Protocols.SNMP.protocol'>"protocol"</classname></inherit> </docgroup> <docgroup homogen-name='set_get_communities' homogen-type='method'><doc><text>set the valid community strings for Get requests </text><group><param name='communities'/><text>an array of valid Get communities </text></group><group><note/><text>send an empty array to disable Get requests </text></group></doc> <method name='set_get_communities'> <arguments><argument name='communities'><type><array/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup>
autodoc.git/onepage.xml:118859: <arguments><argument name='str'><type><string/></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype> </method> </docgroup> <docgroup homogen-name='QueryTextExtents_req' homogen-type='method'> <method name='QueryTextExtents_req'> <arguments><argument name='str'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Protocols.X.Types.Font.QueryTextExtents_req'/></returntype> </method> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Protocols.X.Types'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Protocols.X.Types'>"."</classname></import> </docgroup> <docgroup homogen-name='XResource' homogen-type='inherit'> <inherit name='XResource'><classname resolved='predef::Protocols.X.Types.XResource'>XResource</classname></inherit> </docgroup> </class> <class name='GC'> <docgroup homogen-name='ChangeGC' homogen-type='method'> <method name='ChangeGC'> <arguments><argument name='attributes'><type><mapping/></type></argument></arguments> <returntype><void/></returntype>
autodoc.git/onepage.xml:119669: <docgroup homogen-name='`()' homogen-type='method'><doc><text>Convenience/compatibility method to get a <ref resolved='predef::Regexp.SimpleRegexp'>SimpleRegexp</ref> object. </text></doc> <method name='`()'> <arguments><argument name='regexp'><type><or><void/><string/></or></type></argument></arguments> <returntype><object resolved='predef::Regexp.SimpleRegexp'>SimpleRegexp</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Regexp"' homogen-type='inherit'> - <inherit name='"___Regexp"'><classname>"___Regexp"</classname></inherit> + <docgroup homogen-name='"___Regexp"' homogen-type='inherit'> + <inherit name='"___Regexp"'><classname>"___Regexp"</classname></inherit> </docgroup> <docgroup homogen-name='match' homogen-type='method'><doc><text>Calls <ref resolved='predef::Regexp.PCRE.Plain.match'>Regexp.PCRE.Plain.match</ref> in a temporary regexp object. Faster to type but slower to run... </text></doc> <method name='match'> <arguments><argument name='regexp'><type><string/></type></argument><argument name='data'><type><string/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='replace' homogen-type='method'><doc><text>Calls <ref resolved='predef::Regexp.PCRE.Plain.replace'>Regexp.PCRE.Plain.replace</ref> in a temporary regexp object.
autodoc.git/onepage.xml:119774: "The output is an integer that is set to one if UTF-8 support is available; otherwise it is set to zero." This constant is calculated when the module is initiated by using pcre_config(3). </text></doc> <constant name='buildconfig_UTF8'/> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"____Regexp_PCRE"' homogen-type='inherit'> - <inherit name='"____Regexp_PCRE"'><classname>"____Regexp_PCRE"</classname></inherit> + <docgroup homogen-name='"____Regexp_PCRE"' homogen-type='inherit'> + <inherit name='"____Regexp_PCRE"'><classname>"____Regexp_PCRE"</classname></inherit> </docgroup> <docgroup homogen-name='split_subject' homogen-type='method'><doc><text>Convenience function that splits a subject string on the result from _pcre->exec() equal to map(previous_result/2, lambda(array v) { return subject[v[0]..v[1]-1]; }) </text></doc> <method name='split_subject'> <arguments><argument name='subject'><type><string/></type></argument><argument name='previous_result'><type><array><valuetype><int/></valuetype></array></type></argument></arguments> <returntype><array><valuetype><string/></valuetype></array></returntype>
autodoc.git/onepage.xml:120473: <docgroup homogen-name='get' homogen-type='method'><doc><text>Get a named object from the remote server. </text></doc> <method name='get'> <arguments><argument name='name'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Remote.Client.get'/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> </docgroup> <docgroup homogen-name='provide' homogen-type='method'><doc><text>Provide a named <ref resolved='predef::Remote.Client.provide.thing'>thing</ref> to the <ref resolved='predef::Remote.Server'>Remote.Server</ref>. </text><group><param name='name'/><text>Name to provide <ref resolved='predef::Remote.Client.provide.thing'>thing</ref> under. </text></group><group><param name='thing'/><text>Thing to provide. </text></group></doc> <method name='provide'> <arguments><argument name='name'><type><string/></type></argument><argument name='thing'><type><mixed/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup>
autodoc.git/onepage.xml:120722: </text></group><group><param name='max_call_threads'/><text>Maximum number of concurrent threads. </text></group></doc> <method name='create'> <arguments><argument name='host'><type><string/></type></argument><argument name='port'><type><int/></type></argument><argument name='max_call_threads'><type><or><void/><int/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Remote'>"."</classname></import> </docgroup> <docgroup homogen-name='port' homogen-type='variable'><doc><text>Port for the <ref resolved='predef::Remote.Server'>Remote.Server</ref>. </text></doc> <variable name='port'><type><object resolved='predef::Stdio.Port'>Stdio.Port</object></type></variable> </docgroup> <docgroup homogen-name='provide' homogen-type='method'><doc><text>Provide a named <ref resolved='predef::Remote.Server.provide.thing'>thing</ref> to the <ref resolved='predef::Remote.Client'>Remote.Client</ref>(s). </text><group><param name='name'/><text>Name to provide <ref resolved='predef::Remote.Server.provide.thing'>thing</ref> under. </text></group><group><param name='thing'/><text>Thing to provide. </text></group></doc> <method name='provide'>
autodoc.git/onepage.xml:123034: send_packet() function to transmit packets. </text></doc> <method name='handle_handshake'> <arguments><argument name='type'><type><int/></type></argument><argument name='input'><type><object resolved='predef::SSL.Buffer'>Buffer</object></type></argument><argument name='raw'><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type></argument></arguments> <returntype><int><min>-1</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='Connection' homogen-type='inherit'> <inherit name='Connection'><classname resolved='predef::SSL.Connection'>Connection</classname></inherit> </docgroup> <docgroup homogen-name='keyshares' homogen-type='variable'><doc><text>Active key share offers. NB: Only used with TLS 1.3 and later. </text></doc>
autodoc.git/onepage.xml:123902: </docgroup> <docgroup homogen-name='heartbleed_probe' homogen-type='variable'><doc><text>If set, the other peer will be probed for the heartbleed bug during handshake. If heartbleed is found the connection is closed with insufficient security fatal error. </text></doc> <variable name='heartbleed_probe'><type><int><min>0</min><max>1</max></int></type></variable> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='lookup_session' homogen-type='method'><doc><text>Lookup a session identifier in the cache. Returns the corresponding session, or zero if it is not found or caching is disabled. </text></doc> <method name='lookup_session'> <arguments><argument name='id'><type><string/></type></argument></arguments>
autodoc.git/onepage.xml:124770: send_packet() function to transmit packets. </text></doc> <method name='handle_handshake'> <arguments><argument name='type'><type><int/></type></argument><argument name='input'><type><object resolved='predef::SSL.Buffer'>Buffer</object></type></argument><argument name='raw'><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type></argument></arguments> <returntype><int><min>-1</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='Connection' homogen-type='inherit'> <inherit name='Connection'><classname resolved='predef::SSL.Connection'>Connection</classname></inherit> </docgroup> <docgroup homogen-name='send_renegotiate' homogen-type='method'><doc><text>Renegotiate the connection (server initiated). Sends a <ref>hello_request</ref> to force a new round of handshaking. </text></doc>
autodoc.git/onepage.xml:124912: </text></doc> <variable name='heartbeat_mode'><type><object>HeartBeatModeType</object></type></variable> </docgroup> <docgroup homogen-name='identity' homogen-type='variable'><doc><text>Identifies the session to the server </text></doc> <variable name='identity'><type><string><min>0</min><max>255</max></string></type></variable> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='is_supported_cert' homogen-type='method'><doc><text>Used to filter certificates not supported by the peer. </text><group><param name='cp'/><text>Candidate <ref resolved='predef::SSL.Constants.CertificatePair'>CertificatePair</ref>. </text></group><group><param name='version'/><text>Negotiated version of SSL. </text></group><group><param name='ecc_curves'/><text>The set of ecc_curves supported by the peer. </text></group></doc> <method name='is_supported_cert'><modifiers><protected/></modifiers>
autodoc.git/onepage.xml:125084: <docgroup homogen-name='encrypt_packet' homogen-type='method'><doc><text>Encrypts a packet (including deflating and MAC-generation). </text></doc> <method name='encrypt_packet'> <arguments><argument name='packet'><type><object resolved='predef::SSL.Packet'>Packet</object></type></argument><argument name='ctx'><type><object resolved='predef::SSL.Context'>Context</object></type></argument></arguments> <returntype><or><object resolved='predef::SSL.Alert'>Alert</object><object resolved='predef::SSL.Packet'>Packet</object></or></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::SSL'>"."</classname></import> </docgroup> <docgroup homogen-name='Constants' homogen-type='import'> <import name='Constants'><classname resolved='predef::SSL.Constants'>Constants</classname></import> </docgroup> <docgroup homogen-name='mac' homogen-type='variable'><doc><text>Message Authentication Code </text></doc> <variable name='mac'><type><object resolved='predef::SSL.Cipher.MACAlgorithm'>Cipher.MACAlgorithm</object></type></variable> </docgroup> <docgroup homogen-name='salt' homogen-type='variable'><doc><text>TLS 1.2 IV salt. This is used as a prefix for the IV for the AEAD cipher algorithms.
autodoc.git/onepage.xml:125656: <class name='DefaultParser'> <docgroup homogen-name='create' homogen-type='method'> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='opt'><type><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"."' homogen-type='import'> - <import name='"."'><classname resolved='predef::Search.Grammar'>"."</classname></import> + <docgroup homogen-name='"."' homogen-type='import'> + <import name='"."'><classname resolved='predef::Search.Grammar'>"."</classname></import> </docgroup> <docgroup homogen-name='AbstractParser' homogen-type='inherit'> <inherit name='AbstractParser'><modifiers><protected/></modifiers><classname resolved='predef::Search.Grammar.AbstractParser'>.AbstractParser</classname></inherit> </docgroup> <docgroup homogen-name='Lexer' homogen-type='inherit'> <inherit name='Lexer'><modifiers><protected/></modifiers><classname resolved='predef::Search.Grammar.Lexer'>.Lexer</classname></inherit> </docgroup> <docgroup homogen-name='options' homogen-type='variable'> <variable name='options'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></variable> </docgroup>
autodoc.git/onepage.xml:126938: </text></group><group><note/><text>In versions of Pike prior to 7.2 it was possible to leave out the dbtype, but that has been deprecated, since it never worked well. </text></group><group><note/><text>Exactly which databases are supported by pike depends on the installed set of client libraries when pike was compiled. The possible ones are <dl><group><item name='mysql'/><text>libmysql based mysql connection </text></group><group><item name='mysqls'/><text>libmysql based mysql connection, using SSL </text></group><group><item name='dsn'/><text><ref>ODBC</ref> based connection </text></group><group><item name='msql'/><text><ref resolved='predef::Msql'>Msql</ref> </text></group><group><item name='odbc'/><text><ref>ODBC</ref> based connection - </text></group><group><item name='oracle'/><text><ref>Oracle</ref> using oracle libraries + </text></group><group><item name='oracle'/><text><ref resolved='predef::Oracle'>Oracle</ref> using oracle libraries </text></group><group><item name='pgsql'/><text>PostgreSQL direct network access. This module is independent of any external libraries. </text></group><group><item name='postgres'/><text>PostgreSQL libray access. Uses the <ref resolved='predef::Postgres'>Postgres</ref> module. </text></group><group><item name='rsql'/><text>Remote SQL api, requires a rsql server running on another host. This is an API that uses sockets to communicate with a remote pike running pike -x rsqld on another host. </text></group><group><item name='sqlite'/><text>In-process SQLite database, uses the <ref>SQLite</ref> module </text></group><group><item name='sybase'/><text>Uses the <ref>sybase</ref> module to access sybase </text></group><group><item name='tds'/><text>Sybase and Microsoft SQL direct network access using the TDS protocol. This module is independent of any external libraries.
autodoc.git/onepage.xml:132527: <method name='get_module_xml'> <arguments><argument name='dir'><type><object>Directory</object></type></argument><argument name='id'><type><string/></type></argument><argument name='version'><type><string/></type></argument><argument name='manufacturer'><type><or><string/><void/></or></type></argument><argument name='description'><type><or><string/><void/></or></type></argument><argument name='guid'><type><or><string/><void/></or></type></argument><argument name='comments'><type><or><string/><void/></or></type></argument><argument name='installer_version'><type><or><string/><void/></or></type></argument></arguments> <returntype><object>WixNode</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> </module> </module> + <module name='_BSON'> + <docgroup homogen-name='decode' homogen-type='method'> + <method name='decode'> + <arguments><argument name='document'><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type></argument></arguments> + <returntype><mapping/></returntype> + </method> + </docgroup> + <docgroup homogen-name='decode' homogen-type='method'> + <method name='decode'> + <arguments><argument name='document'><type><string><min>0</min><max>255</max></string></type></argument></arguments> + <returntype><mapping/></returntype> + </method> + </docgroup> </module> - + </module> <module name='Stdio'> <docgroup homogen-name='DATA_CHUNK_SIZE' homogen-type='constant'><doc><text>Size used in various places to divide incoming or outgoing data into chunks. </text></doc> <constant name='DATA_CHUNK_SIZE'><modifiers><final/></modifiers><type><int/></type></constant> </docgroup> <docgroup homogen-name='NOTE_ATTRIB' homogen-type='constant'> <constant name='NOTE_ATTRIB'><type><int/></type></constant> </docgroup> <docgroup homogen-name='NOTE_DELETE' homogen-type='constant'>
autodoc.git/onepage.xml:134447: <arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='open' homogen-type='method'><doc><text>Open a file, or use an existing fd. If <ref resolved='predef::Stdio.Fd.open.filename'>filename</ref> is given, attempt to open the named file. If <ref resolved='predef::Stdio.Fd.open.fd'>fd</ref> is given instead, it should be the file descriptor for an already opened file, which will then be used by this object. <ref resolved='predef::Stdio.Fd.open.mode'>mode</ref> describes how the file is opened. It's a case-insensitive string consisting of one or more of the following letters: - <dl><group><item name='"r"'/><text>Open for reading. - </text></group><group><item name='"w"'/><text>Open for writing. - </text></group><group><item name='"a"'/><text>Append new data to the end. - </text></group><group><item name='"c"'/><text>Create the file if it doesn't exist already. - </text></group><group><item name='"t"'/><text>Truncate the file to zero length if it already contains data. + <dl><group><item name='"r"'/><text>Open for reading. + </text></group><group><item name='"w"'/><text>Open for writing. + </text></group><group><item name='"a"'/><text>Append new data to the end. + </text></group><group><item name='"c"'/><text>Create the file if it doesn't exist already. + </text></group><group><item name='"t"'/><text>Truncate the file to zero length if it already contains data. Use only together with <expr>"w"</expr>. - </text></group><group><item name='"x"'/><text>Open exclusively - the open fails if the file already exists. + </text></group><group><item name='"x"'/><text>Open exclusively - the open fails if the file already exists. Use only together with <expr>"c"</expr>. Note that it's not safe to assume that this is atomic on some systems. </text></group></dl><ref resolved='predef::Stdio.Fd.open.access'>access</ref> specifies the permissions to use if a new file is created. It is a UNIX style permission bitfield: <dl><group><item name='0400'/><text>User has read permission. </text></group><group><item name='0200'/><text>User has write permission. </text></group><group><item name='0100'/><text>User has execute permission. </text></group><group><item name='0040'/><text>Group has read permission. </text></group><group><item name='0020'/><text>Group has write permission. </text></group><group><item name='0010'/><text>Group has execute permission.
autodoc.git/onepage.xml:141205: classes, modules, methods, variables ... The classes can produce XML representations of themselves. </text></doc> <docgroup homogen-name='EmptyDoc' homogen-type='variable'><doc><text>The empty <ref resolved='predef::Tools.AutoDoc.PikeObjects.Documentation'>Documentation</ref>. </text></doc> <variable name='EmptyDoc'><modifiers><protected/></modifiers><type><object resolved='predef::Tools.AutoDoc.PikeObjects.Documentation'>Documentation</object></type></variable> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> - <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> + <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> + <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> </docgroup> <docgroup homogen-name='Tree' homogen-type='inherit'> <inherit name='Tree'><modifiers><protected/></modifiers><classname resolved='predef::Parser.XML.Tree'>Parser.XML.Tree</classname></inherit> </docgroup> <class name='ArrayType'> <doc><text>The class for representing array types. </text><group><seealso/><text><ref resolved='predef::Tools.AutoDoc.PikeObjects.Type'>Type</ref> </text></group></doc> <docgroup homogen-name='create' homogen-type='method'> <method name='create'>
autodoc.git/onepage.xml:142166: </text><group><param name='root'/><text>The root (<tt><autodoc></tt>) node of the documentation tree. </text></group></doc> <method name='handleAppears'> <arguments><argument name='root'><type><object resolved='predef::Parser.XML.Tree.SimpleNode'>SimpleNode</object></type></argument><argument name='flags'><type><or><object resolved='predef::Tools.AutoDoc.Flags'>.Flags</object><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> - <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> + <docgroup homogen-name='"module.pmod"' homogen-type='inherit'> + <inherit name='"module.pmod"'><modifiers><protected/></modifiers><classname resolved='predef::Tools.AutoDoc'>"module.pmod"</classname></inherit> </docgroup> <docgroup homogen-name='Tree' homogen-type='inherit'> <inherit name='Tree'><modifiers><protected/></modifiers><classname resolved='predef::Parser.XML.Tree'>Parser.XML.Tree</classname></inherit> </docgroup> <docgroup homogen-name='mergeTrees' homogen-type='method'><doc><text>Puts all children of <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.source'>source</ref> into the tree <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.dest'>dest</ref>, in their correct place module-hierarchically. Used to merge the results of extractions of different Pike and C files. Some minor effort is expended to normalize the result to some sort of canonical order. </text><group><param name='source'/><param name='dest'/><text>The nodes <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.source'>source</ref> and <ref resolved='predef::Tools.AutoDoc.ProcessXML.mergeTrees.dest'>dest</ref> are <tt><class></tt>, <tt><module></tt>,
autodoc.git/onepage.xml:142305: </docgroup> <docgroup homogen-name='xml' homogen-type='method'><doc><group><returns/><text>Returns a string with an XML-fragment describing the source position. </text></group></doc> <method name='xml'> <arguments><argument name='flags'><type><or><object resolved='predef::Tools.AutoDoc.Flags'>Flags</object><void/></or></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> </class> </module> + <module name='Hilfe'> + <docgroup homogen-name='format_hr_time' homogen-type='method'><doc><text>Helper function that formats a time span in nanoseconds to + something more human readable (ns, ms or s). + </text></doc> + <method name='format_hr_time'> + <arguments><argument name='i'><type><int/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='' homogen-type='import'> + <import name=''><classname resolved='predef::'>predef::</classname></import> + </docgroup> + <class name='Command'> + <doc><text>Abstract class for Hilfe commands. + </text></doc> + <docgroup homogen-name='doc' homogen-type='method'><doc><text>A more elaborate documentation of the command. This should be + less than 68 characters per line. + </text></doc> + <method name='doc'> + <arguments><argument name='what'><type><string/></type></argument><argument name='with'><type><string/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='exec' homogen-type='method'><doc><text>The actual command callback. Messages to the user should be + written out by using the safe_write method in the <ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref> + object. + </text></doc> + <method name='exec'> + <arguments><argument name='e'><type><object resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</object></type></argument><argument name='line'><type><string/></type></argument><argument name='words'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='tokens'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='help' homogen-type='method'><doc><text>Returns a one line description of the command. This help should + be shorter than 54 characters. + </text></doc> + <method name='help'> + <arguments><argument name='what'><type><string/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + </class> + <class name='CommandReset'> + <doc><text>Variable reset command. Put ___Hilfe->commands->reset = + Tools.Hilfe.CommandReset(); in your .hilferc to have this command + defined when you open Hilfe. + </text></doc> + <docgroup homogen-name='Command' homogen-type='inherit'> + <inherit name='Command'><classname resolved='predef::Tools.Hilfe.Command'>Command</classname></inherit> + </docgroup> + </class> + <class name='CommandSet'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='Command' homogen-type='inherit'> + <inherit name='Command'><classname resolved='predef::Tools.Hilfe.Command'>Command</classname></inherit> + </docgroup> + <class name='Intwriter'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='type'><type><string/></type></argument><argument name='fallback'><type><function/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-type='variable'> + <variable name='type'><type><string/></type></variable> + <variable name='fallback'><type><function/></type></variable> + </docgroup> + </class> + <class name='Reswriter'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='format'><type><string/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='format' homogen-type='variable'> + <variable name='format'><type><string/></type></variable> + </docgroup> + </class> + </class> + <class name='Evaluator'> + <doc><text>This class implements the actual Hilfe interpreter. It is accessible + as ___Hilfe from Hilfe expressions. + </text></doc> + <docgroup homogen-name='add_buffer' homogen-type='method'><doc><text>Add buffer tokenizes the input string and determines if the + new line is a Hilfe command. If not, it updates the current + state with the new tokens and sends any and all complete + expressions to evaluation in <ref resolved='predef::Tools.Hilfe.Evaluator.parse_expression'>parse_expression</ref>. + </text></doc> + <method name='add_buffer'> + <arguments><argument name='s'><type><string/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='add_input_hook' homogen-type='method'><doc><text>Adds a function to the input hook, making + all user data be fed into the function. + </text><group><seealso/><text><ref resolved='predef::Tools.Hilfe.Evaluator.remove_input_hook'>remove_input_hook</ref> + </text></group></doc> + <method name='add_input_hook'> + <arguments><argument name='new'><type><or><function/><object resolved='predef::Tools.Hilfe.Evaluator.add_input_hook'/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='add_input_line' homogen-type='method'><doc><text>Input a line of text into Hilfe. It checks if <ref resolved='predef::Tools.Hilfe.Evaluator.add_input_line.s'>s</ref> is + ".", in which case it calls state->flush(). Otherwise + just calls add_buffer. + </text></doc> + <method name='add_input_line'> + <arguments><argument name='s'><type><string/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='add_writer' homogen-type='method'><doc><text>Adds another output function. + </text></doc> + <method name='add_writer'> + <arguments><argument name='new'><type><or><object resolved='predef::Tools.Hilfe.Evaluator.add_writer'/><function><argtype><string/></argtype><returntype><int><min>0</min><max/></int></returntype></function></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='assembler_debug_level' homogen-type='variable'><doc><text>The current assembler debug level. + Only available if Pike is compiled with RTL debug. + </text></doc> + <variable name='assembler_debug_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='commands' homogen-type='variable'><doc><text>This mapping contains the available Hilfe commands, including the + built in ones (dump, exit, help, new, quit), so it is possible to + replace or remove them. The name of a command should be 10 + characters or less. + </text></doc> + <variable name='commands'><type><mapping><indextype><string/></indextype><valuetype><object resolved='predef::Tools.Hilfe.Command'>Command</object></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='compiler_trace_level' homogen-type='variable'><doc><text>The current compiler trace level. + Only available if Pike is compiled with RTL debug. + </text></doc> + <variable name='compiler_trace_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='constants' homogen-type='variable'><doc><text>The locally defined constants (name:value). + </text></doc> + <variable name='constants'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='debug_level' homogen-type='variable'><doc><text>The current debug level. + Only available if Pike is compiled with RTL debug. + </text></doc> + <variable name='debug_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='evaluate' homogen-type='method'><doc><text>Compiles the Pike code <ref resolved='predef::Tools.Hilfe.Evaluator.evaluate.a'>a</ref> and evaluates it by + calling ___HilfeWrapper in the generated object. + If <ref resolved='predef::Tools.Hilfe.Evaluator.evaluate.show_result'>show_result</ref> is set the result will be displayed + and the result buffer updated with its value. + </text></doc> + <method name='evaluate'> + <arguments><argument name='a'><type><string/></type></argument><argument name='show_result'><type><int><min>0</min><max>1</max></int></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='functions' homogen-type='variable'><doc><text>The locally defined functions (name:value). + </text></doc> + <variable name='functions'><type><mapping><indextype><string/></indextype><valuetype><function/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='hilfe_compile' homogen-type='method'><doc><text>Creates a wrapper and compiles the pike code <ref resolved='predef::Tools.Hilfe.Evaluator.hilfe_compile.f'>f</ref> in it. + If a new variable is compiled to be tested, its name + should be given in <ref resolved='predef::Tools.Hilfe.Evaluator.hilfe_compile.new_var'>new_var</ref> so that magically defined + entities can be undefined and a warning printed. + </text></doc> + <method name='hilfe_compile'> + <arguments><argument name='f'><type><string/></type></argument><argument name='new_var'><type><or><void/><string/></or></type></argument></arguments> + <returntype><object resolved='predef::Tools.Hilfe.Evaluator.hilfe_compile'/></returntype> + </method> + </docgroup> + <docgroup homogen-name='history' homogen-type='variable'><doc><text>The current result history. + </text></doc> + <variable name='history'><type><object resolved='predef::Tools.Hilfe.HilfeHistory'>HilfeHistory</object></type></variable> + </docgroup> + <docgroup homogen-name='imports' homogen-type='variable'><doc><text>The current imports. + </text></doc> + <variable name='imports'><type><array><valuetype><string/></valuetype></array></type></variable> + </docgroup> + <docgroup homogen-name='inherits' homogen-type='variable'><doc><text>The current inherits. + </text></doc> + <variable name='inherits'><type><array><valuetype><string/></valuetype></array></type></variable> + </docgroup> + <docgroup homogen-name='last_compile_time' homogen-type='variable'><doc><text>The last compile time; + </text></doc> + <variable name='last_compile_time'><type><int><min>0</min><max/></int></type></variable> + </docgroup> + <docgroup homogen-name='last_compiled_expr' homogen-type='variable'><doc><text>The last created wrapper in which an expression was evaluated. + </text></doc> + <variable name='last_compiled_expr'><type><string/></type></variable> + </docgroup> + <docgroup homogen-name='last_else' homogen-type='variable'><doc><text>Should an else expression be carried out? + </text></doc> + <variable name='last_else'><type><int><min>0</min><max>1</max></int></type></variable> + </docgroup> + <docgroup homogen-name='last_eval_time' homogen-type='variable'><doc><text>The last evaluation time; + </text></doc> + <variable name='last_eval_time'><type><int><min>0</min><max/></int></type></variable> + </docgroup> + <docgroup homogen-name='parse_expression' homogen-type='method'><doc><text>Parses a Pike expression. Returns 0 if everything went well, + or a string with an error message otherwise. + </text></doc> + <method name='parse_expression'> + <arguments><argument name='expr'><type><object resolved='predef::Tools.Hilfe.Expression'>Expression</object></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='print_version' homogen-type='method'><doc><text>Displays the current version of Hilfe. + </text></doc> + <method name='print_version'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='programs' homogen-type='variable'><doc><text>The locally defined programs (name:value). + </text></doc> + <variable name='programs'><type><mapping><indextype><string/></indextype><valuetype><program/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='remove_input_hook' homogen-type='method'><doc><text>Removes a function from the input hook. + </text><group><seealso/><text><ref resolved='predef::Tools.Hilfe.Evaluator.add_input_hook'>add_input_hook</ref> + </text></group></doc> + <method name='remove_input_hook'> + <arguments><argument name='old'><type><or><function/><object resolved='predef::Tools.Hilfe.Evaluator.remove_input_hook'/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='remove_writer' homogen-type='method'><doc><text>Removes an output function. + </text></doc> + <method name='remove_writer'> + <arguments><argument name='old'><type><or><object resolved='predef::Tools.Hilfe.Evaluator.remove_writer'/><function/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='reset_evaluator' homogen-type='method'><doc><text>Clears the current state, history and removes all locally + defined variables, constants, functions and programs. Removes + all imports and inherits. It does not reset the command mapping + nor reevaluate the .hilferc file. + </text></doc> + <method name='reset_evaluator'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='reswrite' homogen-type='variable'><doc><text>The function used to write results. + Gets as arguments in order: The safe_write function + (function(string, mixed ...:int), the result as a string (string), + the history entry number (int), the result (mixed), the compilation + time (int) and the evaulation time (int). If the evaluated expression + didn't return anything (e.g. a for loop) then 0 will be given as the + result string. + </text></doc> + <variable name='reswrite'><type><function/></type></variable> + </docgroup> + <docgroup homogen-name='safe_write' homogen-type='method'><doc><text>An output method that shouldn't crash. + </text></doc> + <method name='safe_write'> + <arguments><argument name='in'><type><or><array><valuetype><string/></valuetype></array><string/></or></type></argument><argument name='args'><type><varargs><mixed/></varargs></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='state' homogen-type='variable'><doc><text>Keeps the state, e.g. multiline input in process etc. + </text></doc> + <variable name='state'><type><object resolved='predef::Tools.Hilfe.ParserState'>ParserState</object></type></variable> + </docgroup> + <docgroup homogen-name='std_reswrite' homogen-type='method'><doc><text>The standard <ref resolved='predef::Tools.Hilfe.Evaluator.reswrite'>reswrite</ref> function. + </text></doc> + <method name='std_reswrite'> + <arguments><argument name='w'><type><function/></type></argument><argument name='sres'><type><string/></type></argument><argument name='num'><type><int/></type></argument><argument name='res'><type><mixed/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='strict_types' homogen-type='variable'><doc><text>Strict types? + </text></doc> + <variable name='strict_types'><type><int><min>0</min><max>1</max></int></type></variable> + </docgroup> + <docgroup homogen-name='trace_level' homogen-type='variable'><doc><text>The current trace level. + </text></doc> + <variable name='trace_level'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='types' homogen-type='variable'><doc><text>The types of the locally defined variables (name:type). + </text></doc> + <variable name='types'><type><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='variables' homogen-type='variable'><doc><text>The locally defined variables (name:value). + </text></doc> + <variable name='variables'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></variable> + </docgroup> + <docgroup homogen-name='warnings' homogen-type='variable'><doc><text>Show warnings? + </text></doc> + <variable name='warnings'><type><int><min>0</min><max>1</max></int></type></variable> + </docgroup> + <docgroup homogen-name='write' homogen-type='variable'><doc><text>The function to use when writing to the user. + </text></doc> + <variable name='write'><type><or><array/><object resolved='predef::Tools.Hilfe.Evaluator'/><function><argtype><string/></argtype><returntype><int><min>0</min><max/></int></returntype></function></or></type></variable> + </docgroup> + <class name='HilfeCompileHandler'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='stack_level'><type><int/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='stack_level' homogen-type='variable'> + <variable name='stack_level'><type><int/></type></variable> + </docgroup> + </class> + </class> + <class name='Expression'> + <doc><text>Represents a Pike expression + </text></doc> + <docgroup homogen-name='_sizeof' homogen-type='method'><doc><text>The number of non-whitespace tokens in the expression. + </text></doc> + <method name='_sizeof'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='`[]' homogen-type='method'><doc><text>Returns a token or a token range without whitespaces. + </text></doc> + <method name='`[]'> + <arguments><argument name='f'><type><int/></type></argument><argument name='t'><type><or><void/><int/></or></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='`[]=' homogen-type='method'><doc><text>Replaces a token with a new token. + </text></doc> + <method name='`[]='> + <arguments><argument name='f'><type><int/></type></argument><argument name='v'><type><string/></type></argument></arguments> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='cast' homogen-type='method'><doc><text>An Expression object can be cast to an array or a string. In + both forms all tokens, including white spaces will be returned. + </text></doc> + <method name='cast'><modifiers><protected/></modifiers> + <arguments><argument name='to'><type><string/></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup> + <docgroup homogen-name='check_modifiers' homogen-type='method'><doc><text>See if there are any forbidden modifiers used in the expression, + e.g. "private int x;" is not valid inside Hilfe. + </text><group><returns/><text>Returns an error message as a string if the expression + contains a forbidden modifier, otherwise <expr>0</expr>. + </text></group></doc> + <method name='check_modifiers'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='code' homogen-type='method'><doc><text>Returns the expression verbatim. + </text></doc> + <method name='code'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='t'/><text>An array of Pike tokens. + </text></group></doc> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='t'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='depth' homogen-type='method'><doc><text>Return the parenthesis depth at the given position. + </text></doc> + <method name='depth'> + <arguments><argument name='f'><type><int/></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='endoftype' homogen-type='method'><doc><text>Returns at which position the type declaration that begins at + position <ref resolved='predef::Tools.Hilfe.Expression.endoftype.position'>position</ref> ends. A return value of -1 means that the + token or tokens from <ref resolved='predef::Tools.Hilfe.Expression.endoftype.position'>position</ref> can not be a type declaration. + </text></doc> + <method name='endoftype'> + <arguments><argument name='position'><type><int><min>-1</min><max/></int></type></argument></arguments> + <returntype><int><min>-1</min><max/></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='find_matching' homogen-type='method'><doc><text>Returns the position of the matching parenthesis of the given + kind, starting from the given position. The position should be + the position after the opening parenthesis, or later. Assuming + balanced code. Returns -1 on failure. + </text></doc> + <method name='find_matching'> + <arguments><argument name='token'><type><string/></type></argument><argument name='pos'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments> + <returntype><int><min>-1</min><max/></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='in_sscanf' homogen-type='method'><doc><text>Returns 1 if the current position is within a sscanf expression. + </text></doc> + <method name='in_sscanf'> + <arguments><argument name='f'><type><int/></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='is_block' homogen-type='method'><doc><text>Is there a block starting at <ref resolved='predef::Tools.Hilfe.Expression.is_block.pos'>pos</ref>? + </text></doc> + <method name='is_block'> + <arguments><argument name='pos'><type><int/></type></argument></arguments> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + </class> + <class name='GenericAsyncHilfe'> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='infile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument><argument name='outfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-type='variable'> + <variable name='infile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></variable> + <variable name='outfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></variable> + </docgroup> + <docgroup homogen-name='Evaluator' homogen-type='inherit'> + <inherit name='Evaluator'><classname resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</classname></inherit> + </docgroup> + </class> + <class name='GenericHilfe'> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='in'><type><object resolved='predef::Stdio.FILE'>Stdio.FILE</object></type></argument><argument name='out'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='Evaluator' homogen-type='inherit'> + <inherit name='Evaluator'><classname resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</classname></inherit> + </docgroup> + </class> + <class name='HilfeHistory'> + <modifiers><protected/></modifiers> + <doc><text>In every Hilfe object (<ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref>) there is a HilfeHistory + object that manages the result history. That history object is + accessible both from __ and ___Hilfe->history in Hilfe expressions. + </text></doc> + <docgroup homogen-name='History' homogen-type='inherit'> + <inherit name='History'><classname resolved='predef::ADT.History'>ADT.History</classname></inherit> + </docgroup> + </class> + <class name='ParserState'> + <modifiers><protected/></modifiers> + <doc><text>In every Hilfe object (<ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref>) there is a ParserState object + that manages the current state of the parser. Essentially tokens are + entered in one end and complete expressions are outputted in the other. + The parser object is accessible as ___Hilfe->state from Hilfe expressions. + </text></doc> + <docgroup homogen-name='datap' homogen-type='method'><doc><text>Returns true if there is any waiting expression that can be fetched + with <ref resolved='predef::Tools.Hilfe.ParserState.read'>read</ref>. + </text></doc> + <method name='datap'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='feed' homogen-type='method'><doc><text>Feed more tokens into the state. + </text></doc> + <method name='feed'> + <arguments><argument name='tokens'><type><array><valuetype><string/></valuetype></array></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='finishedp' homogen-type='method'><doc><text>Are we in the middle of an expression. Used e.g. for changing the + Hilfe prompt when entering multiline expressions. + </text></doc> + <method name='finishedp'> + <arguments/> + <returntype><int><min>0</min><max>1</max></int></returntype> + </method> + </docgroup> + <docgroup homogen-name='flush' homogen-type='method'><doc><text>Clear the current state. + </text></doc> + <method name='flush'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='push_string' homogen-type='method'><doc><text>Sends the input <ref resolved='predef::Tools.Hilfe.ParserState.push_string.line'>line</ref> to <ref resolved='predef::Parser.Pike'>Parser.Pike</ref> for tokenization, + but keeps a state between each call to handle multiline + /**/ comments and multiline #"" strings. + </text></doc> + <method name='push_string'> + <arguments><argument name='line'><type><string/></type></argument></arguments> + <returntype><array><valuetype><string/></valuetype></array></returntype> + </method> + </docgroup> + <docgroup homogen-name='read' homogen-type='method'><doc><text>Read out completed expressions. Returns an array where every element + is an expression represented as an array of tokens. + </text></doc> + <method name='read'> + <arguments/> + <returntype><array><valuetype><object resolved='predef::Tools.Hilfe.Expression'>Expression</object></valuetype></array></returntype> + </method> + </docgroup> + <docgroup homogen-name='show_error' homogen-type='method'><doc><text>Prints out any error that might have occurred while + <ref resolved='predef::Tools.Hilfe.ParserState.push_string'>push_string</ref> was executed. The error will be + printed with the print function <ref resolved='predef::Tools.Hilfe.ParserState.show_error.w'>w</ref>. + </text></doc> + <method name='show_error'> + <arguments><argument name='w'><type><function><argtype><or><array><valuetype><string/></valuetype></array><string/></or></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><int/></returntype></function></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='status' homogen-type='method'><doc><text>Returns the current parser state. Used by "dump state". + </text></doc> + <method name='status'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + </class> + <class name='StdinHilfe'> + <doc><text>This is a wrapper containing a user interface to the Hilfe <ref resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</ref> + so that it can actually be used. This wrapper uses the <ref resolved='predef::Stdio.Readline'>Stdio.Readline</ref> + module to interface with the user. All input history is handled by + that module, and as a consequence loading and saving .hilfe_history is + handled in this class. Also .hilferc is handled by this class. + </text></doc> + <docgroup homogen-name='create' homogen-type='method'><doc><text>Any hilfe statements given in the init array will be executed + once .hilferc has been executed. + </text></doc> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='init'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='Evaluator' homogen-type='inherit'> + <inherit name='Evaluator'><classname resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</classname></inherit> + </docgroup> + <docgroup homogen-name='readline' homogen-type='variable'><doc><text>The readline object, + </text></doc> + <variable name='readline'><type><object resolved='predef::Stdio.Readline'>Stdio.Readline</object></type></variable> + </docgroup> + <docgroup homogen-name='save_history' homogen-type='method'><doc><text>Saves the user input history, if possible, when called. + </text></doc> + <method name='save_history'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + </class> + <class name='SubSysLogger'> + <modifiers><protected/></modifiers> + <class name='Logger'> + <modifiers><protected/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='e'><type><object resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</object></type></argument><argument name='logfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-type='variable'> + <variable name='e'><type><object resolved='predef::Tools.Hilfe.Evaluator'>Evaluator</object></type></variable> + <variable name='logfile'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></variable> + </docgroup> + </class> + </class> + </module> <module name='Install'> <doc><text>Common routines which are useful for various install scripts based on Pike. </text></doc> <docgroup homogen-name='features' homogen-type='method'><doc><text>Return an array of enabled features. </text><group><note/><text>Used by the <ref resolved='predef::master'>master</ref> when given the option <tt>--features</tt>. </text></group><group><seealso/><text><ref>Tools.Standalone.features</ref> </text></group></doc> <method name='features'> <arguments/> <returntype><array><valuetype><string/></valuetype></array></returntype>
autodoc.git/onepage.xml:144586: <docgroup homogen-name='default_domain' homogen-type='method'><doc><text>Returns the default yp-domain. </text></doc> <method name='default_domain'> <arguments/> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> - <docgroup homogen-name='"___Yp"' homogen-type='inherit'> - <inherit name='"___Yp"'><classname>"___Yp"</classname></inherit> + <docgroup homogen-name='"___Yp"' homogen-type='inherit'> + <inherit name='"___Yp"'><classname>"___Yp"</classname></inherit> </docgroup> <class name='Domain'> <docgroup homogen-name='all' homogen-type='method'><doc><text>Returns the whole map as a mapping. <ref resolved='predef::Yp.Domain.all.map'>map</ref> is the YP-map to search in. This must be the full map name, you have to use <tt>passwd.byname</tt> instead of just <tt>passwd</tt>. </text></doc> <method name='all'> <arguments><argument name='map'><type><string/></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping></returntype> </method>
autodoc.git/onepage.xml:144861: <docgroup homogen-name='Session' homogen-type='inherit'> <inherit name='Session'><classname>Configuration::Session</classname></inherit> </docgroup> <docgroup homogen-name='session_id' homogen-type='variable'><doc><text>Session id (if any). </text></doc> <variable name='session_id'><type><string><min>0</min><max>255</max></string></type></variable> </docgroup> </class> </class> </module> + <module name='_Charset'> + <doc><text>Low-level tables and code for the <ref resolved='predef::Charset'>Charset</ref> module. + This is probably not the module you want; try the <ref resolved='predef::Charset'>Charset</ref> module. + </text><group><seealso/><text><ref resolved='predef::Charset'>Charset</ref> + </text></group></doc> + <docgroup homogen-name='rfc1345' homogen-type='method'><doc><text>Low-level charset codec factory. + </text><group><param name='charset'/><text>Canonical name of character set to look up. + </text></group><group><param name='encoder'/><text>Flag indicating that an encoder and not a decoder is wanted. + </text></group><group><param name='rep'/><text>String to use for characters not representable in the <ref resolved='predef::_Charset.rfc1345.charset'>charset</ref>. + Only used for encoders. + </text></group><group><param name='repcb'/><text>Function to call for characters not representable in the <ref resolved='predef::_Charset.rfc1345.charset'>charset</ref>. + Only used for encoders. + This is the main entrypoint into the low-level <ref resolved='predef::_Charset'>_Charset</ref> module. + </text></group><group><returns/><text>Returns a suitable encoder or decoder on success and <expr>0</expr> + (zero) on failure. + </text></group><group><seealso/><text><ref resolved='predef::Charset.encoder'>Charset.encoder()</ref>, <ref resolved='predef::Charset.decoder'>Charset.decoder()</ref> + </text></group></doc> + <method name='rfc1345'> + <arguments><argument name='charset'><type><string/></type></argument><argument name='encoder'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument><argument name='rep'><type><or><string/><void/></or></type></argument><argument name='repcb'><type><or><function><argtype><string/></argtype><returntype><string/></returntype></function><void/></or></type></argument></arguments> + <returntype><object resolved='predef::_Charset.rfc1345'/></returntype> + </method> + </docgroup> + </module> <module name='_Ffmpeg'> <docgroup homogen-type='constant'><doc><text>Various audio and video codecs. </text><group><note/><text>The list of supported codecs depends on Ffmpeg library. </text></group></doc> <constant name='CODEC_ID_NONE'/> <constant name='CODEC_ID_AC3'/> <constant name='CODEC_ID_ADPCM_IMA_QT'/> <constant name='CODEC_ID_ADPCM_IMA_WAV'/> <constant name='CODEC_ID_ADPCM_MS'/> <constant name='CODEC_ID_H263'/>

autodoc.git / onepage.xml