The Falcon Programming Language Library Reference

The Falcon Programming Language Library Reference

This guide contains the reference to the standard library (core module and feathers modules), the reference to the standard extensions (the other modules) as well as some general advices an information about the Falcon language functions, object and classes.

This guide doesn't contain a Language reference nor tutorials related to the Falcon language in general.

Table of contents

• 1The core module
  • 1.1About the garbage collector.
  • 1.2Basic Object Model - Generic item reflection classes
    • 1.2.1Class Array - MetaClass for Falcon arrays.
    • 1.2.2Class BOM - Basic Object Model metaclass
    • 1.2.3Class Class - Metaclass of Class items.
    • 1.2.4Class ClassMethod - Metaclass of ClassMethod items.
    • 1.2.5Class Dictionary - Metaclass for Falcon dictionary types.
    • 1.2.6Class Function - Metaclass for Falcon function type.
    • 1.2.7Class GarbagePointer - Metaclass for internal and application-wide garbage sensible data.
    • 1.2.8Class Integer - Integer type basic object model metaclass.
    • 1.2.9Class LateBinding - Metaclass for LateBinding type.
    • 1.2.10Class MemoryBuffer - Metaclass for MemBuf items.
    • 1.2.11Class Method - Metaclass of method items.
    • 1.2.12Class Numeric - Generic number type basic object model metaclass.
    • 1.2.13Class Object - Object (class instance) type basic object model metaclass.
    • 1.2.14Class Range - Metaclass for Falcon range type.
    • 1.2.15Class String - Metaclass for string items.
  • 1.3Directory functions - Directory and file names functions.
    • 1.3.1Class Directory - Special iterator to access directory listings.
    • 1.3.2Class FileStat - Class holding informations on system files.
  • 1.4System Support - Function and classes supporting OS and environment.
    • 1.4.1Class Stream - Stream oriented I/O class.
  • 1.5Coroutine support
  • 1.6The Falcon Error System. - Falcon classes reflecting internal errors.
    • 1.6.1Class AccessError - Error accessing an indexed item.
    • 1.6.2Class CloneError - Item cannot be cloned.
    • 1.6.3Class CodeError - VM and internal coded related error descriptor.
    • 1.6.4Class Error - Internal VM and runtime error reflection class.
    • 1.6.5Class GenericError - Generic undefined failure.
    • 1.6.6Class InterruptedError - Wait operation interrupted.
    • 1.6.7Class IoError - Error on I/O operations.
    • 1.6.8Class MathError - Mathematical calculation error.
    • 1.6.9Class MessageError - Error in the messaging system.
    • 1.6.10Class ParamError - Incongruent paremeter error.
    • 1.6.11Class ParseError - Generic input parsing error.
    • 1.6.12Class SyntaxError - Syntax error descriptor.
    • 1.6.13Class TableError - Error in Table class core operations.
    • 1.6.14Class TypeError - Type mismatch in a typed operation.
  • 1.7General purpose - Generic language and type oriented functions.
    • 1.7.1Class Format - Controls the rendering of items into strings.
    • 1.7.2Class Iterator - Indirect pointer to sequences.
  • 1.8Raw memory manipulation functions. - DANGEROUS group of functions and methods manipulating memory.
  • 1.9Message oriented model - Functions and classes supporting Message Oriented Programming (MOP)
    • 1.9.1Class VMSlot - VM Interface for message oriented programming operations.
  • 1.10Array support - Array related functions.
  • 1.11Basic I/O - Functions providing basic interface.
  • 1.12Dictionary support - Dictionary related functions.
  • 1.13Environment support - Functions used to access the process environment variables.
  • 1.14Math functions. - Functions providing math support to Falcon.
  • 1.15Random functions - Functions providing random numbers and sequences.
  • 1.16Serialization functions - Function used to store items persistently.
  • 1.17Stream factory functions - Function creating or opening file and system streams.
  • 1.18String functions - Functions manipulating strings
  • 1.19Transcoding functions - Functions needed to transcode texts into various character sets.
  • 1.20Functional programming support - ETA functions and functional constructs.
  • 1.21Type mangling - Functions managing item conversions, type detection, item structure management and generically manipulating Falcon items.
  • 1.22Out of band items support - Handle out of band items.
  • 1.23Message oriented model functions - Functions supporting Message Oriented Programming (MOP)
  • 1.24Variable parameters support - Functions giving informations on variable parameters.
  • 1.25Virtual Machine Informations - Generic informations on the Virtual Machine.
  • 1.26Object GC - Support for script-based garbage collection strategies.
  • 1.27Class Base64 - Collection of methods to handle rfc3548 Base64 encoding.
  • 1.28Class CmdlineParser - Provides simple and powerful parsing of the command line options.
  • 1.29Class Continuation - Intra-context suspension and resume control device.
  • 1.30Class List - Fast growable double linked list.
  • 1.31Class Path - Interface to local filesystem path definition.
  • 1.32Class Sequence - Base abstract class for VM assisted sequences.
  • 1.33Class Set - Storage for uniquely defined items (and ordering criterion).
  • 1.34Class StringStream - Memory based stream.
  • 1.35Class Table - Home of tabular programming.
  • 1.36Class TimeStamp - Representation of times in the system.
  • 1.37Class TimeZone - TimeZone enumeration and services.
  • 1.38Class Tokenizer - Simple stream-oriented parser for efficient basic recognition of incoming data.
  • 1.39Class URI - Interface to RFC3986 Universal Resource Indicator.
  • 1.40Functions
• 2The Feather Modules
  • 2.1bufext
    • 2.1.1Memory Buffers - Easy memory management
      • 2.1.1.1Class BitBuf - Flexible memory buffer optimized for bit-precise binary mangling
      • 2.1.1.2Class ByteBuf - Flexible memory buffer optimized for binary mangling
      • 2.1.1.3Class ByteBufBigEndian - A specialized ByteBuf that stores data in big endian.
      • 2.1.1.4Class ByteBufLittleEndian - A specialized ByteBuf that stores data in little endian.
      • 2.1.1.5Class ByteBufNativeEndian - A specialized ByteBuf that stores data in native endian.
      • 2.1.1.6Class ByteBufReverseEndian - A specialized ByteBuf that stores data in reversed endian.
    • 2.1.2Class BufferError - Error generated by buffer I/O related failures.
  • 2.2Reflexive compiler
    • 2.2.1Class Compiler - Main interface to the reflexive compiler.
    • 2.2.2Class ICompiler - Interaface to incremental evaluator.
    • 2.2.3Class Module - Handle to loaded modules.
    • 2.2.4Class _BaseCompiler - Abstract base class for the Compiler and ICompiler classes.
  • 2.3Configuration file parser
    • 2.3.1Class ConfParser - Interface to configuration files.
  • 2.4Functional extensions
    • 2.4.1Functions
  • 2.5Hashing algorighms
    • 2.5.1Checksums - Classes providing checksum functions
      • 2.5.1.1Class Adler32 - Calculates a 32 bits long Adler32 checksum
      • 2.5.1.2Class CRC32 - Calculates a 32 bits long CRC32 checksum
    • 2.5.2Strong hashes - Classes providing strong hashes, suitable for cryptography
      • 2.5.2.1Class RIPEMD160Hash - Calculates a 160 bits long RIPEMD-160 hash (RIPEMD family)
      • 2.5.2.2Class RIPEMD256Hash - Calculates a 256 bits long RIPEMD-256 hash (RIPEMD family)
      • 2.5.2.3Class RIPEMD320Hash - Calculates a 320 bits long RIPEMD-320 hash (RIPEMD family)
      • 2.5.2.4Class SHA224Hash - Calculates a 224 bits long SHA-224 hash (SHA-2 family)
      • 2.5.2.5Class SHA256Hash - Calculates a 256 bits long SHA-256 hash (SHA-2 family)
      • 2.5.2.6Class SHA384Hash - Calculates a 384 bits long SHA-384 hash (SHA-2 family)
      • 2.5.2.7Class SHA512Hash - Calculates a 512 bits long SHA-512 hash (SHA-2 family)
      • 2.5.2.8Class TigerHash - Calculates a 192 bits long Tiger hash
      • 2.5.2.9Class WhirlpoolHash - Calculates a 512 bits long Whirlpool hash
    • 2.5.3Weak hashes - Classes providing weak / deprecated hashes
      • 2.5.3.1Class MD2Hash - Calculates a 128 bits long MD2 (Message Digest 2) hash
      • 2.5.3.2Class MD4Hash - Calculates a 128 bits long MD4 (Message Digest 4) hash
      • 2.5.3.3Class MD5Hash - Calculates a 128 bits long MD5 (Message Digest 5) hash
      • 2.5.3.4Class RIPEMD128Hash - Calculates a 128 bits long RIPEMD-128 hash (RIPEMD family)
      • 2.5.3.5Class SHA1Hash - Calculates a 160 bits long SHA-1 hash
    • 2.5.4Class HashBase - Base class for each hash algorithm, specialized for overloading.
    • 2.5.5Functions
  • 2.6JSON support
    • 2.6.1Class JSONError - Error generated after error conditions on JSON operations.
    • 2.6.2Functions
  • 2.7Logging facility
    • 2.7.1Object GeneralLog - General logging area.
    • 2.7.2Class LogArea - Collection of log channels.
    • 2.7.3Class LogChannel - Abstract class receiving log requests from log areas.
    • 2.7.4Class LogChannelFiles - Log channel sending logs to a set of (possibly) rotating local files.
    • 2.7.5Class LogChannelStream - Logs on an open stream.
    • 2.7.6Class LogChannelSyslog - Logs on the local system logger facility.
    • 2.7.7Functions
  • 2.8Uncommon math functions
    • 2.8.1Functions
  • 2.9Minimal XML support.
    • 2.9.1Class MXMLDocument - Encapsulates a complete XML document.
    • 2.9.2Class MXMLError - Error raised by the MXML module in case of problems.
    • 2.9.3Class MXMLNode - Minimal entity of the XML document.
    • 2.9.4Enum MXMLErrorCode - Enumeartion listing the possible numeric error codes raised by MXML.
    • 2.9.5Enum MXMLStyle - Document serialization options.
    • 2.9.6Enum MXMLType - Node types.
  • 2.10External process interface
    • 2.10.1Class Process - Execute and control child processes.
    • 2.10.2Class ProcessEnum - Provides a list of currently executed process.
    • 2.10.3Class ProcessError - Error generated by process related system failures.
    • 2.10.4Functions
  • 2.11Regular Expression
    • 2.11.1Class Regex - Regular expression binding encapsulation.
    • 2.11.2Class RegexError - Error generated by regular expression compilation and execution errors.
  • 2.12Low level IP networking.
    • 2.12.1Class NetError - Error generated by network related system failures.
    • 2.12.2Class Socket - TCP/IP networking base class.
    • 2.12.3Class TCPServer - Encapsulates a TCP network service provider.
    • 2.12.4Class TCPSocket - Provides full TCP connectivity.
    • 2.12.5Class UDPSocket - UDP (datagram) manager.
    • 2.12.6Functions
    • 2.12.7Enum NetErrorCode - Network failure error categories.
  • 2.13Multithreading
    • 2.13.1Falcon multithreading model.
    • 2.13.2Multithreading safety
    • 2.13.3Threading module and VM Interruption protocol
    • 2.13.4Waitings - Wating functions and methods.
    • 2.13.5Class Barrier - Gate controlling the transit of threads for certain operations.
    • 2.13.6Class Event - Signaler of relevant processing conditions.
    • 2.13.7Class Grant - Grant for exclusive access to shared resources.
    • 2.13.8Class JoinError - Error generated when trying to wait for a unwaitable thread.
    • 2.13.9Class SyncCounter - Implements a synchronization counter (semaphore).
    • 2.13.10Class SyncQueue - Signaler of relevant processing conditions.
    • 2.13.11Class Thread - Parallel agent main class.
    • 2.13.12Class ThreadError - Error generated by thread related problems.
    • 2.13.13Class Threading - Access to static method that can be used to access threading functionalities.
    • 2.13.14Class Waitable - Base abstract class for synchronization Structures.
  • 2.14ZLib basic binding.
    • 2.14.1Class ZLib - ZLib encapsulation interface.
    • 2.14.2Class ZLibError - Error generated by errors in the ZLib module.
    • 2.14.3Enum ZLibErrorCode - Error codes generated by ZLib methods.
• 3Falcon Database Interface.
  • 3.1Class DBIError - DBI specific error.
  • 3.2Class Handle - DBI connection handle returned by connect.
  • 3.3Class Recordset - Data retuned by SQL queries.
  • 3.4Class Statement - Prepared statements abstraction class
  • 3.5Functions
  • 3.6Firebird Database driver module
    • 3.6.1Class Firebird - Direct interface to Firebird database.
  • 3.7MySQL driver module
    • 3.7.1Class MySQL - Direct interface to MySQL database.
  • 3.8ODBC driver module.
    • 3.8.1Class ODBC - Interface to ODBC connections.
  • 3.9Postgre SQL database driver module
    • 3.9.1Class PgSQL - Direct interface to Postgre SQL database.
  • 3.10Sqlite driver module
    • 3.10.1Class SQLite3 - Direct interface to SQLite3 database.
• 4Falcon Virtual Machine Preemptibility
• 5Web Oriented Programming Interface
  • 5.1Isomorphism of CGI based sites.
  • 5.2CGI stand-alone front-end
  • 5.3CGI falcon module
  • 5.4Micro Falcon-based web server
  • 5.5FastCGI stand-alone front-end
  • 5.6Apache 2 web server module.
  • 5.7Web Oriented Programming Interface model
  • 5.8Building modular applications
  • 5.9Object Reply - Reflects the reply that this script has sent (or will send).
  • 5.10Object Request - Main web server interface object.
  • 5.11Object Wopi - General framework data and functions
  • 5.12Class Uploaded - Entity storing uploaded file data.
  • 5.13Class WopiError - Error generated by wopi in case of failures.
  • 5.14Functions
  • 5.15Variables
• 6conbox
  • 6.1Class ConioError - Error generated because of problems on the console I/O.
  • 6.2Functions
• 7cURL Http/Ftp library binding.
  • 7.1Class CurlError - Error generated by cURL while operating.
  • 7.2Class Handle - Stores an handle for a CURL (easy) connection.
  • 7.3Class Multi - Interface to CURL multi_* operations.
  • 7.4Functions
• 8dbus
  • 8.1Class DBus - Opens the connection to the DBUS system.
  • 8.2Class DBusError - DBus specific error.
  • 8.3Class DBusMessage - Handle dbus messages
  • 8.4Class DBusPendingCall - Handle for currently open method calls.
• 9DataMatrix module
  • 9.1Class DataMatrix - DataMatrix codec
  • 9.2Class DataMatrixError - Error generated DataMatrix operations.
  • 9.3Module dmtx.dmtx_test
    • 9.3.1Object Drawer
• 10dynlib
  • 10.1Structure Support - Functions used to manipulate C structures directly.
  • 10.2Class DynFunction - Internal representation of dynamically loaded functions.
  • 10.3Class DynLib - Creates a reference to a dynamic library.
  • 10.4Class DynLibError - DynLib specific error.
  • 10.5Class DynOpaque - Opaque remote data "pseudo-class" encapsulator.
  • 10.6Functions
• 11The Falcon GTK Binding module
  • 11.1Class GObject - The base object type
  • 11.2Class GParamSpec - Metadata for parameter specifications
  • 11.3Class GdkBitmap - An opaque structure representing an offscreen drawable of depth 1.
  • 11.4Class GdkColor - The GdkColor structure is used to describe an allocated or unallocated color.
  • 11.5Class GdkColormap - The GdkColormap structure is used to describe an allocated or unallocated color.
  • 11.6Class GdkCursor - Standard and pixmap cursors
  • 11.7Class GdkDisplay - An opaque structure representing an offscreen drawable of depth 1.
  • 11.8Class GdkDragContext - A GdkDragContext holds information about a drag in progress.
  • 11.9Class GdkDrawable - Functions for drawing points, lines, arcs, and text
  • 11.10Class GdkEvent - Functions for handling events from the window system
  • 11.11Class GdkEventButton - Used for button press and button release events.
  • 11.12Class GdkGC - Objects to encapsulate drawing properties
  • 11.13Class GdkGCValues - The GdkGCValues structure holds a set of values used to create or modify a graphics context.
  • 11.14Class GdkGeometry - The GdkGeometry struct gives the window manager information about a window's geometry constraints.
  • 11.15Class GdkPixbuf - Information that describes an image.
  • 11.16Class GdkPixmap - Offscreen drawables.
  • 11.17Class GdkPoint - Defines the x and y coordinates of a point.
  • 11.18Class GdkRectangle - GdkRectangle is a structure holding the position and size of a rectangle.
  • 11.19Class GdkRegion - A GdkRegion represents a set of pixels on the screen.
  • 11.20Class GdkScreen - Object representing a physical screen
  • 11.21Class GdkVisual - Low-level display hardware information
  • 11.22Class GdkWindow - Onscreen display areas in the target window system
  • 11.23Class GtkAboutDialog - Display information about an application
  • 11.24Class GtkAction - An action which can be triggered by a menu or toolbar item
  • 11.25Class GtkActivatable - An interface for activatable widgets
  • 11.26Class GtkAdjustment - A GtkObject representing an adjustable bounded value
  • 11.27Class GtkAlignment - A widget which controls the alignment and size of its child
  • 11.28Class GtkArrow - Displays an arrow
  • 11.29Class GtkAspectFrame - A frame that constrains its child to a particular aspect ratio
  • 11.30Class GtkBin - The GtkBin widget is a container with just one child.
  • 11.31Class GtkBox - Base class for box containers
  • 11.32Class GtkBuildable - Interface for objects that can be built by GtkBuilder
  • 11.33Class GtkButton - A widget that creates a signal when clicked on
  • 11.34Class GtkButtonBox - Base class for GtkHButtonBox and GtkVButtonBox
  • 11.35Class GtkCellEditable - Interface for widgets which can are used for editing cells
  • 11.36Class GtkCellRenderer - An object for rendering a single cell on a GdkDrawable
  • 11.37Class GtkCellRendererAccel - Renders a keyboard accelerator in a cell
  • 11.38Class GtkCellRendererCombo - Renders a combobox in a cell
  • 11.39Class GtkCellRendererPixbuf - Renders a pixbuf in a cell
  • 11.40Class GtkCellRendererProgress - Renders numbers as progress bars
  • 11.41Class GtkCellRendererSpin - Renders a spin button in a cell
  • 11.42Class GtkCellRendererSpinner - Renders a spinning animation in a cell
  • 11.43Class GtkCellRendererText - Renders text in a cell
  • 11.44Class GtkCellRendererToggle - Renders a toggle button in a cell
  • 11.45Class GtkCheckButton - Create widgets with a discrete toggle button
  • 11.46Class GtkCheckMenuItem - A menu item with a check box
  • 11.47Class GtkColorButton - A button to launch a color selection dialog
  • 11.48Class GtkColorSelectionDialog - A standard dialog box for selecting a color
  • 11.49Class GtkComboBox - A widget used to choose from a list of items
  • 11.50Class GtkComboBoxEntry - A text entry field with a dropdown list
  • 11.51Class GtkContainer - Abstract container class.
  • 11.52Class GtkDialog - Create popup windows
  • 11.53Class GtkEditable - Interface for text-editing widgets
  • 11.54Class GtkEntry - A single line text entry field
  • 11.55Class GtkEntryBuffer - Text buffer for GtkEntry
  • 11.56Class GtkError - Error generated by falcon-gtk
  • 11.57Class GtkEventBox - A widget used to catch events for widgets which do not have their own window
  • 11.58Class GtkExpander - A container which can hide its child
  • 11.59Class GtkFileChooser - File chooser interface used by GtkFileChooserWidget and GtkFileChooserDialog
  • 11.60Class GtkFileChooserButton - A button to launch a file selection dialog
  • 11.61Class GtkFileChooserDialog - A file chooser dialog, suitable for "File/Open" or "File/Save" commands
  • 11.62Class GtkFileFilter - A filter for selecting a file subset
  • 11.63Class GtkFileFilterInfo - A GtkFileFilterInfo struct is used to pass information about the tested file to gtk_file_filter_filter().
  • 11.64Class GtkFixed - A container which allows you to position widgets at fixed coordinates
  • 11.65Class GtkFontButton - A button to launch a font selection dialog.
  • 11.66Class GtkFrame - A bin with a decorative frame and optional label
  • 11.67Class GtkHBox - Horizontal box
  • 11.68Class GtkHButtonBox - Horizontal button box container.
  • 11.69Class GtkHPaned - A container with two panes arranged horizontally
  • 11.70Class GtkHRuler - A horizontal ruler
  • 11.71Class GtkHScale - A horizontal slider widget for selecting a value from a range
  • 11.72Class GtkHScrollbar - A horizontal scrollbar
  • 11.73Class GtkImage - A widget displaying an image
  • 11.74Class GtkImageMenuItem - A menu item with an icon
  • 11.75Class GtkInfoBar - Report important messages to the user
  • 11.76Class GtkInvisible - A widget which is not displayed
  • 11.77Class GtkItem - Abstract base class for GtkItemItem, GtkListItem and GtkTreeItem
  • 11.78Class GtkLabel - The GtkLabel widget displays a small amount of text.
  • 11.79Class GtkLayout - Infinite scrollable area containing child widgets and/or custom drawing
  • 11.80Class GtkLinkButton - Create buttons bound to a URL
  • 11.81Class GtkListStore - A list-like data structure that can be used with the GtkTreeView
  • 11.82Class GtkMain - Initialize gtk and prepare the main loop
  • 11.83Class GtkMenu - A menu widget
  • 11.84Class GtkMenuBar - A subclass widget for GtkMenuShell which holds GtkMenuItem widgets
  • 11.85Class GtkMenuItem - The widget used for item in menus
  • 11.86Class GtkMenuShell - A base class for menu objects.
  • 11.87Class GtkMenuToolButton - A GtkToolItem containing a button with an additional dropdown menu
  • 11.88Class GtkMessageDialog - A convenient message window
  • 11.89Class GtkMisc - Base class for widgets with alignments and padding.
  • 11.90Class GtkObject - The base class of the GTK+ type hierarchy
  • 11.91Class GtkOptionMenu - A widget used to choose from a list of valid choices
  • 11.92Class GtkOrientable - An interface for flippable widgets
  • 11.93Class GtkPaned - Base class for widgets with two adjustable panes
  • 11.94Class GtkProgress - Base class for GtkProgressBar
  • 11.95Class GtkProgressBar - A widget which indicates progress visually
  • 11.96Class GtkRadioAction - An action of which only one in a group can be active
  • 11.97Class GtkRadioButton - A choice from multiple check buttons
  • 11.98Class GtkRadioMenuItem - A choice from multiple check menu items
  • 11.99Class GtkRadioToolButton - A toolbar item that contains a radio button
  • 11.100Class GtkRange - Base class for widgets which visualize an adjustment
  • 11.101Class GtkRecentFilter - A filter for selecting a subset of recently used files
  • 11.102Class GtkRecentFilterInfo - A GtkRecentFilterInfo struct is used to pass information about the tested file to gtk_recent_filter_filter().
  • 11.103Class GtkRequisition - A GtkRequisition represents the desired size of a widget.
  • 11.104Class GtkRuler - Base class for horizontal or vertical rulers
  • 11.105Class GtkScale - Base class for GtkHScale and GtkVScale
  • 11.106Class GtkScaleButton - A button which pops up a scale
  • 11.107Class GtkScrollbar - Base class for GtkHScrollbar and GtkVScrollbar
  • 11.108Class GtkSeparatorMenuItem - A separator used in menus
  • 11.109Class GtkSeparatorToolItem - A toolbar item that separates groups of other toolbar items
  • 11.110Class GtkSpinButton - Retrieve an integer or floating-point number from the user
  • 11.111Class GtkStatusbar - Report messages of minor importance to the user
  • 11.112Class GtkTable - Pack widgets in regular patterns
  • 11.113Class GtkTearoffMenuItem - A menu item used to tear off and reattach its menu
  • 11.114Class GtkTextBuffer - Stores attributed text for display in a GtkTextView
  • 11.115Class GtkTextIter - Text buffer iterator
  • 11.116Class GtkTextMark - A position in the buffer preserved across buffer modifications
  • 11.117Class GtkTextTag - A tag that can be applied to text in a GtkTextBuffer
  • 11.118Class GtkTextTagTable - Collection of tags that can be used together
  • 11.119Class GtkTextView - Widget that displays a GtkTextBuffer
  • 11.120Class GtkToggleAction - An action which can be toggled between two states
  • 11.121Class GtkToggleButton - Create buttons which retain their state
  • 11.122Class GtkToggleToolButton - A GtkToolItem containing a toggle button
  • 11.123Class GtkToolButton - A GtkToolItem subclass that displays buttons
  • 11.124Class GtkToolItem - The base class of widgets that can be added to GtkToolShell
  • 11.125Class GtkToolItemGroup - A sub container used in a tool palette
  • 11.126Class GtkToolPalette - A tool palette with categories
  • 11.127Class GtkToolShell - Interface for containers containing GtkToolItem widgets
  • 11.128Class GtkToolbar - Create bars of buttons and other widgets
  • 11.129Class GtkTreeIter - The GtkTreeIter is the primary structure for accessing a structure (model).
  • 11.130Class GtkTreeModel - The GtkTreeModel interface defines a generic tree interface for use by the GtkTreeView widget.
  • 11.131Class GtkTreeModelFilter - A GtkTreeModel which hides parts of an underlying tree model
  • 11.132Class GtkTreeModelSort - A GtkTreeModel which makes an underlying tree model sortable
  • 11.133Class GtkTreePath - This structure refers to a row.
  • 11.134Class GtkTreeRowReference - Creates a row reference based on path.
  • 11.135Class GtkTreeSortable - The interface for sortable models used by GtkTreeView
  • 11.136Class GtkTreeStore - A tree-like data structure that can be used with the GtkTreeView
  • 11.137Class GtkTreeView - A widget for displaying both trees and lists
  • 11.138Class GtkTreeViewColumn - A visible column in a GtkTreeView widget
  • 11.139Class GtkVBox - Vertical box class
  • 11.140Class GtkVButtonBox - Vertical button box container.
  • 11.141Class GtkVPaned - A container with two panes arranged vertically
  • 11.142Class GtkVRuler - A vertical ruler
  • 11.143Class GtkVScale - A vertical slider widget for selecting a value from a range
  • 11.144Class GtkVScrollbar - A vertical scrollbar
  • 11.145Class GtkVolumeButton - A button which pops up a volume control
  • 11.146Class GtkWidget - Base class for all widgets
  • 11.147Class GtkWindow - Toplevel which can contain other widgets.
  • 11.148Class GtkWindowGroup - Limit the effect of grabs
• 12Binding for libHaru, a pdf creation library.
  • 12.1Tutorial
  • 12.2Class Doc - Used to operate on a document object.
  • 12.3Class Font - todo.
  • 12.4Class Page - Used to manipulate an individual page.
  • 12.5Enum TextAlignment - Specifies the text alignment to be used.
• 13QR-Code generator module.
  • 13.1Class Image - Class representing a QR code image.
  • 13.2Class Maker - QRcode generator.
• 14MongoDB driver module
  • 14.1Class BSON - Represents a BSON object.
  • 14.2Class BSONIter - Iterator for BSON objects
  • 14.3Class MongoDB - Create a client connection to a MongoDB database.
  • 14.4Class MongoDBError - Error generated MongoDB operations.
  • 14.5Class ObjectID - Mongo Object ID
• 15Module net.imap
  • 15.1Class IMAP - IMAP class.
  • 15.2Class IMAPError
  • 15.3Enum IMAPState - IMAP states.
• 16Module net.smtp
  • 16.1Class SMTP - Simple Mail Transfer Protocol interface.
• 17Generic line-oriented parser and related renderers
  • 17.1Module parser.creole
    • 17.1.1Class Parser
  • 17.2Module parser.faldoc.falsrc
    • 17.2.1Class Parser
  • 17.3Module parser.faldoc.generic
    • 17.3.1Class Parser
  • 17.4Module parser.faldoc.txt
  • 17.5Module parser.genparser
    • 17.5.1Class PState
    • 17.5.2Class Parser - Main parsing class.
    • 17.5.3Module parser.genparser.context
      • 17.5.3.1Class Context - Syntree context.
    • 17.5.4Module parser.genparser.node
      • 17.5.4.1Class InfoNode
      • 17.5.4.2Class LevelNode
      • 17.5.4.3Class Node
      • 17.5.4.4Class StandoutNode - A node that should standout.
      • 17.5.4.5Class TagNode
    • 17.5.5Module parser.genparser.rules
      • 17.5.5.1Class BlanksRule - Eats blanks
      • 17.5.5.2Class CharRule - Matches a single character.
      • 17.5.5.3Class DummyRule - Empty rule meant to immediately do an action and change state without consuming input.
      • 17.5.5.4Class EOLRule - Rule matching the end of line
      • 17.5.5.5Class EOLRuleLA - Rule matching the end of line, with look ahead. This prevents exiting from the loop checking this line when EOLRuleLA is matched
      • 17.5.5.6Class EmptyLineRule - Empty line rule matcher.
      • 17.5.5.7Class ProxyRule - Rule combining one or more sub-rules.
      • 17.5.5.8Class ReRule - Regular expression enabled ruler matcher.
      • 17.5.5.9Class ReRuleEOL - Regular expression enabled ruler matcher -- consuming end of line.
      • 17.5.5.10Class ReRuleLA - Regular expression matcher with look ahead
      • 17.5.5.11Class Rule - Base rule.
      • 17.5.5.12Class TagRule - Class representing a tag rule.
      • 17.5.5.13Class TokenRule - Class representing a token rule.
      • 17.5.5.14Class TokenRuleLA - Class representing a language token, with look ahead.
  • 17.6Module parser.render.docbook
    • 17.6.1Class Article5Frame - Frame creating an article frame in DocBook 5
    • 17.6.2Class ArticleFrame - Frame creating an article frame
    • 17.6.3Class Book5Frame - Frame creating a book frame -- in docbook 5
    • 17.6.4Class BookFrame - Frame creating a book frame
    • 17.6.5Class Renderer - Doocbook Renderer.
  • 17.7Module parser.render.html
    • 17.7.1Class BaseSiteHelper - Default renderer with basic functionalities.
    • 17.7.2Class Renderer - Html Renderer.
  • 17.8Module parser.render.sitehelper
    • 17.8.1Class SiteHelper - Base abstract class for site helpers.
• 18The SDL Falcon Module.
  • 18.1Class SDL - SDL wrapper class
  • 18.2Class SDLColor - Storage for RGB values
  • 18.3Class SDLCursor - Cursor representation for SDL.
  • 18.4Class SDLError - Class used to notify SDL exceptions.
  • 18.5Class SDLEventType - Enumeration of SDL event types.
  • 18.6Class SDLK - Enumeration for SDL Scan Key codes.
  • 18.7Class SDLKMOD - Enumeration for SDL Key Modifiers.
  • 18.8Class SDLMouseState - Allows querying of current mouse status.
  • 18.9Class SDLPalette - Represents the palette of a surface
  • 18.10Class SDLPixelFormat - Encapsulates SDL_PixelFormat structure.
  • 18.11Class SDLRect - Storage for rectangular coordinates.
  • 18.12Class SDLScreen - Screen oriented SDL surface.
  • 18.13Class SDLSurface - Encapsulates SDL_Surface structures and provides related services.
  • 18.14Class SDLVideoInfo - Encapsulate a video info.
  • 18.15Image loading extensions
    • 18.15.1Class IMAGE - Main SDL IMAGE encapsulation class.
  • 18.16SDL AUDIO extensions for the Falcon SDL module.
    • 18.16.1Class MIX - Main SDL Mixer encapsulation class.
    • 18.16.2Class MixChunk - SDL Mixer Chunk encapsulation class.
    • 18.16.3Class MixMusic - SDL Mixer Music encapsulation class.
    • 18.16.4Enum AUDIO - Enumeartion listing the possible audio open modes.
    • 18.16.5Enum MUS - Enumeartion listing the possible music types.
  • 18.17True Type extensions for the Falcon SDL module.
    • 18.17.1Class TTF - Main SDL TTF encapsulation class.
    • 18.17.2Class TTFFont - Font representation of SDL TTF Class.
    • 18.17.3Class TTFMetrics - Metrics for glyphs and rendered strings.
• 19Module struct.tree
  • 19.1Class Node - Generic Node of a tree structure.
• 20AJAX hybrid server-client support.
  • 20.1Class Function - Ajax server-side function wrapper.
  • 20.2Class Param - AJAX function parameter.
  • 20.3Module web.ajax.library
    • 20.3.1Class Generator - AJAX Library generator.
• 21Module web.htmaker
  • 21.1Object ContentModel
  • 21.2Object HTMaker - General module options.
  • 21.3Class A - Anchor.
  • 21.4Class Abbr - Class generating an abbreviation phrase.
  • 21.5Class Acronym - Class indicating an acronym phrase.
  • 21.6Class AllAttribs - Utility class exposing all the attributes
  • 21.7Class AnchorAttribs
  • 21.8Class Area
  • 21.9Class AreaAttribs
  • 21.10Class AttribsBase
  • 21.11Class B - Class generating bold text.
  • 21.12Class BDO - Class overriding directionality in documents
  • 21.13Class BDOAttribs
  • 21.14Class BR - Line Break
  • 21.15Class BaseDom - Base dom elements.
  • 21.16Class BaseInput - Base class for Input items with some common helpers.
  • 21.17Class Big - Class generating big (uppercase/caps) text.
  • 21.18Class Blockquote - Class used to specify a block quotation.
  • 21.19Class Body - Body class
  • 21.20Class BodyAttribs - Attributes used for the Body class
  • 21.21Class Button - Used to create a button type container in a form.
  • 21.22Class ButtonAttribs
  • 21.23Class ButtonInput - Creates a generic button.
  • 21.24Class Caption - Caption for the table.
  • 21.25Class CheckboxInput - Creates a checkbox input.
  • 21.26Class Cite - Class generating a citation phrase.
  • 21.27Class Code - Class generating a 'code' section.
  • 21.28Class Col - Defines attributes for a single column Can contain only a list of Col items.
  • 21.29Class ColAttribs
  • 21.30Class ColGroup - Group of columns. Can contain only a list of Col items.
  • 21.31Class CommonLinkAttribs
  • 21.32Class CoreAttribs - Attributes for all the DomElements
  • 21.33Class DD - Definition data.
  • 21.34Class DL - Definition list.
  • 21.35Class DT - Definition term.
  • 21.36Class Del - Node for text removed from a document.
  • 21.37Class Dfn - Class generating definition phrases.
  • 21.38Class Div - Class representing a DIV html element.
  • 21.39Class DomList
  • 21.40Class Em - Class generating emphathised phrases.
  • 21.41Class EscapingData
  • 21.42Class EventAttribs - Class managing event related attributes
  • 21.43Class Falcon - Creates a Falcon script node.
  • 21.44Class FalconVar - Creates a Falcon "print variable" node.
  • 21.45Class FieldSet - Class used to group fields in forms
  • 21.46Class FileInput - Creates a file input for file upload.
  • 21.47Class FontControl - Base class for all the font and phrase control tags.
  • 21.48Class Form - Creates a form node for data submission and file uploads.
  • 21.49Class FormAttribs
  • 21.50Class Frame
  • 21.51Class FrameAttribs
  • 21.52Class Frameset - Frameset class
  • 21.53Class FramesetAttribs
  • 21.54Class FramesetFrame - Topmost node for HTML Frameset documents.
  • 21.55Class H1 - Heading level 1 node.
  • 21.56Class H2 - Heading level 2 node.
  • 21.57Class H3 - Heading level 3 node.
  • 21.58Class H4 - Heading level 4 node.
  • 21.59Class H5 - Heading level 5 node.
  • 21.60Class H6 - Heading level 6 node.
  • 21.61Class HR - Horizontal ruler
  • 21.62Class Head - Class encapsulating the xhtml header.
  • 21.63Class Heading
  • 21.64Class HiddenInput - Creates an hidden input field (for parameter propagation in forms).
  • 21.65Class I - Class generating italic text.
  • 21.66Class I18nAttribs
  • 21.67Class IFrame
  • 21.68Class IFrameAttribs
  • 21.69Class ImageInput - Creates a graphic button.
  • 21.70Class Img - Hypertext embedded image.
  • 21.71Class ImgAttribs
  • 21.72Class Include - Includes a document verbatim.
  • 21.73Class IncludeFalcon - Includes a falcon document.
  • 21.74Class Input - Creates an input, with an optional type.
  • 21.75Class InputAttribs
  • 21.76Class Ins - Node for text inserted in a document.
  • 21.77Class InsDelAttribs
  • 21.78Class Kbd - Class generating a 'text digited on keyboard' section.
  • 21.79Class LI - List item
  • 21.80Class Label - Class representing a Text label in input forms.
  • 21.81Class LabelAttribs
  • 21.82Class Legend - Used to specify a legend for a set of fields.
  • 21.83Class LegendAttribs
  • 21.84Class Link - Document relationship (link).
  • 21.85Class LinkAttribs
  • 21.86Class Map - Image active link map.
  • 21.87Class MapAttribs
  • 21.88Class Meta
  • 21.89Class MetaAttribs - Attributes used for the Meta class
  • 21.90Class NoScript - Node representing the things to do if the browser doesn't support scripts.
  • 21.91Class Noframes
  • 21.92Class OL - Ordered list.
  • 21.93Class Object - HTML embedding object class.
  • 21.94Class ObjectAttribs
  • 21.95Class OptGroup - Group of otpions represented separated in the Select menu.
  • 21.96Class OptGroupAttribs
  • 21.97Class Option - Single choice of a Select menu.
  • 21.98Class OptionAttribs
  • 21.99Class P - Class bounding the standard paragraph.
  • 21.100Class Param - Class representing a single parameter to be sent to an object.
  • 21.101Class ParamAttribs
  • 21.102Class PasswordInput - Creates a masked text input.
  • 21.103Class Pre - Class bounding pre-formatted text.
  • 21.104Class Q - Class used to specify a quotation.
  • 21.105Class QuotAttribs
  • 21.106Class RadioInput - Creates a radio input.
  • 21.107Class ResetInput - Creates a reset button.
  • 21.108Class Samp - Class generating a 'sample' section.
  • 21.109Class Script - Creates an embedded script.
  • 21.110Class ScriptAttribs
  • 21.111Class Select
  • 21.112Class SelectAttribs
  • 21.113Class Small - Class generating small text.
  • 21.114Class Span - Span text.
  • 21.115Class StrictFrame - Topmost node for HTML Strict documents.
  • 21.116Class Strong - Class generating stronger phrases.
  • 21.117Class Style - Creates an embedded style sheet.
  • 21.118Class StyleAttribs
  • 21.119Class Sub - Subscript phrase generator.
  • 21.120Class SubmitInput - Creates a submit button.
  • 21.121Class Sup - Superscript phrase generator
  • 21.122Class TABLE - Hyper text Table class.
  • 21.123Class TBody - Table body.
  • 21.124Class TCellAttribs
  • 21.125Class TD - Normal table cell.
  • 21.126Class TElemAttribs
  • 21.127Class TFoot - Table footer.
  • 21.128Class TH - Table cell at header position.
  • 21.129Class THead - Table heading.
  • 21.130Class TR - Group of columns. Can contain only a list of Col items.
  • 21.131Class TT - Class generating Typewriter/Tele Type text.
  • 21.132Class TableAttribs - Definition data.
  • 21.133Class Text - Terminal text node.
  • 21.134Class TextArea - Class representing a Text area in a form.
  • 21.135Class TextAreaAttribs
  • 21.136Class TextInput - Creates a text input.
  • 21.137Class Title - Class encapsulating the xhtml header. If the title text (a string) is given, a Title node is automatically created.
  • 21.138Class TransitionalFrame - Topmost node for Transitional documents.
  • 21.139Class UL - Unordered list.
  • 21.140Class ValidHtmlMark - Element rendering as the "Valid HTML 4.01" official mark.
  • 21.141Class ValidXhtmlMark - Element rendering as the "Valid XHTML 1.0" official mark.
  • 21.142Class Var - Class generating a 'variable' phrase.
  • 21.143Class Verbatim - Terminal unparsed node.
  • 21.144Class XHTMLFrame - Topmost node for XHTML documents.
  • 21.145Enum InputType
  • 21.146Module web.htmaker.htmerror
    • 21.146.1Class HTMError - Class raised in case of logic errors in composing XHTML documents.
• 22Module web.mime
  • 22.1Class Part - Part of a MIME document.
  • 22.2Functions
  • 22.3Enum Multipart - Type of multipart entity
• 23Support for OAuth 1.0 protocol.
  • 23.1Class Client - Interface to remote OAuth authentication process server.
  • 23.2Class ProtoError - Error raised from OAuth in case of protocol breach.
  • 23.3Class Token - Class representing an OAuth token.
  • 23.4Enum UseHeader
  • 23.5Enum Via
• 24Support for OAuth 2.0 protocol.
  • 24.1Class Client - Interface to remote OAuth2 authentication process server.
• 25Alphabetical Index