./pygtk-2.14.1-i686/0000755000000000000000000000000011272037331012261 5ustar rootroot./pygtk-2.14.1-i686/usr/0000755000000000000000000000000011272037117013074 5ustar rootroot./pygtk-2.14.1-i686/usr/share/0000755000000000000000000000000011272037125014175 5ustar rootroot./pygtk-2.14.1-i686/usr/share/pygtk/0000755000000000000000000000000011272037120015326 5ustar rootroot./pygtk-2.14.1-i686/usr/share/pygtk/2.0/0000755000000000000000000000000011272037120015625 5ustar rootroot./pygtk-2.14.1-i686/usr/share/pygtk/2.0/defs/0000755000000000000000000000000011272037120016546 5ustar rootroot./pygtk-2.14.1-i686/usr/share/pygtk/2.0/defs/pango.defs0000644000000000000000000020244011272037107020524 0ustar rootroot;; -*- scheme -*- (include "pango-types.defs") ;; From /opt/gtk2/include/pango-1.0/pango/pango-attributes.h (define-function pango_color_get_type (c-name "pango_color_get_type") (return-type "GType") ) (define-method copy (of-object "PangoColor") (c-name "pango_color_copy") (return-type "PangoColor*") ) (define-method free (of-object "PangoColor") (c-name "pango_color_free") (return-type "none") ) (define-function color_parse (c-name "pango_color_parse") (is-constructor-of "PangoColor") (return-type "gboolean") (parameters '("const-char*" "spec") ) ) (define-method to_string (of-object "PangoColor") (c-name "pango_color_to_string") (return-type "gchar*") ) (define-function pango_attr_type_register (c-name "pango_attr_type_register") (return-type "PangoAttrType") (parameters '("const-gchar*" "name") ) ) (define-method copy (of-object "PangoAttribute") (c-name "pango_attribute_copy") (return-type "PangoAttribute*") ) (define-method destroy (of-object "PangoAttribute") (c-name "pango_attribute_destroy") (return-type "none") ) (define-method equal (of-object "PangoAttribute") (c-name "pango_attribute_equal") (return-type "gboolean") (parameters '("const-PangoAttribute*" "attr2") ) ) (define-function AttrLanguage (c-name "pango_attr_language_new") (return-type "PangoAttribute*") (parameters '("PangoLanguage*" "language") ) ) (define-function AttrFamily (c-name "pango_attr_family_new") (return-type "PangoAttribute*") (parameters '("const-char*" "family") ) ) (define-function AttrForeground (c-name "pango_attr_foreground_new") (return-type "PangoAttribute*") (parameters '("guint16" "red") '("guint16" "green") '("guint16" "blue") ) ) (define-function AttrBackground (c-name "pango_attr_background_new") (return-type "PangoAttribute*") (parameters '("guint16" "red") '("guint16" "green") '("guint16" "blue") ) ) (define-function AttrSize (c-name "pango_attr_size_new") (return-type "PangoAttribute*") (parameters '("int" "size") ) ) (define-function AttrSizeAbsolute (c-name "pango_attr_size_new_absolute") (return-type "PangoAttribute*") (parameters '("int" "size") ) ) (define-function AttrStyle (c-name "pango_attr_style_new") (return-type "PangoAttribute*") (parameters '("PangoStyle" "style") ) ) (define-function AttrWeight (c-name "pango_attr_weight_new") (return-type "PangoAttribute*") (parameters '("PangoWeight" "weight") ) ) (define-function AttrVariant (c-name "pango_attr_variant_new") (return-type "PangoAttribute*") (parameters '("PangoVariant" "variant") ) ) (define-function AttrStretch (c-name "pango_attr_stretch_new") (return-type "PangoAttribute*") (parameters '("PangoStretch" "stretch") ) ) (define-function AttrFontDesc (c-name "pango_attr_font_desc_new") (return-type "PangoAttribute*") (parameters '("const-PangoFontDescription*" "desc") ) ) (define-function AttrUnderline (c-name "pango_attr_underline_new") (return-type "PangoAttribute*") (parameters '("PangoUnderline" "underline") ) ) (define-function AttrUnderlineColor (c-name "pango_attr_underline_color_new") (return-type "PangoAttribute*") (parameters '("guint16" "red") '("guint16" "green") '("guint16" "blue") ) ) (define-function AttrStrikethrough (c-name "pango_attr_strikethrough_new") (return-type "PangoAttribute*") (parameters '("gboolean" "strikethrough") ) ) (define-function AttrStrikethroughColor (c-name "pango_attr_strikethrough_color_new") (return-type "PangoAttribute*") (parameters '("guint16" "red") '("guint16" "green") '("guint16" "blue") ) ) (define-function AttrRise (c-name "pango_attr_rise_new") (return-type "PangoAttribute*") (parameters '("int" "rise") ) ) (define-function AttrScale (c-name "pango_attr_scale_new") (return-type "PangoAttribute*") (parameters '("double" "scale_factor") ) ) (define-function AttrFallback (c-name "pango_attr_fallback_new") (return-type "PangoAttribute*") (parameters '("gboolean" "fallback") ) ) (define-function AttrLetterSpacing (c-name "pango_attr_letter_spacing_new") (return-type "PangoAttribute*") (parameters '("int" "letter_spacing") ) ) (define-function AttrShape (c-name "pango_attr_shape_new") (return-type "PangoAttribute*") (parameters '("const-PangoRectangle*" "ink_rect") '("const-PangoRectangle*" "logical_rect") ) ) (define-function attr_shape_new_with_data (c-name "pango_attr_shape_new_with_data") (return-type "PangoAttribute*") (parameters '("const-PangoRectangle*" "ink_rect") '("const-PangoRectangle*" "logical_rect") '("gpointer" "data") '("PangoAttrDataCopyFunc" "copy_func") '("GDestroyNotify" "destroy_func") ) ) (define-function attr_gravity_new (c-name "pango_attr_gravity_new") (is-constructor-of "PangoAttrGravity") (return-type "PangoAttribute*") (parameters '("PangoGravity" "gravity") ) ) (define-function attr_gravity_hint_new (c-name "pango_attr_gravity_hint_new") (is-constructor-of "PangoAttrGravityHint") (return-type "PangoAttribute*") (parameters '("PangoGravityHint" "hint") ) ) (define-function pango_attr_list_get_type (c-name "pango_attr_list_get_type") (return-type "GType") ) (define-function pango_attr_list_new (c-name "pango_attr_list_new") (return-type "PangoAttrList*") (is-constructor-of "PangoAttrList") ) (define-method ref (of-object "PangoAttrList") (c-name "pango_attr_list_ref") (return-type "none") ) (define-method unref (of-object "PangoAttrList") (c-name "pango_attr_list_unref") (return-type "none") ) (define-method copy (of-object "PangoAttrList") (c-name "pango_attr_list_copy") (return-type "PangoAttrList*") ) (define-method insert (of-object "PangoAttrList") (c-name "pango_attr_list_insert") (return-type "none") (parameters '("PangoAttribute*" "attr") ) ) (define-method insert_before (of-object "PangoAttrList") (c-name "pango_attr_list_insert_before") (return-type "none") (parameters '("PangoAttribute*" "attr") ) ) (define-method change (of-object "PangoAttrList") (c-name "pango_attr_list_change") (return-type "none") (parameters '("PangoAttribute*" "attr") ) ) (define-method splice (of-object "PangoAttrList") (c-name "pango_attr_list_splice") (return-type "none") (parameters '("PangoAttrList*" "other") '("gint" "pos") '("gint" "len") ) ) (define-method filter (of-object "PangoAttrList") (c-name "pango_attr_list_filter") (return-type "PangoAttrList*") (parameters '("PangoAttrFilterFunc" "func") '("gpointer" "data") ) ) (define-method get_iterator (of-object "PangoAttrList") (c-name "pango_attr_list_get_iterator") (return-type "PangoAttrIterator*") ) (define-method range (of-object "PangoAttrIterator") (c-name "pango_attr_iterator_range") (return-type "none") (parameters '("gint*" "start") '("gint*" "end") ) ) (define-method next (of-object "PangoAttrIterator") (c-name "pango_attr_iterator_next") (return-type "gboolean") ) (define-method copy (of-object "PangoAttrIterator") (c-name "pango_attr_iterator_copy") (return-type "PangoAttrIterator*") ) (define-method destroy (of-object "PangoAttrIterator") (c-name "pango_attr_iterator_destroy") (return-type "none") ) (define-method get (of-object "PangoAttrIterator") (c-name "pango_attr_iterator_get") (return-type "PangoAttribute*") (parameters '("PangoAttrType" "type") ) ) (define-method get_font (of-object "PangoAttrIterator") (c-name "pango_attr_iterator_get_font") (return-type "none") (parameters '("PangoFontDescription*" "desc") '("PangoLanguage**" "language") '("GSList**" "extra_attrs") ) ) (define-method get_attrs (of-object "PangoAttrIterator") (c-name "pango_attr_iterator_get_attrs") (return-type "GSList*") ) (define-function parse_markup (c-name "pango_parse_markup") (return-type "gboolean") (parameters '("const-char*" "markup_text") '("int" "length") '("gunichar" "accel_marker") '("PangoAttrList**" "attr_list") '("char**" "text") '("gunichar*" "accel_char") '("GError**" "error") ) ) (define-virtual copy (of-object "PangoAttr") (return-type "PangoAttribute*") ) (define-virtual destroy (of-object "PangoAttr") (return-type "none") ) (define-virtual equal (of-object "PangoAttr") (return-type "gboolean") (parameters '("const-PangoAttribute*" "attr2") ) ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-break.h (define-function break (c-name "pango_break") (return-type "none") (parameters '("const-gchar*" "text") '("gint" "length") '("PangoAnalysis*" "analysis") '("PangoLogAttr*" "attrs") ) ) (define-function find_paragraph_boundary (c-name "pango_find_paragraph_boundary") (return-type "none") (parameters '("const-gchar*" "text") '("gint" "length") '("gint*" "paragraph_delimiter_index") '("gint*" "next_paragraph_start") ) ) (define-function get_log_attrs (c-name "pango_get_log_attrs") (return-type "none") (parameters '("const-char*" "text") '("int" "length") '("int" "level") '("PangoLanguage*" "language") '("PangoLogAttr*" "log_attrs") ) ) (define-function default_break (c-name "pango_default_break") (return-type "none") (parameters '("const-gchar*" "text") '("int" "length") '("PangoAnalysis*" "analysis") '("PangoLogAttr*" "attrs") '("int" "attrs_len") ) ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-context.h (define-function context_get_type (c-name "pango_context_get_type") (return-type "GType") ) (define-function pango_context_new (c-name "pango_context_new") (return-type "PangoContext*") (is-constructor-of "PangoContext") ) (define-method add_font_map (of-object "PangoContext") (c-name "pango_context_set_font_map") (return-type "none") (parameters '("PangoFontMap*" "font_map") ) ) (define-method get_font_map (of-object "PangoContext") (c-name "pango_context_get_font_map") (return-type "PangoFontMap*") ) (define-method list_families (of-object "PangoContext") (c-name "pango_context_list_families") (return-type "none") (parameters '("PangoFontFamily***" "families") '("int*" "n_families") ) ) (define-method load_font (of-object "PangoContext") (c-name "pango_context_load_font") (return-type "PangoFont*") (parameters '("const-PangoFontDescription*" "desc") ) ) (define-method load_fontset (of-object "PangoContext") (c-name "pango_context_load_fontset") (return-type "PangoFontset*") (parameters '("const-PangoFontDescription*" "desc") '("PangoLanguage*" "language") ) ) (define-method get_metrics (of-object "PangoContext") (c-name "pango_context_get_metrics") (return-type "PangoFontMetrics*") (caller-owns-return #t) (parameters '("const-PangoFontDescription*" "desc") '("PangoLanguage*" "language" (null-ok) (default "NULL")) ) ) (define-method set_font_description (of-object "PangoContext") (c-name "pango_context_set_font_description") (return-type "none") (parameters '("const-PangoFontDescription*" "desc") ) ) (define-method get_font_description (of-object "PangoContext") (c-name "pango_context_get_font_description") (return-type "PangoFontDescription*") ) (define-method get_language (of-object "PangoContext") (c-name "pango_context_get_language") (return-type "PangoLanguage*") ) (define-method set_language (of-object "PangoContext") (c-name "pango_context_set_language") (return-type "none") (parameters '("PangoLanguage*" "language") ) ) (define-method set_base_dir (of-object "PangoContext") (c-name "pango_context_set_base_dir") (return-type "none") (parameters '("PangoDirection" "direction") ) ) (define-method get_base_dir (of-object "PangoContext") (c-name "pango_context_get_base_dir") (return-type "PangoDirection") ) (define-method set_matrix (of-object "PangoContext") (c-name "pango_context_set_matrix") (return-type "none") (parameters '("const-PangoMatrix*" "matrix") ) ) (define-method get_matrix (of-object "PangoContext") (c-name "pango_context_get_matrix") (return-type "const-PangoMatrix*") ) (define-method set_base_gravity (of-object "PangoContext") (c-name "pango_context_set_base_gravity") (return-type "none") (parameters '("PangoGravity" "gravity") ) ) (define-method get_base_gravity (of-object "PangoContext") (c-name "pango_context_get_base_gravity") (return-type "PangoGravity") ) (define-method get_gravity (of-object "PangoContext") (c-name "pango_context_get_gravity") (return-type "PangoGravity") ) (define-method set_gravity_hint (of-object "PangoContext") (c-name "pango_context_set_gravity_hint") (return-type "none") (parameters '("PangoGravityHint" "hint") ) ) (define-method get_gravity_hint (of-object "PangoContext") (c-name "pango_context_get_gravity_hint") (return-type "PangoGravityHint") ) (define-function itemize (c-name "pango_itemize") (return-type "GList*") (parameters '("PangoContext*" "context") '("const-char*" "text") '("int" "start_index") '("int" "length") '("PangoAttrList*" "attrs") '("PangoAttrIterator*" "cached_iter" (null-ok) (default "NULL")) ) ) (define-function itemize_with_base_dir (c-name "pango_itemize_with_base_dir") (return-type "GList*") (parameters '("PangoContext*" "context") '("PangoDirection" "base_dir") '("const-char*" "text") '("int" "start_index") '("int" "length") '("PangoAttrList*" "attrs") '("PangoAttrIterator*" "cached_iter") ) ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-coverage.h (define-function coverage_new (c-name "pango_coverage_new") (is-constructor-of "PangoCoverage") (return-type "PangoCoverage*") ) (define-method ref (of-object "PangoCoverage") (c-name "pango_coverage_ref") (return-type "PangoCoverage*") ) (define-method unref (of-object "PangoCoverage") (c-name "pango_coverage_unref") (return-type "none") ) (define-method copy (of-object "PangoCoverage") (c-name "pango_coverage_copy") (return-type "PangoCoverage*") ) (define-method get (of-object "PangoCoverage") (c-name "pango_coverage_get") (return-type "PangoCoverageLevel") (parameters '("int" "index") ) ) (define-method set (of-object "PangoCoverage") (c-name "pango_coverage_set") (return-type "none") (parameters '("int" "index") '("PangoCoverageLevel" "level") ) ) (define-method max (of-object "PangoCoverage") (c-name "pango_coverage_max") (return-type "none") (parameters '("PangoCoverage*" "other") ) ) (define-method to_bytes (of-object "PangoCoverage") (c-name "pango_coverage_to_bytes") (return-type "none") (parameters '("guchar**" "bytes") '("int*" "n_bytes") ) ) (define-function coverage_from_bytes (c-name "pango_coverage_from_bytes") (is-constructor-of "PangoCoverage") (return-type "PangoCoverage*") (parameters '("guchar*" "bytes") '("int" "n_bytes") ) ) ;; From pango-engine.h (ifdef PANGO_ENABLE_ENGINE (define-function engine_get_type (c-name "pango_engine_get_type") (return-type "GType") ) (define-function engine_lang_get_type (c-name "pango_engine_lang_get_type") (return-type "GType") ) (define-function engine_shape_get_type (c-name "pango_engine_shape_get_type") (return-type "GType") ) (define-virtual script_break (of-object "PangoEngineLang") (return-type "none") (parameters '("const-char*" "text") '("int" "len") '("PangoAnalysis*" "analysis") '("PangoLogAttr*" "attrs") '("int" "attrs_len") ) ) (define-virtual script_shape (of-object "PangoEngineShape") (return-type "none") (parameters '("PangoFont*" "font") '("const-char*" "text") '("int" "length") '("PangoAnalysis*" "analysis") '("PangoGlyphString*" "glyphs") ) ) (define-virtual covers (of-object "PangoEngineShape") (return-type "PangoCoverageLevel") (parameters '("PangoFont*" "font") '("PangoLanguage*" "language") '("gunichar" "wc") ) ) ) ;; PANGO_ENABLE_ENGINE ;; From pango-enum-types.h (define-function attr_type_get_type (c-name "pango_attr_type_get_type") (return-type "GType") ) (define-function underline_get_type (c-name "pango_underline_get_type") (return-type "GType") ) (define-function coverage_level_get_type (c-name "pango_coverage_level_get_type") (return-type "GType") ) (define-function style_get_type (c-name "pango_style_get_type") (return-type "GType") ) (define-function variant_get_type (c-name "pango_variant_get_type") (return-type "GType") ) (define-function weight_get_type (c-name "pango_weight_get_type") (return-type "GType") ) (define-function stretch_get_type (c-name "pango_stretch_get_type") (return-type "GType") ) (define-function font_mask_get_type (c-name "pango_font_mask_get_type") (return-type "GType") ) (define-function alignment_get_type (c-name "pango_alignment_get_type") (return-type "GType") ) (define-function wrap_mode_get_type (c-name "pango_wrap_mode_get_type") (return-type "GType") ) (define-function ellipsize_mode_get_type (c-name "pango_ellipsize_mode_get_type") (return-type "GType") ) (define-function render_part_get_type (c-name "pango_render_part_get_type") (return-type "GType") ) (define-function script_get_type (c-name "pango_script_get_type") (return-type "GType") ) (define-function tab_align_get_type (c-name "pango_tab_align_get_type") (return-type "GType") ) (define-function direction_get_type (c-name "pango_direction_get_type") (return-type "GType") ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-font.h (define-function font_description_get_type (c-name "pango_font_description_get_type") (return-type "GType") ) (define-function pango_font_description_new (c-name "pango_font_description_new") (is-constructor-of "PangoFontDescription") (return-type "PangoFontDescription*") ) (define-method copy (of-object "PangoFontDescription") (c-name "pango_font_description_copy") (return-type "PangoFontDescription*") ) (define-method copy_static (of-object "PangoFontDescription") (c-name "pango_font_description_copy_static") (return-type "PangoFontDescription*") ) (define-method hash (of-object "PangoFontDescription") (c-name "pango_font_description_hash") (return-type "guint") ) (define-method equal (of-object "PangoFontDescription") (c-name "pango_font_description_equal") (return-type "gboolean") (parameters '("const-PangoFontDescription*" "desc2") ) ) (define-method free (of-object "PangoFontDescription") (c-name "pango_font_description_free") (return-type "none") ) (define-function pango_font_descriptions_free (c-name "pango_font_descriptions_free") (return-type "none") (parameters '("PangoFontDescription**" "descs") '("int" "n_descs") ) ) (define-method set_family (of-object "PangoFontDescription") (c-name "pango_font_description_set_family") (return-type "none") (parameters '("const-char*" "family") ) ) (define-method set_family_static (of-object "PangoFontDescription") (c-name "pango_font_description_set_family_static") (return-type "none") (parameters '("const-char*" "family") ) ) (define-method get_family (of-object "PangoFontDescription") (c-name "pango_font_description_get_family") (return-type "const-char*") ) (define-method set_style (of-object "PangoFontDescription") (c-name "pango_font_description_set_style") (return-type "none") (parameters '("PangoStyle" "style") ) ) (define-method get_style (of-object "PangoFontDescription") (c-name "pango_font_description_get_style") (return-type "PangoStyle") ) (define-method set_variant (of-object "PangoFontDescription") (c-name "pango_font_description_set_variant") (return-type "none") (parameters '("PangoVariant" "variant") ) ) (define-method get_variant (of-object "PangoFontDescription") (c-name "pango_font_description_get_variant") (return-type "PangoVariant") ) (define-method set_weight (of-object "PangoFontDescription") (c-name "pango_font_description_set_weight") (return-type "none") (parameters '("PangoWeight" "weight") ) ) (define-method get_weight (of-object "PangoFontDescription") (c-name "pango_font_description_get_weight") (return-type "PangoWeight") ) (define-method set_stretch (of-object "PangoFontDescription") (c-name "pango_font_description_set_stretch") (return-type "none") (parameters '("PangoStretch" "stretch") ) ) (define-method get_stretch (of-object "PangoFontDescription") (c-name "pango_font_description_get_stretch") (return-type "PangoStretch") ) (define-method set_size (of-object "PangoFontDescription") (c-name "pango_font_description_set_size") (return-type "none") (parameters '("gint" "size") ) ) (define-method get_size (of-object "PangoFontDescription") (c-name "pango_font_description_get_size") (return-type "gint") ) (define-method set_absolute_size (of-object "PangoFontDescription") (c-name "pango_font_description_set_absolute_size") (return-type "none") (parameters '("double" "size") ) ) (define-method get_size_is_absolute (of-object "PangoFontDescription") (c-name "pango_font_description_get_size_is_absolute") (return-type "gboolean") ) (define-method set_gravity (of-object "PangoFontDescription") (c-name "pango_font_description_set_gravity") (return-type "none") (parameters '("PangoGravity" "gravity") ) ) (define-method get_gravity (of-object "PangoFontDescription") (c-name "pango_font_description_get_gravity") (return-type "PangoGravity") ) (define-method get_set_fields (of-object "PangoFontDescription") (c-name "pango_font_description_get_set_fields") (return-type "PangoFontMask") ) (define-method unset_fields (of-object "PangoFontDescription") (c-name "pango_font_description_unset_fields") (return-type "none") (parameters '("PangoFontMask" "to_unset") ) ) (define-method merge (of-object "PangoFontDescription") (c-name "pango_font_description_merge") (return-type "none") (parameters '("const-PangoFontDescription*" "desc_to_merge") '("gboolean" "replace_existing") ) ) (define-method merge_static (of-object "PangoFontDescription") (c-name "pango_font_description_merge_static") (return-type "none") (parameters '("const-PangoFontDescription*" "desc_to_merge") '("gboolean" "replace_existing") ) ) (define-method better_match (of-object "PangoFontDescription") (c-name "pango_font_description_better_match") (return-type "gboolean") (parameters '("const-PangoFontDescription*" "old_match" (null-ok) (default "NULL")) '("const-PangoFontDescription*" "new_match") ) ) (define-function pango_font_description_from_string (c-name "pango_font_description_from_string") (is-constructor-of "PangoFontDescription") (return-type "PangoFontDescription*") (parameters '("const-char*" "str") ) ) (define-method to_string (of-object "PangoFontDescription") (c-name "pango_font_description_to_string") (return-type "char*") ) (define-method to_filename (of-object "PangoFontDescription") (c-name "pango_font_description_to_filename") (return-type "char*") ) (define-function pango_font_metrics_get_type (c-name "pango_font_metrics_get_type") (return-type "GType") ) (define-method ref (of-object "PangoFontMetrics") (c-name "pango_font_metrics_ref") (return-type "PangoFontMetrics*") ) (define-method unref (of-object "PangoFontMetrics") (c-name "pango_font_metrics_unref") (return-type "none") ) (define-method get_ascent (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_ascent") (return-type "int") ) (define-method get_descent (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_descent") (return-type "int") ) (define-method get_approximate_char_width (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_approximate_char_width") (return-type "int") ) (define-method get_approximate_digit_width (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_approximate_digit_width") (return-type "int") ) (define-method get_underline_position (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_underline_position") (return-type "int") ) (define-method get_underline_thickness (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_underline_thickness") (return-type "int") ) (define-method get_strikethrough_position (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_strikethrough_position") (return-type "int") ) (define-method get_strikethrough_thickness (of-object "PangoFontMetrics") (c-name "pango_font_metrics_get_strikethrough_thickness") (return-type "int") ) (ifdef PANGO_ENABLE_BACKEND (define-function font_metrics_new (c-name "pango_font_metrics_new") (is-constructor-of "PangoFontMetrics") (return-type "PangoFontMetrics*") ) ) ;; PANGO_ENABLE_BACKEND (define-function pango_font_family_get_type (c-name "pango_font_family_get_type") (return-type "GType") ) (define-method list_faces (of-object "PangoFontFamily") (c-name "pango_font_family_list_faces") (return-type "none") (parameters '("PangoFontFace***" "faces") '("int*" "n_faces") ) ) (define-method get_name (of-object "PangoFontFamily") (c-name "pango_font_family_get_name") (return-type "const-char*") ) (define-method is_monospace (of-object "PangoFontFamily") (c-name "pango_font_family_is_monospace") (return-type "gboolean") ) (define-function pango_font_face_get_type (c-name "pango_font_face_get_type") (return-type "GType") ) (define-method describe (of-object "PangoFontFace") (c-name "pango_font_face_describe") (return-type "PangoFontDescription*") ) (define-method get_face_name (of-object "PangoFontFace") (c-name "pango_font_face_get_face_name") (return-type "const-char*") ) (define-method list_sizes (of-object "PangoFontFace") (c-name "pango_font_face_list_sizes") (return-type "none") (parameters '("int**" "sizes") '("int*" "n_sizes") ) ) (define-function pango_font_get_type (c-name "pango_font_get_type") (return-type "GType") ) (define-method describe (of-object "PangoFont") (c-name "pango_font_describe") (return-type "PangoFontDescription*") ) (define-method get_coverage (of-object "PangoFont") (c-name "pango_font_get_coverage") (return-type "PangoCoverage*") (parameters '("PangoLanguage*" "language") ) ) (define-method find_shaper (of-object "PangoFont") (c-name "pango_font_find_shaper") (return-type "PangoEngineShape*") (parameters '("PangoLanguage*" "language") '("guint32" "ch") ) ) (define-method get_metrics (of-object "PangoFont") (c-name "pango_font_get_metrics") (return-type "PangoFontMetrics*") (parameters '("PangoLanguage*" "language" (null-ok) (default "NULL")) ) ) (define-method get_glyph_extents (of-object "PangoFont") (c-name "pango_font_get_glyph_extents") (return-type "none") (parameters '("PangoGlyph" "glyph") '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_font_map (of-object "PangoFont") (c-name "pango_font_get_font_map") (return-type "PangoFontMap*") ) (define-virtual list_faces (of-object "PangoFontFamily") (return-type "none") (parameters '("PangoFontFace***" "faces") '("int*" "n_faces") ) ) (define-virtual get_name (of-object "PangoFontFamily") (return-type "const-char*") ) (define-virtual is_monospace (of-object "PangoFontFamily") (return-type "gboolean") ) (define-virtual get_face_name (of-object "PangoFontFace") (return-type "const-char*") ) (define-virtual describe (of-object "PangoFontFace") (return-type "PangoFontDescription*") ) (define-virtual list_sizes (of-object "PangoFontFace") (return-type "none") (parameters '("int**" "sizes") '("int*" "n_sizes") ) ) (define-virtual describe (of-object "PangoFont") (return-type "PangoFontDescription*") ) (define-virtual get_coverage (of-object "PangoFont") (return-type "PangoCoverage*") (parameters '("PangoLanguage*" "lang") ) ) (define-virtual find_shaper (of-object "PangoFont") (return-type "PangoEngineShape*") (parameters '("PangoLanguage*" "lang") '("guint32" "ch") ) ) (define-virtual get_glyph_extents (of-object "PangoFont") (return-type "none") (parameters '("PangoGlyph" "glyph") '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-virtual get_metrics (of-object "PangoFont") (return-type "PangoFontMetrics*") (parameters '("PangoLanguage*" "language") ) ) (define-virtual get_font_map (of-object "PangoFont") (return-type "PangoFontMap*") ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-fontmap.h (define-function font_map_get_type (c-name "pango_font_map_get_type") (return-type "GType") ) (define-method load_font (of-object "PangoFontMap") (c-name "pango_font_map_load_font") (return-type "PangoFont*") (parameters '("PangoContext*" "context") '("const-PangoFontDescription*" "desc") ) ) (define-method load_fontset (of-object "PangoFontMap") (c-name "pango_font_map_load_fontset") (return-type "PangoFontset*") (parameters '("PangoContext*" "context") '("const-PangoFontDescription*" "desc") '("PangoLanguage*" "language") ) ) (define-method list_families (of-object "PangoFontMap") (c-name "pango_font_map_list_families") (return-type "none") (parameters '("PangoFontFamily***" "families") '("int*" "n_families") ) ) (define-method get_shape_engine_type (of-object "PangoFontMap") (c-name "pango_font_map_get_shape_engine_type") (return-type "const-char*") ) (define-virtual load_font (of-object "PangoFontMap") (return-type "PangoFont*") (parameters '("PangoContext*" "context") '("const-PangoFontDescription*" "desc") ) ) (define-virtual list_families (of-object "PangoFontMap") (return-type "none") (parameters '("PangoFontFamily***" "families") '("int*" "n_families") ) ) (define-virtual load_fontset (of-object "PangoFontMap") (return-type "PangoFontset*") (parameters '("PangoContext*" "context") '("const-PangoFontDescription*" "desc") '("PangoLanguage*" "language") ) ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-fontset.h (define-function fontset_get_type (c-name "pango_fontset_get_type") (return-type "GType") ) (define-method get_font (of-object "PangoFontset") (c-name "pango_fontset_get_font") (return-type "PangoFont*") (parameters '("guint" "wc") ) ) (define-method get_metrics (of-object "PangoFontset") (c-name "pango_fontset_get_metrics") (return-type "PangoFontMetrics*") ) (define-method foreach (of-object "PangoFontset") (c-name "pango_fontset_foreach") (return-type "none") (parameters '("PangoFontsetForeachFunc" "func") '("gpointer" "data") ) ) (define-function fontset_simple_get_type (c-name "pango_fontset_simple_get_type") (return-type "GType") ) (define-function pango_fontset_simple_new (c-name "pango_fontset_simple_new") (is-constructor-of "PangoFontsetSimple") (return-type "PangoFontsetSimple*") (parameters '("PangoLanguage*" "language") ) ) (define-method append (of-object "PangoFontsetSimple") (c-name "pango_fontset_simple_append") (return-type "none") (parameters '("PangoFont*" "font") ) ) (define-method size (of-object "PangoFontsetSimple") (c-name "pango_fontset_simple_size") (return-type "int") ) (define-virtual get_font (of-object "PangoFontset") (return-type "PangoFont*") (parameters '("guint" "wc") ) ) (define-virtual get_metrics (of-object "PangoFontset") (return-type "PangoFontMetrics*") ) (define-virtual get_language (of-object "PangoFontset") (return-type "PangoLanguage*") ) (define-virtual foreach (of-object "PangoFontset") (return-type "none") (parameters '("PangoFontsetForeachFunc" "func") '("gpointer" "data") ) ) ;; From pango-gravity.h (define-function gravity_to_rotation (c-name "pango_gravity_to_rotation") (return-type "double") (parameters '("PangoGravity" "gravity") ) ) (define-function gravity_get_for_matrix (c-name "pango_gravity_get_for_matrix") (return-type "PangoGravity") (parameters '("const-PangoMatrix*" "matrix") ) ) (define-function gravity_get_for_script (c-name "pango_gravity_get_for_script") (return-type "PangoGravity") (parameters '("PangoScript" "script") '("PangoGravity" "base_gravity") '("PangoGravityHint" "hint") ) ) ;; From pango-glyph-item.h (define-method split (of-object "PangoGlyphItem") (c-name "pango_glyph_item_split") (return-type "PangoGlyphItem*") (parameters '("const-char*" "text") '("int" "split_index") ) ) (define-method free (of-object "PangoGlyphItem") (c-name "pango_glyph_item_free") (return-type "none") ) (define-method apply_attrs (of-object "PangoGlyphItem") (c-name "pango_glyph_item_apply_attrs") (return-type "GSList*") (parameters '("const-char*" "text") '("PangoAttrList*" "list") ) ) (define-method letter_space (of-object "PangoGlyphItem") (c-name "pango_glyph_item_letter_space") (return-type "none") (parameters '("const-char*" "text") '("PangoLogAttr*" "log_attrs") '("int" "letter_spacing") ) ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-glyph.h (define-function pango_glyph_string_new (c-name "pango_glyph_string_new") (is-constructor-of "PangoGlyphString") (return-type "PangoGlyphString*") ) (define-method set_size (of-object "PangoGlyphString") (c-name "pango_glyph_string_set_size") (return-type "none") (parameters '("gint" "new_len") ) ) (define-function pango_glyph_string_get_type (c-name "pango_glyph_string_get_type") (return-type "GType") ) (define-method copy (of-object "PangoGlyphString") (c-name "pango_glyph_string_copy") (return-type "PangoGlyphString*") ) (define-method free (of-object "PangoGlyphString") (c-name "pango_glyph_string_free") (return-type "none") ) (define-method extents (of-object "PangoGlyphString") (c-name "pango_glyph_string_extents") (return-type "none") (parameters '("PangoFont*" "font") '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method extents_range (of-object "PangoGlyphString") (c-name "pango_glyph_string_extents_range") (return-type "none") (parameters '("int" "start") '("int" "end") '("PangoFont*" "font") '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_logical_widths (of-object "PangoGlyphString") (c-name "pango_glyph_string_get_logical_widths") (return-type "none") (parameters '("const-char*" "text") '("int" "length") '("int" "embedding_level") '("int*" "logical_widths") ) ) (define-method index_to_x (of-object "PangoGlyphString") (c-name "pango_glyph_string_index_to_x") (return-type "none") (parameters '("char*" "text") '("int" "length") '("PangoAnalysis*" "analysis") '("int" "index") '("gboolean" "trailing") '("int*" "x_pos") ) ) (define-method x_to_index (of-object "PangoGlyphString") (c-name "pango_glyph_string_x_to_index") (return-type "none") (parameters '("char*" "text") '("int" "length") '("PangoAnalysis*" "analysis") '("int" "x_pos") '("int*" "index") '("int*" "trailing") ) ) (define-function shape (c-name "pango_shape") (return-type "none") (parameters '("const-gchar*" "text") '("gint" "length") '("PangoAnalysis*" "analysis") '("PangoGlyphString*" "glyphs") ) ) (define-function reorder_items (c-name "pango_reorder_items") (return-type "GList*") (parameters '("GList*" "logical_items") ) ) ;; From pango-item.h (define-function item_get_type (c-name "pango_item_get_type") (return-type "GType") ) (define-function item_new (c-name "pango_item_new") (is-constructor-of "PangoItem") (return-type "PangoItem*") ) (define-method copy (of-object "PangoItem") (c-name "pango_item_copy") (return-type "PangoItem*") ) (define-method free (of-object "PangoItem") (c-name "pango_item_free") (return-type "none") ) (define-method split (of-object "PangoItem") (c-name "pango_item_split") (return-type "PangoItem*") (parameters '("int" "split_index") '("int" "split_offset") ) ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-layout.h (define-function pango_layout_get_type (c-name "pango_layout_get_type") (return-type "GType") ) (define-function pango_layout_new (c-name "pango_layout_new") (is-constructor-of "PangoLayout") (return-type "PangoLayout*") (parameters '("PangoContext*" "context") ) ) (define-method copy (of-object "PangoLayout") (c-name "pango_layout_copy") (return-type "PangoLayout*") ) (define-method get_context (of-object "PangoLayout") (c-name "pango_layout_get_context") (return-type "PangoContext*") ) (define-method set_attributes (of-object "PangoLayout") (c-name "pango_layout_set_attributes") (return-type "none") (parameters '("PangoAttrList*" "attrs") ) ) (define-method get_attributes (of-object "PangoLayout") (c-name "pango_layout_get_attributes") (return-type "PangoAttrList*") ) (define-method set_text (of-object "PangoLayout") (c-name "pango_layout_set_text") (return-type "none") (parameters '("const-char*" "text") '("int" "length") ) ) (define-method get_text (of-object "PangoLayout") (c-name "pango_layout_get_text") (return-type "const-char*") ) (define-method set_markup (of-object "PangoLayout") (c-name "pango_layout_set_markup") (return-type "none") (parameters '("const-char*" "markup") '("int" "length") ) ) (define-method set_markup_with_accel (of-object "PangoLayout") (c-name "pango_layout_set_markup_with_accel") (return-type "none") (parameters '("const-char*" "markup") '("int" "length") '("gunichar" "accel_marker") '("gunichar*" "accel_char") ) ) (define-method set_font_description (of-object "PangoLayout") (c-name "pango_layout_set_font_description") (return-type "none") (parameters '("const-PangoFontDescription*" "desc" (null-ok)) ) ) (define-method get_font_description (of-object "PangoLayout") (c-name "pango_layout_get_font_description") (return-type "const-PangoFontDescription*") ) (define-method set_width (of-object "PangoLayout") (c-name "pango_layout_set_width") (return-type "none") (parameters '("int" "width") ) ) (define-method get_width (of-object "PangoLayout") (c-name "pango_layout_get_width") (return-type "int") ) (define-method set_wrap (of-object "PangoLayout") (c-name "pango_layout_set_wrap") (return-type "none") (parameters '("PangoWrapMode" "wrap") ) ) (define-method get_wrap (of-object "PangoLayout") (c-name "pango_layout_get_wrap") (return-type "PangoWrapMode") ) (define-method is_wrapped (of-object "PangoLayout") (c-name "pango_layout_is_wrapped") (return-type "gboolean") ) (define-method set_indent (of-object "PangoLayout") (c-name "pango_layout_set_indent") (return-type "none") (parameters '("int" "indent") ) ) (define-method get_indent (of-object "PangoLayout") (c-name "pango_layout_get_indent") (return-type "int") ) (define-method set_spacing (of-object "PangoLayout") (c-name "pango_layout_set_spacing") (return-type "none") (parameters '("int" "spacing") ) ) (define-method get_spacing (of-object "PangoLayout") (c-name "pango_layout_get_spacing") (return-type "int") ) (define-method set_justify (of-object "PangoLayout") (c-name "pango_layout_set_justify") (return-type "none") (parameters '("gboolean" "justify") ) ) (define-method get_justify (of-object "PangoLayout") (c-name "pango_layout_get_justify") (return-type "gboolean") ) (define-method set_auto_dir (of-object "PangoLayout") (c-name "pango_layout_set_auto_dir") (return-type "none") (parameters '("gboolean" "auto_dir") ) ) (define-method get_auto_dir (of-object "PangoLayout") (c-name "pango_layout_get_auto_dir") (return-type "gboolean") ) (define-method set_alignment (of-object "PangoLayout") (c-name "pango_layout_set_alignment") (return-type "none") (parameters '("PangoAlignment" "alignment") ) ) (define-method get_alignment (of-object "PangoLayout") (c-name "pango_layout_get_alignment") (return-type "PangoAlignment") ) (define-method set_tabs (of-object "PangoLayout") (c-name "pango_layout_set_tabs") (return-type "none") (parameters '("PangoTabArray*" "tabs" (null-ok)) ) ) (define-method get_tabs (of-object "PangoLayout") (c-name "pango_layout_get_tabs") (return-type "PangoTabArray*") ) (define-method set_single_paragraph_mode (of-object "PangoLayout") (c-name "pango_layout_set_single_paragraph_mode") (return-type "none") (parameters '("gboolean" "setting") ) ) (define-method get_single_paragraph_mode (of-object "PangoLayout") (c-name "pango_layout_get_single_paragraph_mode") (return-type "gboolean") ) (define-method set_ellipsize (of-object "PangoLayout") (c-name "pango_layout_set_ellipsize") (return-type "none") (parameters '("PangoEllipsizeMode" "ellipsize") ) ) (define-method get_ellipsize (of-object "PangoLayout") (c-name "pango_layout_get_ellipsize") (return-type "PangoEllipsizeMode") ) (define-method is_ellipsized (of-object "PangoLayout") (c-name "pango_layout_is_ellipsized") (return-type "gboolean") ) (define-method get_unknown_glyphs_count (of-object "PangoLayout") (c-name "pango_layout_get_unknown_glyphs_count") (return-type "int") ) (define-method context_changed (of-object "PangoLayout") (c-name "pango_layout_context_changed") (return-type "none") ) (define-method get_log_attrs (of-object "PangoLayout") (c-name "pango_layout_get_log_attrs") (return-type "none") (parameters '("PangoLogAttr**" "attrs") '("gint*" "n_attrs") ) ) (define-method index_to_pos (of-object "PangoLayout") (c-name "pango_layout_index_to_pos") (return-type "none") (parameters '("int" "index") '("PangoRectangle*" "pos") ) ) (define-method get_cursor_pos (of-object "PangoLayout") (c-name "pango_layout_get_cursor_pos") (return-type "none") (parameters '("int" "index") '("PangoRectangle*" "strong_pos") '("PangoRectangle*" "weak_pos") ) ) (define-method move_cursor_visually (of-object "PangoLayout") (c-name "pango_layout_move_cursor_visually") (return-type "none") (parameters '("gboolean" "strong") '("int" "old_index") '("int" "old_trailing") '("int" "direction") '("int*" "new_index") '("int*" "new_trailing") ) ) (define-method xy_to_index (of-object "PangoLayout") (c-name "pango_layout_xy_to_index") (return-type "gboolean") (parameters '("int" "x") '("int" "y") '("int*" "index") '("int*" "trailing") ) ) (define-method get_extents (of-object "PangoLayout") (c-name "pango_layout_get_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_pixel_extents (of-object "PangoLayout") (c-name "pango_layout_get_pixel_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_size (of-object "PangoLayout") (c-name "pango_layout_get_size") (return-type "none") (parameters '("int*" "width") '("int*" "height") ) ) (define-method get_pixel_size (of-object "PangoLayout") (c-name "pango_layout_get_pixel_size") (return-type "none") (parameters '("int*" "width") '("int*" "height") ) ) (define-method get_line_count (of-object "PangoLayout") (c-name "pango_layout_get_line_count") (return-type "int") ) (define-method get_line (of-object "PangoLayout") (c-name "pango_layout_get_line") (return-type "PangoLayoutLine*") (parameters '("int" "line") ) ) (define-method get_line_readonly (of-object "PangoLayout") (c-name "pango_layout_get_line_readonly") (return-type "PangoLayoutLine*") (parameters '("int" "line") ) ) (define-method get_lines (of-object "PangoLayout") (c-name "pango_layout_get_lines") (return-type "GSList*") ) (define-method get_lines_readonly (of-object "PangoLayout") (c-name "pango_layout_get_lines_readonly") (return-type "GSList*") ) (define-function layout_line_get_type (c-name "pango_layout_line_get_type") (return-type "GType") ) (define-method ref (of-object "PangoLayoutLine") (c-name "pango_layout_line_ref") (return-type "PangoLayoutLine*") ) (define-method unref (of-object "PangoLayoutLine") (c-name "pango_layout_line_unref") (return-type "none") ) (define-method x_to_index (of-object "PangoLayoutLine") (c-name "pango_layout_line_x_to_index") (return-type "gboolean") (parameters '("int" "x_pos") '("int*" "index") '("int*" "trailing") ) ) (define-method index_to_x (of-object "PangoLayoutLine") (c-name "pango_layout_line_index_to_x") (return-type "none") (parameters '("int" "index") '("gboolean" "trailing") '("int*" "x_pos") ) ) (define-method get_x_ranges (of-object "PangoLayoutLine") (c-name "pango_layout_line_get_x_ranges") (return-type "none") (parameters '("int" "start_index") '("int" "end_index") '("int**" "ranges") '("int*" "n_ranges") ) ) (define-method get_extents (of-object "PangoLayoutLine") (c-name "pango_layout_line_get_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_pixel_extents (of-object "PangoLayoutLine") (c-name "pango_layout_line_get_pixel_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-function pango_layout_iter_get_type (c-name "pango_layout_iter_get_type") (return-type "GType") ) (define-method get_iter (of-object "PangoLayout") (c-name "pango_layout_get_iter") (return-type "PangoLayoutIter*") ) (define-method free (of-object "PangoLayoutIter") (c-name "pango_layout_iter_free") (return-type "none") ) (define-method get_index (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_index") (return-type "int") ) (define-method get_run (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_run") (return-type "PangoLayoutRun*") ) (define-method get_run_readonly (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_run_readonly") (return-type "PangoLayoutRun*") ) (define-method get_line (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_line") (return-type "PangoLayoutLine*") ) (define-method get_line_readonly (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_line_readonly") (return-type "PangoLayoutLine*") ) (define-method at_last_line (of-object "PangoLayoutIter") (c-name "pango_layout_iter_at_last_line") (return-type "gboolean") ) (define-method next_char (of-object "PangoLayoutIter") (c-name "pango_layout_iter_next_char") (return-type "gboolean") ) (define-method next_cluster (of-object "PangoLayoutIter") (c-name "pango_layout_iter_next_cluster") (return-type "gboolean") ) (define-method next_run (of-object "PangoLayoutIter") (c-name "pango_layout_iter_next_run") (return-type "gboolean") ) (define-method next_line (of-object "PangoLayoutIter") (c-name "pango_layout_iter_next_line") (return-type "gboolean") ) (define-method get_char_extents (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_char_extents") (return-type "none") (parameters '("PangoRectangle*" "logical_rect") ) ) (define-method get_cluster_extents (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_cluster_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_run_extents (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_run_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_line_extents (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_line_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_line_yrange (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_line_yrange") (return-type "none") (parameters '("int*" "y0") '("int*" "y1") ) ) (define-method get_layout_extents (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_layout_extents") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-method get_baseline (of-object "PangoLayoutIter") (c-name "pango_layout_iter_get_baseline") (return-type "int") ) ;; From pango-modules.h (ifdef PANGO_ENABLE_BACKEND (define-function find_map (c-name "pango_find_map") (return-type "PangoMap*") (parameters '("PangoLanguage*" "language") '("guint" "engine_type_id") '("guint" "render_type_id") ) ) (define-method get_engine (of-object "PangoMap") (c-name "pango_map_get_engine") (return-type "PangoEngine*") (parameters '("PangoScript" "script") ) ) (define-method get_engines (of-object "PangoMap") (c-name "pango_map_get_engines") (return-type "none") (parameters '("PangoScript" "script") '("GSList**" "exact_engines") '("GSList**" "fallback_engines") ) ) (define-function module_register (c-name "pango_module_register") (return-type "none") (parameters '("PangoIncludedModule*" "module") ) ) ) ;; PANGO_ENABLE_BACKEND ;; From /home/jdahlin/dev/gtk-2.8/pango/pango/pango-renderer.h (define-function pango_renderer_get_type (c-name "pango_renderer_get_type") (return-type "GType") ) (define-method draw_layout (of-object "PangoRenderer") (c-name "pango_renderer_draw_layout") (return-type "none") (parameters '("PangoLayout*" "layout") '("int" "x") '("int" "y") ) ) (define-method draw_layout_line (of-object "PangoRenderer") (c-name "pango_renderer_draw_layout_line") (return-type "none") (parameters '("PangoLayoutLine*" "line") '("int" "x") '("int" "y") ) ) (define-method draw_glyphs (of-object "PangoRenderer") (c-name "pango_renderer_draw_glyphs") (return-type "none") (parameters '("PangoFont*" "font") '("PangoGlyphString*" "glyphs") '("int" "x") '("int" "y") ) ) (define-method draw_rectangle (of-object "PangoRenderer") (c-name "pango_renderer_draw_rectangle") (return-type "none") (parameters '("PangoRenderPart" "part") '("int" "x") '("int" "y") '("int" "width") '("int" "height") ) ) (define-method draw_error_underline (of-object "PangoRenderer") (c-name "pango_renderer_draw_error_underline") (return-type "none") (parameters '("int" "x") '("int" "y") '("int" "width") '("int" "height") ) ) (define-method draw_trapezoid (of-object "PangoRenderer") (c-name "pango_renderer_draw_trapezoid") (return-type "none") (parameters '("PangoRenderPart" "part") '("double" "y1_") '("double" "x11") '("double" "x21") '("double" "y2") '("double" "x12") '("double" "x22") ) ) (define-method draw_glyph (of-object "PangoRenderer") (c-name "pango_renderer_draw_glyph") (return-type "none") (parameters '("PangoFont*" "font") '("PangoGlyph" "glyph") '("double" "x") '("double" "y") ) ) (define-method activate (of-object "PangoRenderer") (c-name "pango_renderer_activate") (return-type "none") ) (define-method deactivate (of-object "PangoRenderer") (c-name "pango_renderer_deactivate") (return-type "none") ) (define-method part_changed (of-object "PangoRenderer") (c-name "pango_renderer_part_changed") (return-type "none") (parameters '("PangoRenderPart" "part") ) ) (define-method set_color (of-object "PangoRenderer") (c-name "pango_renderer_set_color") (return-type "none") (parameters '("PangoRenderPart" "part") '("const-PangoColor*" "color") ) ) (define-method get_color (of-object "PangoRenderer") (c-name "pango_renderer_get_color") (return-type "PangoColor*") (parameters '("PangoRenderPart" "part") ) ) (define-method set_matrix (of-object "PangoRenderer") (c-name "pango_renderer_set_matrix") (return-type "none") (parameters '("const-PangoMatrix*" "matrix") ) ) (define-method get_matrix (of-object "PangoRenderer") (c-name "pango_renderer_get_matrix") (return-type "const-PangoMatrix*") ) (define-virtual draw_glyphs (of-object "PangoRenderer") (return-type "none") (parameters '("PangoFont*" "font") '("PangoGlyphString*" "glyphs") '("int" "x") '("int" "y") ) ) (define-virtual draw_rectangle (of-object "PangoRenderer") (return-type "none") (parameters '("PangoRenderPart" "part") '("int" "x") '("int" "y") '("int" "width") '("int" "height") ) ) (define-virtual draw_error_underline (of-object "PangoRenderer") (return-type "none") (parameters '("int" "x") '("int" "y") '("int" "width") '("int" "height") ) ) (define-virtual draw_shape (of-object "PangoRenderer") (return-type "none") (parameters '("PangoAttrShape*" "attr") '("int" "x") '("int" "y") ) ) (define-virtual draw_trapezoid (of-object "PangoRenderer") (return-type "none") (parameters '("PangoRenderPart" "part") '("double" "y1_") '("double" "x11") '("double" "x21") '("double" "y2") '("double" "x12") '("double" "x22") ) ) (define-virtual draw_glyph (of-object "PangoRenderer") (return-type "none") (parameters '("PangoFont*" "font") '("PangoGlyph" "glyph") '("double" "x") '("double" "y") ) ) (define-virtual part_changed (of-object "PangoRenderer") (return-type "none") (parameters '("PangoRenderPart" "part") ) ) (define-virtual begin (of-object "PangoRenderer") (return-type "none") ) (define-virtual end (of-object "PangoRenderer") (return-type "none") ) (define-virtual prepare_run (of-object "PangoRenderer") (return-type "none") (parameters '("PangoLayoutRun*" "run") ) ) ;; From pango-script.h (define-function script_for_unichar (c-name "pango_script_for_unichar") (return-type "PangoScript") (parameters '("gunichar" "ch") ) ) (define-function script_iter_new (c-name "pango_script_iter_new") (is-constructor-of "PangoScriptIter") (return-type "PangoScriptIter*") (parameters '("const-char*" "text") '("int" "length") ) ) (define-method get_range (of-object "PangoScriptIter") (c-name "pango_script_iter_get_range") (return-type "none") (parameters '("const-char**" "start") '("const-char**" "end") '("PangoScript*" "script") ) ) (define-method next (of-object "PangoScriptIter") (c-name "pango_script_iter_next") (return-type "gboolean") ) (define-method free (of-object "PangoScriptIter") (c-name "pango_script_iter_free") (return-type "none") ) (define-function get_sample_language (c-name "pango_script_get_sample_language") (return-type "PangoLanguage*") (parameters '("PangoScript" "script") ) ) (define-method includes_script (of-object "PangoLanguage") (c-name "pango_language_includes_script") (return-type "gboolean") (parameters '("PangoScript" "script") ) ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-tabs.h (define-function pango_tab_array_new (c-name "pango_tab_array_new") (is-constructor-of "PangoTabArray") (return-type "PangoTabArray*") (parameters '("gint" "initial_size") '("gboolean" "positions_in_pixels") ) ) (define-function pango_tab_array_new_with_positions (c-name "pango_tab_array_new_with_positions") (is-constructor-of "PangoTabArray") (return-type "PangoTabArray*") (parameters '("gint" "size") '("gboolean" "positions_in_pixels") '("PangoTabAlign" "first_alignment") '("gint" "first_position") ) (varargs #t) ) (define-function pango_tab_array_get_type (c-name "pango_tab_array_get_type") (return-type "GType") ) (define-method copy (of-object "PangoTabArray") (c-name "pango_tab_array_copy") (return-type "PangoTabArray*") ) (define-method free (of-object "PangoTabArray") (c-name "pango_tab_array_free") (return-type "none") ) (define-method get_size (of-object "PangoTabArray") (c-name "pango_tab_array_get_size") (return-type "gint") ) (define-method resize (of-object "PangoTabArray") (c-name "pango_tab_array_resize") (return-type "none") (parameters '("gint" "new_size") ) ) (define-method set_tab (of-object "PangoTabArray") (c-name "pango_tab_array_set_tab") (return-type "none") (parameters '("gint" "tab_index") '("PangoTabAlign" "alignment") '("gint" "location") ) ) (define-method get_tab (of-object "PangoTabArray") (c-name "pango_tab_array_get_tab") (return-type "none") (parameters '("gint" "tab_index") '("PangoTabAlign*" "alignment") '("gint*" "location") ) ) (define-method get_tabs (of-object "PangoTabArray") (c-name "pango_tab_array_get_tabs") (return-type "none") (parameters '("PangoTabAlign**" "alignments") '("gint**" "locations") ) ) (define-method get_positions_in_pixels (of-object "PangoTabArray") (c-name "pango_tab_array_get_positions_in_pixels") (return-type "gboolean") ) ;; From /opt/gtk2/include/pango-1.0/pango/pango-types.h (define-function matrix_get_type (c-name "pango_matrix_get_type") (return-type "GType") ) (define-method copy (of-object "PangoMatrix") (c-name "pango_matrix_copy") (return-type "PangoMatrix*") ) (define-method free (of-object "PangoMatrix") (c-name "pango_matrix_free") (return-type "none") ) (define-method translate (of-object "PangoMatrix") (c-name "pango_matrix_translate") (return-type "none") (parameters '("double" "tx") '("double" "ty") ) ) (define-method scale (of-object "PangoMatrix") (c-name "pango_matrix_scale") (return-type "none") (parameters '("double" "scale_x") '("double" "scale_y") ) ) (define-method rotate (of-object "PangoMatrix") (c-name "pango_matrix_rotate") (return-type "none") (parameters '("double" "degrees") ) ) (define-method concat (of-object "PangoMatrix") (c-name "pango_matrix_concat") (return-type "none") (parameters '("const-PangoMatrix*" "new_matrix") ) ) (define-method transform_point (of-object "PangoMatrix") (c-name "pango_matrix_transform_point") (return-type "none") (parameters '("double*" "x") '("double*" "y") ) ) (define-method transform_distance (of-object "PangoMatrix") (c-name "pango_matrix_transform_distance") (return-type "none") (parameters '("double*" "dx") '("double*" "dy") ) ) (define-method transform_rectangle (of-object "PangoMatrix") (c-name "pango_matrix_transform_rectangle") (return-type "none") (parameters '("PangoRectangle*" "rect") ) ) (define-method transform_pixel_rectangle (of-object "PangoMatrix") (c-name "pango_matrix_transform_pixel_rectangle") (return-type "none") (parameters '("PangoRectangle*" "rect") ) ) (define-function language_get_type (c-name "pango_language_get_type") (return-type "GType") ) (define-function pango_language_from_string (is-constructor-of "PangoLanguage") (c-name "pango_language_from_string") (return-type "PangoLanguage*") (parameters '("const-char*" "language") ) ) (define-function pango_language_from_string (c-name "pango_language_from_string1") (return-type "PangoLanguage*") (parameters '("const-char*" "language") ) (deprecated "use pango.Language instead") ) (define-function pango_language_matches (c-name "pango_language_matches1") (return-type "gboolean") (parameters '("PangoLanguage*" "language" (null-ok)) '("const-char*" "range_list") ) (deprecated "use pango.Language.matches instead") ) (define-method matches (of-object "PangoLanguage") (c-name "pango_language_matches") (return-type "gboolean") (parameters '("const-char*" "range_list") ) ) (define-method to_string (of-object "PangoLanguage") (c-name "pango_language_to_string") (return-type "const-char*") ) (define-function get_mirror_char (c-name "pango_get_mirror_char") (return-type "gboolean") (parameters '("gunichar" "ch") '("gunichar*" "mirrored_ch") ) (deprecated "deprecated") ) (define-function unichar_direction (c-name "pango_unichar_direction") (return-type "PangoDirection") (parameters '("gunichar" "ch") ) ) (define-function find_base_dir (c-name "pango_find_base_dir") (return-type "PangoDirection") (parameters '("const-gchar*" "text") '("gint" "length") ) ) (define-function extents_to_pixels (c-name "pango_extents_to_pixels") (return-type "none") (parameters '("PangoRectangle*" "ink_rect") '("PangoRectangle*" "logical_rect") ) ) (define-function units_from_double (c-name "pango_units_from_double") (return-type "int") (parameters '("double" "d") ) ) (define-function units_to_double (c-name "pango_units_to_double") (return-type "double") (parameters '("int" "i") ) ) ;; (define-function PIXELS (c-name "PANGO_PIXELS") (return-type "gint") (parameters '("gint" "size") ) ) (define-function ASCENT (c-name "PANGO_ASCENT") (return-type "gint") (parameters '("PangoRectangle" "rect") ) ) (define-function DESCENT (c-name "PANGO_DESCENT") (return-type "gint") (parameters '("PangoRectangle" "rect") ) ) (define-function LBEARING (c-name "PANGO_LBEARING") (return-type "gint") (parameters '("PangoRectangle" "rect") ) ) (define-function RBEARING (c-name "PANGO_RBEARING") (return-type "gint") (parameters '("PangoRectangle" "rect") ) ) ;; From pango-utils.h (ifdef USE_PANGO_UTILS (define-function split_file_list (c-name "pango_split_file_list") (return-type "char**") (parameters '("const-char*" "str") ) ) (define-function trim_string (c-name "pango_trim_string") (return-type "char*") (parameters '("const-char*" "str") ) ) (define-function read_line (c-name "pango_read_line") (return-type "gint") (parameters '("FILE*" "stream") '("GString*" "str") ) ) (define-function skip_space (c-name "pango_skip_space") (return-type "gboolean") (parameters '("const-char**" "pos") ) ) (define-function scan_word (c-name "pango_scan_word") (return-type "gboolean") (parameters '("const-char**" "pos") '("GString*" "out") ) ) (define-function scan_string (c-name "pango_scan_string") (return-type "gboolean") (parameters '("const-char**" "pos") '("GString*" "out") ) ) (define-function scan_int (c-name "pango_scan_int") (return-type "gboolean") (parameters '("const-char**" "pos") '("int*" "out") ) ) (define-function config_key_get (c-name "pango_config_key_get") (return-type "char*") (parameters '("const-char*" "key") ) ) (define-function lookup_aliases (c-name "pango_lookup_aliases") (return-type "none") (parameters '("const-char*" "fontname") '("char***" "families") '("int*" "n_families") ) ) (define-function parse_enum (c-name "pango_parse_enum") (return-type "gboolean") (parameters '("GType" "type") '("const-char*" "str") '("int*" "value") '("gboolean" "warn") '("char**" "possible_values") ) ) (define-function parse_style (c-name "pango_parse_style") (return-type "gboolean") (parameters '("const-char*" "str") '("PangoStyle*" "style") '("gboolean" "warn") ) ) (define-function parse_variant (c-name "pango_parse_variant") (return-type "gboolean") (parameters '("const-char*" "str") '("PangoVariant*" "variant") '("gboolean" "warn") ) ) (define-function parse_weight (c-name "pango_parse_weight") (return-type "gboolean") (parameters '("const-char*" "str") '("PangoWeight*" "weight") '("gboolean" "warn") ) ) (define-function parse_stretch (c-name "pango_parse_stretch") (return-type "gboolean") (parameters '("const-char*" "str") '("PangoStretch*" "stretch") '("gboolean" "warn") ) ) (define-function get_sysconf_subdirectory (c-name "pango_get_sysconf_subdirectory") (return-type "const-char*") ) (define-function get_lib_subdirectory (c-name "pango_get_lib_subdirectory") (return-type "const-char*") ) (define-function log2vis_get_embedding_levels (c-name "pango_log2vis_get_embedding_levels") (return-type "guint8*") (parameters '("const-gchar*" "text") '("int" "length") '("PangoDirection*" "pbase_dir") ) ) (define-method get_sample_string (of-object "PangoLanguage") (c-name "pango_language_get_sample_string") (return-type "const-char*") ) (define-function language_get_default (c-name "pango_language_get_default") (return-type "PangoLanguage*") ) (define-function is_zero_width (c-name "pango_is_zero_width") (return-type "gboolean") (parameters '("gunichar" "ch") ) ) ) ;; USE_PANGO_UTILS (define-function version (c-name "pango_version") (return-type "int") ) (define-function version_string (c-name "pango_version_string") (return-type "const-char*") ) (define-function version_check (c-name "pango_version_check") (return-type "const-char*") (parameters '("int" "required_major") '("int" "required_minor") '("int" "required_micro") ) ) ./pygtk-2.14.1-i686/usr/share/pygtk/2.0/defs/pango-types.defs0000644000000000000000000003027711272037107021675 0ustar rootroot;; -*- scheme -*- ;; boxed definitions ... (define-boxed AttrList (in-module "Pango") (c-name "PangoAttrList") (gtype-id "PANGO_TYPE_ATTR_LIST") (copy-func "pango_attr_list_ref") (release-func "pango_attr_list_unref") ) (define-boxed Color (in-module "Pango") (c-name "PangoColor") (gtype-id "PANGO_TYPE_COLOR") (copy-func "pango_color_copy") (release-func "pango_color_free") (fields '("guint16" "red") '("guint16" "green") '("guint16" "blue") ) ) (define-boxed FontDescription (in-module "Pango") (c-name "PangoFontDescription") (gtype-id "PANGO_TYPE_FONT_DESCRIPTION") (copy-func "pango_font_description_copy") (release-func "pango_font_description_free") ) (define-boxed FontMetrics (in-module "Pango") (c-name "PangoFontMetrics") (gtype-id "PANGO_TYPE_FONT_METRICS") (copy-func "pango_font_metrics_ref") (release-func "pango_font_metrics_unref") ) (define-boxed GlyphString (in-module "Pango") (c-name "PangoGlyphString") (gtype-id "PANGO_TYPE_GLYPH_STRING") (copy-func "pango_glyph_string_copy") (release-func "pango_glyph_string_free") (fields '("gint" "num_glyphs") '("PangoGlyphInfo*" "glyphs") '("gint*" "log_clusters") ) ) (define-boxed Item (in-module "Pango") (c-name "PangoItem") (fields '("gint" "offset") '("gint" "length") '("gint" "num_chars") '("PangoEngineShape*" "analysis.shape_engine") '("PangoEngineLang*" "analysis.lang_engine") '("PangoFont*" "analysis.font") '("guint8" "analysis.level") '("PangoLanguage*" "analysis.language") '("GSList*" "analysis.extra_attrs") ) (gtype-id "PANGO_TYPE_ITEM") ) (define-boxed Language (in-module "Pango") (c-name "PangoLanguage") (gtype-id "PANGO_TYPE_LANGUAGE") ) (define-boxed LayoutIter (in-module "Pango") (c-name "PangoLayoutIter") (gtype-id "PANGO_TYPE_LAYOUT_ITER") (release-func "pango_layout_iter_free") ) (define-boxed LayoutLine (in-module "Pango") (c-name "PangoLayoutLine") (gtype-id "PANGO_TYPE_LAYOUT_LINE") (fields ; '("PangoLayout*" "layout") ;; omitted for fear of creating reference cycles '("gint" "start_index") '("gint" "length") '("GSList*" "runs") '("guint" "is_paragraph_start") '("guint" "resolved_dir") ) ) (define-boxed Matrix (in-module "Pango") (c-name "PangoMatrix") (gtype-id "PANGO_TYPE_MATRIX") ) (define-boxed TabArray (in-module "Pango") (c-name "PangoTabArray") (gtype-id "PANGO_TYPE_TAB_ARRAY") (copy-func "pango_tab_array_copy") (release-func "pango_tab_array_free") ) ; object definitions ... (define-object Context (in-module "Pango") (parent "GObject") (c-name "PangoContext") (gtype-id "PANGO_TYPE_CONTEXT") ) (define-object Engine (in-module "Pango") (parent "GObject") (c-name "PangoEngine") (gtype-id "PANGO_TYPE_ENGINE") ) (define-object EngineLang (in-module "Pango") (parent "PangoEngine") (c-name "PangoEngineLang") (gtype-id "PANGO_TYPE_ENGINE_LANG") ) (define-object EngineShape (in-module "Pango") (parent "PangoEngine") (c-name "PangoEngineShape") (gtype-id "PANGO_TYPE_ENGINE_SHAPE") ) (define-object Font (in-module "Pango") (parent "GObject") (c-name "PangoFont") (gtype-id "PANGO_TYPE_FONT") ) (define-object FontFace (in-module "Pango") (parent "GObject") (c-name "PangoFontFace") (gtype-id "PANGO_TYPE_FONT_FACE") ) (define-object FontFamily (in-module "Pango") (parent "GObject") (c-name "PangoFontFamily") (gtype-id "PANGO_TYPE_FONT_FAMILY") ) (define-object FontMap (in-module "Pango") (parent "GObject") (c-name "PangoFontMap") (gtype-id "PANGO_TYPE_FONT_MAP") ) (define-object Fontset (in-module "Pango") (parent "GObject") (c-name "PangoFontset") (gtype-id "PANGO_TYPE_FONTSET") ) (define-object FontsetSimple (in-module "Pango") (parent "PangoFontset") (c-name "PangoFontsetSimple") (gtype-id "PANGO_TYPE_FONTSET_SIMPLE") ) (define-object Layout (in-module "Pango") (parent "GObject") (c-name "PangoLayout") (gtype-id "PANGO_TYPE_LAYOUT") ) (define-object Renderer (in-module "Pango") (parent "GObject") (c-name "PangoRenderer") (gtype-id "PANGO_TYPE_RENDERER") ) ;; Enumerations and flags ... (define-enum Alignment (in-module "Pango") (c-name "PangoAlignment") (gtype-id "PANGO_TYPE_ALIGNMENT") (values '("left" "PANGO_ALIGN_LEFT") '("center" "PANGO_ALIGN_CENTER") '("right" "PANGO_ALIGN_RIGHT") ) ) (define-enum AttrType (in-module "Pango") (c-name "PangoAttrType") (gtype-id "PANGO_TYPE_ATTR_TYPE") (values '("invalid" "PANGO_ATTR_INVALID") '("language" "PANGO_ATTR_LANGUAGE") '("family" "PANGO_ATTR_FAMILY") '("style" "PANGO_ATTR_STYLE") '("weight" "PANGO_ATTR_WEIGHT") '("variant" "PANGO_ATTR_VARIANT") '("stretch" "PANGO_ATTR_STRETCH") '("size" "PANGO_ATTR_SIZE") '("font-desc" "PANGO_ATTR_FONT_DESC") '("foreground" "PANGO_ATTR_FOREGROUND") '("background" "PANGO_ATTR_BACKGROUND") '("underline" "PANGO_ATTR_UNDERLINE") '("strikethrough" "PANGO_ATTR_STRIKETHROUGH") '("rise" "PANGO_ATTR_RISE") '("shape" "PANGO_ATTR_SHAPE") '("scale" "PANGO_ATTR_SCALE") '("fallback" "PANGO_ATTR_FALLBACK") '("letter-spacing" "PANGO_ATTR_LETTER_SPACING") '("underline-color" "PANGO_ATTR_UNDERLINE_COLOR") '("strikethrough-color" "PANGO_ATTR_STRIKETHROUGH_COLOR") '("absolute-size" "PANGO_ATTR_ABSOLUTE_SIZE") ) ) (define-enum CoverageLevel (in-module "Pango") (c-name "PangoCoverageLevel") (gtype-id "PANGO_TYPE_COVERAGE_LEVEL") (values '("none" "PANGO_COVERAGE_NONE") '("fallback" "PANGO_COVERAGE_FALLBACK") '("approximate" "PANGO_COVERAGE_APPROXIMATE") '("exact" "PANGO_COVERAGE_EXACT") ) ) (define-enum Direction (in-module "Pango") (c-name "PangoDirection") (gtype-id "PANGO_TYPE_DIRECTION") (values '("ltr" "PANGO_DIRECTION_LTR") '("rtl" "PANGO_DIRECTION_RTL") '("ttb-ltr" "PANGO_DIRECTION_TTB_LTR") '("ttb-rtl" "PANGO_DIRECTION_TTB_RTL") '("weak-ltr" "PANGO_DIRECTION_WEAK_LTR") '("weak-rtl" "PANGO_DIRECTION_WEAK_RTL") '("neutral" "PANGO_DIRECTION_NEUTRAL") ) ) (define-enum EllipsizeMode (in-module "Pango") (c-name "PangoEllipsizeMode") (gtype-id "PANGO_TYPE_ELLIPSIZE_MODE") (values '("none" "PANGO_ELLIPSIZE_NONE") '("start" "PANGO_ELLIPSIZE_START") '("middle" "PANGO_ELLIPSIZE_MIDDLE") '("end" "PANGO_ELLIPSIZE_END") ) ) (define-enum Gravity (in-module "Pango") (c-name "PangoGravity") (gtype-id "PANGO_TYPE_GRAVITY") (values '("south" "PANGO_GRAVITY_SOUTH") '("east" "PANGO_GRAVITY_EAST") '("north" "PANGO_GRAVITY_NORTH") '("west" "PANGO_GRAVITY_WEST") '("auto" "PANGO_GRAVITY_AUTO") ) ) (define-enum GravityHint (in-module "Pango") (c-name "PangoGravityHint") (gtype-id "PANGO_TYPE_GRAVITY_HINT") (values '("natural" "PANGO_GRAVITY_HINT_NATURAL") '("strong" "PANGO_GRAVITY_HINT_STRONG") '("line" "PANGO_GRAVITY_HINT_LINE") ) ) (define-enum RenderPart (in-module "Pango") (c-name "PangoRenderPart") (gtype-id "PANGO_TYPE_RENDER_PART") (values '("foreground" "PANGO_RENDER_PART_FOREGROUND") '("background" "PANGO_RENDER_PART_BACKGROUND") '("underline" "PANGO_RENDER_PART_UNDERLINE") '("strikethrough" "PANGO_RENDER_PART_STRIKETHROUGH") ) ) (define-enum Script (in-module "Pango") (c-name "PangoScript") (gtype-id "PANGO_TYPE_SCRIPT") (values '("invalid-code" "PANGO_SCRIPT_INVALID_CODE") '("common" "PANGO_SCRIPT_COMMON") '("inherited" "PANGO_SCRIPT_INHERITED") '("arabic" "PANGO_SCRIPT_ARABIC") '("armenian" "PANGO_SCRIPT_ARMENIAN") '("bengali" "PANGO_SCRIPT_BENGALI") '("bopomofo" "PANGO_SCRIPT_BOPOMOFO") '("cherokee" "PANGO_SCRIPT_CHEROKEE") '("coptic" "PANGO_SCRIPT_COPTIC") '("cyrillic" "PANGO_SCRIPT_CYRILLIC") '("deseret" "PANGO_SCRIPT_DESERET") '("devanagari" "PANGO_SCRIPT_DEVANAGARI") '("ethiopic" "PANGO_SCRIPT_ETHIOPIC") '("georgian" "PANGO_SCRIPT_GEORGIAN") '("gothic" "PANGO_SCRIPT_GOTHIC") '("greek" "PANGO_SCRIPT_GREEK") '("gujarati" "PANGO_SCRIPT_GUJARATI") '("gurmukhi" "PANGO_SCRIPT_GURMUKHI") '("han" "PANGO_SCRIPT_HAN") '("hangul" "PANGO_SCRIPT_HANGUL") '("hebrew" "PANGO_SCRIPT_HEBREW") '("hiragana" "PANGO_SCRIPT_HIRAGANA") '("kannada" "PANGO_SCRIPT_KANNADA") '("katakana" "PANGO_SCRIPT_KATAKANA") '("khmer" "PANGO_SCRIPT_KHMER") '("lao" "PANGO_SCRIPT_LAO") '("latin" "PANGO_SCRIPT_LATIN") '("malayalam" "PANGO_SCRIPT_MALAYALAM") '("mongolian" "PANGO_SCRIPT_MONGOLIAN") '("myanmar" "PANGO_SCRIPT_MYANMAR") '("ogham" "PANGO_SCRIPT_OGHAM") '("old-italic" "PANGO_SCRIPT_OLD_ITALIC") '("oriya" "PANGO_SCRIPT_ORIYA") '("runic" "PANGO_SCRIPT_RUNIC") '("sinhala" "PANGO_SCRIPT_SINHALA") '("syriac" "PANGO_SCRIPT_SYRIAC") '("tamil" "PANGO_SCRIPT_TAMIL") '("telugu" "PANGO_SCRIPT_TELUGU") '("thaana" "PANGO_SCRIPT_THAANA") '("thai" "PANGO_SCRIPT_THAI") '("tibetan" "PANGO_SCRIPT_TIBETAN") '("canadian-aboriginal" "PANGO_SCRIPT_CANADIAN_ABORIGINAL") '("yi" "PANGO_SCRIPT_YI") '("tagalog" "PANGO_SCRIPT_TAGALOG") '("hanunoo" "PANGO_SCRIPT_HANUNOO") '("buhid" "PANGO_SCRIPT_BUHID") '("tagbanwa" "PANGO_SCRIPT_TAGBANWA") '("braille" "PANGO_SCRIPT_BRAILLE") '("cypriot" "PANGO_SCRIPT_CYPRIOT") '("limbu" "PANGO_SCRIPT_LIMBU") '("osmanya" "PANGO_SCRIPT_OSMANYA") '("shavian" "PANGO_SCRIPT_SHAVIAN") '("linear-b" "PANGO_SCRIPT_LINEAR_B") '("tai-le" "PANGO_SCRIPT_TAI_LE") '("ugaritic" "PANGO_SCRIPT_UGARITIC") '("new-tai-lue" "PANGO_SCRIPT_NEW_TAI_LUE") '("buginese" "PANGO_SCRIPT_BUGINESE") '("glagolitic" "PANGO_SCRIPT_GLAGOLITIC") '("tifinagh" "PANGO_SCRIPT_TIFINAGH") '("syloti-nagri" "PANGO_SCRIPT_SYLOTI_NAGRI") '("old-persian" "PANGO_SCRIPT_OLD_PERSIAN") '("kharoshthi" "PANGO_SCRIPT_KHAROSHTHI") ) ) (define-enum Stretch (in-module "Pango") (c-name "PangoStretch") (gtype-id "PANGO_TYPE_STRETCH") (values '("ultra-condensed" "PANGO_STRETCH_ULTRA_CONDENSED") '("extra-condensed" "PANGO_STRETCH_EXTRA_CONDENSED") '("condensed" "PANGO_STRETCH_CONDENSED") '("semi-condensed" "PANGO_STRETCH_SEMI_CONDENSED") '("normal" "PANGO_STRETCH_NORMAL") '("semi-expanded" "PANGO_STRETCH_SEMI_EXPANDED") '("expanded" "PANGO_STRETCH_EXPANDED") '("extra-expanded" "PANGO_STRETCH_EXTRA_EXPANDED") '("ultra-expanded" "PANGO_STRETCH_ULTRA_EXPANDED") ) ) (define-enum Style (in-module "Pango") (c-name "PangoStyle") (gtype-id "PANGO_TYPE_STYLE") (values '("normal" "PANGO_STYLE_NORMAL") '("oblique" "PANGO_STYLE_OBLIQUE") '("italic" "PANGO_STYLE_ITALIC") ) ) (define-enum TabAlign (in-module "Pango") (c-name "PangoTabAlign") (gtype-id "PANGO_TYPE_TAB_ALIGN") (values '("left" "PANGO_TAB_LEFT") ) ) (define-enum Underline (in-module "Pango") (c-name "PangoUnderline") (gtype-id "PANGO_TYPE_UNDERLINE") (values '("none" "PANGO_UNDERLINE_NONE") '("single" "PANGO_UNDERLINE_SINGLE") '("double" "PANGO_UNDERLINE_DOUBLE") '("low" "PANGO_UNDERLINE_LOW") '("error" "PANGO_UNDERLINE_ERROR") ) ) (define-enum Variant (in-module "Pango") (c-name "PangoVariant") (gtype-id "PANGO_TYPE_VARIANT") (values '("normal" "PANGO_VARIANT_NORMAL") '("small-caps" "PANGO_VARIANT_SMALL_CAPS") ) ) (define-enum Weight (in-module "Pango") (c-name "PangoWeight") (gtype-id "PANGO_TYPE_WEIGHT") (values '("ultralight" "PANGO_WEIGHT_ULTRALIGHT") '("light" "PANGO_WEIGHT_LIGHT") '("normal" "PANGO_WEIGHT_NORMAL") '("semibold" "PANGO_WEIGHT_SEMIBOLD") '("bold" "PANGO_WEIGHT_BOLD") '("ultrabold" "PANGO_WEIGHT_ULTRABOLD") '("heavy" "PANGO_WEIGHT_HEAVY") ) ) (define-enum WrapMode (in-module "Pango") (c-name "PangoWrapMode") (gtype-id "PANGO_TYPE_WRAP_MODE") (values '("word" "PANGO_WRAP_WORD") '("char" "PANGO_WRAP_CHAR") '("word-char" "PANGO_WRAP_WORD_CHAR") ) ) (define-flags FontMask (in-module "Pango") (c-name "PangoFontMask") (gtype-id "PANGO_TYPE_FONT_MASK") (values '("family" "PANGO_FONT_MASK_FAMILY") '("style" "PANGO_FONT_MASK_STYLE") '("variant" "PANGO_FONT_MASK_VARIANT") '("weight" "PANGO_FONT_MASK_WEIGHT") '("stretch" "PANGO_FONT_MASK_STRETCH") '("size" "PANGO_FONT_MASK_SIZE") ) ) ./pygtk-2.14.1-i686/usr/share/pygtk/2.0/defs/atk-types.defs0000644000000000000000000002553311272037107021347 0ustar rootroot;; -*- scheme -*- ; object definitions ... (define-object Hyperlink (in-module "Atk") (parent "GObject") (c-name "AtkHyperlink") (gtype-id "ATK_TYPE_HYPERLINK") ) (define-object GObjectAccessible (in-module "Atk") (parent "AtkObject") (c-name "AtkGObjectAccessible") (gtype-id "ATK_TYPE_GOBJECT_ACCESSIBLE") ) (define-object Object (in-module "Atk") (parent "GObject") (c-name "AtkObject") (gtype-id "ATK_TYPE_OBJECT") ) (define-object NoOpObject (in-module "Atk") (parent "AtkObject") (c-name "AtkNoOpObject") (gtype-id "ATK_TYPE_NO_OP_OBJECT") ) (define-object ObjectFactory (in-module "Atk") (parent "GObject") (c-name "AtkObjectFactory") (gtype-id "ATK_TYPE_OBJECT_FACTORY") ) (define-object NoOpObjectFactory (in-module "Atk") (parent "AtkObjectFactory") (c-name "AtkNoOpObjectFactory") (gtype-id "ATK_TYPE_NO_OP_OBJECT_FACTORY") ) (define-object Registry (in-module "Atk") (parent "GObject") (c-name "AtkRegistry") (gtype-id "ATK_TYPE_REGISTRY") ) (define-object Relation (in-module "Atk") (parent "GObject") (c-name "AtkRelation") (gtype-id "ATK_TYPE_RELATION") ) (define-object RelationSet (in-module "Atk") (parent "GObject") (c-name "AtkRelationSet") (gtype-id "ATK_TYPE_RELATION_SET") ) (define-object StateSet (in-module "Atk") (parent "GObject") (c-name "AtkStateSet") (gtype-id "ATK_TYPE_STATE_SET") ) (define-object Util (in-module "Atk") (parent "GObject") (c-name "AtkUtil") (gtype-id "ATK_TYPE_UTIL") ) (define-interface Action (in-module "Atk") (c-name "AtkAction") (gtype-id "ATK_TYPE_ACTION") ) (define-interface Component (in-module "Atk") (c-name "AtkComponent") (gtype-id "ATK_TYPE_COMPONENT") ) (define-interface Document (in-module "Atk") (c-name "AtkDocument") (gtype-id "ATK_TYPE_DOCUMENT") ) (define-interface EditableText (in-module "Atk") (c-name "AtkEditableText") (gtype-id "ATK_TYPE_EDITABLE_TEXT") ) (define-interface HyperlinkImpl (in-module "Atk") (c-name "AtkHyperlinkImpl") (gtype-id "ATK_TYPE_HYPERLINK_IMPL") ) (define-interface Hypertext (in-module "Atk") (c-name "AtkHypertext") (gtype-id "ATK_TYPE_HYPERTEXT") ) (define-interface Image (in-module "Atk") (c-name "AtkImage") (gtype-id "ATK_TYPE_IMAGE") ) (define-interface ImplementorIface (in-module "Atk") (c-name "AtkImplementorIface") (gtype-id "ATK_TYPE_IMPLEMENTOR") ) (define-interface Selection (in-module "Atk") (c-name "AtkSelection") (gtype-id "ATK_TYPE_SELECTION") ) (define-interface StreamableContent (in-module "Atk") (c-name "AtkStreamableContent") (gtype-id "ATK_TYPE_STREAMABLE_CONTENT") ) (define-interface Table (in-module "Atk") (c-name "AtkTable") (gtype-id "ATK_TYPE_TABLE") ) (define-interface Text (in-module "Atk") (c-name "AtkText") (gtype-id "ATK_TYPE_TEXT") ) (define-interface Value (in-module "Atk") (c-name "AtkValue") (gtype-id "ATK_TYPE_VALUE") ) (define-boxed Rectangle (in-module "Atk") (c-name "AtkRectangle") (gtype-id "ATK_TYPE_RECTANGLE") (fields '("gint" "x") '("gint" "y") '("gint" "width") '("gint" "height") ) ) ;; Enumerations and flags ... (define-enum Role (in-module "Atk") (c-name "AtkRole") (gtype-id "ATK_TYPE_ROLE") (values '("invalid" "ATK_ROLE_INVALID") '("accel-label" "ATK_ROLE_ACCEL_LABEL") '("alert" "ATK_ROLE_ALERT") '("animation" "ATK_ROLE_ANIMATION") '("arrow" "ATK_ROLE_ARROW") '("calendar" "ATK_ROLE_CALENDAR") '("canvas" "ATK_ROLE_CANVAS") '("check-box" "ATK_ROLE_CHECK_BOX") '("check-menu-item" "ATK_ROLE_CHECK_MENU_ITEM") '("color-chooser" "ATK_ROLE_COLOR_CHOOSER") '("column-header" "ATK_ROLE_COLUMN_HEADER") '("combo-box" "ATK_ROLE_COMBO_BOX") '("date-editor" "ATK_ROLE_DATE_EDITOR") '("desktop-icon" "ATK_ROLE_DESKTOP_ICON") '("desktop-frame" "ATK_ROLE_DESKTOP_FRAME") '("dial" "ATK_ROLE_DIAL") '("dialog" "ATK_ROLE_DIALOG") '("directory-pane" "ATK_ROLE_DIRECTORY_PANE") '("drawing-area" "ATK_ROLE_DRAWING_AREA") '("file-chooser" "ATK_ROLE_FILE_CHOOSER") '("filler" "ATK_ROLE_FILLER") '("font-chooser" "ATK_ROLE_FONT_CHOOSER") '("frame" "ATK_ROLE_FRAME") '("glass-pane" "ATK_ROLE_GLASS_PANE") '("html-container" "ATK_ROLE_HTML_CONTAINER") '("icon" "ATK_ROLE_ICON") '("image" "ATK_ROLE_IMAGE") '("internal-frame" "ATK_ROLE_INTERNAL_FRAME") '("label" "ATK_ROLE_LABEL") '("layered-pane" "ATK_ROLE_LAYERED_PANE") '("list" "ATK_ROLE_LIST") '("list-item" "ATK_ROLE_LIST_ITEM") '("menu" "ATK_ROLE_MENU") '("menu-bar" "ATK_ROLE_MENU_BAR") '("menu-item" "ATK_ROLE_MENU_ITEM") '("option-pane" "ATK_ROLE_OPTION_PANE") '("page-tab" "ATK_ROLE_PAGE_TAB") '("page-tab-list" "ATK_ROLE_PAGE_TAB_LIST") '("panel" "ATK_ROLE_PANEL") '("password-text" "ATK_ROLE_PASSWORD_TEXT") '("popup-menu" "ATK_ROLE_POPUP_MENU") '("progress-bar" "ATK_ROLE_PROGRESS_BAR") '("push-button" "ATK_ROLE_PUSH_BUTTON") '("radio-button" "ATK_ROLE_RADIO_BUTTON") '("radio-menu-item" "ATK_ROLE_RADIO_MENU_ITEM") '("root-pane" "ATK_ROLE_ROOT_PANE") '("row-header" "ATK_ROLE_ROW_HEADER") '("scroll-bar" "ATK_ROLE_SCROLL_BAR") '("scroll-pane" "ATK_ROLE_SCROLL_PANE") '("separator" "ATK_ROLE_SEPARATOR") '("slider" "ATK_ROLE_SLIDER") '("split-pane" "ATK_ROLE_SPLIT_PANE") '("spin-button" "ATK_ROLE_SPIN_BUTTON") '("statusbar" "ATK_ROLE_STATUSBAR") '("table" "ATK_ROLE_TABLE") '("table-cell" "ATK_ROLE_TABLE_CELL") '("table-column-header" "ATK_ROLE_TABLE_COLUMN_HEADER") '("table-row-header" "ATK_ROLE_TABLE_ROW_HEADER") '("tear-off-menu-item" "ATK_ROLE_TEAR_OFF_MENU_ITEM") '("terminal" "ATK_ROLE_TERMINAL") '("text" "ATK_ROLE_TEXT") '("toggle-button" "ATK_ROLE_TOGGLE_BUTTON") '("tool-bar" "ATK_ROLE_TOOL_BAR") '("tool-tip" "ATK_ROLE_TOOL_TIP") '("tree" "ATK_ROLE_TREE") '("tree-table" "ATK_ROLE_TREE_TABLE") '("unknown" "ATK_ROLE_UNKNOWN") '("viewport" "ATK_ROLE_VIEWPORT") '("window" "ATK_ROLE_WINDOW") '("last-defined" "ATK_ROLE_LAST_DEFINED") ) ) (define-enum Layer (in-module "Atk") (c-name "AtkLayer") (gtype-id "ATK_TYPE_LAYER") (values '("invalid" "ATK_LAYER_INVALID") '("background" "ATK_LAYER_BACKGROUND") '("canvas" "ATK_LAYER_CANVAS") '("widget" "ATK_LAYER_WIDGET") '("mdi" "ATK_LAYER_MDI") '("popup" "ATK_LAYER_POPUP") '("overlay" "ATK_LAYER_OVERLAY") ) ) (define-enum RelationType (in-module "Atk") (c-name "AtkRelationType") (gtype-id "ATK_TYPE_RELATION_TYPE") (values '("null" "ATK_RELATION_NULL") '("controlled-by" "ATK_RELATION_CONTROLLED_BY") '("controller-for" "ATK_RELATION_CONTROLLER_FOR") '("label-for" "ATK_RELATION_LABEL_FOR") '("labelled-by" "ATK_RELATION_LABELLED_BY") '("member-of" "ATK_RELATION_MEMBER_OF") '("node-child-of" "ATK_RELATION_NODE_CHILD_OF") '("last-defined" "ATK_RELATION_LAST_DEFINED") ) ) (define-enum StateType (in-module "Atk") (c-name "AtkStateType") (gtype-id "ATK_TYPE_STATE_TYPE") (values '("invalid" "ATK_STATE_INVALID") '("active" "ATK_STATE_ACTIVE") '("armed" "ATK_STATE_ARMED") '("busy" "ATK_STATE_BUSY") '("checked" "ATK_STATE_CHECKED") '("defunct" "ATK_STATE_DEFUNCT") '("editable" "ATK_STATE_EDITABLE") '("enabled" "ATK_STATE_ENABLED") '("expandable" "ATK_STATE_EXPANDABLE") '("expanded" "ATK_STATE_EXPANDED") '("focusable" "ATK_STATE_FOCUSABLE") '("focused" "ATK_STATE_FOCUSED") '("horizontal" "ATK_STATE_HORIZONTAL") '("iconified" "ATK_STATE_ICONIFIED") '("modal" "ATK_STATE_MODAL") '("multi-line" "ATK_STATE_MULTI_LINE") '("multiselectable" "ATK_STATE_MULTISELECTABLE") '("opaque" "ATK_STATE_OPAQUE") '("pressed" "ATK_STATE_PRESSED") '("resizable" "ATK_STATE_RESIZABLE") '("selectable" "ATK_STATE_SELECTABLE") '("selected" "ATK_STATE_SELECTED") '("sensitive" "ATK_STATE_SENSITIVE") '("showing" "ATK_STATE_SHOWING") '("single-line" "ATK_STATE_SINGLE_LINE") '("stale" "ATK_STATE_STALE") '("transient" "ATK_STATE_TRANSIENT") '("vertical" "ATK_STATE_VERTICAL") '("visible" "ATK_STATE_VISIBLE") '("last-defined" "ATK_STATE_LAST_DEFINED") ) ) (define-enum TextAttribute (in-module "Atk") (c-name "AtkTextAttribute") (gtype-id "ATK_TYPE_TEXT_ATTRIBUTE") (values '("left-margin" "ATK_TEXT_ATTR_LEFT_MARGIN") '("right-margin" "ATK_TEXT_ATTR_RIGHT_MARGIN") '("indent" "ATK_TEXT_ATTR_INDENT") '("invisible" "ATK_TEXT_ATTR_INVISIBLE") '("editable" "ATK_TEXT_ATTR_EDITABLE") '("pixels-above-lines" "ATK_TEXT_ATTR_PIXELS_ABOVE_LINES") '("pixels-below-lines" "ATK_TEXT_ATTR_PIXELS_BELOW_LINES") '("pixels-inside-wrap" "ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP") '("bg-full-height" "ATK_TEXT_ATTR_BG_FULL_HEIGHT") '("rise" "ATK_TEXT_ATTR_RISE") '("underline" "ATK_TEXT_ATTR_UNDERLINE") '("strikethrough" "ATK_TEXT_ATTR_STRIKETHROUGH") '("size" "ATK_TEXT_ATTR_SIZE") '("scale" "ATK_TEXT_ATTR_SCALE") '("weight" "ATK_TEXT_ATTR_WEIGHT") '("language" "ATK_TEXT_ATTR_LANGUAGE") '("family-name" "ATK_TEXT_ATTR_FAMILY_NAME") '("bg-color" "ATK_TEXT_ATTR_BG_COLOR") '("fg-color" "ATK_TEXT_ATTR_FG_COLOR") '("bg-stipple" "ATK_TEXT_ATTR_BG_STIPPLE") '("fg-stipple" "ATK_TEXT_ATTR_FG_STIPPLE") '("wrap-mode" "ATK_TEXT_ATTR_WRAP_MODE") '("direction" "ATK_TEXT_ATTR_DIRECTION") '("justification" "ATK_TEXT_ATTR_JUSTIFICATION") '("stretch" "ATK_TEXT_ATTR_STRETCH") '("variant" "ATK_TEXT_ATTR_VARIANT") '("style" "ATK_TEXT_ATTR_STYLE") ) ) (define-enum TextBoundary (in-module "Atk") (c-name "AtkTextBoundary") (gtype-id "ATK_TYPE_TEXT_BOUNDARY") (values '("char" "ATK_TEXT_BOUNDARY_CHAR") '("word-start" "ATK_TEXT_BOUNDARY_WORD_START") '("word-end" "ATK_TEXT_BOUNDARY_WORD_END") '("sentence-start" "ATK_TEXT_BOUNDARY_SENTENCE_START") '("sentence-end" "ATK_TEXT_BOUNDARY_SENTENCE_END") '("line-start" "ATK_TEXT_BOUNDARY_LINE_START") '("line-end" "ATK_TEXT_BOUNDARY_LINE_END") ) ) (define-enum KeyEventType (in-module "Atk") (c-name "AtkKeyEventType") (gtype-id "ATK_TYPE_KEY_EVENT_TYPE") (values '("press" "ATK_KEY_EVENT_PRESS") '("release" "ATK_KEY_EVENT_RELEASE") '("last-defined" "ATK_KEY_EVENT_LAST_DEFINED") ) ) (define-enum CoordType (in-module "Atk") (c-name "AtkCoordType") (gtype-id "ATK_TYPE_COORD_TYPE") (values '("screen" "ATK_XY_SCREEN") '("window" "ATK_XY_WINDOW") ) ) (define-flags HyperlinkStateFlags (in-module "Atk") (c-name "AtkHyperlinkStateFlags") (gtype-id "ATK_TYPE_HYPERLINK_STATE_FLAGS") (values '("e" "ATK_HYPERLINK_IS_INLINE") ) ) (define-enum TextClipType (in-module "Atk") (c-name "AtkTextClipType") (gtype-id "ATK_TYPE_TEXT_CLIP_TYPE") (values '("none" "ATK_TEXT_CLIP_NONE") '("min" "ATK_TEXT_CLIP_MIN") '("max" "ATK_TEXT_CLIP_MAX") '("both" "ATK_TEXT_CLIP_BOTH") ) ) ./pygtk-2.14.1-i686/usr/share/pygtk/2.0/defs/atk.defs0000644000000000000000000016372611272037107020214 0ustar rootroot;; -*- scheme -*- (include "atk-types.defs") ;; From atk-enum-types.h (define-function hyperlink_state_flags_get_type (c-name "atk_hyperlink_state_flags_get_type") (return-type "GType") ) (define-function role_get_type (c-name "atk_role_get_type") (return-type "GType") ) (define-function layer_get_type (c-name "atk_layer_get_type") (return-type "GType") ) (define-function relation_type_get_type (c-name "atk_relation_type_get_type") (return-type "GType") ) (define-function state_type_get_type (c-name "atk_state_type_get_type") (return-type "GType") ) (define-function text_attribute_get_type (c-name "atk_text_attribute_get_type") (return-type "GType") ) (define-function text_boundary_get_type (c-name "atk_text_boundary_get_type") (return-type "GType") ) (define-function text_clip_type_get_type (c-name "atk_text_clip_type_get_type") (return-type "GType") ) (define-function key_event_type_get_type (c-name "atk_key_event_type_get_type") (return-type "GType") ) (define-function coord_type_get_type (c-name "atk_coord_type_get_type") (return-type "GType") ) ;; From /usr/include/atk-1.0/atk/atkaction.h (define-function atk_action_get_type (c-name "atk_action_get_type") (return-type "GType") (parameters ) ) (define-method do_action (of-object "AtkAction") (c-name "atk_action_do_action") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-method get_n_actions (of-object "AtkAction") (c-name "atk_action_get_n_actions") (return-type "gint") ) (define-method get_description (of-object "AtkAction") (c-name "atk_action_get_description") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-method get_name (of-object "AtkAction") (c-name "atk_action_get_name") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-method get_keybinding (of-object "AtkAction") (c-name "atk_action_get_keybinding") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-method set_description (of-object "AtkAction") (c-name "atk_action_set_description") (return-type "gboolean") (parameters '("gint" "i") '("const-gchar*" "desc") ) ) (define-method get_localized_name (of-object "AtkAction") (c-name "atk_action_get_localized_name") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-virtual do_action (of-object "AtkAction") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-virtual get_n_actions (of-object "AtkAction") (return-type "gint") ) (define-virtual get_description (of-object "AtkAction") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-virtual get_name (of-object "AtkAction") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-virtual get_keybinding (of-object "AtkAction") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-virtual set_description (of-object "AtkAction") (return-type "gboolean") (parameters '("gint" "i") '("const-gchar*" "desc") ) ) (define-virtual get_localized_name (of-object "AtkAction") (return-type "const-gchar*") (parameters '("gint" "i") ) ) ;; From /usr/include/atk-1.0/atk/atkcomponent.h (define-function atk_component_get_type (c-name "atk_component_get_type") (return-type "GType") (parameters ) ) (define-method add_focus_handler (of-object "AtkComponent") (c-name "atk_component_add_focus_handler") (return-type "guint") (parameters '("AtkFocusHandler" "handler") ) ) (define-method contains (of-object "AtkComponent") (c-name "atk_component_contains") (return-type "gboolean") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coord_type") ) ) (define-method ref_accessible_at_point (of-object "AtkComponent") (c-name "atk_component_ref_accessible_at_point") (return-type "AtkObject*") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coord_type") ) ) (define-method get_extents (of-object "AtkComponent") (c-name "atk_component_get_extents") (return-type "none") (parameters '("gint*" "x") '("gint*" "y") '("gint*" "width") '("gint*" "height") '("AtkCoordType" "coord_type") ) ) (define-method get_position (of-object "AtkComponent") (c-name "atk_component_get_position") (return-type "none") (parameters '("gint*" "x") '("gint*" "y") '("AtkCoordType" "coord_type") ) ) (define-method get_size (of-object "AtkComponent") (c-name "atk_component_get_size") (return-type "none") (parameters '("gint*" "width") '("gint*" "height") ) ) (define-method grab_focus (of-object "AtkComponent") (c-name "atk_component_grab_focus") (return-type "gboolean") ) (define-method remove_focus_handler (of-object "AtkComponent") (c-name "atk_component_remove_focus_handler") (return-type "none") (parameters '("guint" "handler_id") ) ) (define-method set_extents (of-object "AtkComponent") (c-name "atk_component_set_extents") (return-type "gboolean") (parameters '("gint" "x") '("gint" "y") '("gint" "width") '("gint" "height") '("AtkCoordType" "coord_type") ) ) (define-method set_position (of-object "AtkComponent") (c-name "atk_component_set_position") (return-type "gboolean") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coord_type") ) ) (define-method set_size (of-object "AtkComponent") (c-name "atk_component_set_size") (return-type "gboolean") (parameters '("gint" "width") '("gint" "height") ) ) (define-function rectangle_get_type (c-name "atk_rectangle_get_type") (return-type "GType") ) (define-method get_layer (of-object "AtkComponent") (c-name "atk_component_get_layer") (return-type "AtkLayer") ) (define-method get_mdi_zorder (of-object "AtkComponent") (c-name "atk_component_get_mdi_zorder") (return-type "gint") ) (define-method get_alpha (of-object "AtkComponent") (c-name "atk_component_get_alpha") (return-type "gdouble") ) (define-virtual add_focus_handler (of-object "AtkComponent") (return-type "guint") (parameters '("AtkFocusHandler" "handler") ) ) (define-virtual contains (of-object "AtkComponent") (return-type "gboolean") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coord_type") ) ) (define-virtual ref_accessible_at_point (of-object "AtkComponent") (return-type "AtkObject*") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coord_type") ) ) (define-virtual get_extents (of-object "AtkComponent") (return-type "none") (parameters '("gint*" "x") '("gint*" "y") '("gint*" "width") '("gint*" "height") '("AtkCoordType" "coord_type") ) ) (define-virtual get_position (of-object "AtkComponent") (return-type "none") (parameters '("gint*" "x") '("gint*" "y") '("AtkCoordType" "coord_type") ) ) (define-virtual get_size (of-object "AtkComponent") (return-type "none") (parameters '("gint*" "width") '("gint*" "height") ) ) (define-virtual grab_focus (of-object "AtkComponent") (return-type "gboolean") ) (define-virtual remove_focus_handler (of-object "AtkComponent") (return-type "none") (parameters '("guint" "handler_id") ) ) (define-virtual set_extents (of-object "AtkComponent") (return-type "gboolean") (parameters '("gint" "x") '("gint" "y") '("gint" "width") '("gint" "height") '("AtkCoordType" "coord_type") ) ) (define-virtual set_position (of-object "AtkComponent") (return-type "gboolean") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coord_type") ) ) (define-virtual set_size (of-object "AtkComponent") (return-type "gboolean") (parameters '("gint" "width") '("gint" "height") ) ) (define-virtual get_layer (of-object "AtkComponent") (return-type "AtkLayer") ) (define-virtual get_mdi_zorder (of-object "AtkComponent") (return-type "gint") ) (define-virtual bounds_changed (of-object "AtkComponent") (return-type "none") (parameters '("AtkRectangle*" "bounds") ) ) (define-virtual get_alpha (of-object "AtkComponent") (return-type "gdouble") ) ;; From /usr/include/atk-1.0/atk/atkdocument.h (define-function atk_document_get_type (c-name "atk_document_get_type") (return-type "GType") ) (define-method get_document_type (of-object "AtkDocument") (c-name "atk_document_get_document_type") (return-type "const-gchar*") ) (define-method get_document (of-object "AtkDocument") (c-name "atk_document_get_document") (return-type "gpointer") ) (define-method get_attributes (of-object "AtkDocument") (c-name "atk_document_get_attributes") (return-type "AtkAttributeSet*") ) (define-method get_attribute_value (of-object "AtkDocument") (c-name "atk_document_get_attribute_value") (return-type "const-gchar*") (parameters '("const-gchar*" "attribute_name") ) ) (define-method set_attribute_value (of-object "AtkDocument") (c-name "atk_document_set_attribute_value") (return-type "gboolean") (parameters '("const-gchar*" "attribute_name") '("const-gchar*" "attribute_value") ) ) (define-virtual get_document_type (of-object "AtkDocument") (return-type "const-gchar*") ) (define-virtual get_document (of-object "AtkDocument") (return-type "gpointer") ) (define-virtual get_document_attributes (of-object "AtkDocument") (return-type "AtkAttributeSet*") ) (define-virtual get_document_attribute_value (of-object "AtkDocument") (return-type "G_CONST_RETURNgchar*") (parameters '("const-gchar*" "attribute_name") ) ) (define-virtual set_document_attribute (of-object "AtkDocument") (return-type "gboolean") (parameters '("const-gchar*" "attribute_name") '("const-gchar*" "attribute_value") ) ) ;; From /usr/include/atk-1.0/atk/atkeditabletext.h (define-function atk_editable_text_get_type (c-name "atk_editable_text_get_type") (return-type "GType") ) (define-method set_run_attributes (of-object "AtkEditableText") (c-name "atk_editable_text_set_run_attributes") (return-type "gboolean") (parameters '("AtkAttributeSet*" "attrib_set") '("gint" "start_offset") '("gint" "end_offset") ) ) (define-method set_text_contents (of-object "AtkEditableText") (c-name "atk_editable_text_set_text_contents") (return-type "none") (parameters '("const-gchar*" "string") ) ) (define-method insert_text (of-object "AtkEditableText") (c-name "atk_editable_text_insert_text") (return-type "none") (parameters '("const-gchar*" "string") '("gint" "length") '("gint*" "position") ) ) (define-method copy_text (of-object "AtkEditableText") (c-name "atk_editable_text_copy_text") (return-type "none") (parameters '("gint" "start_pos") '("gint" "end_pos") ) ) (define-method cut_text (of-object "AtkEditableText") (c-name "atk_editable_text_cut_text") (return-type "none") (parameters '("gint" "start_pos") '("gint" "end_pos") ) ) (define-method delete_text (of-object "AtkEditableText") (c-name "atk_editable_text_delete_text") (return-type "none") (parameters '("gint" "start_pos") '("gint" "end_pos") ) ) (define-method paste_text (of-object "AtkEditableText") (c-name "atk_editable_text_paste_text") (return-type "none") (parameters '("gint" "position") ) ) (define-virtual set_run_attributes (of-object "AtkEditableText") (return-type "gboolean") (parameters '("AtkAttributeSet*" "attrib_set") '("gint" "start_offset") '("gint" "end_offset") ) ) (define-virtual set_text_contents (of-object "AtkEditableText") (return-type "none") (parameters '("const-gchar*" "string") ) ) (define-virtual insert_text (of-object "AtkEditableText") (return-type "none") (parameters '("const-gchar*" "string") '("gint" "length") '("gint*" "position") ) ) (define-virtual copy_text (of-object "AtkEditableText") (return-type "none") (parameters '("gint" "start_pos") '("gint" "end_pos") ) ) (define-virtual cut_text (of-object "AtkEditableText") (return-type "none") (parameters '("gint" "start_pos") '("gint" "end_pos") ) ) (define-virtual delete_text (of-object "AtkEditableText") (return-type "none") (parameters '("gint" "start_pos") '("gint" "end_pos") ) ) (define-virtual paste_text (of-object "AtkEditableText") (return-type "none") (parameters '("gint" "position") ) ) ;; From atkgobjectaccessible.h (define-function gobject_accessible_get_type (c-name "atk_gobject_accessible_get_type") (return-type "GType") ) (define-function gobject_accessible_for_object (c-name "atk_gobject_accessible_for_object") (return-type "AtkObject*") (parameters '("GObject*" "obj") ) ) (define-method get_object (of-object "AtkGObjectAccessible") (c-name "atk_gobject_accessible_get_object") (return-type "GObject*") ) ;; From /usr/include/atk-1.0/atk/atk.h ;; From /usr/include/atk-1.0/atk/atkhyperlink.h (define-function atk_hyperlink_get_type (c-name "atk_hyperlink_get_type") (return-type "GType") ) (define-method get_uri (of-object "AtkHyperlink") (c-name "atk_hyperlink_get_uri") (return-type "gchar*") (parameters '("gint" "i") ) ) (define-method get_object (of-object "AtkHyperlink") (c-name "atk_hyperlink_get_object") (return-type "AtkObject*") (parameters '("gint" "i") ) ) (define-method get_end_index (of-object "AtkHyperlink") (c-name "atk_hyperlink_get_end_index") (return-type "gint") ) (define-method get_start_index (of-object "AtkHyperlink") (c-name "atk_hyperlink_get_start_index") (return-type "gint") ) (define-method is_valid (of-object "AtkHyperlink") (c-name "atk_hyperlink_is_valid") (return-type "gboolean") ) (define-method get_n_anchors (of-object "AtkHyperlink") (c-name "atk_hyperlink_get_n_anchors") (return-type "gint") ) (define-method is_inline (of-object "AtkHyperlink") (c-name "atk_hyperlink_is_inline") (return-type "gboolean") ) (define-method is_selected_link (of-object "AtkHyperlink") (c-name "atk_hyperlink_is_selected_link") (return-type "gboolean") ) (define-method get_attributes (of-object "AtkObject") (c-name "atk_object_get_attributes") (return-type "AtkAttributeSet*") ) (define-virtual get_uri (of-object "AtkHyperlink") (return-type "gchar*") (parameters '("gint" "i") ) ) (define-virtual get_object (of-object "AtkHyperlink") (return-type "AtkObject*") (parameters '("gint" "i") ) ) (define-virtual get_end_index (of-object "AtkHyperlink") (return-type "gint") ) (define-virtual get_start_index (of-object "AtkHyperlink") (return-type "gint") ) (define-virtual is_valid (of-object "AtkHyperlink") (return-type "gboolean") ) (define-virtual get_n_anchors (of-object "AtkHyperlink") (return-type "gint") ) (define-virtual link_state (of-object "AtkHyperlink") (return-type "guint") ) (define-virtual is_selected_link (of-object "AtkHyperlink") (return-type "gboolean") ) (define-virtual link_activated (of-object "AtkHyperlink") (return-type "none") ) (define-virtual get_attributes (of-object "AtkObject") (return-type "AtkAttributeSet*") ) ;; From atkhyperlinkimpl.h (define-function atk_hyperlink_impl_get_type (c-name "atk_hyperlink_impl_get_type") (return-type "GType") ) (define-method get_hyperlink (of-object "AtkHyperlinkImpl") (c-name "atk_hyperlink_impl_get_hyperlink") (return-type "AtkHyperlink*") ) (define-virtual get_hyperlink (of-object "AtkHyperlinkImpl") (return-type "AtkHyperlink*") ) ;; From /usr/include/atk-1.0/atk/atkhypertext.h (define-function atk_hypertext_get_type (c-name "atk_hypertext_get_type") (return-type "GType") ) (define-method get_link (of-object "AtkHypertext") (c-name "atk_hypertext_get_link") (return-type "AtkHyperlink*") (parameters '("gint" "link_index") ) ) (define-method get_n_links (of-object "AtkHypertext") (c-name "atk_hypertext_get_n_links") (return-type "gint") ) (define-method get_link_index (of-object "AtkHypertext") (c-name "atk_hypertext_get_link_index") (return-type "gint") (parameters '("gint" "char_index") ) ) (define-virtual get_link (of-object "AtkHypertext") (return-type "AtkHyperlink*") (parameters '("gint" "link_index") ) ) (define-virtual get_n_links (of-object "AtkHypertext") (return-type "gint") ) (define-virtual get_link_index (of-object "AtkHypertext") (return-type "gint") (parameters '("gint" "char_index") ) ) (define-virtual link_selected (of-object "AtkHypertext") (return-type "none") (parameters '("gint" "link_index") ) ) ;; From /usr/include/atk-1.0/atk/atkimage.h (define-function atk_image_get_type (c-name "atk_image_get_type") (return-type "GType") ) (define-method get_image_description (of-object "AtkImage") (c-name "atk_image_get_image_description") (return-type "const-gchar*") ) (define-method get_image_size (of-object "AtkImage") (c-name "atk_image_get_image_size") (return-type "none") (parameters '("gint*" "width") '("gint*" "height") ) ) (define-method set_image_description (of-object "AtkImage") (c-name "atk_image_set_image_description") (return-type "gboolean") (parameters '("const-gchar*" "description") ) ) (define-method get_image_position (of-object "AtkImage") (c-name "atk_image_get_image_position") (return-type "none") (parameters '("gint*" "x") '("gint*" "y") '("AtkCoordType" "coord_type") ) ) (define-virtual get_image_position (of-object "AtkImage") (return-type "none") (parameters '("gint*" "x") '("gint*" "y") '("AtkCoordType" "coord_type") ) ) (define-virtual get_image_description (of-object "AtkImage") (return-type "const-gchar*") ) (define-virtual get_image_size (of-object "AtkImage") (return-type "none") (parameters '("gint*" "width") '("gint*" "height") ) ) (define-virtual set_image_description (of-object "AtkImage") (return-type "gboolean") (parameters '("const-gchar*" "description") ) ) ;; From /usr/include/atk-1.0/atk/atknoopobjectfactory.h (define-function atk_no_op_object_factory_get_type (c-name "atk_no_op_object_factory_get_type") (return-type "GType") (parameters ) ) (define-function atk_no_op_object_factory_new (c-name "atk_no_op_object_factory_new") (return-type "AtkObjectFactory*") (is-constructor-of AtkNoOpObjectFactory) (parameters ) ) ;; From /usr/include/atk-1.0/atk/atknoopobject.h (define-function atk_no_op_object_get_type (c-name "atk_no_op_object_get_type") (return-type "GType") ) (define-function atk_no_op_object_new (c-name "atk_no_op_object_new") (return-type "AtkNoOpObject*") (is-constructor-of AtkNoOpObject) (parameters '("GObject*" "obj") ) ) ;; From /usr/include/atk-1.0/atk/atkobjectfactory.h (define-function atk_object_factory_get_type (c-name "atk_object_factory_get_type") (return-type "GType") (parameters ) ) (define-method create_accessible (of-object "AtkObjectFactory") (c-name "atk_object_factory_create_accessible") (return-type "AtkObject*") (parameters '("GObject*" "obj") ) ) (define-method invalidate (of-object "AtkObjectFactory") (c-name "atk_object_factory_invalidate") (return-type "none") ) (define-method get_accessible_type (of-object "AtkObjectFactory") (c-name "atk_object_factory_get_accessible_type") (return-type "GType") ) (define-virtual create_accessible (of-object "AtkObjectFactory") (return-type "AtkObject*") ) (define-virtual invalidate (of-object "AtkObjectFactory") (return-type "none") ) ;; From /usr/include/atk-1.0/atk/atkobject.h (define-function atk_object_get_type (c-name "atk_object_get_type") (return-type "GType") ) (define-function atk_implementor_get_type (c-name "atk_implementor_get_type") (return-type "GType") ) (define-method ref_accessible (of-object "AtkImplementorIface") (c-name "atk_implementor_ref_accessible") (return-type "AtkObject*") ) (define-virtual ref_accessible (of-object "AtkImplementor") (return-type "AtkObject*") ) (define-method get_name (of-object "AtkObject") (c-name "atk_object_get_name") (return-type "const-gchar*") ) (define-method get_description (of-object "AtkObject") (c-name "atk_object_get_description") (return-type "const-gchar*") ) (define-method get_parent (of-object "AtkObject") (c-name "atk_object_get_parent") (return-type "AtkObject*") ) (define-method get_n_accessible_children (of-object "AtkObject") (c-name "atk_object_get_n_accessible_children") (return-type "gint") ) (define-method ref_accessible_child (of-object "AtkObject") (c-name "atk_object_ref_accessible_child") (return-type "AtkObject*") (parameters '("gint" "i") ) ) (define-method ref_relation_set (of-object "AtkObject") (c-name "atk_object_ref_relation_set") (return-type "AtkRelationSet*") ) (define-method get_role (of-object "AtkObject") (c-name "atk_object_get_role") (return-type "AtkRole") ) (define-method get_layer (of-object "AtkObject") (c-name "atk_object_get_layer") (return-type "AtkLayer") ) (define-method get_mdi_zorder (of-object "AtkObject") (c-name "atk_object_get_mdi_zorder") (return-type "gint") ) (define-method ref_state_set (of-object "AtkObject") (c-name "atk_object_ref_state_set") (return-type "AtkStateSet*") ) (define-method get_index_in_parent (of-object "AtkObject") (c-name "atk_object_get_index_in_parent") (return-type "gint") ) (define-method set_name (of-object "AtkObject") (c-name "atk_object_set_name") (return-type "none") (parameters '("const-gchar*" "name") ) ) (define-method set_description (of-object "AtkObject") (c-name "atk_object_set_description") (return-type "none") (parameters '("const-gchar*" "description") ) ) (define-method set_parent (of-object "AtkObject") (c-name "atk_object_set_parent") (return-type "none") (parameters '("AtkObject*" "parent") ) ) (define-method set_role (of-object "AtkObject") (c-name "atk_object_set_role") (return-type "none") (parameters '("AtkRole" "role") ) ) (define-method connect_property_change_handler (of-object "AtkObject") (c-name "atk_object_connect_property_change_handler") (return-type "guint") (parameters '("AtkPropertyChangeHandler*" "handler") ) ) (define-method remove_property_change_handler (of-object "AtkObject") (c-name "atk_object_remove_property_change_handler") (return-type "none") (parameters '("guint" "handler_id") ) ) (define-method notify_state_change (of-object "AtkObject") (c-name "atk_object_notify_state_change") (return-type "none") (parameters '("AtkState" "state") '("gboolean" "value") ) ) (define-virtual get_name (of-object "AtkObject") (return-type "const-gchar*") ) (define-virtual get_description (of-object "AtkObject") (return-type "const-gchar*") ) (define-virtual get_parent (of-object "AtkObject") (return-type "AtkObject*") ) (define-virtual get_n_children (of-object "AtkObject") (return-type "gint") ) (define-virtual ref_child (of-object "AtkObject") (return-type "AtkObject*") (parameters '("gint" "i") ) ) (define-virtual get_index_in_parent (of-object "AtkObject") (return-type "gint") ) (define-virtual ref_relation_set (of-object "AtkObject") (return-type "AtkRelationSet*") ) (define-virtual get_role (of-object "AtkObject") (return-type "AtkRole") ) (define-virtual get_layer (of-object "AtkObject") (return-type "AtkLayer") ) (define-virtual get_mdi_zorder (of-object "AtkObject") (return-type "gint") ) (define-virtual ref_state_set (of-object "AtkObject") (return-type "AtkStateSet*") ) (define-virtual set_name (of-object "AtkObject") (return-type "none") (parameters '("const-gchar*" "name") ) ) (define-virtual set_description (of-object "AtkObject") (return-type "none") (parameters '("const-gchar*" "description") ) ) (define-virtual set_parent (of-object "AtkObject") (return-type "none") (parameters '("AtkObject*" "parent") ) ) (define-virtual set_role (of-object "AtkObject") (return-type "none") (parameters '("AtkRole" "role") ) ) (define-virtual connect_property_change_handler (of-object "AtkObject") (return-type "guint") (parameters '("AtkPropertyChangeHandler*" "handler") ) ) (define-virtual remove_property_change_handler (of-object "AtkObject") (return-type "none") (parameters '("guint" "handler_id") ) ) (define-virtual initialize (of-object "AtkObject") (return-type "none") (parameters '("gpointer" "data") ) ) (define-virtual children_changed (of-object "AtkObject") (return-type "none") (parameters '("guint" "change_index") '("gpointer" "changed_child") ) ) (define-virtual focus_event (of-object "AtkObject") (return-type "none") (parameters '("gboolean" "focus_in") ) ) (define-virtual property_change (of-object "AtkObject") (return-type "none") (parameters '("AtkPropertyValues*" "values") ) ) (define-virtual state_change (of-object "AtkObject") (return-type "none") (parameters '("const-gchar*" "name") '("gboolean" "state_set") ) ) (define-virtual visible_data_changed (of-object "AtkObject") (return-type "none") ) (define-virtual active_descendant_changed (of-object "AtkObject") (return-type "none") (parameters '("gpointer*" "child") ) ) (define-function role_register (c-name "atk_role_register") (return-type "AtkRole") (parameters '("const-gchar*" "name") ) ) (define-method initialize (of-object "AtkObject") (c-name "atk_object_initialize") (return-type "none") (parameters '("gpointer" "data") ) ) (define-method add_relationship (of-object "AtkObject") (c-name "atk_object_add_relationship") (return-type "gboolean") (parameters '("AtkRelationType" "relationship") '("AtkObject*" "target") ) ) (define-method remove_relationship (of-object "AtkObject") (c-name "atk_object_remove_relationship") (return-type "gboolean") (parameters '("AtkRelationType" "relationship") '("AtkObject*" "target") ) ) (define-function role_get_localized_name (c-name "atk_role_get_localized_name") (return-type "const-gchar*") (parameters '("AtkRole" "role") ) ) ;; From /usr/include/atk-1.0/atk/atkregistry.h (define-function atk_registry_get_type (c-name "atk_registry_get_type") (return-type "GType") ) (define-method set_factory_type (of-object "AtkRegistry") (c-name "atk_registry_set_factory_type") (return-type "none") (parameters '("GType" "type") '("GType" "factory_type") ) ) (define-method get_factory_type (of-object "AtkRegistry") (c-name "atk_registry_get_factory_type") (return-type "GType") (parameters '("GType" "type") ) ) (define-method get_factory (of-object "AtkRegistry") (c-name "atk_registry_get_factory") (return-type "AtkObjectFactory*") (parameters '("GType" "type") ) ) (define-function get_default_registry (c-name "atk_get_default_registry") (return-type "AtkRegistry*") (parameters ) ) ;; From /usr/include/atk-1.0/atk/atkrelation.h (define-function atk_relation_get_type (c-name "atk_relation_get_type") (return-type "GType") ) (define-function relation_type_register (c-name "atk_relation_type_register") (return-type "AtkRelationType") (parameters '("const-gchar*" "name") ) ) (define-function relation_type_get_name (c-name "atk_relation_type_get_name") (return-type "const-gchar*") (parameters '("AtkRelationType" "relationship") ) ) (define-function relation_type_for_name (c-name "atk_relation_type_for_name") (return-type "AtkRelationType") (parameters '("const-gchar*" "name") ) ) (define-function relation_new (c-name "atk_relation_new") (return-type "AtkRelation*") (is-constructor-of AtkRelation) (parameters '("AtkObject**" "targets") '("gint" "n_targets") '("AtkRelationType" "relationship") ) ) (define-method get_relation_type (of-object "AtkRelation") (c-name "atk_relation_get_relation_type") (return-type "AtkRelationType") ) (define-method get_target (of-object "AtkRelation") (c-name "atk_relation_get_target") (return-type "GPtrArray*") ) (define-method add_target (of-object "AtkRelation") (c-name "atk_relation_add_target") (return-type "none") (parameters '("AtkObject*" "target") ) ) ;; From /usr/include/atk-1.0/atk/atkrelationset.h (define-function atk_relation_set_get_type (c-name "atk_relation_set_get_type") (return-type "GType") ) (define-function relation_set_new (c-name "atk_relation_set_new") (is-constructor-of AtkRelationSet) (return-type "AtkRelationSet*") ) (define-method contains (of-object "AtkRelationSet") (c-name "atk_relation_set_contains") (return-type "gboolean") (parameters '("AtkRelationType" "relationship") ) ) (define-method remove (of-object "AtkRelationSet") (c-name "atk_relation_set_remove") (return-type "none") (parameters '("AtkRelation*" "relation") ) ) (define-method add (of-object "AtkRelationSet") (c-name "atk_relation_set_add") (return-type "none") (parameters '("AtkRelation*" "relation") ) ) (define-method get_n_relations (of-object "AtkRelationSet") (c-name "atk_relation_set_get_n_relations") (return-type "gint") ) (define-method get_relation (of-object "AtkRelationSet") (c-name "atk_relation_set_get_relation") (return-type "AtkRelation*") (parameters '("gint" "i") ) ) (define-method get_relation_by_type (of-object "AtkRelationSet") (c-name "atk_relation_set_get_relation_by_type") (return-type "AtkRelation*") (parameters '("AtkRelationType" "relationship") ) ) (define-method add_relation_by_type (of-object "AtkRelationSet") (c-name "atk_relation_set_add_relation_by_type") (return-type "none") (parameters '("AtkRelationType" "relationship") '("AtkObject*" "target") ) ) ;; From /usr/include/atk-1.0/atk/atkselection.h (define-function atk_selection_get_type (c-name "atk_selection_get_type") (return-type "GType") (parameters ) ) (define-method add_selection (of-object "AtkSelection") (c-name "atk_selection_add_selection") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-method clear_selection (of-object "AtkSelection") (c-name "atk_selection_clear_selection") (return-type "gboolean") ) (define-method ref_selection (of-object "AtkSelection") (c-name "atk_selection_ref_selection") (return-type "AtkObject*") (parameters '("gint" "i") ) ) (define-method get_selection_count (of-object "AtkSelection") (c-name "atk_selection_get_selection_count") (return-type "gint") ) (define-method is_child_selected (of-object "AtkSelection") (c-name "atk_selection_is_child_selected") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-method remove_selection (of-object "AtkSelection") (c-name "atk_selection_remove_selection") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-method select_all_selection (of-object "AtkSelection") (c-name "atk_selection_select_all_selection") (return-type "gboolean") ) (define-virtual add_selection (of-object "AtkSelection") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-virtual clear_selection (of-object "AtkSelection") (return-type "gboolean") ) (define-virtual ref_selection (of-object "AtkSelection") (return-type "AtkObject*") (parameters '("gint" "i") ) ) (define-virtual get_selection_count (of-object "AtkSelection") (return-type "gint") ) (define-virtual is_child_selected (of-object "AtkSelection") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-virtual remove_selection (of-object "AtkSelection") (return-type "gboolean") (parameters '("gint" "i") ) ) (define-virtual select_all_selection (of-object "AtkSelection") (return-type "gboolean") ) (define-virtual selection_changed (of-object "AtkSelection") (return-type "none") ) ;; From /usr/include/atk-1.0/atk/atkstate.h (define-function state_type_register (c-name "atk_state_type_register") (return-type "AtkStateType") (parameters '("const-gchar*" "name") ) ) (define-function state_type_get_name (c-name "atk_state_type_get_name") (return-type "const-gchar*") (parameters '("AtkStateType" "type") ) ) (define-function state_type_for_name (c-name "atk_state_type_for_name") (return-type "AtkStateType") (parameters '("const-gchar*" "name") ) ) ;; From /usr/include/atk-1.0/atk/atkstateset.h (define-function atk_state_set_get_type (c-name "atk_state_set_get_type") (return-type "GType") ) (define-function atk_state_set_new (c-name "atk_state_set_new") (is-constructor-of "AtkStateSet") (return-type "AtkStateSet*") ) (define-method is_empty (of-object "AtkStateSet") (c-name "atk_state_set_is_empty") (return-type "gboolean") ) (define-method add_state (of-object "AtkStateSet") (c-name "atk_state_set_add_state") (return-type "gboolean") (parameters '("AtkStateType" "type") ) ) (define-method add_states (of-object "AtkStateSet") (c-name "atk_state_set_add_states") (return-type "none") (parameters '("AtkStateType*" "types") '("gint" "n_types") ) ) (define-method clear_states (of-object "AtkStateSet") (c-name "atk_state_set_clear_states") (return-type "none") ) (define-method contains_state (of-object "AtkStateSet") (c-name "atk_state_set_contains_state") (return-type "gboolean") (parameters '("AtkStateType" "type") ) ) (define-method contains_states (of-object "AtkStateSet") (c-name "atk_state_set_contains_states") (return-type "gboolean") (parameters '("AtkStateType*" "types") '("gint" "n_types") ) ) (define-method remove_state (of-object "AtkStateSet") (c-name "atk_state_set_remove_state") (return-type "gboolean") (parameters '("AtkStateType" "type") ) ) (define-method and_sets (of-object "AtkStateSet") (c-name "atk_state_set_and_sets") (return-type "AtkStateSet*") (parameters '("AtkStateSet*" "compare_set") ) ) (define-method or_sets (of-object "AtkStateSet") (c-name "atk_state_set_or_sets") (return-type "AtkStateSet*") (parameters '("AtkStateSet*" "compare_set") ) ) (define-method xor_sets (of-object "AtkStateSet") (c-name "atk_state_set_xor_sets") (return-type "AtkStateSet*") (parameters '("AtkStateSet*" "compare_set") ) ) ;; From /usr/include/atk-1.0/atk/atkstreamablecontent.h (define-function atk_streamable_content_get_type (c-name "atk_streamable_content_get_type") (return-type "GType") ) (define-method get_n_mime_types (of-object "AtkStreamableContent") (c-name "atk_streamable_content_get_n_mime_types") (return-type "gint") ) (define-method get_mime_type (of-object "AtkStreamableContent") (c-name "atk_streamable_content_get_mime_type") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-method get_stream (of-object "AtkStreamableContent") (c-name "atk_streamable_content_get_stream") (return-type "GIOChannel*") (parameters '("const-gchar*" "mime_type") ) ) (define-method get_uri (of-object "AtkStreamableContent") (c-name "atk_streamable_content_get_uri") (return-type "gchar*") (parameters '("const-gchar*" "mime_type") ) ) (define-virtual get_n_mime_types (of-object "AtkStreamableContent") (return-type "gint") ) (define-virtual get_mime_type (of-object "AtkStreamableContent") (return-type "const-gchar*") (parameters '("gint" "i") ) ) (define-virtual get_stream (of-object "AtkStreamableContent") (return-type "GIOChannel*") (parameters '("const-gchar*" "mime_type") ) ) (define-virtual get_uri (of-object "AtkStreamableContent") (return-type "G_CONST_RETURNgchar*") (parameters '("const-gchar*" "mime_type") ) ) ;; From /usr/include/atk-1.0/atk/atktable.h (define-function atk_table_get_type (c-name "atk_table_get_type") (return-type "GType") (parameters ) ) (define-method ref_at (of-object "AtkTable") (c-name "atk_table_ref_at") (return-type "AtkObject*") (parameters '("gint" "row") '("gint" "column") ) ) (define-method get_index_at (of-object "AtkTable") (c-name "atk_table_get_index_at") (return-type "gint") (parameters '("gint" "row") '("gint" "column") ) ) (define-method get_column_at_index (of-object "AtkTable") (c-name "atk_table_get_column_at_index") (return-type "gint") (parameters '("gint" "index") ) ) (define-method get_row_at_index (of-object "AtkTable") (c-name "atk_table_get_row_at_index") (return-type "gint") (parameters '("gint" "index") ) ) (define-method get_n_columns (of-object "AtkTable") (c-name "atk_table_get_n_columns") (return-type "gint") ) (define-method get_n_rows (of-object "AtkTable") (c-name "atk_table_get_n_rows") (return-type "gint") ) (define-method get_column_extent_at (of-object "AtkTable") (c-name "atk_table_get_column_extent_at") (return-type "gint") (parameters '("gint" "row") '("gint" "column") ) ) (define-method get_row_extent_at (of-object "AtkTable") (c-name "atk_table_get_row_extent_at") (return-type "gint") (parameters '("gint" "row") '("gint" "column") ) ) (define-method get_caption (of-object "AtkTable") (c-name "atk_table_get_caption") (return-type "AtkObject*") ) (define-method get_column_description (of-object "AtkTable") (c-name "atk_table_get_column_description") (return-type "const-gchar*") (parameters '("gint" "column") ) ) (define-method get_column_header (of-object "AtkTable") (c-name "atk_table_get_column_header") (return-type "AtkObject*") (parameters '("gint" "column") ) ) (define-method get_row_description (of-object "AtkTable") (c-name "atk_table_get_row_description") (return-type "const-gchar*") (parameters '("gint" "row") ) ) (define-method get_row_header (of-object "AtkTable") (c-name "atk_table_get_row_header") (return-type "AtkObject*") (parameters '("gint" "row") ) ) (define-method get_summary (of-object "AtkTable") (c-name "atk_table_get_summary") (return-type "AtkObject*") ) (define-method set_caption (of-object "AtkTable") (c-name "atk_table_set_caption") (return-type "none") (parameters '("AtkObject*" "caption") ) ) (define-method set_column_description (of-object "AtkTable") (c-name "atk_table_set_column_description") (return-type "none") (parameters '("gint" "column") '("const-gchar*" "description") ) ) (define-method set_column_header (of-object "AtkTable") (c-name "atk_table_set_column_header") (return-type "none") (parameters '("gint" "column") '("AtkObject*" "header") ) ) (define-method set_row_description (of-object "AtkTable") (c-name "atk_table_set_row_description") (return-type "none") (parameters '("gint" "row") '("const-gchar*" "description") ) ) (define-method set_row_header (of-object "AtkTable") (c-name "atk_table_set_row_header") (return-type "none") (parameters '("gint" "row") '("AtkObject*" "header") ) ) (define-method set_summary (of-object "AtkTable") (c-name "atk_table_set_summary") (return-type "none") (parameters '("AtkObject*" "accessible") ) ) (define-method get_selected_columns (of-object "AtkTable") (c-name "atk_table_get_selected_columns") (return-type "gint") (parameters '("gint**" "selected") ) ) (define-method get_selected_rows (of-object "AtkTable") (c-name "atk_table_get_selected_rows") (return-type "gint") (parameters '("gint**" "selected") ) ) (define-method is_column_selected (of-object "AtkTable") (c-name "atk_table_is_column_selected") (return-type "gboolean") (parameters '("gint" "column") ) ) (define-method is_row_selected (of-object "AtkTable") (c-name "atk_table_is_row_selected") (return-type "gboolean") (parameters '("gint" "row") ) ) (define-method is_selected (of-object "AtkTable") (c-name "atk_table_is_selected") (return-type "gboolean") (parameters '("gint" "row") '("gint" "column") ) ) (define-method add_row_selection (of-object "AtkTable") (c-name "atk_table_add_row_selection") (return-type "gboolean") (parameters '("gint" "row") ) ) (define-method remove_row_selection (of-object "AtkTable") (c-name "atk_table_remove_row_selection") (return-type "gboolean") (parameters '("gint" "row") ) ) (define-method add_column_selection (of-object "AtkTable") (c-name "atk_table_add_column_selection") (return-type "gboolean") (parameters '("gint" "column") ) ) (define-method remove_column_selection (of-object "AtkTable") (c-name "atk_table_remove_column_selection") (return-type "gboolean") (parameters '("gint" "column") ) ) (define-virtual ref_at (of-object "AtkTable") (return-type "AtkObject*") (parameters '("gint" "row") '("gint" "column") ) ) (define-virtual get_index_at (of-object "AtkTable") (return-type "gint") (parameters '("gint" "row") '("gint" "column") ) ) (define-virtual get_column_at_index (of-object "AtkTable") (return-type "gint") (parameters '("gint" "index") ) ) (define-virtual get_row_at_index (of-object "AtkTable") (return-type "gint") (parameters '("gint" "index") ) ) (define-virtual get_n_columns (of-object "AtkTable") (return-type "gint") ) (define-virtual get_n_rows (of-object "AtkTable") (return-type "gint") ) (define-virtual get_column_extent_at (of-object "AtkTable") (return-type "gint") (parameters '("gint" "row") '("gint" "column") ) ) (define-virtual get_row_extent_at (of-object "AtkTable") (return-type "gint") (parameters '("gint" "row") '("gint" "column") ) ) (define-virtual get_caption (of-object "AtkTable") (return-type "AtkObject*") ) (define-virtual get_column_description (of-object "AtkTable") (return-type "const-gchar*") (parameters '("gint" "column") ) ) (define-virtual get_column_header (of-object "AtkTable") (return-type "AtkObject*") (parameters '("gint" "column") ) ) (define-virtual get_row_description (of-object "AtkTable") (return-type "const-gchar*") (parameters '("gint" "row") ) ) (define-virtual get_row_header (of-object "AtkTable") (return-type "AtkObject*") (parameters '("gint" "row") ) ) (define-virtual get_summary (of-object "AtkTable") (return-type "AtkObject*") ) (define-virtual set_caption (of-object "AtkTable") (return-type "none") (parameters '("AtkObject*" "caption") ) ) (define-virtual set_column_description (of-object "AtkTable") (return-type "none") (parameters '("gint" "column") '("const-gchar*" "description") ) ) (define-virtual set_column_header (of-object "AtkTable") (return-type "none") (parameters '("gint" "column") '("AtkObject*" "header") ) ) (define-virtual set_row_description (of-object "AtkTable") (return-type "none") (parameters '("gint" "row") '("const-gchar*" "description") ) ) (define-virtual set_row_header (of-object "AtkTable") (return-type "none") (parameters '("gint" "row") '("AtkObject*" "header") ) ) (define-virtual set_summary (of-object "AtkTable") (return-type "none") (parameters '("AtkObject*" "accessible") ) ) (define-virtual get_selected_columns (of-object "AtkTable") (return-type "gint") (parameters '("gint**" "selected") ) ) (define-virtual get_selected_rows (of-object "AtkTable") (return-type "gint") (parameters '("gint**" "selected") ) ) (define-virtual is_column_selected (of-object "AtkTable") (return-type "gboolean") (parameters '("gint" "column") ) ) (define-virtual is_row_selected (of-object "AtkTable") (return-type "gboolean") (parameters '("gint" "row") ) ) (define-virtual is_selected (of-object "AtkTable") (return-type "gboolean") (parameters '("gint" "row") '("gint" "column") ) ) (define-virtual add_row_selection (of-object "AtkTable") (return-type "gboolean") (parameters '("gint" "row") ) ) (define-virtual remove_row_selection (of-object "AtkTable") (return-type "gboolean") (parameters '("gint" "row") ) ) (define-virtual add_column_selection (of-object "AtkTable") (return-type "gboolean") (parameters '("gint" "column") ) ) (define-virtual remove_column_selection (of-object "AtkTable") (return-type "gboolean") (parameters '("gint" "column") ) ) (define-virtual row_inserted (of-object "AtkTable") (return-type "none") (parameters '("gint" "row") '("gint" "num_inserted") ) ) (define-virtual column_inserted (of-object "AtkTable") (return-type "none") (parameters '("gint" "column") '("gint" "num_inserted") ) ) (define-virtual row_deleted (of-object "AtkTable") (return-type "none") (parameters '("gint" "row") '("gint" "num_deleted") ) ) (define-virtual column_deleted (of-object "AtkTable") (return-type "none") (parameters '("gint" "column") '("gint" "num_deleted") ) ) (define-virtual row_reordered (of-object "AtkTable") (return-type "none") ) (define-virtual column_reordered (of-object "AtkTable") (return-type "none") ) (define-virtual model_changed (of-object "AtkTable") (return-type "none") ) ;; From /usr/include/atk-1.0/atk/atktext.h (define-function atk_text_get_type (c-name "atk_text_get_type") (return-type "GType") ) (define-method get_text (of-object "AtkText") (c-name "atk_text_get_text") (return-type "gchar*") (parameters '("gint" "start_offset") '("gint" "end_offset") ) ) (define-method get_character_at_offset (of-object "AtkText") (c-name "atk_text_get_character_at_offset") (return-type "gunichar") (parameters '("gint" "offset") ) ) (define-method get_text_after_offset (of-object "AtkText") (c-name "atk_text_get_text_after_offset") (return-type "gchar*") (parameters '("gint" "offset") '("AtkTextBoundary" "boundary_type") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-method get_text_at_offset (of-object "AtkText") (c-name "atk_text_get_text_at_offset") (return-type "gchar*") (parameters '("gint" "offset") '("AtkTextBoundary" "boundary_type") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-method get_text_before_offset (of-object "AtkText") (c-name "atk_text_get_text_before_offset") (return-type "gchar*") (parameters '("gint" "offset") '("AtkTextBoundary" "boundary_type") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-method get_caret_offset (of-object "AtkText") (c-name "atk_text_get_caret_offset") (return-type "gint") ) (define-method get_character_extents (of-object "AtkText") (c-name "atk_text_get_character_extents") (return-type "none") (parameters '("gint" "offset") '("gint*" "x") '("gint*" "y") '("gint*" "width") '("gint*" "height") '("AtkCoordType" "coords") ) ) (define-method get_run_attributes (of-object "AtkText") (c-name "atk_text_get_run_attributes") (return-type "AtkAttributeSet*") (parameters '("gint" "offset") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-method get_default_attributes (of-object "AtkText") (c-name "atk_text_get_default_attributes") (return-type "AtkAttributeSet*") ) (define-method get_character_count (of-object "AtkText") (c-name "atk_text_get_character_count") (return-type "gint") ) (define-method get_offset_at_point (of-object "AtkText") (c-name "atk_text_get_offset_at_point") (return-type "gint") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coords") ) ) (define-method get_n_selections (of-object "AtkText") (c-name "atk_text_get_n_selections") (return-type "gint") ) (define-method get_selection (of-object "AtkText") (c-name "atk_text_get_selection") (return-type "gchar*") (parameters '("gint" "selection_num") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-method add_selection (of-object "AtkText") (c-name "atk_text_add_selection") (return-type "gboolean") (parameters '("gint" "start_offset") '("gint" "end_offset") ) ) (define-method remove_selection (of-object "AtkText") (c-name "atk_text_remove_selection") (return-type "gboolean") (parameters '("gint" "selection_num") ) ) (define-method set_selection (of-object "AtkText") (c-name "atk_text_set_selection") (return-type "gboolean") (parameters '("gint" "selection_num") '("gint" "start_offset") '("gint" "end_offset") ) ) (define-method set_caret_offset (of-object "AtkText") (c-name "atk_text_set_caret_offset") (return-type "gboolean") (parameters '("gint" "offset") ) ) (define-method get_range_extents (of-object "AtkText") (c-name "atk_text_get_range_extents") (return-type "none") (parameters '("gint" "start_offset") '("gint" "end_offset") '("AtkCoordType" "coord_type") '("AtkTextRectangle*" "rect") ) ) (define-method get_bounded_ranges (of-object "AtkText") (c-name "atk_text_get_bounded_ranges") (return-type "AtkTextRange**") (parameters '("AtkTextRectangle*" "rect") '("AtkCoordType" "coord_type") '("AtkTextClipType" "x_clip_type") '("AtkTextClipType" "y_clip_type") ) ) (define-function text_free_ranges (c-name "atk_text_free_ranges") (return-type "none") (parameters '("AtkTextRange**" "ranges") ) ) (define-method free (of-object "AtkAttributeSet") (c-name "atk_attribute_set_free") (return-type "none") ) (define-function text_attribute_get_name (c-name "atk_text_attribute_get_name") (return-type "const-gchar*") (parameters '("AtkTextAttribute" "attr") ) ) (define-function text_attribute_get_value (c-name "atk_text_attribute_get_value") (return-type "const-gchar*") (parameters '("AtkTextAttribute" "attr") '("gint" "index") ) ) (define-function text_attribute_register (c-name "atk_text_attribute_register") (return-type "AtkTextAttribute") (parameters '("const-gchar*" "name") ) ) (define-function text_attribute_for_name (c-name "atk_text_attribute_for_name") (return-type "AtkTextAttribute") (parameters '("const-gchar*" "name") ) ) (define-virtual get_text (of-object "AtkText") (return-type "gchar*") (parameters '("gint" "start_offset") '("gint" "end_offset") ) ) (define-virtual get_text_after_offset (of-object "AtkText") (return-type "gchar*") (parameters '("gint" "offset") '("AtkTextBoundary" "boundary_type") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-virtual get_text_at_offset (of-object "AtkText") (return-type "gchar*") (parameters '("gint" "offset") '("AtkTextBoundary" "boundary_type") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-virtual get_character_at_offset (of-object "AtkText") (return-type "gunichar") (parameters '("gint" "offset") ) ) (define-virtual get_text_before_offset (of-object "AtkText") (return-type "gchar*") (parameters '("gint" "offset") '("AtkTextBoundary" "boundary_type") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-virtual get_caret_offset (of-object "AtkText") (return-type "gint") ) (define-virtual get_run_attributes (of-object "AtkText") (return-type "AtkAttributeSet*") (parameters '("gint" "offset") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-virtual get_default_attributes (of-object "AtkText") (return-type "AtkAttributeSet*") ) (define-virtual get_character_extents (of-object "AtkText") (return-type "none") (parameters '("gint" "offset") '("gint*" "x") '("gint*" "y") '("gint*" "width") '("gint*" "height") '("AtkCoordType" "coords") ) ) (define-virtual get_character_count (of-object "AtkText") (return-type "gint") ) (define-virtual get_offset_at_point (of-object "AtkText") (return-type "gint") (parameters '("gint" "x") '("gint" "y") '("AtkCoordType" "coords") ) ) (define-virtual get_n_selections (of-object "AtkText") (return-type "gint") ) (define-virtual get_selection (of-object "AtkText") (return-type "gchar*") (parameters '("gint" "selection_num") '("gint*" "start_offset") '("gint*" "end_offset") ) ) (define-virtual add_selection (of-object "AtkText") (return-type "gboolean") (parameters '("gint" "start_offset") '("gint" "end_offset") ) ) (define-virtual remove_selection (of-object "AtkText") (return-type "gboolean") (parameters '("gint" "selection_num") ) ) (define-virtual set_selection (of-object "AtkText") (return-type "gboolean") (parameters '("gint" "selection_num") '("gint" "start_offset") '("gint" "end_offset") ) ) (define-virtual set_caret_offset (of-object "AtkText") (return-type "gboolean") (parameters '("gint" "offset") ) ) (define-virtual text_changed (of-object "AtkText") (return-type "none") (parameters '("gint" "position") '("gint" "length") ) ) (define-virtual text_caret_moved (of-object "AtkText") (return-type "none") (parameters '("gint" "location") ) ) (define-virtual text_selection_changed (of-object "AtkText") (return-type "none") ) (define-virtual text_attributes_changed (of-object "AtkText") (return-type "none") ) (define-virtual get_range_extents (of-object "AtkText") (return-type "none") (parameters '("gint" "start_offset") '("gint" "end_offset") '("AtkCoordType" "coord_type") '("AtkTextRectangle*" "rect") ) ) (define-virtual get_bounded_ranges (of-object "AtkText") (return-type "AtkTextRange**") (parameters '("AtkTextRectangle*" "rect") '("AtkCoordType" "coord_type") '("AtkTextClipType" "x_clip_type") '("AtkTextClipType" "y_clip_type") ) ) ;; From /usr/include/atk-1.0/atk/atkutil.h (define-function atk_util_get_type (c-name "atk_util_get_type") (return-type "GType") ) (define-function add_focus_tracker (c-name "atk_add_focus_tracker") (return-type "guint") (parameters '("AtkEventListener" "focus_tracker") ) ) (define-function remove_focus_tracker (c-name "atk_remove_focus_tracker") (return-type "none") (parameters '("guint" "tracker_id") ) ) (define-function focus_tracker_init (c-name "atk_focus_tracker_init") (return-type "none") (parameters '("AtkEventListenerInit" "add_function") ) ) (define-function focus_tracker_notify (c-name "atk_focus_tracker_notify") (return-type "none") (parameters '("AtkObject*" "object") ) ) (define-function add_global_event_listener (c-name "atk_add_global_event_listener") (return-type "guint") (parameters '("GSignalEmissionHook" "listener") '("const-gchar*" "event_type") ) ) (define-function remove_global_event_listener (c-name "atk_remove_global_event_listener") (return-type "none") (parameters '("guint" "listener_id") ) ) (define-function add_key_event_listener (c-name "atk_add_key_event_listener") (return-type "guint") (parameters '("AtkKeySnoopFunc" "listener") '("gpointer" "data") ) ) (define-function remove_key_event_listener (c-name "atk_remove_key_event_listener") (return-type "none") (parameters '("guint" "listener_id") ) ) (define-function get_root (c-name "atk_get_root") (return-type "AtkObject*") ) (define-function get_toolkit_name (c-name "atk_get_toolkit_name") (return-type "const-gchar*") ) (define-function get_toolkit_version (c-name "atk_get_toolkit_version") (return-type "const-gchar*") ) (define-function get_focus_object (c-name "atk_get_focus_object") (return-type "AtkObject*") ) (define-virtual add_global_event_listener (of-object "AtkUtil") (return-type "guint") (parameters '("const-gchar*" "event_type") ) ) (define-virtual remove_global_event_listener (of-object "AtkUtil") (return-type "none") ) (define-virtual add_key_event_listener (of-object "AtkUtil") (return-type "guint") (parameters '("gpointer" "data") ) ) (define-virtual remove_key_event_listener (of-object "AtkUtil") (return-type "none") ) ;; From /usr/include/atk-1.0/atk/atkvalue.h (define-function atk_value_get_type (c-name "atk_value_get_type") (return-type "GType") ) (define-method get_current_value (of-object "AtkValue") (c-name "atk_value_get_current_value") (return-type "none") (parameters '("GValue*" "value") ) ) (define-method get_maximum_value (of-object "AtkValue") (c-name "atk_value_get_maximum_value") (return-type "none") (parameters '("GValue*" "value") ) ) (define-method get_minimum_value (of-object "AtkValue") (c-name "atk_value_get_minimum_value") (return-type "none") (parameters '("GValue*" "value") ) ) (define-method set_current_value (of-object "AtkValue") (c-name "atk_value_set_current_value") (return-type "gboolean") (parameters '("const-GValue*" "value") ) ) (define-method get_minimum_increment (of-object "AtkValue") (c-name "atk_value_get_minimum_increment") (return-type "none") (parameters '("GValue*" "value") ) ) (define-virtual get_current_value (of-object "AtkValue") (return-type "none") (parameters '("GValue*" "value") ) ) (define-virtual get_maximum_value (of-object "AtkValue") (return-type "none") (parameters '("GValue*" "value") ) ) (define-virtual get_minimum_value (of-object "AtkValue") (return-type "none") (parameters '("GValue*" "value") ) ) (define-virtual set_current_value (of-object "AtkValue") (return-type "gboolean") (parameters '("const-GValue*" "value") ) ) (define-virtual get_minimum_increment (of-object "AtkValue") (return-type "none") (parameters '("GValue*" "value") ) ) (define-function role_get_name (c-name "atk_role_get_name") (return-type "const-gchar*") (parameters '("AtkRole" "role") ) ) (define-function role_for_name (c-name "atk_role_for_name") (return-type "AtkRole") (parameters '("const-gchar*" "name") ) ) (define-function rectangle_new (c-name "atk_rectangle_new") (is-constructor-of "AtkRectangle") (return-type "AtkRectangle") ) ./pygtk-2.14.1-i686/usr/share/pygobject/0000755000000000000000000000000011272037114016161 5ustar rootroot./pygtk-2.14.1-i686/usr/share/pygobject/2.0/0000755000000000000000000000000011272037114016460 5ustar rootroot./pygtk-2.14.1-i686/usr/share/pygobject/2.0/codegen/0000755000000000000000000000000011272037114020064 5ustar rootroot./pygtk-2.14.1-i686/usr/share/pygobject/2.0/codegen/scmexpr.pyc0000644000000000000000000001111011272037077022264 0ustar rootroot =Jc @sNddklZddkZddklZdefdYZdgdZxSedD]EZ e e ei ei djoe e ee dt|dit t|f} t||| ndS(Ntrtnames s s();'"iit;is'(t(t)s&close parenthesis found when none openit"s$string found outside of s-expressions\tns s tts sunclosed quoted stringRs(identifier found outside of s-expressionsC%d unclosed parentheses found at end of file (opened on line(s) %s)s, (( t isinstancetstrtopentgetattrtlentappendRtjointmaxtintt ValueErrortfloattmap(Rtfpt whitespacet nonsymboltstackt openlinesRtlinetpostclosedtendpostcharstsymbolR((s+/usr/share/pygobject/2.0/codegen/scmexpr.pytparses        (     '  tParsercBs/eZdZddZdZdZRS(cCs ||_dS(s9Argument is either a string, a parse tree, or file objectN(R(RR((s+/usr/share/pygobject/2.0/codegen/scmexpr.pyRlscCs8t|p|i}x|D]}|i|qWdS(N(R.Rthandle(RRt statementst statement((s+/usr/share/pygobject/2.0/codegen/scmexpr.pyt startParsingoscCsRti|dt}t||ot|||dn|i|dS(Nii(tstringt translatettransthasattrRtunknown(Rttuptcmd((s+/usr/share/pygobject/2.0/codegen/scmexpr.pyR0sscCsdS(N((RR9((s+/usr/share/pygobject/2.0/codegen/scmexpr.pyR8ysN(R R RtNoneR3R0R8(((s+/usr/share/pygobject/2.0/codegen/scmexpr.pyR/ks   s; a scheme file (define-func gdk_font_load ; a comment at end of line GdkFont ((string name))) (define-boxed GdkEvent gdk_event_copy gdk_event_free "sizeof(GdkEvent)") t__main__i((t __future__RR4t cStringIORRRR6trangetitchrtletterstdigitsRR.R/t _testStringR tsystargvRR#R1ts(((s+/usr/share/pygobject/2.0/codegen/scmexpr.pyss,   ! R    ./pygtk-2.14.1-i686/usr/share/gtk-doc/0000755000000000000000000000000011272037125015525 5ustar rootroot./pygtk-2.14.1-i686/usr/share/gtk-doc/html/0000755000000000000000000000000011272037125016471 5ustar rootroot./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/0000755000000000000000000000000011272037206017627 5ustar rootroot./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkrequisition.html0000644000000000000000000001356511272037113024710 0ustar rootrootgtk.Requisition
gtk.Requisition
Prev The gtk Class Reference Next

gtk.Requisition

gtk.Requisition — an object containing information about the desired space requirements of a widget.

Synopsis

class gtk.Requisition(gobject.GBoxed):
    def copy()
    def free()

Attributes

"width"Read-Writethe desired width of the widget
"height"Read-Writethe desired height of the widget

Description

A gtk.Requisition holds the information about the desired space requirements (width and height) of a widget. A gtk.Requisition object has width and height attributes that can be read and written.

Note

There appears to be no way to create or use a gtk.Requisition in PyGTK other than as an argument in the handler for the gtk.Widget "size-request" signal.

Methods

gtk.Requisition.copy

    def copy()

Returns :

a copy of the gtk.Requisition

The copy() method returns a copy of the gtk.Requisition.

gtk.Requisition.free

    def free()

Warning

This method is deprecated and should not be used since it can crash your application.

The free() method frees the resources allocated to the gtk.Requisition.

Prev Up Next
gtk.RecentManager Home gtk.Ruler
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkdragcontext.html0000644000000000000000000014236311272037113024636 0ustar rootrootgtk.gdk.DragContext
gtk.gdk.DragContext
Prev The gtk.gdk Class Reference Next

gtk.gdk.DragContext

gtk.gdk.DragContext — an object containing the drag and drop context data

Synopsis

class gtk.gdk.DragContext(gobject.GObject):
    gtk.gdk.DragContext()
    def drag_status(action, time)
    def drop_reply(ok, time)
    def drop_finish(success, time)
    def drag_get_selection()
    def drag_find_window(drag_window, x_root, y_root)
    def drag_find_window_for_screen(drag_window, screen, x_root, y_root)
    def drag_motion(dest_window, protocol, x_root, y_root, suggested_action, possible_actions, time)
    def drag_drop(time)
    def drag_abort(time)
    def finish(success, del_, time)
    def get_source_widget()
    def set_icon_widget(widget, hot_x, hot_y)
    def set_icon_pixmap(colormap, pixmap, mask, hot_x, hot_y)
    def set_icon_pixbuf(pixbuf, hot_x, hot_y)
    def set_icon_stock(stock_id, hot_x, hot_y)
    def set_icon_name(icon_name, hot_x, hot_y)
    def set_icon_default()
    def drag_drop_succeeded()

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.DragContext

Attributes

"action"Readthe action chosen by the destination. One of: gtk.gdk.ACTION_COPY, gtk.gdk.ACTION_MOVE, gtk.gdk.ACTION_LINK, gtk.gdk.ACTION_PRIVATE
"actions"Reada bitmask of actions proposed by the source when suggested_action is gtk.gdk.ACTION_ASK. A combination of: gtk.gdk.ACTION_COPY, gtk.gdk.ACTION_MOVE, gtk.gdk.ACTION_LINK, gtk.gdk.ACTION_PRIVATE
"dest_window"Readthe destination gtk.gdk.Window of this drag.
"is_source"Readif True the context is used on the source side.
"protocol"Readthe DND protocol which governs this drag - one of: gtk.gdk.DRAG_PROTO_MOTIF, gtk.gdk.DRAG_PROTO_XDND, gtk.gdk.DRAG_PROTO_ROOTWIN, gtk.gdk.DRAG_PROTO_NONE, gtk.gdk.DRAG_PROTO_WIN32_DROPFILES, gtk.gdk.DRAG_PROTO_OLE2, gtk.gdk.DRAG_PROTO_LOCAL
"source_window"Readthe source gtk.gdk.Window of this drag.
"start_time"Reada timestamp recording the start time of this drag.
"suggested_action"Readthe action suggested by the source. One of: gtk.gdk.ACTION_DEFAULT, gtk.gdk.ACTION_COPY, gtk.gdk.ACTION_MOVE, gtk.gdk.ACTION_LINK, gtk.gdk.ACTION_PRIVATE, gtk.gdk.ACTION_ASK
"targets"Reada list of targets offered by the source.

Description

A gtk.gdk.DragContext holds information about a drag in progress. It is used for both source and destination. A gtk.gdk.DragContext can be created using the gtk.gdk.DragContext() constructor but since there is no way to set its attributes the new object is not much use. Useful gtk.gdk.DragContext objects are created as a result of the gtk.gdk.Window.drag_begin() or the gtk.Widget.drag_begin() methods.

Constructor

    gtk.gdk.DragContext()

Returns :

a new gtk.gdk.DragContext

Creates a new gtk.gdk.DragContext object.

Methods

gtk.gdk.DragContext.drag_status

    def drag_status(action, time)

action :

a drag action that will be taken when a drop happens

time :

the timestamp for this action

The drag_status() method sets the specified action to be taken when a drop happens. The value of action is one of:

gtk.gdk.ACTION_DEFAULT

gtk.gdk.ACTION_COPY

Copy the data.

gtk.gdk.ACTION_MOVE

Move the data, i.e. first copy it, then delete it from the source using the DELETE target of the X selection protocol.

gtk.gdk.ACTION_LINK

Add a link to the data. Note that this is only useful if source and destination agree on what it means.

gtk.gdk.ACTION_PRIVATE

Special action which tells the source that the destination will do something that the source doesn't understand.

gtk.gdk.ACTION_ASK

Ask the user what to do with the data.

The time the action occurred is specified by time. This method is called by the drag destination in response to drag_motion() called by the drag source.

gtk.gdk.DragContext.drop_reply

    def drop_reply(ok, time)

ok :

if True the drop is accepted by the destination

time :

the timestamp

The drop_reply() method determines if the drop is accepted or rejected according to the value specified by ok. If ok is True the drop is accepted. time specifies the time that the drop reply occurred. This method is called by the drag destination when a drop is initiated by the drag source.

gtk.gdk.DragContext.drop_finish

    def drop_finish(success, time)

success :

if True the data was received

time :

the time of the finish

The drop_finish() method ends a drag operation and indicates if the drop was successful by setting the value of success. time indicates the time of the drop finish. This method is called by the drag destination.

gtk.gdk.DragContext.drag_get_selection

    def drag_get_selection()

Returns :

the selection atom

The drag_get_selection() method returns the selection atom for the current source window.

gtk.gdk.DragContext.drag_find_window

    def drag_find_window(drag_window, x_root, y_root)

drag_window :

a gtk.gdk.Window

x_root :

the x position of the pointer in root coordinates.

y_root :

the y position of the pointer in root coordinates.

Returns :

a 2-tuple containing the drag destination gtk.gdk.Window and the drag protocol

The drag_find_window() method returns a 2-tuple containing the drag destination gtk.gdk.Window and the drag protocol being used. The drag protocol is one of:

gtk.gdk.DRAG_PROTO_MOTIF

The Motif DND protocol.

gtk.gdk.DRAG_PROTO_XDND

The Xdnd protocol.

gtk.gdk.DRAG_PROTO_ROOTWIN

An extension to the Xdnd protocol for unclaimed root window drops.

gtk.gdk.DRAG_PROTO_NONE

no protocol.

gtk.gdk.DRAG_PROTO_WIN32_DROPFILES

The simple WM_DROPFILES protocol.

gtk.gdk.DRAG_PROTO_OLE2

The complex OLE2 DND protocol (not implemented).

gtk.gdk.DRAG_PROTO_LOCAL

Intra-application DND.

drag_window is a gtk.gdk.Window and x_root and y_root specify the location of the mouse pointer in the root window.

gtk.gdk.DragContext.drag_find_window_for_screen

    def drag_find_window_for_screen(drag_window, screen, x_root, y_root)

drag_window :

a gtk.gdk.Window

screen :

a gtk.gdk.Screen

x_root :

the x position of the pointer in root coordinates.

y_root :

the y position of the pointer in root coordinates.

Returns :

a 2-tuple containing the drag destination gtk.gdk.Window and the drag protocol

Note

This method is available in PyGTK 2.2 and above.

The drag_find_window_for_screen() method returns a 2-tuple containing the drag destination gtk.gdk.Window and the drag protocol being used. The drag protocol is one of:

gtk.gdk.DRAG_PROTO_MOTIF

The Motif DND protocol.

gtk.gdk.DRAG_PROTO_XDND

The Xdnd protocol.

gtk.gdk.DRAG_PROTO_ROOTWIN

An extension to the Xdnd protocol for unclaimed root window drops.

gtk.gdk.DRAG_PROTO_NONE

no protocol.

gtk.gdk.DRAG_PROTO_WIN32_DROPFILES

The simple WM_DROPFILES protocol.

gtk.gdk.DRAG_PROTO_OLE2

The complex OLE2 DND protocol (not implemented).

gtk.gdk.DRAG_PROTO_LOCAL

Intra-application DND.

drag_window is a gtk.gdk.Window and x_root and y_root specify the location of the mouse pointer in the root window.

gtk.gdk.DragContext.drag_motion

    def drag_motion(dest_window, protocol, x_root, y_root, suggested_action, possible_actions, time)

dest_window :

the destination gtk.gdk.Window the drag is moving over

protocol :

the drag protocol in use

x_root :

the x root coordinate of the mouse pointer

y_root :

the y root coordinate of the mouse pointer

suggested_action :

the suggest drag action

possible_actions :

the possible drag actions

time :

the timestamp of the drag motion

Returns :

True if there is a drag destination window and the drag has paused or a drop has occurred.

The drag_motion() method updates the drag context when the pointer moves or the set of actions changes. This method is called by the drag source. dest_window specifies the drag destination gtk.gdk.Window; protocol specifies the drag protocol being used (see the drag_find_window() method for details); x_root and y_root specify the root window coordinates of the mouse pointer; suggested_action specifies the suggested drag action (see the drag_status() method for more detail); possible_actions specifies the possible drag actions for the drag (see the drag_status() method for more detail); and, time specifies the timestamp of the drag motion.

gtk.gdk.DragContext.drag_drop

    def drag_drop(time)

time :

the timestamp of the drag drop.

The drag_drop() method initiates a drop on the current drag destination at the time specified by time. This method is called by the drag source.

gtk.gdk.DragContext.drag_abort

    def drag_abort(time)

time :

the time of the drag abort operation

The drag_abort() method aborts the current drag operation at the specified time. No drop operation is initiated. This method is called by the drag source.

gtk.gdk.DragContext.finish

    def finish(success, del_, time)

success :

if True the drop was completed

del_ :

if True the drag source should delete the source data

time :

the time of the drag finish operation.

The finish() method informs the drag source that the drop is finished, and that the data of the drag will no longer be required. If success is True the drag drop completed successfully; if del_ is True the source data should be deleted; time is the timestamp of the finish operation. This method is called by the drag destination.

gtk.gdk.DragContext.get_source_widget

    def get_source_widget()

Returns :

the source gtk.Widget if the drag is within the same application or None otherwise.

The get_source_widget() method returns the source gtk.Widget if the drag is within the application; otherwise None is returned.

gtk.gdk.DragContext.set_icon_widget

    def set_icon_widget(widget, hot_x, hot_y)

widget :

a toplevel window to use as an icon.

hot_x :

the X offset within widget of the hotspot.

hot_y :

the Y offset within widget of the hotspot.

The set_icon_widget() method changes the icon for a drag source to the specified widget with its hot spot at the offset specified by hot_x and hot_y. PyGTK will not destroy the icon, so if you don't want it to persist, you should connect to the "drag_end" signal and destroy it yourself.

gtk.gdk.DragContext.set_icon_pixmap

    def set_icon_pixmap(colormap, pixmap, mask, hot_x, hot_y)

colormap :

the colormap of the icon

pixmap :

the gtk.gdk.Pixmap image data for the icon

mask :

the gtk.gdk.Pixmap transparency mask for the icon

hot_x :

the X offset within pixmap of the hotspot.

hot_y :

the Y offset within pixmap of the hotspot.

The set_icon_pixmap() method sets pixmap as the icon for the drag. mask is a bitmap mask for pixmap and hot_x and hot_y specify the offset of the hot spot in pixmap. In general, gtk.gdk.DragContext.set_icon_pixbuf() will be more convenient to use.

gtk.gdk.DragContext.set_icon_pixbuf

    def set_icon_pixbuf(pixbuf, hot_x, hot_y)

pixbuf :

the gtk.gdk.Pixbuf to use as the drag icon.

hot_x :

the X offset within pixbuf of the hotspot.

hot_y :

the Y offset within pixbuf of the hotspot.

The set_icon_pixbuf() method sets pixbuf as the icon for the drag. hot_x and hot_y specify the offset of the hot spot within pixbuf.

gtk.gdk.DragContext.set_icon_stock

    def set_icon_stock(stock_id, hot_x, hot_y)

stock_id :

the ID of the stock icon to use for the drag.

hot_x :

the X offset within the icon of the hotspot.

hot_y :

the Y offset within the icon of the hotspot.

The set_icon_stock() method sets the the icon for a given drag from a stock ID specified by stock_id. hot_x and hot_y specify the offset of the hot spot within the stock icon.

gtk.gdk.DragContext.set_icon_name

    def set_icon_name(icon_name, hot_x, hot_y)

icon_name :

the name of the icon to use for the drag.

hot_x :

the X offset within the icon of the hotspot.

hot_y :

the Y offset within the icon of the hotspot.

Note

This method is available in PyGTK 2.10 and above.

The set_icon_name() method sets the the icon for a given drag from the named themed icon specified by icon_name. hot_x and hot_y specify the offset of the hot spot within the stock icon. See the docs for gtk.IconTheme for more information. Note that the size of the icon depends on the icon theme (the icon is loaded at the symbolic size gtk.ICON_SIZE_DND), thus hot_x and hot_y have to be used with care.

gtk.gdk.DragContext.set_icon_default

    def set_icon_default()

The set_icon_default() method sets the icon for the drag to the default icon.

gtk.gdk.DragContext.drag_drop_succeeded

    def drag_drop_succeeded()

Returns :

True if the drop was successful.

The drag_drop_succeeded() method returns True if the dropped data has been successfully transferred. This method is intended to be used while handling a gtk.gdk.DROP_FINISHED event, its return value is meaningless at other times.

Prev Up Next
gtk.gdk.DisplayManager Home gtk.gdk.Drawable
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkaspectframe.html0000644000000000000000000003736311272037113024631 0ustar rootrootgtk.AspectFrame
gtk.AspectFrame
Prev The gtk Class Reference Next

gtk.AspectFrame

gtk.AspectFrame — A frame that constrains its child to a particular aspect ratio.

Synopsis

class gtk.AspectFrame(gtk.Frame):
    gtk.AspectFrame(label=None, xalign=0.5, yalign=0.5, ratio=1.0, obey_child=True)
    def set(xalign=0.0, yalign=0.0, ratio=1.0, obey_child=True)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Frame
            +-- gtk.AspectFrame

Implemented Interfaces

gtk.AspectFrame implements gtk.Buildable

gtk.AspectFrame Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Frame Properties

"obey-child"Read/WriteMake aspect ratio match that of the child widget
"xalign"Read/WriteThe fraction of horizontal free space to the left of the child. 0.0 means no free space to the left, 1.0 means all free space to the left.
"ratio"Read/WriteThe aspect ratio of the widget in the range of 0.0001 to 10000.0 if "obey-child" is False.
"yalign"Read/WriteThe fraction of vertical free space above the child. 0.0 means no free space above, 1.0 means all free space above.

gtk.AspectFrame Style Properties

gtk.Widget Style Properties

gtk.AspectFrame Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

The gtk.AspectFrame packs a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. gtk.AspectFrame derives from gtk.Frame, so it can draw a label and a frame around the child. The frame will be "shrink-wrapped" to the size of the child.

The aspect frame "ratio" property determines the widget width:height ratio. An aspect ratio of 0.5 means the width is one half the height; an aspect ratio of 2.0 means the width is twice the height. The default value for the "ratio" property is 1.0.

The align properties are used to place the child widget within the available area by specifying the fraction of free space (space in the aspect frame that is not used by the child widget) that is placed above or to the left of the child widget. The values range from 0.0 (meaning no free space above or to the left of the child) to 1.0 (meaning all free space above or to the left of the child) . The default value for both align properties is 0.5.

If the "obey-child" property is True (the default value), the "ratio" property is ignored and the aspect ratio is set by the child widget.

Constructor

    gtk.AspectFrame(label=None, xalign=0.5, yalign=0.5, ratio=1.0, obey_child=True)

label :

a string used to set the aspect frame label

xalign :

The fraction of horizontal free space to the left of the child. 0.0 means no free space to the left, 1.0 means all free space to the left.

yalign :

The fraction of vertical free space above the child. 0.0 means no free space above, 1.0 means all free space above.

ratio :

the ratio of the child width to height (in the range 0.0001 to 10000.0) if obey_child is False

obey_child :

if True, ratio is ignored, and the aspect ratio is taken from the requisition of the child.

Returns :

a new aspect frame object

Creates a new aspect frame object with the specified label, xalign and yalign values. The default values are: label, None; xalign, 0.5; and, yalign, 0.5. If obey_child is True the ratio value is ignored. If obey_child is False, ratio sets the aspect ratio for the child widget. The default value for ratio is 1.0. The default value for obey_child is True.

Methods

gtk.AspectFrame.set

    def set(xalign=0.0, yalign=0.0, ratio=1.0, obey_child=True)

xalign :

The fraction of horizontal free space to the left of the child. 0.0 means no free space to the left, 1.0 means all free space to the left.

yalign :

The fraction of vertical free space above the child. 0.0 means no free space above, 1.0 means all free space above.

ratio :

the ratio of the child width to height (in the range 0.0001 to 10000.0) if obey_child is False

obey_child :

if True, ratio is ignored, and the aspect ratio is taken from the requisition of the child

The set() method changes the aspect frame properties to the values specified by xalign, yalign, ratio and obey_child. The default values are: xalign, 0; yalign, 0.0; ratio, 1.0; and, obey_child, True.

Prev Up Next
gtk.Arrow Home gtk.Assistant
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkrectangle.html0000644000000000000000000002704111272037113024253 0ustar rootrootgtk.gdk.Rectangle
gtk.gdk.Rectangle
Prev The gtk.gdk Class Reference Next

gtk.gdk.Rectangle

gtk.gdk.Rectangle — an object holding data about a rectangle

Synopsis

class gtk.gdk.Rectangle(gobject.GBoxed):
    gtk.gdk.Rectangle(x=0, y=0, width=0, height=0)
    def intersect(src)
    def union(src)

Attributes

"x"Read-WriteThe X coordinate of the top left corner of the rectangle.
"y"Read-WriteThe Y coordinate of the top left corner of the rectangle.
"width"Read-WriteThe width of the rectangle.
"height"Read-WriteThe height of the rectangle.

Description

A gtk.gdk.Rectangle holds the position and size of a rectangle. The position is specified by the "x" and "y" attributes and the size, by the "width" and "height" attributes.

Starting with PyGTK 2.14 gtk.gdk.Rectangle objects are properly comparable. By Python rules, rectangles (being mutable) are now unhashable. If you need to use them as dictionary keys, convert rectangle objects to tuples first. You can convert such tuples back to gtk.gdk.Rectangle using the following code: 

  rectangle = gtk.gdk.Rectangle(*tuple)

Also beginning with PyGTK 2.14 gtk.gdk.Rectangle objects have custom support for repr Python function. For any rectangle it holds that: 

  rectangle == eval(repr(rectangle))

Constructor

    gtk.gdk.Rectangle(x=0, y=0, width=0, height=0)

x :

the X coordinate of the top left corner of the rectangle

y :

the Y coordinate of the top left corner of the rectangle

width :

the width of the rectangle

height :

the height of the rectangle

Returns :

a new gtk.gdk.Rectangle object

Creates a new gtk.gdk.Rectangle with the attributes specified by x, y, width and height. Any unspecified attributes default to 0.

Methods

gtk.gdk.Rectangle.intersect

    def intersect(src)

src :

a gtk.gdk.Rectangle of a 4-tuple specifying the attributes of a rectangle as (x, y, width, height)

Returns :

a gtk.gdk.Rectangle that is the intersection of src and the rectangle

The intersect() method returns a gtk.gdk.Rectangle that is the intersection of this rectangle and the gtk.gdk.Rectangle specified by src. The value of src is either a gtk.gdk.Rectangle or a 4-tuple containing the position and size of a rectangle. If the rectangles do not intersect the returned gtk.gdk.Rectangle will have all attributes set to 0.

gtk.gdk.Rectangle.union

    def union(src)

src :

a gtk.gdk.Rectangle of a 4-tuple specifying the attributes of a rectangle as (x, y, width, height)

Returns :

a gtk.gdk.Rectangle that includes both src and the rectangle

The union() method returns a gtk.gdk.Rectangle that is the smallest rectangle containing both this rectangle and the gtk.gdk.Rectangle specified by src. The value of src is either a gtk.gdk.Rectangle or a 4-tuple containing the position and size of a rectangle.

Prev Up Next
gtk.gdk.Pixmap Home gtk.gdk.Region
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkhypertext.html0000644000000000000000000002352511272037113024360 0ustar rootrootatk.Hypertext
atk.Hypertext
Prev The atk Class Reference Next

atk.Hypertext

atk.Hypertext — the ATK interface which provides standard mechanism for manipulating hyperlinks.

Synopsis

class atk.Hypertext(gobject.GInterface):
    def get_link(link_index)
    def get_n_links()
    def get_link_index(char_index)

atk.Hypertext Signal Prototypes

"link-selected"

 def callback(atkhypertext, index, user_param1, ...)

Description

An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document. A atk.Hypertext instance is associated with one or more atk.Hyperlink objects, which are associated with particular offsets within the atk.Hypertext's included content. While this interface is derived from atk.Text, there is no requirement that atk.Hypertext instances have textual content; they may implement atk.Image as well, and atk.Hyperlink objects need not have non-zero text offsets.

Methods

atk.Hypertext.get_link

    def get_link(link_index)

link_index :

an integer specifying the desired link

Returns :

the link in this hypertext document at index link_index

Gets the link in this hypertext document at index link_index

atk.Hypertext.get_n_links

    def get_n_links()

Returns :

the number of links within this hypertext document

Gets the number of links within this hypertext document.

atk.Hypertext.get_link_index

    def get_link_index(char_index)

char_index :

a character index

Returns :

an index into the array of hyperlinks in the hypertext

Gets the index into the array of hyperlinks that is associated with the character specified by char_index, or -1 if there is no hyperlink associated with this character.

Signals

The "link-selected" atk.Hypertext Signal

    def callback(atkhypertext, index, user_param1, ...)

atkhypertext :

the object which received the signal.

index :

the index of the hyperlink which is selected

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "link-selected" signal is emitted by an atk.HyperText object when one of the hyperlinks associated with the object is selected.

Prev Up Next
atk.Hyperlink Home atk.Image
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkstatusicon.html0000644000000000000000000016261211272037113024527 0ustar rootrootgtk.StatusIcon
gtk.StatusIcon
Prev The gtk Class Reference Next

gtk.StatusIcon

gtk.StatusIcon — display an icon in the system tray (new in PyGTK 2.10)

Synopsis

class gtk.StatusIcon(gobject.GObject):
    gtk.StatusIcon()
    def get_storage_type()
    def get_gicon()
    def get_pixbuf()
    def get_stock()
    def get_icon_name()
    def get_size()
    def get_x11_window_id()
    def set_tooltip(tooltip_text)
    def set_visible(visible)
    def get_visible()
    def set_blinking(blinking)
    def get_blinking()
    def is_embedded()
    def get_geometry(screen, area, orientation)
    def get_screen()
    def set_screen(screen)
    def set_from_pixbuf(pixbuf)
    def set_from_file(filename)
    def set_from_stock(stock_id)
    def set_from_icon_name(icon_name)
    def set_from_gicon(gicon)
Functions

    def gtk.status_icon_new_from_pixbuf(pixbuf)
    def gtk.status_icon_new_from_file(filename)
    def gtk.status_icon_new_from_gicon(filename)
    def gtk.status_icon_new_from_stock(stock_id)
    def gtk.status_icon_new_from_icon_name(icon_name)
    def gtk.status_icon_position_menu(menu, statusicon)

Ancestry

+-- gobject.GObject
  +-- gtk.StatusIcon

gtk.StatusIcon Properties

"blinking"Read-Writeif True the status icon is blinking. Default value: False.
"embedded"Read-WriteTrue if the status icon is embedded in a notification area. Default value: False. This property is available in GTK+ 2.12 and above.
"file"WriteFilename to load and display. Default value: None.
"gicon"Read-WriteThe GIcon displayed in the GtkStatusIcon. For themed icons, the image will be updated automatically if the theme changes.
"icon-name"Read-WriteThe name of the icon from the icon theme. Default value: None.
"orientation"Read-WriteThe orientation of the tray in which the statusicon is embedded. Default value: gtk.ORIENTATION_HORIZONTAL. This property is available in GTK+ 2.12 and above.
"pixbuf"Read-WriteA gtk.gdk.Pixbuf to display.
"size"ReadThe size of the icon. Default value: 0.
"stock"Read-WriteStock ID for a stock image to display. Default value: None.
"storage-type"ReadThe representation being used for image data. Default value: gtk.IMAGE_EMPTY.
"visible"Read-WriteIf True the status icon is visible. Default value: True.

gtk.StatusIcon Signal Prototypes

gobject.GObject Signal Prototypes

"activate"

 def callback(status_icon, user_param1, ...)

"popup-menu"

 def callback(status_icon, button, activate_time, user_param1, ...)

"size-changed"

 def callback(status_icon, size, user_param1, ...)

Description

The "system tray" or notification area is normally used for transient icons that indicate some special state. For example, a system tray icon might appear to tell the user that they have new mail, or have an incoming instant message, or something along those lines. The basic idea is that creating an icon in the notification area is less annoying than popping up a dialog.

A gtk.StatusIcon object can be used to display an icon in a "system tray". The icon can have a tooltip, and the user can interact with it by activating it or popping up a context menu. Critical information should not solely be displayed in a gtk.StatusIcon, since it may not be visible (e.g. when the user doesn't have a notification area on his panel). This can be checked with the gtk.StatusIcon.is_embedded() method.

On X11, the implementation follows the freedesktop.org "System Tray" specification. Implementations of the "tray" side of this specification can be found e.g. in the GNOME and KDE panel applications.

Note that a gtk.StatusIcon is not a widget, but just a gobject.GObject. Making it a widget would be impractical, since the system tray on Win32 doesn't allow to embed arbitrary widgets.

Constructor

gtk.StatusIcon

    gtk.StatusIcon()

Returns :

a new gtk.StatusIcon

Note

This constructor is available in PyGTK 2.10 and above.

Creates an empty status icon object.

Methods

gtk.StatusIcon.set_from_pixbuf

    def set_from_pixbuf(pixbuf)

pixbuf :

a gtk.gdk.Pixbuf or None

Note

This method is available in PyGTK 2.10 and above.

Makes status_icon display pixbuf. See the gtk.status_icon_new_from_pixbuf() function for details.

gtk.StatusIcon.set_from_file

    def set_from_file(filename)

filename :

a filename

Note

This method is available in PyGTK 2.10 and above.

Makes status_icon display the file filename. See the gtk.status_icon_new_from_file() function for details.

gtk.StatusIcon.set_from_stock

    def set_from_stock(stock_id)

stock_id :

a stock icon id

Note

This method is available in PyGTK 2.10 and above.

Makes status_icon display the stock icon with the id stock_id. See the gtk.status_icon_new_from_stock() function for details.

gtk.StatusIcon.set_from_icon_name

    def set_from_icon_name(icon_name)

icon_name :

an icon name

Note

This method is available in PyGTK 2.10 and above.

Makes status_icon display the icon named icon_name from the current icon theme. See the gtk.status_icon_new_from_icon_name() function for details.

gtk.StatusIcon.set_from_gicon

    def set_from_gicon(gicon)

gicon :

a gio.Icon()

Note

This method is available in PyGTK 2.14 and above.

Makes status_icon display the gio.Icon() See gtk.status_icon_new_from_gicon() for details

gtk.StatusIcon.get_storage_type

    def get_storage_type()

Returns :

the image representation being used - one of the GTK Image Type Constants.

Note

This method is available in PyGTK 2.10 and above.

Gets the type of representation being used by the gtk.StatusIcon to store image data. If the gtk.StatusIcon has no image data, the return value will be gtk.IMAGE_EMPTY.

gtk.StatusIcon.get_gicon

    def get_gicon()

Returns :

the displayed icon, or None if the image is empty.

Note

This method is available in PyGTK 2.14 and above.

Retrieves the gio.Icon() being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_GICON. If this method fails, icon is left unchanged;

gtk.StatusIcon.get_x11_window_id

    def get_x11_window_id()

Returns :

An 32 bit unsigned integer identifier for the underlying X11 Window.

Note

This method is available in PyGTK 2.14 and above.

This function is only useful on the X11/freedesktop.org platform. It returns a window ID for the widget in the underlying status icon implementation. This is useful for the Galago notification service, which can send a window ID in the protocol in order for the server to position notification windows pointing to a status icon reliably.

This function is not intended for other use cases which are more likely to be met by one of the non-X11 specific methods, such as gtk.status_icon_position_menu().

gtk.StatusIcon.get_pixbuf

    def get_pixbuf()

Returns :

the displayed pixbuf, or None if the image is empty.

Note

This method is available in PyGTK 2.10 and above.

Gets the gtk.gdk.Pixbuf being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_PIXBUF (see the gtk.StatusIcon.get_storage_type() method).

gtk.StatusIcon.get_stock

    def get_stock()

Returns :

stock id of the displayed stock icon, or None if the image is empty.

Note

This method is available in PyGTK 2.10 and above.

Gets the id of the stock icon being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_STOCK (see the gtk.StatusIcon.get_storage_type() method).

gtk.StatusIcon.get_icon_name

    def get_icon_name()

Returns :

name of the displayed icon, or None if the image is empty.

Note

This method is available in PyGTK 2.10 and above.

Gets the name of the icon being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_ICON_NAME (see the gtk.StatusIcon.get_storage_type() method).

gtk.StatusIcon.get_size

    def get_size()

Returns :

the size that is available for the image

Note

This method is available in PyGTK 2.10 and above.

Gets the size in pixels that is available for the image. Stock icons and named icons adapt their size automatically if the size of the notification area changes. For other storage types, the "size-changed" signal can be used to react to size changes.

gtk.StatusIcon.set_tooltip

    def set_tooltip(tooltip_text)

tooltip_text :

the tooltip text, or None

Note

This method is available in PyGTK 2.10 and above.

Sets the tooltip of the status icon.

gtk.StatusIcon.set_visible

    def set_visible(visible)

visible :

if True show the status icon, if False hide it

Note

This method is available in PyGTK 2.10 and above.

Shows or hides a status icon.

gtk.StatusIcon.get_visible

    def get_visible()

Returns :

True if the status icon is visible

Note

This method is available in PyGTK 2.10 and above.

Returns True if the status icon is visible. Note that being visible does not guarantee that the user can actually see the icon, see also the gtk.StatusIcon.is_embedded() method.

gtk.StatusIcon.set_blinking

    def set_blinking(blinking)

blinking :

if True turn blinking on, if False turn it off

Note

This method is available in PyGTK 2.10 and above.

Makes the status icon start or stop blinking. Note that blinking user interface elements may be problematic for some users, and thus may be turned off, in which case this setting has no effect.

gtk.StatusIcon.get_blinking

    def get_blinking()

Returns :

True if the icon is blinking

Note

This method is available in PyGTK 2.10 and above.

Returns True if the icon is blinking, see the gtk.StatusIcon.set_blinking() method.

gtk.StatusIcon.is_embedded

    def is_embedded()

Returns :

True if the status icon is embedded in a notification area.

Note

This method is available in PyGTK 2.10 and above.

Returns True if the status icon is embedded in a notification area.

gtk.StatusIcon.get_geometry

    def get_geometry()

Returns :

a 3-tuple (containing the screen, area occupied by the status icon and the panel orientation) or None.

Note

This method is available in PyGTK 2.10 and above.

Returns information in a 3-tuple about the location of the status icon on screen. The 3-tuple contains the gtk.gdk.Screen, the area occupied by the status icon as a gtk.gdk.Rectangle and the orientation of the panel containing the statis icon - one of the GTK Orientation Constants. This information can be used to e.g. position popups like notification bubbles. See the gtk.status_icon_position_menu() function for a more convenient alternative for positioning menus.

Note that some platforms do not provide this information.

gtk.StatusIcon.get_screen

    def get_screen()

Returns :

a gtk.gdk.Screen.

Note

This method is available in PyGTK 2.12 and above.

Returns the gtk.gdk.Screen associated with status_icon.

gtk.StatusIcon.set_screen

    def set_screen(screen)

screen :

a gtk.gdk.Screen.

Note

This method is available in PyGTK 2.12 and above.

Sets the gtk.gdk.Screen where status_icon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen.

Functions

gtk.status_icon_new_from_pixbuf

    def gtk.status_icon_new_from_pixbuf(pixbuf)

pixbuf :

Returns :

a new gtk.StatusIcon

Creates a status icon displaying pixbuf. The image will be scaled down to fit in the available space in the notification area, if necessary.

gtk.status_icon_new_from_file

    def gtk.status_icon_new_from_file(filename)

filename :

Returns :

a new gtk.StatusIcon

Creates a status icon displaying the image in the file specified by filename. The image will be scaled down to fit in the available space in the notification area, if necessary.

gtk.status_icon_new_from_gicon

    def gtk.status_icon_new_from_gicon(gicon)

gicon :

Returns :

a new gtk.StatusIcon

Creates a status icon displaying a gio.Icon(). If the icon is a themed icon, it will be updated when the theme changes.

gtk.status_icon_new_from_stock

    def gtk.status_icon_new_from_stock(stock_id)

stock_id :

a stock icon id

Returns :

a new gtk.StatusIcon

Creates a status icon displaying a stock icon. Sample stock icon names are gtk.STOCK_OPEN, gtk.STOCK_QUIT. You can register your own stock icon names, see the gtk.IconFactory.add_default() and gtk.IconFactory.add() methods.

gtk.status_icon_new_from_icon_name

    def gtk.status_icon_new_from_icon_name(icon_name)

icon_name :

an icon name

Returns :

a new gtk.StatusIcon

Creates a status icon displaying an icon from the current icon theme. If the current icon theme is changed, the icon will be updated appropriately.

gtk.status_icon_position_menu

    def gtk.status_icon_position_menu(menu, statusicon)

menu :

the gtk.Menu

statusicon :

the gtk.StatusIcon

Returns :

a 3-tuple containing the x and y coordinates for the menu and a boolean indicating whether the menu should be pushed in to be completely inside the screen instead of just clamped to the size to the screen.

Menu positioning function to use with the popup() method to position menu aligned to statusicon .

Eample use of this function is:

  menu.popup(None, None, gtk.status_icon_position_menu, 
             event.button, event.time, statusicon)

Signals

The "activate" gtk.StatusIcon Signal

    def callback(status_icon, user_param1, ...)

status_icon :

the object which received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

Gets emitted when the user activates the status icon. If and how status icons can be activated is platform-dependent.

The "popup-menu" gtk.StatusIcon Signal

    def callback(status_icon, button, activate_time, user_param1, ...)

status_icon :

the object which received the signal

button :

the button that was pressed, or 0 if the signal is not emitted in response to a button press event

activate_time :

the timestamp of the event that triggered the signal emission

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

Gets emitted when the user brings up the context menu of the status icon. Whether status icons can have context menus and how these are activated is platform-dependent.

The button and activate_timeout parameters should be passed as the last two arguments to the gtk.Menu.popup() method.

The "size-changed" gtk.StatusIcon Signal

    def callback(status_icon, size, statusicon, arg1, user_param1, ...)

status_icon :

the object which received the signal

size :

the new size

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Returns :

True if the icon was updated for the new size. Otherwise, GTK+ will scale the icon as necessary.

Note

This signal is available in GTK+ 2.10 and above.

Gets emitted when the size available for the image changes, e.g. because the notification area got resized.

Prev Up Next
gtk.Statusbar Home gtk.Style
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkhscale.html0000644000000000000000000001674211272037113023574 0ustar rootrootgtk.HScale
gtk.HScale
Prev The gtk Class Reference Next

gtk.HScale

gtk.HScale — a horizontal slider widget for selecting a value from a range.

Synopsis

class gtk.HScale(gtk.Scale):
    gtk.HScale(adjustment=None)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Range
        +-- gtk.Scale
          +-- gtk.HScale

Implemented Interfaces

gtk.HScale implements gtk.Buildable

gtk.HScale Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Range Properties

gtk.Scale Properties

gtk.HScale Style Properties

gtk.Widget Style Properties

gtk.Range Style Properties

gtk.Scale Style Properties

gtk.HScale Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Range Signal Prototypes

gtk.Scale Signal Prototypes

Description

The gtk.HScale is subclassed from gtk.Scale to provide a widget that allows a user to select a value using a horizontal slider. See the gtk.Scale description for more information on the methods available to manage a gtk.HScale.

Constructor

    gtk.HScale(adjustment=None)

adjustment :

a gtk.Adjustment object

Returns :

a new hscale widget

Creates a new gtk.HScale widget and associates a gtk.Adjustment specified by adjustment. The default value of adjustment is None which creates the hscale with no gtk.Adjustment.

Prev Up Next
gtk.HRuler Home gtk.HScrollbar
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkrectangle.html0000644000000000000000000001351711272037113024270 0ustar rootrootatk.Rectangle
atk.Rectangle
Prev The atk Class Reference Next

atk.Rectangle

atk.Rectangle — an object holding data about a rectangle

Synopsis

class atk.Rectangle(gobject.GBoxed):
    atk.Rectangle(x=0, y=0, width=0, height=0)

Attributes

"x"Read-WriteThe X coordinate of the top left corner of the rectangle.
"y"Read-WriteThe Y coordinate of the top left corner of the rectangle.
"width"Read-WriteThe width of the rectangle.
"height"Read-WriteThe height of the rectangle.

Description

A atk.Rectangle holds the position and size of a rectangle. The position is specified by the "x" and "y" attributes and the size, by the "width" and "height" attributes.

Constructor

atk.Rectangle

    atk.Rectangle(x=0, y=0, width=0, height=0)

Returns :

a new atk.Rectangle

Creates a new atk.Rectangle with the attributes specified by x, y, width and height. Any unspecified attributes default to 0.

Prev Up Next
atk.ObjectFactory Home atk.Registry
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pygtkgenericcellrenderer.html0000644000000000000000000001713711272037113026710 0ustar rootrootgtk.GenericCellRenderer
gtk.GenericCellRenderer
Prev The gtk Class Reference Next

gtk.GenericCellRenderer

gtk.GenericCellRenderer — a TreeView cell renderer that helps create cell renderers in Python

Synopsis

class gtk.GenericCellRenderer(gtk.CellRenderer):
    gtk.GenericCellRenderer()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.CellRenderer
      +-- gtk.GenericCellRenderer

Description

The gtk.GenericCellRenderer helps in the creation of gtk.TreeView cell renderers in Python. The gtk.GenericCellRenderer is subclassed to provide a new cell renderer that provides cell renderer behavior using methods with predefined names that are called by the gtk.GenericCellRenderer methods as required to provide the various cell renderer operations. The methods that need to be defined by the programmer in Python are:

def on_get_size(widget, cell_area)
def on_render(window, widget, background_area, cell_area, expose_area, flags)
def on_activate(event, widget, path, background_area, cell_area, flags)
def on_start_editing(event, widget, path, background_area, cell_area, flags)

See the gtk.CellRenderer description for details of the above methods.

Constructor

    gtk.GenericCellRenderer()

Returns :

a new gtk.GenericCellRenderer object

Creates a new gtk.GenericCellRenderer

Prev Up Next
gtk.GammaCurve Home gtk.GenericTreeModel
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkmisc.html0000644000000000000000000002664611272037113023274 0ustar rootrootgtk.Misc
gtk.Misc
Prev The gtk Class Reference Next

gtk.Misc

gtk.Misc — a base class for widgets with alignments and padding.

Synopsis

class gtk.Misc(gtk.Widget):
    def set_alignment(xalign, yalign)
    def get_alignment()
    def set_padding(xpad, ypad)
    def get_padding()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Misc

Implemented Interfaces

gtk.Misc implements gtk.Buildable

gtk.Misc Properties

gtk.Object Properties

gtk.Widget Properties

"xalign"Read-WriteThe horizontal alignment, from 0.0 to 1.0
"xpad"Read-WriteThe amount of space to add on the left and right of the widget, in pixels
"yalign"Read-WriteThe vertical alignment, from 0.0 to 1.0
"ypad"Read-WriteThe amount of space to add above and below the widget, in pixels

gtk.Misc Style Properties

gtk.Widget Style Properties

gtk.Misc Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

Description

The gtk.Misc widget is an abstract widget used to derive subclasses which have alignment and padding attributes. The horizontal and vertical padding attributes allow extra space to be added around the widget. The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. The alignment values represent the fraction of available free space (allocation minus the widget size) to place to the left or above the widget for x and y alignment respectively. 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 have no effect.

Methods

gtk.Misc.set_alignment

    def set_alignment(xalign, yalign)

xalign :

the horizontal alignment

yalign :

the vertical alignment

The set_alignment() method sets the alignment of the widget in its allocated space. xalign sets the fraction (0.0-1.0) of free space (horizontal allocation minus widget width) to place to the left of the widget. yalign sets the fraction (0.0-1.0) of free space (vertical allocation minus widget height) to place above the widget.

gtk.Misc.get_alignment

    def get_alignment()

Returns :

a tuple containing the X and Y alignments of the widget

The get_alignment() method returns a tuple containing the X and Y alignments of the widget within its allocation. See set_alignment().

gtk.Misc.set_padding

    def set_padding(xpad, ypad)

xpad :

the amount of space to add on the left and right of the widget, in pixels.

ypad :

the amount of space to add on the top and bottom of the widget, in pixels.

The set_padding() method sets the amount of space to add around the widget. The xpad value specifies the number of pixels of padding to add to the left and right of the widget. The yalign value specifies the number of pixels to add above and below the widget.

gtk.Misc.get_padding

    def get_padding()

Returns :

a tuple containing the horizontal and vertical padding in pixels for the widget.

The get_padding() method returns a tuple containing the padding in the horizontal and vertical directions of the widget. See set_padding().

Prev Up Next
gtk.MessageDialog Home gtk.MountOperation
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkentry.html0000644000000000000000000022335011272037113023471 0ustar rootrootgtk.Entry
gtk.Entry
Prev The gtk Class Reference Next

gtk.Entry

gtk.Entry — a single line text entry field.

Synopsis

class gtk.Entry(gtk.Widget, gtk.Editable, gtk.CellEditable):
    gtk.Entry(max=0)
    def set_visibility(visible)
    def get_visibility()
    def set_invisible_char(ch)
    def get_invisible_char()
    def set_has_frame(setting)
    def get_has_frame()
    def set_max_length(max)
    def get_max_length()
    def set_activates_default(setting)
    def get_activates_default()
    def set_width_chars(n_chars)
    def get_width_chars()
    def set_text(text)
    def get_text()
    def get_layout()
    def get_layout_offsets()
    def set_alignment(xalign)
    def get_alignment()
    def set_completion(width_chars)
    def get_completion()
    def set_inner_border(border)
    def get_inner_border()
    def get_cursor_hadjustment()
    def set_cursor_hadjustment(adjustment)
    def get_override_mode()
    def set_override_mode(override)
    def get_text_length()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Entry

Implemented Interfaces

gtk.Entry implements gtk.Buildable atk.ImplementorIFace gtk.Editable gtk.CellEditable

gtk.Entry Properties

gtk.Object Properties

gtk.Widget Properties

"activates-default"Read/WriteIf True activate the default widget (such as the default button in a dialog) when Enter is pressed. Default value: False.
"cursor-position"ReadThe current position of the insertion cursor as a character index. Allowed values: [0,65535]. Default value: 0
"editable"Read/WriteIf True the entry contents can be edited. Default value: True.
"has-frame"Read/WriteIf False removes outside bevel from entry. Default value: True.
"inner-border"Read/WriteThe text area's border between the text and the frame as a gtkBorder. Available in GTK+ 2.10.
"invisible-char"Read/WriteThe character to use when masking entry contents (when "visibility" is False). Default value: '*'.
"max-length"Read/WriteThe maximum number of characters for this entry. Zero if no maximum. Allowed values: [0,65535] Default value: 0.
"override-mode"Read/WriteIf text is overwritten when typing in the GtkEntry. Default value: False. Available in GTK+ 2.14 and above.
"scroll-offset"ReadThe number of pixels of the entry scrolled off the screen to the left. Allowed values: >= 0 Default value: 0.
"selection-bound"ReadThe position of the opposite end of the selection from the cursor as a character index. Allowed values: [0,65535] Default value: 0.
"shadow-type"Read/WriteWhich kind of shadow to draw around the entry when GtkEntry:has-frame is set to True. Default value: gtk.SHADOW_IN Available in GTK+ 2.12 and above.
"text"Read/WriteThe contents of the entry. Default value: "".
"text-length"ReadThe length of the text in the GtkEntry. Allowed values: [0,65535]. Default value: 0. Available in GTK+ 2.14 and above.
"truncate-multiline"Read/WriteIf True, pasted multi-line text is truncated to the first line. Default value: False. Available in GTK+ 2.10 and above.
"visibility"Read/WriteIf False displays the "invisible char" instead of the actual text (e.g. password mode). Default value: True.
"width-chars"Read/WriteThe number of characters to leave space for in the entry. Allowed values: >= -1. Default value: -1.
"xalign"Read/WriteThe horizontal alignment ranging from 0.0 to 1.0 representing the fraction of freespace to the left (right for RTL layouts) of the text. Available in GTK+ 2.4 and above.

gtk.Entry Style Properties

gtk.Widget Style Properties

"inner-border"ReadSets the text area's border between the text and the frame This property is available in GTK+ 2.10 and above.

gtk.Entry Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Editable Signal Prototypes

gtk.CellEditable Signal Prototypes

"activate"

 def callback(entry, user_param1, ...)

"backspace

 def callback(entry, user_param1, ...)

"copy-clipboard"

 def callback(entry, user_param1, ...)

"cut-clipboard"

 def callback(entry, user_param1, ...)

"delete-from-cursor"

 def callback(entry, delete_type, count, user_param1, ...)

"insert-at-cursor"

 def callback(entry, string, user_param1, ...)

"move-cursor"

 def callback(entry, step_size, count, extend_selection, user_param1, ...)

"paste-clipboard"

 def callback(entry, user_param1, ...)

"populate-popup"

 def callback(entry, menu, user_param1, ...)

"toggle-overwrite"

 def callback(entry, user_param1, ...)

Description

The gtk.Entry widget is a single line text entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.

Constructor

    gtk.Entry(max=0)

max :

the maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be limited to the range 0-65536.

Returns :

a new gtk.Entry.

Creates a new gtk.Entry widget with the maximum length specified by max.

Methods

gtk.Entry.set_visibility

    def set_visibility(visible)

visible :

If False the contents are obscured using the "invisible-char"

The set_visibility() method sets the "visibility" property to the value of visible. If visible is True the contents of the entry are displayed as plain text. If visible is False, the contents are obscured by replacing the characters with the invisible character (specified by the "invisible-char" property). The characters will also be obscured when the text in the entry widget is copied elsewhere. The default invisible char is the asterisk '*', but it can be changed with set_invisible_char().

gtk.Entry.get_visibility

    def get_visibility()

Returns :

True if the text is currently visible

The get_visibility() method retrieves the value of the "visibility" property that determines whether the text in entry is visible. See set_visibility().

gtk.Entry.set_invisible_char

    def set_invisible_char(ch)

ch :

a Unicode character

The set_invisible_char() method sets the "invisible-char" property with the value of ch. The "invisible-char" is the character to use in place of the actual text when set_visibility() has been called to set text visibility to False. i.e. this is the character used in "password mode" to show the user how many characters have been typed. The default invisible character is an asterisk ('*'). If you set the invisible character to 0, then the user will get no feedback at all; there will be no text on the screen as they type.

gtk.Entry.get_invisible_char

    def get_invisible_char()

Returns :

the current invisible char, or 0, if the entry does not show invisible text at all.

The get_invisible_char() method retrieves the value of the "invisible-char" property. The "invisible-char" is the character displayed in place of the real characters for entries with visibility set to False. See set_invisible_char().

gtk.Entry.set_has_frame

    def set_has_frame(setting)

setting :

If True the entry is displayed with a beveled frame around it.

The set_has_frame() method sets the "has-frame" property to the value of setting. If setting is True the entry is displayed with a beveled frame around it.

gtk.Entry.get_has_frame

    def get_has_frame()

Returns :

whether the entry has a beveled frame

The get_has_frame() method gets the value of the "has-frame" property. If "has-frame" is True the entry will be displayed with a beveled frame around it.

gtk.Entry.set_max_length

    def set_max_length(max)

max :

the maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.

The set_max_length() method sets the "max-length" property to the value of max. The "max-length" property sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit. If max is 0 then there is no maximum length (other than 65536).

gtk.Entry.get_max_length

    def get_max_length()

Returns :

the maximum allowed number of characters in gtk.Entry, or 0 if there is no maximum.

The get_max_length() method retrieves the value of the "max-length" property that specifies the maximum allowed length of the text in the entry. See set_max_length().

gtk.Entry.set_activates_default

    def set_activates_default(setting)

setting :

If True activate the window's default widget on an Enter key press

The set_activates_default() method sets the "activates-default" property to the value of setting. If setting is True, pressing the Enter key in the entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons.

(For experts: if setting is True, the entry calls gtk.Window.activate_default() on the window containing the entry, in the default handler for the "activate" signal.)

gtk.Entry.get_activates_default

    def get_activates_default()

Returns :

True if the entry will activate the default widget

The get_activates_default() method retrieves the value of the "activates-default" property which is set by set_activates_default(). If "activates-default" is True pressing the Enter key in the entry will activate the default widget for the window containing the entry.

gtk.Entry.set_width_chars

    def set_width_chars(n_chars)

n_chars :

width in chars

The set_width_chars() method sets the "width-chars" property to the value of n_char. Setting the "width-chars" property changes the size request of the entry to be about the right size for n_chars characters. Note that it only changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.

gtk.Entry.get_width_chars

    def get_width_chars()

Returns :

number of chars to request space for, or negative if unset

The get_width_chars() method gets the value of the "width-chars" property which is set by the set_width_chars() method.

gtk.Entry.set_text

    def set_text(text)

text :

a string to use as the new contents of the entry

The set_text() method sets the "text" property to the value of text. The string in text replaces the current contents of the entry.

gtk.Entry.get_text

    def get_text()

Returns :

the contents of the entry as a string

The get_text() method returns the value of the "text" property which is a string containing the contents of the entry.

gtk.Entry.get_layout

    def get_layout()

Returns :

the pango.Layout for this entry

The get_layout() method gets the pango.Layout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with get_layout_offsets().

gtk.Entry.get_layout_offsets

    def get_layout_offsets()

Returns :

a tuple containing the X and Y offsets of the pango layout

The get_layout_offsets() method obtains the position of the pango.Layout used to render text in the entry, in widget coordinates and returns it as a tuple. This method is used to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget. It is also useful to convert mouse events into coordinates inside the pango.Layout, e.g. to take some action if some part of the entry text is clicked.

Note that as the user scrolls around in the entry the offsets will change; you'll need to connect to the "notify::scroll_offset" signal to track this.

gtk.Entry.set_alignment

    def set_alignment(xalign)

xalign :

The horizontal alignment ranging from 0.0 to 1.0 representing the freespace to the left (right for RTL layouts) of the text.

Note

This method is available in PyGTK 2.4 and above.

The set_alignment() method sets the "xalign" property to the value of xalign. The alignment controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry. The value of xalign is the fraction of freespace to the left (right in RTL layouts) of the text.

gtk.Entry.get_alignment

    def get_alignment()

Returns :

The horizontal alignment ranging from 0.0 to 1.0 representing the freespace to the left (right for RTL layouts) of the text.

Note

This method is available in PyGTK 2.4 and above.

The get_alignment() method returns the value of the "xalign" property which is the fraction of freespace (if any) to the left (right in RTL layouts) of the text.

gtk.Entry.set_completion

    def set_completion(completion)

completion :

a gtk.EntryCompletion

Note

This method is available in PyGTK 2.4 and above.

The set_completion() method sets the gtk.EntryCompletion specified by completion to be the auxiliary completion object to use with the entry. All further configuration of the completion mechanism is done using completion and the gtk.EntryCompletion methods.

gtk.Entry.get_completion

    def get_completion()

Returns :

the auxiliary completion object

Note

This method is available in PyGTK 2.4 and above.

The get_completion() method returns the gtk.EntryCompletion object currently in use by the entry.

gtk.Entry.set_inner_border

    def set_inner_border(border)

border :

a gtk.Border, or None

Note

This method is available in PyGTK 2.10 and above.

The set_inner_border() method sets the entry's "inner-border" property to the value specified by border, or clears it if None is passed. The "inner-border" is the area around the entry's text, but inside its frame.

If set, this property overrides the inner-border style property. Overriding the style-provided border is useful when you want to do in-place editing of some text in a canvas or list widget, where pixel-exact positioning of the entry is important.

gtk.Entry.get_inner_border

    def get_inner_border()

Returns :

the entry's gtk.Border, or None if none was set.

Note

This method is available in PyGTK 2.10 and above.

The get_inner_border() method returns the value of the entry's "inner-border" property. See set_inner_border() for more information.

gtk.Entry.set_cursor_hadjustment

    def set_cursor_hadjustment(adjustment)

adjustment :

An adjustment which should be adjusted when the cursor is moved, or None.

Note

This method is available in PyGTK 2.12 and above.

The set_cursor_hadjustment() method hooks up an adjustment to the cursor position in an entry, so that when the cursor is moved, the adjustment is scrolled to show that position. See gtk.ScrolledWindow.get_hadjustment for a typical way of obtaining the adjustment. The adjustment has to be in pixel units and in the same coordinate system as the entry.

gtk.Entry.get_cursor_hadjustment

    def get_cursor_hadjustment()

Returns :

The horizontal cursor adjustment, or None if none has been set.

Note

This method is available in PyGTK 2.12 and above.

The get_cursor_hadjustment() method retrieves the horizontal cursor adjustment for the entry. See set_cursor_hadjustment.

gtk.Entry.set_override_mode

    def set_override_mode(override)

override :

new value.

Note

This method is available in PyGTK 2.14 and above.

The set_override_mode() method sets whether the text is overwritten when typing in the GtkEntry.

gtk.Entry.get_override_mode

    def get_override_mode()

Returns :

whether the text is overwritten when typing.

Note

This method is available in PyGTK 2.14 and above.

The get_override_mode() method gets the value set by gtk.Entry.set_override_mode().

gtk.Entry.get_text_length

    def get_text_length()

Returns :

the current number of characters in GtkEntry, or 0 if there are none.

Note

This method is available in PyGTK 2.14 and above.

The get_text_length() method retrieves the current length of the text in entry.

Signals

The "activate" gtk.Entry Signal

    def callback(entry, user_param1, ...)

entry :

the entry that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "activate" signal is emitted when the entry is activated either by user action (pressing the Enter key) or programmatically with the gtk.Widget.activate() method

The "backspace" gtk.Entry Signal

    def callback(entry, user_param1, ...)

entry :

the object which received the signal.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "backspace" signal is emitted when the Backspace key is entered from the keyboard.

The "copy-clipboard" gtk.Entry Signal

    def callback(entry, user_param1, ...)

entry :

the entry that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "copy-clipboard" signal is emitted when the selection text in the entry is copied to the clipboard.

The "cut-clipboard" gtk.Entry Signal

    def callback(entry, user_param1, ...)

entry :

the entry that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "cut-clipboard" signal is emitted when the selection in the entry is cut (removed from the entry) and placed in the clipboard.

The "delete-from-cursor" gtk.Entry Signal

    def callback(entry, delete_type, count, user_param1, ...)

entry :

the entry that received the signal

delete_type :

the type of deletion

count :

the number of deletions of the type to perform

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "delete-from-cursor" signal is emitted when the a deletion from the cursor i.e. removal o text at the cursor position, either before it (negative count) or after it (positive count). The value of delete_type can be one of:

  • gtk.DELETE_CHARS
  • gtk.DELETE_WORD_ENDS
  • gtk.DELETE_WORDS
  • gtk.DELETE_DISPLAY_LINES
  • gtk.DELETE_DISPLAY_LINE_ENDS
  • gtk.DELETE_PARAGRAPH_ENDS
  • gtk.DELETE_PARAGRAPHS
  • gtk.DELETE_WHITESPACE

The "insert-at-cursor" gtk.Entry Signal

    def callback(entry, string, user_param1, ...)

entry :

the entry that received the signal

string :

the text being inserted in the entry

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "insert-at-cursor" signal is emitted when text is being inserted in the entry.

The "move-cursor" gtk.Entry Signal

    def callback(entry, step, count, extend_selection, user_param1, ...)

entry :

the entry that received the signal

step :

the size of the step to move the cursor

count :

the number of steps to move the cursor

extend_selection :

if True extend the selection as well as moving the cursor

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "move-cursor" signal is emitted when the cursor is being moved by count steps of size step. If extend_selection is True the selection is extended as the cursor is being moved. The value of step can be one of:

  • gtk.MOVEMENT_LOGICAL_POSITIONS
  • gtk.MOVEMENT_VISUAL_POSITIONS
  • gtk.MOVEMENT_WORDS
  • gtk.MOVEMENT_DISPLAY_LINES
  • gtk.MOVEMENT_DISPLAY_LINE_ENDS
  • gtk.MOVEMENT_PARAGRAPH_ENDS
  • gtk.MOVEMENT_PARAGRAPHS
  • gtk.MOVEMENT_PAGES
  • gtk.MOVEMENT_BUFFER_ENDS

The "paste-clipboard" gtk.Entry Signal

    def callback(entry, user_param1, ...)

entry :

the entry that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "paste-clipboard" signal is emitted when the contents of the clipboard are pasted into the entry.

The "populate-popup" gtk.Entry Signal

    def callback(entry, menu, user_param1, ...)

entry :

the entry that received the signal

menu :

the menu that needs populating

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "populate-popup" signal is emitted when the menu needs populating.

The "toggle-overwrite" gtk.Entry Signal

    def callback(entry, user_param1, ...)

entry :

the entry that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "toggle-overwrite" signal is emitted when the internal entry attribute "overwrite_mode" is toggled by pressing the Insert key.

Prev Up Next
gtk.Editable Home gtk.EntryCompletion
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkpixmap.html0000644000000000000000000011642011272037113023605 0ustar rootrootgtk.gdk.Pixmap
gtk.gdk.Pixmap
Prev The gtk.gdk Class Reference Next

gtk.gdk.Pixmap

gtk.gdk.Pixmap — An offscreen gtk.gdk.Drawable

Synopsis

class gtk.gdk.Pixmap(gtk.gdk.Drawable):
    gtk.gdk.Pixmap(drawable, width, height, depth=-1)
Functions

    def gtk.gdk.bitmap_create_from_data(drawable, data, width, height)
    def gtk.gdk.pixmap_create_from_data(drawable, data, width, height, depth, fg, bg)
    def gtk.gdk.pixmap_create_from_xpm(window, transparent_color, filename)
    def gtk.gdk.pixmap_colormap_create_from_xpm(window, colormap, transparent_color, filename)
    def gtk.gdk.pixmap_create_from_xpm_d(window, transparent_color, data)
    def gtk.gdk.pixmap_colormap_create_from_xpm_d(window, colormap, transparent_color, data)
    def gtk.gdk.pixmap_foreign_new(anid)
    def gtk.gdk.pixmap_lookup(anid)
    def gtk.gdk.pixmap_foreign_new_for_display(display, anid)
    def gtk.gdk.pixmap_lookup_for_display(display, anid)

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.Drawable
    +-- gtk.gdk.Pixmap

Description

A gtk.gdk.Pixmap is an offscreen gtk.gdk.Drawable. It can be drawn upon with the standard gtk.gdk.Drawable drawing primitives, then copied to another gtk.gdk.Drawable (such as a gtk.gdk.Window) with the draw_drawable() method. The depth of a pixmap is the number of bits per pixels. A bitmaps are simply a gtk.gdk.Pixmap with a depth of 1. (That is, they are monochrome pixmaps - each pixel can be either on or off).

Constructor

    gtk.gdk.Pixmap(drawable, width, height, depth=-1)

drawable :

a gtk.gdk.Drawable used to determine default values for the new pixmap or None if depth is specified.

width :

the width of the new pixmap in pixels.

height :

the height of the new pixmap in pixels.

depth :

the depth (number of bits per pixel) of the new pixmap or -1 to use the depth of drawable.

Returns :

a new gtk.gdk.Pixmap object

Creates a new gtk.gdk.Pixmap with the size specified by width and height and the number of bits per pixel specified by depth.

Functions

gtk.gdk.bitmap_create_from_data

    def gtk.gdk.bitmap_create_from_data(drawable, data, width, height)

drawable :

a gtk.gdk.Drawable used to determine default values for the new pixmap or None to use the root window.

data :

a string containing the XBM data

width :

the width of the new bitmap in pixels.

height :

the height of the new bitmap in pixels.

Returns :

a new bitmap (gtk.gdk.Pixmap) object

The gtk.gdk.bitmap_create_from_data() function returns a new bitmap of the size specified by width and height from the XBM format string specified by data.

gtk.gdk.pixmap_create_from_data

    def gtk.gdk.pixmap_create_from_data(drawable, data, width, height, depth, fg, bg)

drawable :

a gtk.gdk.Drawable used to determine default values for the new pixmap or None if depth is specified.

data :

the string containing the pixmap data.

width :

the width of the new pixmap in pixels.

height :

the height of the new pixmap in pixels.

depth :

the depth (number of bits per pixel) of the new pixmap or -1 to use the depth of drawable.

fg :

the foreground color.

bg :

he background color.

Returns :

a new gtk.gdk.Pixmap object

The gtk.gdk.pixmap_create_from_data() function creates a two-color gtk.gdk.Pixmap of the size specified by width and height from the XBM format string specified by data. The foreground and background colors of the pixmap are specified by fg and bg respectively. If depth is -1 drawable is used to determine the bits per pixels otherwise the value of depth is used.

gtk.gdk.pixmap_create_from_xpm

    def gtk.gdk.pixmap_create_from_xpm(window, transparent_color, filename)

window :

a gtk.gdk.Drawable, used to determine default values for the new gtk.gdk.Pixmap.

transparent_color :

the color to be used for the pixels that are transparent in the input file or None to use a default color.

filename :

the name of a file containing XPM data.

Returns :

a tuple containing a new gtk.gdk.Pixmap object and a bitmap that is the transparency mask.

The gtk.gdk.pixmap_create_from_xpm() function returns a tuple containing a gtk.gdk.Pixmap and a bitmap transparency mask created from the XPM data in the file specified by filename. transparent_color (if not None) specifies the gtk.gdk.Color to by used for the transparent pixels.

gtk.gdk.pixmap_colormap_create_from_xpm

    def gtk.gdk.pixmap_colormap_create_from_xpm(window, colormap, transparent_color, filename)

window :

a gtk.gdk.Drawable, used to determine default values for the new gtk.gdk.Pixmap or None if a gtk.gdk.Colormap is specified.

colormap :

the gtk.gdk.Colormap that the new gtk.gdk.Pixmap will be use or None to use the colormap of window.

transparent_color :

the color to be used for the pixels that are transparent in the input file or None to use a default color.

filename :

the name of a file containing XPM data.

Returns :

a tuple containing a new gtk.gdk.Pixmap object and a bitmap that is the transparency mask.

The gtk.gdk.pixmap_colormap_create_from_xpm() function returns a tuple containing a gtk.gdk.Pixmap and a bitmap transparency mask created from the XPM data in the file specified by filename. transparent_color (if not None) specifies the gtk.gdk.Color to by used for the transparent pixels. If colormap is not None it must specify a gtk.gdk.Colormap that the new gtk.gdk.Pixmap will use. If colormap is None the new gtk.gdk.Pixmap will use the colormap of window.

gtk.gdk.pixmap_create_from_xpm_d

    def gtk.gdk.pixmap_create_from_xpm_d(window, transparent_color, data)

window :

a gtk.gdk.Drawable, used to determine default values for the new gtk.gdk.Pixmap.

transparent_color :

the color to be used for the pixels that are transparent in the input file or None to use a default color.

data :

a list of strings containing the XPM data.

Returns :

a tuple containing a new gtk.gdk.Pixmap object and a bitmap that is the transparency mask.

The gtk.gdk.pixmap_create_from_xpm_d() function returns a tuple containing a new gtk.gdk.Pixmap and a bitmap transparency mask created from the XPM data contained in data. transparent_color (if not None) specifies the gtk.gdk.Color to by used for the transparent pixels.

gtk.gdk.pixmap_colormap_create_from_xpm_d

    def gtk.gdk.pixmap_colormap_create_from_xpm_d(window, colormap, transparent_color, data)

window :

a gtk.gdk.Drawable, used to determine default values for the new gtk.gdk.Pixmap.

colormap :

the gtk.gdk.Colormap that the new gtk.gdk.Pixmap will be use or None to use the colormap of window.

transparent_color :

the color to be used for the pixels that are transparent in the input file or None to use a default color.

data :

a list of strings containing the XPM data.

Returns :

a tuple containing a new gtk.gdk.Pixmap object and a bitmap that is the transparency mask.

The gtk.gdk.pixmap_colormap_create_from_xpm_d() function returns a tuple containing a new gtk.gdk.Pixmap and a bitmap transparency mask created from the XPM data contained in data. transparent_color (if not None) specifies the gtk.gdk.Color to by used for the transparent pixels. If colormap is not None it must specify a gtk.gdk.Colormap that the new gtk.gdk.Pixmap will use. If colormap is None the new gtk.gdk.Pixmap will use the colormap of window.

gtk.gdk.pixmap_foreign_new

    def gtk.gdk.pixmap_foreign_new(anid)

anid :

 a native window system pixmap handle.

Returns :

 the new gtk.gdk.Pixmap wrapper for the native pixmap or None if the pixmap has been destroyed.

The gtk.gdk.pixmap_foreign_new() function returns a gtk.gdk.Pixmap that wraps the native window specified by anid for the default display. If the pixmap has been destroyed this function returns None. In the X backend, anid must specify an Xlib XID that is a native pixmap handle.

gtk.gdk.pixmap_lookup

    def gtk.gdk.pixmap_lookup(anid)

anid :

 a native window system pixmap handle.

Returns :

 the new gtk.gdk.Pixmap wrapper for the native pixmap or None if the pixmap has been destroyed.

The gtk.gdk.pixmap_lookup() function returns looks up and returns the gtk.gdk.Pixmap that wraps the native pixmap handle specified by anid. This method returns None if no gtk.gdk.Pixmap wraps anid. In the X backend, anid must specify an Xlib XID that is a native pixmap handle.

gtk.gdk.pixmap_foreign_new_for_display

    def gtk.gdk.pixmap_foreign_new_for_display(display, anid)

display :

a gtk.gdk.Display object

anid :

 a native window system pixmap handle.

Returns :

 the new gtk.gdk.Pixmap wrapper for the native pixmap or None if the pixmap has been destroyed.

Note

This function is available in PyGTK2.2 and above.

The gtk.gdk.pixmap_foreign_new_for_display() function returns a gtk.gdk.Pixmap that wraps the native window specified by anid for the gtk.gdk.Display specified by display. If the pixmap has been destroyed this function returns None. In the X backend, anid must specify an Xlib XID that is a native pixmap handle.

gtk.gdk.pixmap_lookup_for_display

    def gtk.gdk.pixmap_lookup_for_display(display, anid)

display :

a gtk.gdk.Display object

anid :

 a native window system pixmap handle.

Returns :

 the new gtk.gdk.Pixmap wrapper for the native pixmap or None if the pixmap has been destroyed.

Note

This function is available in PyGTK2.2 and above.

The gtk.gdk.pixmap_lookup_for_display() function returns looks up and returns the gtk.gdk.Pixmap that wraps the native pixmap handle specified by anid for the gtk.gdk.Display specified by display. This method returns None if no gtk.gdk.Pixmap wraps anid. In the X backend, anid must specify an Xlib XID that is a native pixmap handle.

Prev Up Next
gtk.gdk.PixbufLoader Home gtk.gdk.Rectangle
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/unixprint-class-reference.html0000644000000000000000000000613411272037113025615 0ustar rootrootThe gtkunixprint Class Reference
The gtkunixprint Class Reference
Prev   Next

The gtkunixprint Class Reference

Table of Contents

gtkunixprint.PageSetupUnixDialog — a dialog for setting up a printer page on Unix (new in PyGTK 2.10)
gtkunixprint.Printer — an object representing a print in Unix (new in PyGTK 2.10)
gtkunixprint.PrintJob — an object that represents a print job (new in PyGTK 2.10)
gtkunixprint.PrintUnixDialog — an dialog for selecting a printer in Unix (new in PyGTK 2.10)
gtkunixprint Functions — the built-in functions of the gtkunixprint module
gtkunixprint Constants — the built-in constants of the gtkunixprint module (new in PyGTK 2.10)
Prev   Next
pangocairo Constants Home gtkunixprint.PageSetupUnixDialog
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkaccelmap.html0000644000000000000000000010607611272037113024102 0ustar rootrootgtk.AccelMap
gtk.AccelMap
Prev The gtk Class Reference Next

gtk.AccelMap

gtk.AccelMap — Loadable keyboard accelerator specifications (new in PyGTK 2.10)

Synopsis

class gtk.AccelMap(gobject.GObject):

Functions
    def gtk.accel_map_add_entry(accel_path, accel_key, accel_mods)
    def gtk.accel_map_lookup_entry(accel_path)
    def gtk.accel_map_change_entry(accel_path, accel_key, accel_mods, replace)
    def gtk.accel_map_foreach(foreach_func, data=None)
    def gtk.accel_map_foreach_unfiltered(foreach_func, data=None)
    def gtk.accel_map_get()
    def gtk.accel_map_load(file_name)
    def gtk.accel_map_save(file_name)
    def gtk.accel_map_load_fd(fd)
    def gtk.accel_map_save_fd(fd)
    def gtk.accel_map_lock_path(accel_path)
    def gtk.accel_map_unlock_path(accel_path)
    def gtk.accel_map_add_filter(filter_pattern)
    def gtk.accel_groups_from_object(object)

Ancestry

+-- gobject.GObject
  +-- gtk.AccelMap

gtk.AccelMap Signal Prototypes

gobject.GObject Signal Prototypes

"changed"

 def callback(object, accel_path, accel_key, accel_mods, user_param1, ...)

Description

Functions

gtk.accel_map_add_entry

    def gtk.accel_map_add_entry(accel_path, accel_key, accel_mods)

accel_path :

a valid accelerator path

accel_key :

the accelerator key

accel_mods :

the accelerator modifiers

Note

This function is available in PyGTK 2.4 and above.

The gtk.accel_map_add_entry() function registers a new accelerator specified by accel_key and accel_mods with the global accelerator map. The accelerator will be associated with the accelerator path specified by accel_path. This function should only be called once per accel_path with the canonical accel_key and accel_mods for this path. To change the accelerator during runtime programatically, use the gtk.accel_map_change_entry() function. The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action", where <WINDOWTYPE> should be a unique application-specific identifier, that corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image", "Abiword-Document" or "Gnumeric-Settings". The Category1/.../Action portion is most appropriately chosen by the action the accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path, e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a full valid accelerator path may look like: "<Gimp-Toolbox>/File/Dialogs/Tool Options...".

gtk.accel_map_lookup_entry

    def gtk.accel_map_lookup_entry(accel_path)

accel_path :

a valid accelerator path

Returns :

a 2-tuple containing the keyval and modifier mask corresponding to accel_path or None if not valid

The gtk.accel_map_lookup_entry() function returns a 2-tuple containing the keyval and modifier mask corresponding to the accelerator path specified by accel_path or None if accel_path is not a valid accelerator path.

The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action", where <WINDOWTYPE> should be a unique application-specific identifier, that corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image", "Abiword-Document" or "Gnumeric-Settings". The Category1/.../Action portion is most appropriately chosen by the action the accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path, e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a full valid accelerator path may look like: "<Gimp-Toolbox>/File/Dialogs/Tool Options...".

gtk.accel_map_change_entry

    def gtk.accel_map_change_entry(accel_path, accel_key, accel_mods, replace)

accel_path :

a valid accelerator path

accel_key :

 the new accelerator key

accel_mods :

 the new accelerator modifiers

replace :

if True other accelerators may be deleted if conflicting

Returns :

True if the accelerator could be changed

The gtk.accel_map_change_entry() function changes the keyval and modifier mask currently associated with the accelerator path specified by accel_path to the values specified by accel_key and accel_mods respectively. Due to conflicts with other accelerators, a change may not always be possible. If replace is True the other accelerators may be deleted to resolve such conflicts. A change will only occur if all conflicts could be resolved (which might not be the case if conflicting accelerators are locked). Successful changes are indicated by a True return value.

gtk.accel_map_foreach

    def gtk.accel_map_foreach(foreach_func, data=None)

foreach_func :

function to be executed for each accel map entry which is not filtered out

data :

data to be passed into foreach_func

Note

This function is available in PyGTK 2.10 and above.

Loops over the entries in the accelerator map whose accel path doesn't match any of the filters added with the gtk.accel_map_add_filter() function, and executes foreach_func on each. The signature of foreach_func is:

  def foreach_func(accel_path, accel_key, accel_mode, changed, user_data):

where accel_path, accel_key and accel_mode describe the accel map accelerator entry and the changed parameter indicates whether this accelerator was changed during runtime ( and thus, would need saving during an accelerator map dump). user_data is data if data was specified. See the gtk.accel_map_add_entry() function for more information.

gtk.accel_map_foreach_unfiltered

    def gtk.accel_map_foreach_unfiltered(foreach_func, data=None)

foreach_func :

function to be executed for each accel map entry

data :

data to be passed into foreach_func

Note

This function is available in PyGTK 2.10 and above.

Loops over all entries in the accelerator map, and executes foreach_func on each. The signature of foreach_func is:

  def foreach_func(accel_path, accel_key, accel_mode, changed, user_data):

where accel_path, accel_key and accel_mode describe the accel map accelerator entry and the changed parameter indicates whether this accelerator was changed during runtime (thus, would need saving during an accelerator map dump). user_data is data if data was specified. See the gtk.accel_map_add_entry() function for more information.

gtk.accel_map_get

    def gtk.accel_map_get()

Returns :

the global gtk.AccelMap object

Note

This function is available in PyGTK 2.10 and above.

Gets the singleton global gtk.AccelMap object. This object is useful only for notification of changes to the accelerator map via the "changed" signal. it has no methods or properties.

gtk.accel_map_load

    def gtk.accel_map_load(file_name)

file_name :

the file containing accelerator specifications

The gtk.accel_map_load() function parses the file (specified by file_name) previously saved with the gtk.accel_map_save() function for accelerator specifications, and propagates them accordingly.

gtk.accel_map_save

    def gtk.accel_map_save(file_name)

file_name :

the file to save the accelerator specifications in

The gtk.accel_map_save() function saves current accelerator specifications (accelerator path, key and modifiers) to the file specified by file_name. The file is written in a format suitable to be read back in by the gtk.accel_map_load() function.

gtk.accel_map_load_fd

    def gtk.accel_map_load_fd(fd)

fd :

a Python file object or an integer file descriptor

The gtk.accel_map_load_fd() function loads the accelerator map from the open Python file object specified by fd. fd may also be an integer file descriptor. See the gtk.accel_map_load() function.

gtk.accel_map_save_fd

    def gtk.accel_map_save_fd(fd)

fd :

a Python file object or an integer file descriptor

The gtk.accel_map_save_fd() function saves the accelerator map into the open Python file object specified by fd. fd may also be an integer file descriptor. See the gtk.accel_map_save() function.

gtk.accel_map_lock_path

    def gtk.accel_map_lock_path(accel_path)

accel_path :

a valid accelerator path

Note

This function is available in PyGTK 2.4 and above.

The gtk.accel_map_lock_path() function locks the accelerator path specified by accel_path. If the accelerator map doesn't yet contain an entry for accel_path, a new one is created.

Locking an accelerator path prevents its accelerator from being changed during runtime. A locked accelerator path can be unlocked by the gtk.accel_map_unlock_path() function. Refer to the gtk.accel_map_change_entry() function for information about runtime accelerator changes.

If called more than once, accel_path remains locked until the gtk.accel_map_unlock_path() function has been called an equivalent number of times.

Note that locking of individual accelerator paths is independent from locking the gtk.AccelGroup containing them. For runtime accelerator changes to be possible both the accelerator path and its gtk.AccelGroup have to be unlocked.

gtk.accel_map_unlock_path

    def gtk.accel_map_unlock_path(accel_path)

accel_path :

a valid accelerator path

Note

This function is available in PyGTK 2.4 and above.

The gtk.accel_map_unlock_path() function undoes the last call to the gtk.accel_map_lock_path() function on the accelerator path specified by accel_path. Refer to the gtk.accel_map_lock_path() function for information about accelerator path locking.

gtk.accel_map_add_filter

    def gtk.accel_map_add_filter(filter_pattern)

filter_pattern :

a glob-style pattern

Returns :

The gtk.accel_map_add_filter() function adds the filter pattern specified by filter_pattern to the global list of accel path filters. The pattern specified by filter_pattern contain '*' and '?' wildcards with similar semantics as the Python glob.py and fnmatch.py modules: '*' matches an arbitrary, possibly empty, string, '?' matches an arbitrary character. Note that in contrast to glob.py, the '/' character can be matched by the wildcards, there are no '[...]' character ranges and '*' and '?' can not be escaped to include them literally in a pattern. Accelerator map entries whose accelerator path matches one of the filters are skipped by the gtk.accel_map_foreach() function. This function is intended for PyGTK modules that create their own menus, but don't want them to be saved into the applications accelerator map dump.

Signals

The "changed" gtk.AccelMap Signal

    def callback(object, accel_path, accel_key, accel_mods, user_param1, ...)

object :

the global accel map object

accel_path :

the path of the accelerator that changed

accel_key :

the key value for the new accelerator

accel_mods :

the modifier mask for the new accelerator

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.4 and above.

Notifies of a change in the global accelerator map. The path is also used as the detail for the signal, so it is possible to connect to changed::accel_path.

Prev Up Next
gtk.AccelLabel Home gtk.Accessible
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkstreamablecontent.html0000644000000000000000000001334611272037113026036 0ustar rootrootatk.StreamableContent
atk.StreamableContent
Prev The atk Class Reference Next

atk.StreamableContent

atk.StreamableContent — the ATK interface which provides access to streamable content.

Synopsis

class atk.StreamableContent(gobject.GInterface):
    def get_n_mime_types()
    def get_mime_type(i)

Description

An interface whereby an object allows its backing content to be streamed to clients. Typical implementors would be images or icons, HTML content, or multimedia display/rendering widgets.

Negotiation of content type is allowed. Clients may examine the backing data and transform, convert, or parse the content in order to present it in an alternate form to end-users.

The atk.StreamableContent interface is particularly useful for saving, printing, or post-processing entire documents, or for persisting alternate views of a document. If document content itself is being serialized, stored, or converted, then use of the atk.StreamableContent interface can help address performance issues. Unlike most ATK interfaces, this interface is not strongly tied to the current user-agent view of the a particular document, but may in some cases give access to the underlying model data.

Methods

atk.StreamableContent.get_n_mime_types

    def get_n_mime_types()

Returns :

an integer which is the number of mime types supported by the object.

Gets the number of mime types supported by this object.

atk.StreamableContent.get_mime_type

    def get_mime_type(i)

i :

an index representing the position of the mime type starting from 0

Returns :

: a string* representing the specified mime type.

Gets the character string of the specified mime type. The first mime type is at position 0, the second at position 1, and so on.

Prev Up Next
atk.StateSet Home atk.Table
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/pango-constants.html0000644000000000000000000006125411272037113023640 0ustar rootrootpango Constants
pango Constants
Prev The pango Class Reference Next

pango Constants

pango Constants — the built-in constants of the pango module

Synopsis

Pango Alignment Constants
Pango Attribute Type Constants
Pango Coverage Level Constants
Pango Direction Constants
Pango Ellipsize Mode Constants
Pango Font Mask Flag Constants
Pango Render Part Constants
Pango Scale Constants
Pango Stretch Constants
Pango Style Constants
Pango Tab Constants
Pango Underline Constants
Pango Variant Constants
Pango Weight Constants
Pango Wrap Mode Constants

Description

Pango Alignment Constants

The Alignment constants specify how to align the lines of a pango.Layout within the available space. If the pango.Layout is set to justify using the pango.Layout.set_justify() method, then this only has an effect for partial lines.

pango.ALIGN_LEFT

Put all available space on the right

pango.ALIGN_CENTER

Center the line within the available space

pango.ALIGN_RIGHT

Put all available space on the left

Pango Attribute Type Constants

The Attribute Type constants specify the type of a pango.Attribute.Along with the predefined values, it is possible to allocate additional values for custom attributes using the pango.attr_type_register() function. The predefined values are given below. The type of structure used to store the attribute is listed in parentheses after the description.

pango.ATTR_LANGUAGE

Specifies a pango.Language.

pango.ATTR_FAMILY

Specifies a font family name list as a string.

pango.ATTR_STYLE

Specifies a font slant style. See the pango.AttrStyle() function for more details.

pango.ATTR_WEIGHT

Specifies a font weight. See the pango.AttrWeight() function for more detail.

pango.ATTR_VARIANT

Specifies a font variant (normal or small caps). See the pango.AttrVariant() function for more detail.

pango.ATTR_STRETCH

Specifies a font stretch. See the pango.AttrStretch() function for more details.

pango.ATTR_SIZE

Specifies a font size in thousandths of a point.

pango.ATTR_FONT_DESC

Specifies a pango.FontDescription.

pango.ATTR_FOREGROUND

Specifies a foreground pango.Color.

pango.ATTR_BACKGROUND

Specifies a background pango.Color.

pango.ATTR_UNDERLINE

Specifies an underline style. See the pango.AttrUnderline() function for more details.

pango.ATTR_STRIKETHROUGH

If True the text is struck through.

pango.ATTR_RISE

Specifies the displacement of the text from the baseline.

pango.ATTR_SHAPE

Specifies a shape. See the pango.AttrShape() function for more details.

pango.ATTR_SCALE

Specifies a font size scale factor.

pango.ATTR_FALLBACK

if True, fallback to other fonts is enabled (

Pango Coverage Level Constants

pango.COVERAGE_NONE

The character is not representable with the font.

pango.COVERAGE_FALLBACK

The character is represented in a way that may be comprehensible but is not the correct graphical form. For instance, a Hangul character represented as a a sequence of Jamos, or a Latin transliteration of a Cyrillic word.

pango.COVERAGE_APPROXIMATE

The character is represented as basically the correct graphical form, but with a stylistic variant inappropriate for the current script.

pango.COVERAGE_EXACT

The character is represented as the correct graphical form.

Pango Direction Constants

The pango Direction constants specify a direction in the Unicode bidirectional algorithm. Not every value in this enumeration makes sense for every usage of pango Direction.

The pango.DIRECTION_TTB_LTR, pango.DIRECTION_TTB_RTL values come from an earlier interpretation of this enumeration as the writing direction of a block of text and are no longer used; See the Text module of the CSS3 spec for how vertical text is planned to be handled in a future version of Pango. The explanation of why pango.DIRECTION_TTB_LTR is treated as pango.DIRECTION_RTL can be found there as well.

pango.DIRECTION_LTR

A strong left-to-right direction

pango.DIRECTION_RTL

A strong right-to-left direction

pango.DIRECTION_TTB_LTR

Deprecated value; treated the same as pango.DIRECTION_RTL.

pango.DIRECTION_TTB_RTL

Deprecated value; treated the same as pango.DIRECTION_LTR

pango.DIRECTION_WEAK_LTR

A weak left-to-right direction

pango.DIRECTION_WEAK_RTL

A weak right-to-left direction

pango.DIRECTION_NEUTRAL

No direction specified

Pango Ellipsize Mode Constants

The Ellipsize Mode constants specify what sort of (if any) ellipsization should be applied to a line of text. In the ellipsization process characters are removed from the text in order to make it fit to a given width and replaced with an ellipsis (...).

pango.ELLIPSIZE_NONE

 No ellipsization.

pango.ELLIPSIZE_START

Omit characters at the start of the text.

pango.ELLIPSIZE_MIDDLE

 Omit characters in the middle of the text.

pango.ELLIPSIZE_END

 Omit characters at the end of the text.

Pango Font Mask Flag Constants

The Font Mask flag constants are bit-flags that correspond to fields in a pango.FontDescription that have been set.

pango.FONT_MASK_FAMILY

the font family is specified.

pango.FONT_MASK_STYLE

the font style is specified.

pango.FONT_MASK_VARIANT

the font variant is specified.

pango.FONT_MASK_WEIGHT

the font weight is specified.

pango.FONT_MASK_STRETCH

the font stretch is specified.

pango.FONT_MASK_SIZE

the font size is specified.

Pango Render Part Constants

pango.RENDER_PART

The pango.RENDER_PART constants define different items to render for purposes such as setting colors. Available since PyGTK 2.8.

pango.RENDER_PART_FOREGROUND

The text itself.

pango.RENDER_PART_BACKGROUND

The area behind the text.

pango.RENDER_PART_UNDERLINE

The underlined areas.

pango.RENDER_PART_STRIKETHROUGH

The strikethrough areas.

Pango Scale Constants

pango.SCALE

The pango.SCALE constant represents the scale between dimensions used for Pango distances and device units. (The definition of device units is dependent on the output device; it will typically be pixels for a screen, and points for a printer.) pango.SCALE is currently 1024, but this may be changed in the future. When setting font sizes, device units are always considered to be points (as in "12 point font"), rather than pixels.

pango.SCALE_XX_SMALL

The scale factor for three shrinking steps (1 / (1.2 * 1.2 * 1.2)).

pango.SCALE_X_SMALL

The scale factor for two shrinking steps (1 / (1.2 * 1.2)).

pango.SCALE_SMALL

The scale factor for one shrinking step (1 / 1.2).

pango.SCALE_MEDIUM

The scale factor for normal size (1.0).

pango.SCALE_LARGE

The scale factor for one magnification step (1.2).

pango.SCALE_X_LARGE

he scale factor for two magnification steps (1.2 * 1.2).

pango.SCALE_XX_LARGE

The scale factor for three magnification steps (1.2 * 1.2 * 1.2).

Pango Stretch Constants

The Stretch constants specify the width of the font relative to other designs within a family.

pango.STRETCH_ULTRA_CONDENSED

The most narrow width

pango.STRETCH_EXTRA_CONDENSED

pango.STRETCH_CONDENSED

pango.STRETCH_SEMI_CONDENSED

pango.STRETCH_NORMAL

The normal width.

pango.STRETCH_SEMI_EXPANDED

pango.STRETCH_EXPANDED

pango.STRETCH_EXTRA_EXPANDED

pango.STRETCH_ULTRA_EXPANDED

The most expanded width

Pango Style Constants

The Style constants specify the various slant styles possible for a font.

pango.STYLE_NORMAL

The font is upright.

pango.STYLE_OBLIQUE

The font is slanted in a roman style.

pango.STYLE_ITALIC

The font is slanted in an italic style.

Pango Tab Constants

The Tab constants specify where a tab stop appears relative to the text.

pango.TAB_LEFT

the tab stop appears to the left of the text.

Pango Underline Constants

The Underline constants specify he type of underlining (if any) to be used.

pango.UNDERLINE_NONE

No underline should be drawn.

pango.UNDERLINE_SINGLE

A single underline should be drawn.

pango.UNDERLINE_DOUBLE

A double underline should be drawn.

pango.UNDERLINE_LOW

A single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining single characters, such as for keyboard accelerators. pango.UNDERLINE_SINGLE should be used for extended portions of text.

Pango Variant Constants

The Variant constants specify the capitalization variant of the font.

pango.VARIANT_NORMAL

A normal font.

pango.VARIANT_SMALL_CAPS

A font with the lower case characters replaced by smaller variants of the capital characters.

Pango Weight Constants

The Weight constants specify the weight (boldness) of a font. This is a numerical value ranging from 100 to 900, but there are some predefined values:

pango.WEIGHT_ULTRALIGHT

The ultralight weight (= 200).

pango.WEIGHT_LIGHT

The light weight (=300).

pango.WEIGHT_NORMAL

The default weight (= 400).

pango.WEIGHT_BOLD

The bold weight (= 700).

pango.WEIGHT_ULTRABOLD

The ultrabold weight (= 800).

pango.WEIGHT_HEAVY

The heavy weight (= 900).

Pango Wrap Mode Constants

The Wrap Mode constants specify how to wrap the lines of a pango.Layout to the desired width.

pango.WRAP_WORD

wrap lines at word boundaries.

pango.WRAP_CHAR

wrap lines at character boundaries.

pango.WRAP_WORD_CHAR

wrap lines at word boundaries, but fall back to character boundaries if there is not enough space for a full word.
Prev Up Next
pango Functions Home The pangocairo Class Reference
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkcursor.html0000644000000000000000000006552611272037113023636 0ustar rootrootgtk.gdk.Cursor
gtk.gdk.Cursor
Prev The gtk.gdk Class Reference Next

gtk.gdk.Cursor

gtk.gdk.Cursor — standard and pixmap cursors

Synopsis

class gtk.gdk.Cursor(gobject.GBoxed):
    gtk.gdk.Cursor(cursor_type)
    gtk.gdk.Cursor(display, cursor_type)
    gtk.gdk.Cursor(display, pixbuf, x, y)
    gtk.gdk.Cursor(source, mask, fg, bg, x, y)
    def get_display()

Description

A gtk.gdk.Cursor represents a bitmap image used for the mouse pointer. Each gtk.gdk.Window can have its own cursor. By default a gtk.gdk.Window uses its parent's cursor. A standard set of cursors is provided in PyGTK:

gtk.gdk.X_CURSOR

gtk.gdk.ARROW

gtk.gdk.BASED_ARROW_DOWN

gtk.gdk.BASED_ARROW_UP

gtk.gdk.BOAT

gtk.gdk.BOGOSITY

gtk.gdk.BOTTOM_LEFT_CORNER

gtk.gdk.BOTTOM_RIGHT_CORNER

gtk.gdk.BOTTOM_SIDE

gtk.gdk.BOTTOM_TEE

gtk.gdk.BOX_SPIRAL

gtk.gdk.CENTER_PTR

gtk.gdk.CIRCLE

gtk.gdk.CLOCK

gtk.gdk.COFFEE_MUG

gtk.gdk.CROSS

gtk.gdk.CROSS_REVERSE

gtk.gdk.CROSSHAIR

gtk.gdk.DIAMOND_CROSS

gtk.gdk.DOT

gtk.gdk.DOTBOX

gtk.gdk.DOUBLE_ARROW

gtk.gdk.DRAFT_LARGE

gtk.gdk.DRAFT_SMALL

gtk.gdk.DRAPED_BOX

gtk.gdk.EXCHANGE

gtk.gdk.FLEUR

gtk.gdk.GOBBLER

gtk.gdk.GUMBY

gtk.gdk.HAND1

gtk.gdk.HAND2

gtk.gdk.HEART

gtk.gdk.ICON

gtk.gdk.IRON_CROSS

gtk.gdk.LEFT_PTR

gtk.gdk.LEFT_SIDE

gtk.gdk.LEFT_TEE

gtk.gdk.LEFTBUTTON

gtk.gdk.LL_ANGLE

gtk.gdk.LR_ANGLE

gtk.gdk.MAN

gtk.gdk.MIDDLEBUTTON

gtk.gdk.MOUSE

gtk.gdk.PENCIL

gtk.gdk.PIRATE

gtk.gdk.PLUS

gtk.gdk.QUESTION_ARROW

gtk.gdk.RIGHT_PTR

gtk.gdk.RIGHT_SIDE

gtk.gdk.RIGHT_TEE

gtk.gdk.RIGHTBUTTON

gtk.gdk.RTL_LOGO

gtk.gdk.SAILBOAT

gtk.gdk.SB_DOWN_ARROW

gtk.gdk.SB_H_DOUBLE_ARROW

gtk.gdk.SB_LEFT_ARROW

gtk.gdk.SB_RIGHT_ARROW

gtk.gdk.SB_UP_ARROW

gtk.gdk.SB_V_DOUBLE_ARROW

gtk.gdk.SHUTTLE

gtk.gdk.SIZING

gtk.gdk.SPIDER

gtk.gdk.SPRAYCAN

gtk.gdk.STAR

gtk.gdk.TARGET

gtk.gdk.TCROSS

gtk.gdk.TOP_LEFT_ARROW

gtk.gdk.TOP_LEFT_CORNER

gtk.gdk.TOP_RIGHT_CORNER

gtk.gdk.TOP_SIDE

gtk.gdk.TOP_TEE

gtk.gdk.TREK

gtk.gdk.UL_ANGLE

gtk.gdk.UMBRELLA

gtk.gdk.UR_ANGLE

gtk.gdk.WATCH

gtk.gdk.XTERM

Constructor

    gtk.gdk.Cursor(cursor_type)

cursor_type :

the standard cursor to create

Returns :

a new gtk.gdk.Cursor

Creates the new gtk.gdk.Cursor from a builtin cursor specified by cursor_type. To make the cursor invisible, see the description of the gtk.gdk.Cursor() constructor that creates a cursor from a pixmap below.

    gtk.gdk.Cursor(display, cursor_type)

display :

the gtk.gdk.Display to create the cursor for

cursor_type :

the standard cursor to create

Returns :

a new gtk.gdk.Cursor

Note

This constructor is available in PyGTK 2.4 and above.

Creates the new gtk.gdk.Cursor for the gtk.gdk.Display specified by display from a builtin cursor specified by cursor_type. To make the cursor invisible, see the description of the gtk.gdk.Cursor() constructor that creates a cursor from a pixmap below.

    gtk.gdk.Cursor(display, pixbuf, x, y)

display :

the gtk.gdk.Display to create the cursor for

pixbuf :

the gtk.gdk.Pixbuf holding the cursor image

x :

the "hot spot" x offset

y :

the "hot spot" y offset

Returns :

a new gtk.gdk.Cursor

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.gdk.Cursor for the gtk.gdk.Display specified by display using the gtk.gdk.Pixbuf specified by source as the icon image. The "hotspot" of the cursor will be located as the position specified by x and y. To make the cursor invisible, see the description of the gtk.gdk.Cursor() constructor that creates a cursor from a pixmap below

    gtk.gdk.Cursor(source, mask, fg, bg, x, y)

source :

the gtk.gdk.Pixmap holding the cursor image

mask :

the gtk.gdk.Pixmap to use as a mask

fg :

the unallocated foreground gtk.gdk.Color

bg :

the unallocated background gtk.gdk.Color

x :

the "hot spot" x offset

y :

the "hot spot" y offset

Returns :

a new gtk.gdk.Cursor

Creates a new gtk.gdk.Cursor using:

  • the gtk.gdk.Pixmap specified by source as the icon image
  • the gtk.gdk.Pixmap specified by mask to mask source (must be the same size as source)
  • the gtk.gdk.Color specified by fg as the foreground color of the cursor
  • the gtk.gdk.Color specified by bg as the background color of the cursor
  • the horizontal offset of the cursor "hot spot" specified by x
  • the vertical offset of the cursor "hot spot" specified by y

To make the cursor invisible, create a cursor from an empty gtk.gdk.Pixmap as follows:

  pixmap = gtk.gdk.Pixmap(None, 1, 1, 1)
  color = gtk.gdk.Color()
  cursor = gtk.gdk.Cursor(pixmap, pixmap, color, color, 0, 0)

Methods

gtk.gdk.Cursor.get_display

    def get_display()

Returns :

the associated gtk.gdk.Display

Note

This method is available in PyGTK 2.2 and above.

The get_display() method returns the gtk.gdk.Display on which the cursor is defined.

Prev Up Next
gtk.gdk.Colormap Home gtk.gdk.Device
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkruler.html0000644000000000000000000003434311272037113023463 0ustar rootrootgtk.Ruler
gtk.Ruler
Prev The gtk Class Reference Next

gtk.Ruler

gtk.Ruler — a base class for horizontal or vertical rulers

Synopsis

class gtk.Ruler(gtk.Widget):
    def set_metric(metric)
    def set_range(lower, upper, position, max_size)
    def draw_ticks()
    def draw_pos()
    def get_metric()
    def get_range()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Ruler

Implemented Interfaces

gtk.Ruler implements gtk.Buildable

gtk.Ruler Properties

gtk.Object Properties

gtk.Widget Properties

"lower"Read-Writethe lower limit of the ruler
"max-size"Read-Writethe maximum size of the ruler
"metric"Read-WriteThe metric used for the ruler. This property is available in GTK+ 2.8 and above.
"position"Read-Writethe position of the mark on the ruler
"upper"Read-Writethe upper limit of the ruler

gtk.Ruler Style Properties

gtk.Widget Style Properties

gtk.Ruler Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

Description

Note

This widget is considered too specialized or little-used for PyGTK and GTK+, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, it will eventually move out of the PyGTK and GTK+ distribution.

The gtk.Ruler widget is a base class for horizontal and vertical rulers. Rulers are used to show the mouse pointer's location in a window. Within the ruler a small triangle indicates the location of the mouse relative to the horizontal or vertical ruler. See gtk.HRuler to learn about horizontal rulers. See gtk.VRuler to learn about vertical rulers.

Methods

gtk.Ruler.set_metric

    def set_metric(metric)

metric :

the measurement units

The set_metric() method sets the measurement units of the ruler to the value specified by metric. Available units are gtk.PIXELS, gtk.INCHES, or gtk.CENTIMETERS. The default unit of measurement is gtk.PIXELS.

gtk.Ruler.set_range

    def set_range(lower, upper, position, max_size)

lower :

the upper limit of the ruler

upper :

the lower limit of the ruler

position :

the position of the mark on the ruler

max_size :

the maximum size of the rule

The set_range() method sets the range of the ruler to the values specified by lower, upper, position and max_size (all values are floats).

gtk.Ruler.draw_ticks

    def draw_ticks()

The draw_ticks() method is overridden by the gtk.Ruler subclasses (gtk.HRuler and gtk.VRuler) to draw the tick marks on the ruler. This method is not used by applications.

gtk.Ruler.draw_pos

    def draw_pos()

The draw_pos() method is overridden by the gtk.Ruler subclasses (gtk.HRuler and gtk.VRuler) to draw the position mark on the ruler. This method is not used by applications.

gtk.Ruler.get_metric

    def get_metric()

Returns :

the measurement units currently used for the ruler

The get_metric() method returns the units used for a gtk.Ruler. See the set_metric() method.

gtk.Ruler.get_range

    def get_range()

Returns> :

a tuple containing: the lower limit of the ruler, the upper limit of the ruler, the current position of the mark on the ruler and the maximum size of the ruler used when calculating the space to leave for the text.

The get_range() method returns a tuple containing the values indicating the range and current position of a gtk.Ruler. See the set_range() method.

Prev Up Next
gtk.Requisition Home gtk.Scale
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkrecentchoosermenu.html0000644000000000000000000003263011272037113026057 0ustar rootrootgtk.RecentChooserMenu
gtk.RecentChooserMenu
Prev The gtk Class Reference Next

gtk.RecentChooserMenu

gtk.RecentChooserMenu — Displays recently used files in a menu (new in PyGTK 2.10)

Synopsis

class gtk.RecentChooserMenu(gtk.Menu, gtk.RecentChooser):
    gtk.RecentChooserMenu(manager)
    def get_show_numbers()
    def set_show_numbers(show_numbers)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.MenuShell
          +-- gtk.Menu
            +-- gtk.RecentChooserMenu (implements gtk.RecentChooser)

Implemented Interfaces

gtk.RecentChooserMenu implements gtk.Buildable

gtk.RecentChooserMenu Properties

gtk.RecentChooser Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.MenuShell Properties

gtk.Menu Properties

"show-numbers"Read-WriteWhether the first ten items in the menu should be prepended by a number acting as a unique mnemonic. This property is available in GTK+ 2.10 and above.

gtk.RecentChooserMenu Style Properties

gtk.Widget Style Properties

gtk.Menu Style Properties

gtk.RecentChooserMenu Child Properties

gtk.Menu Child Properties

gtk.RecentChooserMenu Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.MenuShell Signal Prototypes

gtk.Menu Signal Prototypes

gtk.RecentChooser Signal Prototypes

Description

gtk.RecentChooserMenu is a widget suitable for displaying recently used files inside a menu. It can be used to set a sub-menu of a gtk.MenuItem using gtk.MenuItem.set_submenu(), or as the menu of a gtk.MenuToolButton.

Note that gtk.RecentChooserMenu does not have any methods of its own. Instead, you should use the functions that work on a gtk.RecentChooser.

Recently used files are supported since GTK+ 2.10.

Constructor

gtk.RecentChooserMenu

    gtk.RecentChooserMenu(manager)

manager :

a gtk.RecentManager

Returns :

a new gtk.RecentChooserMenu, bound to manager.

Note

This constructor is available in PyGTK 2.10 and above.

Creates a new gtk.RecentChooserMenu widget using manager as the underlying recently used resources manager.

This is useful if you have implemented your own recent manager, or if you have a customized instance of a gtk.RecentManager object or if you wish to share a common gtk.RecentManager object among multiple gtk.RecentChooser widgets.

Methods

gtk.RecentChooserMenu.get_show_numbers

    def get_show_numbers()

Returns :

True if numbers should be shown.

Note

This method is available in PyGTK 2.10 and above.

Returns the value set by gtk.RecentChooserMenu.set_show_numbers().

gtk.RecentChooserMenu.set_show_numbers

    def set_show_numbers(show_numbers)

show_numbers :

whether to show numbers

Note

This method is available in PyGTK 2.10 and above.

Sets whether a number should be added to the items of menu. The numbers are shown to provide a unique character for a mnemonic to be used inside the menu item's label. Only the first the items get a number to avoid clashes.

Prev Up Next
gtk.RecentChooserDialog Home gtk.RecentChooserWidget
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkdrawable.html0000644000000000000000000032467411272037113024104 0ustar rootrootgtk.gdk.Drawable
gtk.gdk.Drawable
Prev The gtk.gdk Class Reference Next

gtk.gdk.Drawable

gtk.gdk.Drawable — a base class for drawing methods

Synopsis

class gtk.gdk.Drawable(gobject.GObject):
    def get_size()
    def set_colormap(colormap)
    def get_colormap()
    def get_visual()
    def get_depth()
    def get_screen()
    def get_display()
    def draw_point(gc, x, y)
    def draw_line(gc, x1, y1, x2, y2)
    def draw_rectangle(gc, filled, x, y, width, height)
    def draw_arc(gc, filled, x, y, width, height, angle1, angle2)
    def draw_polygon(gc, filled, points)
    def draw_drawable(gc, src, xsrc, ysrc, xdest, ydest, width, height)
    def draw_image(gc, image, xsrc, ysrc, xdest, ydest, width, height)
    def draw_points(gc, points)
    def draw_segments(gc, segs)
    def draw_lines(gc, points)
    def draw_pixbuf(gc, pixbuf, src_x, src_y, dest_x, dest_y, width=-1, height=-1, dither=gtk.gdk.RGB_DITHER_NORMAL, x_dither=0, y_dither=0)
    def draw_glyphs(gc, font, x, y, glyphs)
    def draw_layout_line(gc, x, y, line, layout, foreground=None, background=None)
    def draw_layout(gc, x, y, layout, foreground=None, background=None)
    def get_image(x, y, width, height)
    def get_clip_region()
    def get_visible_region()
    def new_gc(foreground, background, font, function, fill, tile, stipple, clip_mask, subwindow_mode, ts_x_origin, ts_y_origin, clip_x_origin, clip_y_origin, graphics_exposures, line_width, line_style, cap_style, join_style>)
    def draw_rgb_image(gc, x, y, width, height, dith, rgb_buf, rowstride=-1, xdith=0, ydith=0)
    def draw_rgb_32_image(gc, x, y, width, height, dith, rgb_buf, rowstride=-1, xdith=0, ydith=0)
    def draw_gray_image(gc, x, y, width, height, dith, buf, rowstride=-1)
    def draw_indexed_image(gc, x, y, width, height, dith, buf, rowstride, cmap)
    def cairo_create()

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.Drawable

Attributes

"handle"ReadThe handle of the MS Windows window associated with the drawable. Not supported on X11.
"xid"ReadThe id of the X window available with the drawable. Not supported on MS Windows

Description

A gtk.gdk.Drawable is a base class providing drawing primitives for its subclasses: gtk.gdk.Pixmap and gtk.gdk.Window.

These methods provide support for drawing points, lines, arcs and text onto what are called 'drawables'. Drawables, as the name suggests, are things which support drawing onto them, and are either gtk.gdk.Window or gtk.gdk.Pixmap objects.

Many of the drawing operations take a gtk.gdk.GC argument, which represents a graphics context. This gtk.gdk.GC contains a number of drawing attributes such as foreground color, background color and line width, and is used to reduce the number of arguments needed for each drawing operation. See the Graphics Contexts section for more information.

Some of the drawing operations take Pango objects like pango.Context or pango.Layout as arguments. Use the gtk.Widget.create_pango_context() or gtk.Widget.create_pango_layout() methods to obtain these objects.

Methods

gtk.gdk.Drawable.get_size

    def get_size()

Returns :

a tuple containing the drawable's width and height

The get_size() method returns a tuple containing the width and height of the drawable.

On the X11 platform, if the drawable is a gtk.gdk.Window, the returned size is the size reported in the most-recently-processed configure event, rather than the current size on the X server.

gtk.gdk.Drawable.set_colormap

    def set_colormap(colormap)

colormap :

a gtk.gdk.Colormap

The set_colormap() method sets the gtk.gdk.Colormap associated with the drawable to the value specified by colormap. Normally this will happen automatically when the drawable is created; you only need to use this function if the drawable-creating function did not have a way to determine the colormap, and you then use drawable operations that require a colormap. The colormap for all drawables and graphics contexts you intend to use together should match. i.e. when using a gtk.gdk.GC to draw to a drawable, or copying one drawable to another, the colormaps should match.

gtk.gdk.Drawable.get_colormap

    def get_colormap()

Returns :

the colormap, or None

The get_colormap() method returns the gtk.gdk.Colormap for the drawable or None if no colormap is set.

gtk.gdk.Drawable.get_visual

    def get_visual()

Returns :

a gtk.gdk.Visual

The get_visual() method returns the gtk.gdk.Visual describing the pixel format of the drawable.

gtk.gdk.Drawable.get_depth

    def get_depth()

Returns :

the number of bits per pixel

The get_depth() method returns the bit depth of the drawable, that is, the number of bits that make up a pixel in the drawable's visual. Examples are 8 bits per pixel, 24 bits per pixel, etc.

gtk.gdk.Drawable.get_screen

    def get_screen()

Returns :

the gtk.gdk.Screen associated with the drawable

Note

This method is available in PyGTK 2.2 and above.

The get_screen() method returns the gtk.gdk.Screen associated with the drawable.

gtk.gdk.Drawable.get_display

    def get_display()

Returns :

the gtk.gdk.Display associated with the drawable

Note

This method is available in PyGTK 2.2 and above.

The get_display() method returns the gtk.gdk.Display associated with the drawable.

gtk.gdk.Drawable.draw_point

    def draw_point(gc, x, y)

gc :

a graphics context

x :

the X coordinate of the point in drawable coordinates

y :

the Y coordinate of the point in drawable coordinates

The draw_point() method draws a point at the location specified by x and y in the drawable using the gtk.gdk.GC graphics context specified by gc.

gtk.gdk.Drawable.draw_line

    def draw_line(gc, x1, y1, x2, y2)

gc :

a graphics context

x1 :

the X coordinate of the first point

y1 :

the Y coordinate of the first point

x2 :

the X coordinate of the second point

y2 :

the Y coordinate of the second point

The draw_line() method draws a line between the two points specified by (x1, y1) and (x2, y2) using the gtk.gdk.GC graphics context specified by gc.

gtk.gdk.Drawable.draw_rectangle

    def draw_rectangle(gc, filled, x, y, width, height)

gc :

a graphics context

filled :

if True the rectangle will be filled with the foreground color

x :

the X coordinate of the top left corner

y :

the Y coordinate of the top left corner

width :

the width of the rectangle

height :

the height of the rectangle

The draw_rectangle() method draws a rectangle of the specified width and height with its top left corner at the location specified by (x, y) using the gtk.gdk.GC graphics context specified by gc. If filled is True the rectangle will be filled with the foreground color.

Note

A rectangle drawn filled is 1 pixel smaller in both dimensions than a rectangle outlined. Calling:

  window.draw_rectangle(gc, True, 0, 0, 20, 20)

results in a filled rectangle 20 pixels wide and 20 pixels high. Calling:

  window.draw_rectangle(gc, False, 0, 0, 20, 20)

results in an outlined rectangle with corners at (0, 0), (0, 20), (20, 20), and (20, 0), which makes it 21 pixels wide and 21 pixels high.

gtk.gdk.Drawable.draw_arc

    def draw_arc(gc, filled, x, y, width, height, angle1, angle2)

gc :

a graphics context

filled :

if True the arc will be filled with the foreground color creating a "pie slice"

x :

the X coordinate of the left edge of the bounding rectangle.

y :

the Y coordinate of the top edge of the bounding rectangle.

width :

the width of the bounding rectangle.

height :

the height of the bounding rectangle.

angle1 :

the start angle of the arc, relative to the 3 o'clock position, counter-clockwise, in 1/64ths of a degree.

angle2 :

the end angle of the arc, relative to angle1, counter-clockwise, in 1/64ths of a degree.

The draw_arc() method draws an arc or a filled 'pie slice' if filled is True. The arc is defined by the bounding rectangle of the entire ellipse (specified by x, y, width and height), and the start and end angles of the part of the ellipse to be drawn (specified by angle1 and angle2). The gtk.gdk.GC graphics context specified by gc is used to determine the drawing attributes.

gtk.gdk.Drawable.draw_polygon

    def draw_polygon(gc, filled, points)

gc :

a graphics context

filled :

if True the polygon will be filled with the foreground color

points :

a sequence of 2-tuples

The draw_polygon() method draws an outlined or filled polygon using the points specified by points. points is a sequence of 2-tuples that each contain an x and y coordinate of a point. The points are connected in the order that they are specified and the last point is automatically connected to the first point. The gtk.gdk.GC graphics context specified by gc is used to determine the drawing attributes.

gtk.gdk.Drawable.draw_drawable

    def draw_drawable(gc, src, xsrc, ysrc, xdest, ydest, width, height)

gc :

a gtk.gdk.GC sharing the drawable's visual and colormap

src :

another gtk.gdk.Drawable

xsrc :

the X position in src of rectangle to draw

ysrc :

the Y position in src of rectangle to draw

xdest :

the X position in the drawable where the rectangle should be drawn

ydest :

the Y position in the drawable where the rectangle should be drawn

width :

the width of rectangle to draw, or -1 for entire src width

height :

the height of rectangle to draw, or -1 for entire src height

The draw_drawable() method copies the specified width x height area of the drawable specified by src at the specified coordinates (xsrc, ysrc) to the specified coordinates (xdest, ydest) in the drawable. width and height may be given as -1, to copy the entire src drawable. Most fields in the gtk.gdk.GC specified by gc are not used for this operation, but the clip mask or clip region will be honored.

The source and destination drawables must have the same visual and colormap, or errors will result. (On X11, failure to match visual and colormap results in a BadMatch error from the X server.) A common cause of this problem is an attempt to draw a bitmap to a color drawable. The way to draw a bitmap is to set the bitmap as a clip mask on your gtk.gdk.GC, then use the draw_rectangle() method to draw a rectangle clipped to the bitmap.

gtk.gdk.Drawable.draw_image

    def draw_image(gc, image, xsrc, ysrc, xdest, ydest, width, height)

gc :

a graphics context

image :

a gtk.gdk.Image

xsrc :

the left edge of the source rectangle within image.

ysrc :

the top edge of the source rectangle within image.

xdest :

the left edge of the destination within drawable.

ydest :

the top edge of the destination within drawable.

width :

the width of the area to be copied, or -1 to make the area extend to the right edge of image.

height :

the height of the area to be copied, or -1 to make the area extend to the bottom edge of image.

The draw_image() method draws the portion of the gtk.gdk.Image specified by the rectangle (xsrc, ysrc, width and height) onto the drawable at the location specified by xdest and ydest. The depth of the gtk.gdk.Image must match the depth of the gtk.gdk.Drawable. The gtk.gdk.GC graphics context specified by gc is used to determine the drawing attributes.

gtk.gdk.Drawable.draw_points

    def draw_points(gc, points)

gc :

a graphics context

points :

a sequence of 2-tuples

The draw_points() method draws the set of points specified by points on the drawable using the gtk.gdk.GC graphics context specified by gc. points is a sequence of 2-tuples each containing a pair of x and y coordinates of a point location in the drawable.

gtk.gdk.Drawable.draw_segments

    def draw_segments(gc, segs)

gc :

a graphics context

segs :

a sequence of 4-tuples

The draw_segments() method draws a set of line segments specified by segs on the drawable using the gtk.gdk.GC graphics context specified by gc to specify the drawing attributes. segs is a sequence of 4-tuples each containing the coordinates of the start and end points of the line segment in the format (x1, y1, x2, y2).

gtk.gdk.Drawable.draw_lines

    def draw_lines(gc, points)

gc :

a graphics context

points :

a sequence of 2-tuples

The draw_lines() method draws a series of lines connecting the points specified by points. points is a sequence of 2-tuples each containing the x and y coordinates of a point location. The gtk.gdk.GC graphics context specified by gc is used to determine the drawing attributes.The style of joins between lines is determined by the cap style attribute in the gtk.gdk.GC. This can be set with the gtk.gdk.GC.set_line_attributes() method.

gtk.gdk.Drawable.draw_pixbuf

    def draw_pixbuf(gc, pixbuf, src_x, src_y, dest_x, dest_y, width=-1, height=-1, dither=gtk.gdk.RGB_DITHER_NORMAL, x_dither=0, y_dither=0)

gc :

a gtk.gdk.GC, used for clipping, or None

pixbuf :

a gtk.gdk.Pixbuf

src_x :

Source X coordinate within pixbuf.

src_y :

Source Y coordinate within pixbuf.

dest_x :

Destination X coordinate within drawable.

dest_y :

Destination Y coordinate within drawable.

width :

Width of region to render, in pixels, or -1 to use pixbuf width. Must be specified in PyGTK 2.2.

height :

Height of region to render, in pixels, or -1 to use pixbuf height. Must be specified in PyGTK 2.2

dither :

Dithering mode for GdkRGB.

x_dither :

X offset for dither.

y_dither :

Y offset for dither.

Note

This method is available in PyGTK 2.2 and above.

The draw_pixbuf() method renders a rectangular portion of a gtk.gdk.Pixbuf specified by pixbuf to the drawable using the gtk.gdk.GC specified by gc. The portion of pixbuf that is rendered is specified by the origin point (src_x src_y) and the width and height arguments. pixbuf is rendered to the location in the drawable specified by (dest_x dest_y). dither specifies the dithering mode as one of:

gtk.gdk.RGB_DITHER_NONE

Never use dithering.

gtk.gdk.RGB_DITHER_NORMAL

Use dithering in 8 bits per pixel (and below) only.

gtk.gdk.RGB_DITHER_MAX

Use dithering in 16 bits per pixel and below.

The destination drawable must have a colormap. All windows have a colormap, however, pixmaps only have colormap by default if they were created with a non-None window argument. Otherwise a colormap must be set on them with the gtk.gdk.Drawable.set_colormap() method.

On older X servers, rendering pixbufs with an alpha channel involves round trips to the X server, and may be somewhat slow. The clip mask of gc is ignored, but clip rectangles and clip regions work fine.

gtk.gdk.Drawable.draw_glyphs

    def draw_glyphs(gc, font, x, y, glyphs)

gc :

a gtk.gdk.GC

font :

the font to be used

x :

the X coordinate of baseline origin

y :

the Y coordinate of baseline origin

glyphs :

the glyphs to render

The draw_glyphs() method draws the sequence of glyphs (characters in a font) specified by glyphs at the location specified by x and y using the font specified by font. Instead of using this method 99% of text rendering should be done using the draw_layout() method.

gtk.gdk.Drawable.draw_layout_line

    def draw_layout_line(gc, x, y, line, foreground=None, background=None)

gc :

base graphics to use

x :

the x position of start of string (in pixels)

y :

the y position of baseline (in pixels)

line :

a pango.LayoutLine

foreground :

a gtk.gdk.Color to override the foreground color or None

background :

a gtk.gdk.Color to override the background color or None

Note

This method is available in PyGTK 2.10 and above.

The draw_layout_line() method renders the pango.LayoutLine specified by line onto the drawable at the position specified by (x, y). The gtk.gdk.GC specified by gc is used as the graphics context but the layout's normal colors may be overriden with the gtk.gdk.Colors specified by foreground and/or background. foreground and background are optional and default to None.

If the layout's pango.Context has a transformation matrix set, then x and y specify the position of the left edge of the baseline (left is in before-tranform user coordinates) in after-transform device coordinates.

gtk.gdk.Drawable.draw_layout

    def draw_layout(gc, x, y, layout, foreground=None, background=None)

gc :

base graphics context to use

x :

the X position of the left of the layout (in pixels)

y :

the Y position of the top of the layout (in pixels)

layout :

a pango.Layout

foreground :

a gtk.gdk.Color to override the foreground color or None

background :

a gtk.gdk.Color to override the background color or None

The draw_layout() method renders the pango.Layout specified by layout onto the drawable at the location specified by x and y. If foreground or background has a value other than None it is used to override the corresponding attribute specified by gc.

gtk.gdk.Drawable.get_image

    def get_image(x, y, width, height)

x :

the X coordinate on the drawable

y :

the Y coordinate on the drawable

width :

the width of region to get

height :

the height or region to get

Returns :

a gtk.gdk.Image containing the contents of the drawable

The get_image() method returns a gtk.gdk.Image object containing a copy of the region in the drawable specified by x, y, width and height. A gtk.gdk.Image stores client-side image data (pixels). In contrast, a gtk.gdk.Pixmap and gtk.gdk.Window are server-side objects. The get_image() method retrieves the pixels from a server-side drawable as a client-side gtk.gdk.Image. The format of a gtk.gdk.Image depends on the gtk.gdk.Visual of the current display, which makes manipulating gtk.gdk.Image extremely difficult; therefore, in most cases you should use the gtk.gdk.Pixbuf.get_from_drawable() method instead of this lower-level function. A gtk.gdk.Pixbuf contains image data in a canonicalized RGB format, rather than a display-dependent format. Of course, there's a convenience vs. speed tradeoff here, so you'll want to think about what makes sense for your application.

You would usually copy image data to the client side if you intend to examine the values of individual pixels, for example to darken an image or add a red tint. It would be prohibitively slow to make a round-trip request to the windowing system for each pixel, so instead you get all of them at once, modify them, then copy them all back at once. If the X server or other windowing system backend is on the local machine, this function may use shared memory to avoid copying the image data. If the source drawable is a gtk.gdk.Window and partially off screen or obscured, then the obscured portions of the returned image will contain undefined data.

gtk.gdk.Drawable.get_clip_region

    def get_clip_region()

Returns :

a gtk.gdk.Region.

Note

This method is available in PyGTK 2.10 and above.

The get_clip_region() method computes and returns the gtk.gdk.Region of the drawable that potentially can be written to by drawing primitives. This region will not take into account the clip region for the gtk.gdk.GC, and may also not take into account other factors such as if the window is obscured by other windows, but no area outside of this region will be affected by drawing primitives.

gtk.gdk.Drawable.get_visible_region

    def get_visible_region()

Returns :

a gtk.gdk.Region. This must be freed with gdk_region_destroy() when you are done.

Note

This method is available in PyGTK 2.10 and above.

The get_visible_region() method computes and returns the gtk.gdk.Region of the drawable that is potentially visible. This does not necessarily take into account if the window is obscured by other windows, but no area outside of this region is visible.

gtk.gdk.Drawable.new_gc

    def new_gc(foreground, background, font, function, fill, tile, stipple, clip_mask, subwindow_mode, ts_x_origin, ts_y_origin, clip_x_origin, clip_y_origin, graphics_exposures, line_width, line_style, cap_style, join_style>)

foreground :

the foreground gtk.gdk.Color

background :

the background gtk.gdk.Color

font :

a font (deprecated and ignored)

function :

the bitwise operator used to combine the existing pixel value and a new pixel value - usually one of: gtk.gdk.COPY, gtk.gdk.XOR or gtk.gdk.INVERT.

fill :

the fill style - one of: gtk.gdk.SOLID, gtk.gdk.TILED, gtk.gdk.STIPPLED, gtk.gdk.OPAQUE_STIPPLED

tile :

a gtk.gdk.Pixmap used for tiling the background

stipple :

a gtk.gdk.Pixmap used for stippling the background

clip_mask :

a gtk.gdk.Pixmap of depth 1 used to mask pixels to be drawn

subwindow_mode :

the mode of drawing on subwindows in a gtk.gdk.Window - one of: gtk.gdk.CLIP_BY_CHILDREN or gtk.gdk.INCLUDE_INFERIORS

ts_x_origin :

the X coordinate of the origin of tile or stipple

ts_y_origin :

the Y coordinate of the origin of tile or stipple

clip_x_origin :

the X coordinate of the origin of clip_mask

clip_y_origin :

the Y coordinate of the origin of clip_mask

graphics_exposures :

if True graphics exposures are enabled for calls to the draw_drawable() method.

line_width :

the line width in pixels

line_style :

the line style - one of: gtk.gdk.LINE_SOLID, gtk.gdk.LINE_ON_OFF_DASH, gtk.gdk.LINE_DOUBLE_DASH

cap_style :

the style of line ends - one of: gtk.gdk.CAP_NOT_LAST, gtk.gdk.CAP_BUTT, gtk.gdk.CAP_ROUND, gtk.gdk.CAP_PROJECTING

join_style :

the style of line joins - one of: gtk.gdk.JOIN_MITER, gtk.gdk.JOIN_ROUND, gtk.gdk.JOIN_BEVEL

Returns :

a graphics context

The new_gc() method creates a new gtk.gdk.GC object with the attributes as specified by the arguments. Since there are a large number of parameters it's probably best to specify the attributes using keywords. Any attributes not specified will use a default value.

gtk.gdk.Drawable.draw_rgb_image

    def draw_rgb_image_dithalign(gc, x, y, width, height, dith, rgb_buf, rowstride=-1, xdith=0, ydith=0)

gc :

a graphics context

x :

the X coordinate of the top-left corner in the drawable.

y :

the Y coordinate of the top-left corner in the drawable.

width :

the width of the image to be drawn.

height :

the height of the image to be drawn.

dith :

a dither value - one of: gtk.gdk.RGB_DITHER_NONE, gtk.gdk.RGB_DITHER_NORMAL, gtk.gdk.RGB_DITHER_MAX

rgb_buf :

the pixel data, represented as packed 24-bit data.

rowstride :

the number of bytes from the start of one row in rgb_buf to the start of the next or -1 to calculate the number of bytes.

xdith :

an X offset for dither alignment.

ydith :

a Y offset for dither alignment.

The draw_rgb_image() method draws an RGB image in the drawable, with an adjustment for dither alignment. This method is useful when drawing dithered images into a window that may be scrolled. Pixel (x, y) will be drawn dithered as if its actual location is (x + xdith, y + ydith). Thus, if you draw an image into a window using zero dither alignment, then scroll up one pixel, subsequent draws to the window should have ydith = 1. Setting the dither alignment correctly allows updating of small parts of the screen while avoiding visible "seams" between the different dither textures.

gtk.gdk.Drawable.draw_rgb_32_image

    def draw_rgb_32_image(gc, x, y, width, height, dith, rgb_buf, rowstride=-1, xdith=0, ydith=0)

gc :

a graphics context

x :

the X coordinate of the top-left corner in the drawable.

y :

the Y coordinate of the top-left corner in the drawable.

width :

the width of the image to be drawn.

height :

the height of the image to be drawn.

dith :

a dither value - one of: gtk.gdk.RGB_DITHER_NONE, gtk.gdk.RGB_DITHER_NORMAL, gtk.gdk.RGB_DITHER_MAX

buf :

the pixel data, represented as padded 32-bit data.

rowstride :

the number of bytes from the start of one row in buf to the start of the next or -1 to calculate the number of bytes.

xdith :

an X offset for dither alignment.

ydith :

a Y offset for dither alignment.

The draw_rgb_32_image() method draws a padded RGB image in the drawable. The image is stored as one pixel per 32-bit word. It is laid out as a red byte, a green byte, a blue byte, and a padding byte. Otherwise this method works the same as the draw_rgb_image() method.

gtk.gdk.Drawable.draw_gray_image

    def draw_gray_image(gc, x, y, width, height, dith, buf, rowstride=-1)

gc :

a graphics context

x :

the X coordinate of the top-left corner in the drawable.

y :

the Y coordinate of the top-left corner in the drawable.

width :

the width of the image to be drawn.

height :

the height of the image to be drawn.

dith :

a dither value - one of: gtk.gdk.RGB_DITHER_NONE, gtk.gdk.RGB_DITHER_NORMAL, gtk.gdk.RGB_DITHER_MAX

buf :

the pixel data, represented as 8-bit gray values.

rowstride :

the number of bytes from the start of one row in buf to the start of the next or -1 to calculate the number of bytes.

The draw_gray_image() method draws a grayscale image on the drawable at the location specified by x and y with the image data in buf.

gtk.gdk.Drawable.draw_indexed_image

    def draw_indexed_image(gc, x, y, width, height, dith, buf, rowstride, colors)

gc :

a graphics context

x :

The x coordinate of the top-left corner in the drawable.

y :

the y coordinate of the top-left corner in the drawable.

width :

the width of the rectangle to be drawn.

height :

the height of the rectangle to be drawn.

dith :

a GdkRgbDither value, selecting the desired dither mode.

buf :

the pixel data, represented as 8-bit color indices.

rowstride :

the number of bytes from the start of one row in buf to the start of the next.

colors :

a list of colors represented as 0xRRGGBB integer values.

Note

This method is available in PyGTK 2.10 and above.

The draw_indexed_image() method draws an indexed image in the drawable, using the list of colors specified by colors to assign actual colors to the image's color indices.

gtk.gdk.Drawable.cairo_create

    def cairo_create()

Returns :

a gtk.gdk.CairoContext

Note

This method is available in PyGTK 2.8 and above.

The cairo_create() method returns a gtk.gdk.CairoContext object to be used for drawing on the drawable using Cairo drawing operations.

Prev Up Next
gtk.gdk.DragContext Home gtk.gdk.Event
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkobjectfactory.html0000644000000000000000000001606011272037113025156 0ustar rootrootatk.ObjectFactory
atk.ObjectFactory
Prev The atk Class Reference Next

atk.ObjectFactory

atk.ObjectFactory — the base object class for a factory used to create accessible objects for objects of a specific GType.

Synopsis

class atk.ObjectFactory(gobject.GObject):
    def create_accessible(obj)
    def invalidate()
    def get_accessible_type()

Ancestry

+-- gobject.GObject
  +-- atk.ObjectFactory

atk.ObjectFactory Signal Prototypes

gobject.GObject Signal Prototypes

Description

This class is the base object class for a factory used to create an accessible object for a specific GType. The method atk.Registry.set_factory_type() is normally called to store in the registry the factory type to be used to create an accessible of a particular GType.

Methods

atk.ObjectFactory.create_accessible

    def create_accessible(obj)

obj :

a gobject.GObject

Returns :

an atk.Object that implements an accessibility interface on behalf of obj

Provides an atk.Object that implements an accessibility interface on behalf of obj

atk.ObjectFactory.invalidate

    def invalidate()

Inform the factory that it is no longer being used to create accessibles. When called, the factory may need to inform the atk.Object objects it has created that they need to be re-instantiated. Note: primarily used for runtime replacement of atk.ObjectFactory objects in object registries.

atk.ObjectFactory.get_accessible_type

    def get_accessible_type()

Returns :

the type of the accessible which is created by the factory.

Gets the GType of the accessible which is created by the factory. The value gobject.TYPE_INVALID is returned if no type if found.

Prev Up Next
atk.Object Home atk.Rectangle
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkhruler.html0000644000000000000000000001454611272037113023636 0ustar rootrootgtk.HRuler
gtk.HRuler
Prev The gtk Class Reference Next

gtk.HRuler

gtk.HRuler — a horizontal ruler.

Synopsis

class gtk.HRuler(gtk.Ruler):
    gtk.HRuler()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Ruler
        +-- gtk.HRuler

Implemented Interfaces

gtk.HRuler implements gtk.Buildable

gtk.HRuler Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Ruler Properties

gtk.HRuler Style Properties

gtk.Widget Style Properties

gtk.HRuler Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

Description

Note

This widget is considered too specialized or little-used for PyGTK, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, it will eventually move out of the PyGTK distribution.

The gtk.HRuler widget is arranged horizontally creating a ruler that is used in conjunction with other widgets such as a text widget. The ruler is used to show the location of the mouse on the window and to show the size of the window in specified units. The available units of measurement are gtk.PIXELS (the default), gtk.INCHES and gtk.CENTIMETERS. See the gtk.Ruler description for more information on the methods that are used to manage a gtk.HRuler.

Constructor

    gtk.HRuler()

Returns :

a new hruler widget

Creates a new gtk.HRuler widget.

Prev Up Next
gtk.HPaned Home gtk.HScale
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcomboboxentry.html0000644000000000000000000005063611272037113025227 0ustar rootrootgtk.ComboBoxEntry
gtk.ComboBoxEntry
Prev The gtk Class Reference Next

gtk.ComboBoxEntry

gtk.ComboBoxEntry — a text entry field with a dropdown list (new in PyGTK 2.4)

Synopsis

class gtk.ComboBoxEntry(gtk.ComboBox, gtk.CellLayout):
    gtk.ComboBoxEntry(model=None, column=-1)
    def set_text_column(text_column)
    def get_text_column()
Functions

    def gtk.combo_box_entry_new_text()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.ComboBox
            +-- gtk.ComboBoxEntry

Implemented Interfaces

gtk.ComboBoxEntry implements gtk.Buildable gtk.CellLayout

gtk.ComboBoxEntry Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.ComboBox Properties

"text-column"Read-WriteThe column in the gtk.TreeModel to get the strings from.

gtk.ComboBoxEntry Style Properties

gtk.Widget Style Properties

gtk.ComboBox Style Properties

gtk.ComboBoxEntry Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.ComboBox Signal Prototypes

gtk.CellEditable Signal Prototypes

Description

Note

This widget is available in GTK+ 2.4 and PyGTK 2.4 and above.

The gtk.ComboBoxEntry is a replacement for the gtk.Combo. The gtk.ComboBoxEntry is subclassed from gtk.ComboBox and implements the gtk.CellLayout interface; refer to their descriptions for a number of useful methods and properties for managing the contents of a combo box entry. A gtk.ComboBoxEntry also contains a child gtk.Entry accessed by using the child attribute of the combo box entry:

  entry = comboboxentry.child

A gtk.ComboBoxEntry is created with the gtk.ComboBoxEntry() constructor. The constructor can also be called with the optional parameters model (a gtk.TreeModel - default None) and column (a number of a column in model - default 0). If no gtk.TreeModel is specified it can be added later with the set_model() method. The text column can be changed using the set_text_column() method. A new combo box entry is created and packed with a gtk.CellRendererText but no attribute mappings are set on the cell renderer.

Alternatively, the gtk.combo_box_entry_new_text() function creates a gtk.ComboBoxEntry with an associated gtk.ListStore model and the text column attribute mapping set to 0. In this combo box entry each list item is a text string that can be selected. The convenience methods gtk.ComboBox.append_text(), gtk.ComboBox.prepend_text(), gtk.ComboBox.insert_text() and gtk.ComboBox.remove_text() can be used to manage the contents of the gtk.ComboBoxEntry. Using the gtk.combo_box_entry_new_text() function is equivalent to:

  liststore = gtk.ListStore(gobject.TYPE_STRING)
  comboboxentry = gtk.ComboBoxEntry(liststore, 0)

Constructor

    gtk.ComboBoxEntry(model=None, column=-1)

model :

The gtk.TreeModel to associate with the combo box entry, or None

column :

The number of the column to use for setting the strings of the combo box entry.

Returns :

A new gtk.ComboBoxEntry.

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.ComboBoxEntry that has a gtk.Entry as child and associated with the gtk.TreeModel specified by model and using the column of model specified by column to retrieve strings. If model was not specified it defaults to None but you can change the model using the gtk.ComboBox.set_model() method. If column was not specified it defaults to -1 meaning the text column is unset but you can change it using the set_text_column() method. Once the text column is set either in the constructor or using the set_text_column() method it cannot be changed. A ValueError exception is thrown if column is outside the range of column numbers for model.

Methods

gtk.ComboBoxEntry.set_text_column

    def set_text_column(text_column)

text_column :

A column in the associated gtk.TreeModel to use as the data source for the strings.

Note

This method is available in PyGTK 2.4 and above.

The set_text_column() method sets the "text-column" property to the value of tree_column only if the text column has not been set (that is, "text-column" is -1). The value of tree_column is the number of the tree model column used as the data source for the strings of the combo box entry.

gtk.ComboBoxEntry.get_text_column

    def get_text_column()

Returns :

The number of the column in the associated gtk.TreeModel used as the data source for the combo box entry.

Note

This method is available in PyGTK 2.4 and above.

The get_text_column() method returns the number of the gtk.TreeModel column that is used as the data source for the strings of the combo box entry.

Functions

gtk.combo_box_entry_new_text

    def gtk.combo_box_entry_new_text()

Returns :

A new gtk.ComboBoxEntry widget.

Note

This function is available in PyGTK 2.4 and above.

The gtk.combo_box_entry_new_text() function is a convenience function which constructs a new gtk.ComboBoxEntry, just displaying strings. If you use this function to create a combo box entry, you should only manipulate its gtk.TreeModel data source with the following gtk.ComboBox convenience methods: gtk.ComboBox.append_text(), gtk.ComboBox.insert_text(), gtk.ComboBox.prepend_text() and gtk.ComboBox.remove_text().

Prev Up Next
gtk.ComboBox Home gtk.Container
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkscalebutton.html0000644000000000000000000010252311272037113024651 0ustar rootrootgtk.ScaleButton
gtk.ScaleButton
Prev The gtk Class Reference Next

gtk.ScaleButton

gtk.ScaleButton — A button which pops up a scale. (new in PyGTK 2.12)

Synopsis

class gtk.ScaleButton(gtk.Button):
    gtk.ScaleButton(size, min, max, step, icons=None)
    def get_adjustment()
    def get_minus_button()
    def get_orientation()
    def get_plus_button()
    def get_popup()
    def get_value()
    def set_adjustment(adjustment)
    def set_icons(icons)
    def set_orientation(icons)
    def set_value(value)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Button
            +-- gtk.ScaleButton

Implemented Interfaces

gtk.ScaleButton implements gtk.Buildable

gtk.ScaleButton Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Button Properties

"adjustment"Read/Write The gtk.Adjustment that contains the current value of this scale button object.
"icons"Read/Write The names of the icons to be used by the scale button. The first item in the array will be used in the button when the current value is the lowest value, the second item for the highest value. All the subsequent icons will be used for all the other values, spread evenly over the range of values. If there's only one icon name in the icons array, it will be used for all the values. If only two icon names are in the icons array, the first one will be used for the bottom 50% of the scale, and the second one for the top 50%. It is recommended to use at least 3 icons so that the GtkScaleButton reflects the current value of the scale better for the users.
"orientation"Read/Write The orientation of the gtk.ScaleButton's popup window. Default value: gtk.ORIENTATION_VERTICAL. Available from GTK+ 2.14.
"size"Read/Write The icon size. Default value: gtk.ICON_SIZE_SMALL_TOOLBAR.
"value"Read/Write The value of the scale. Default value: 0.

gtk.ScaleButton Style Properties

gtk.Widget Style Properties

gtk.Button Style Properties

gtk.ScaleButton Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.Button Signal Prototypes

"popdown"

 def callback(scalebutton, user_param1, ...)

"popup"

 def callback(scalebutton, user_param1, ...)

"value-changed"

 def callback(scalebutton, value, user_param1, ...)

Description

gtk.ScaleButton provides a button which pops up a scale widget. This kind of widget is commonly used for volume controls in multimedia applications, and GTK+ provides a gtk.VolumeButton subclass that is tailored for this use case.

Constructor

    gtk.ScaleButton(size, min, max, step, icons=None)

size :

A stock icon size.

min :

The minimum value of the scale (usually 0).

max :

The maximum value of the scale (usually 100).

step :

The stepping of value when a scroll-wheel event, or up/down arrow event occurs (usually 2).

icons :

Optionally a list or tuple of icon names, you will be able to set the list later with set_icons

Returns :

a new gtk.ScaleButton object.

Note

This constructor is available in PyGTK 2.12 and above.

Creates a gtk.ScaleButton, with a range between min and max, with a stepping of step.

Methods

gtk.ScaleButton.get_adjustment

    def get_adjustment()

Returns :

The gtk.Adjustment associated with the scale.

Note

This method is available in PyGTK 2.12 and above.

The get_adjustment() method gets the gtk.Adjustment associated with the gtk.ScaleButton's scale. See gtk.Range.get_adjustment for details.

gtk.ScaleButton.get_minus_button

    def get_minus_button()

Returns :

the minus button of the gtk.ScaleButton.

Note

This method is available in PyGTK 2.14 and above.

The get_minus_button() method retrieves the minus button of the gtk.ScaleButton.

gtk.ScaleButton.get_orientation

    def get_orientation()

Returns :

the gtk.ScaleButton's orientation.

Note

This method is available in PyGTK 2.14 and above.

The get_orientation() method gets the orientation of the gtk.ScaleButton's popup window.

gtk.ScaleButton.get_plus_button

    def get_plus_button()

Returns :

the plus button of the gtk.ScaleButton.

Note

This method is available in PyGTK 2.14 and above.

The get_plus_button() method retrieves the plus button of the gtk.ScaleButton.

gtk.ScaleButton.get_popup

    def get_popup()

Returns :

the popup of the gtk.ScaleButton.

Note

This method is available in PyGTK 2.14 and above.

The get_popup() method gets the popup of the gtk.ScaleButton.

gtk.ScaleButton.get_value

    def get_value()

Returns :

The current value of the scale button.

Note

This method is available in PyGTK 2.12 and above.

The get_value() method gets the current value of the scale button.

gtk.ScaleButton.set_adjustment

    def set_adjustment(adjustment)

adjustment :

The gtk.Adjustment to set.

Note

This method is available in PyGTK 2.12 and above.

The set_adjustment() method sets the gtk.Adjustment to be used as a model for the gtk.ScaleButton's scale. See gtk.Range.set_adjustment for details.

gtk.ScaleButton.set_icons

    def set_icons(icons)

icons :

A list or tuple of icon names.

Note

This method is available in PyGTK 2.12 and above.

The set_icons() method sets the icons to be used by the scale button. For details, see the gtk.ScaleButton:icons property for details.

gtk.ScaleButton.set_orientation

    def set_orientation(icons)

orientation :

the new orientation.

Note

This method is available in PyGTK 2.14 and above.

The set_orientation() method sets the orientation of the gtk.ScaleButton's popup window.

gtk.ScaleButton.set_value

    def set_value(value)

value :

The new value of the scale button.

Note

This method is available in PyGTK 2.12 and above.

The set_value() method sets the current value of the scale; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The scale button emits the value-changed signal if the value changes.

Signals

The "popdown" gtk.ScaleButton Signal

    def callback(scalebutton, user_param1, ...)

scalebutton :

the scalebutton that received the "popdown" signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.12 and above.

The "popdown" signal is a keybinding signal which gets emitted to popdown the scale widget. The default binding for this signal is Escape.

The "popup" gtk.ScaleButton Signal

    def callback(scalebutton, user_param1, ...)

scalebutton :

the scalebutton that received the "popup" signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.12 and above.

The "popup" signal is a keybinding signal which gets emitted to popup the scale widget. The default bindings for this signal are Space, Enter and Return.

The "value-changed" gtk.ScaleButton Signal

    def callback(scalebutton, value, user_param1, ...)

scalebutton :

the scalebutton that received the "value-changed" signal

value :

the new value

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.12 and above.

The "value-changed" signal is emitted when the value field has changed.

Prev Up Next
gtk.Scale Home gtk.Scrollbar
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcheckbutton.html0000644000000000000000000002311611272037113024637 0ustar rootrootgtk.CheckButton
gtk.CheckButton
Prev The gtk Class Reference Next

gtk.CheckButton

gtk.CheckButton — a toggle button widget styled as a checkbox and label

Synopsis

class gtk.CheckButton(gtk.ToggleButton):
    gtk.CheckButton(label=None, use_underline=True)

Ancestry

+-- gobject.GObject
   +-- gtk.Object
      +-- gtk.Widget
         +-- gtk.Container
            +-- gtk.Bin
               +-- gtk.Button
                  +-- gtk.ToggleButton
                     +-- gtk.CheckButton

Implemented Interfaces

gtk.CheckButton implements gtk.Buildable

gtk.CheckButton Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Button Properties

gtk.ToggleButton Properties

gtk.CheckButton Style Properties

gtk.Widget Style Properties

gtk.Button Style Properties

"indicator-size"Read/WriteThe size of the check or radio indicator
"indicator-spacing"Read/WriteThe spacing around the check or radio indicator

gtk.CheckButton Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.Button Signal Prototypes

gtk.ToggleButton Signal Prototypes

Description

A gtk.CheckButton places a discrete gtk.ToggleButton next to a widget, (usually a gtk.Label). See the section on gtk.ToggleButton widgets for more information about toggle and check buttons. The signal ('toggled') is also inherited from gtk.ToggleButton.

Constructor

    gtk.CheckButton(label=None, use_underline=True)

label :

a string to be used as the label text or None

use_underline :

if True, an underscore in the label text indicates the next character should be underlined and used for the mnemonic accelerator key if it is the first character so marked. Available in PyGTK 2.4 and above.

Returns :

a new checkbutton object

Creates a new checkbutton with a text label specified by label. If label is None or not specified then no label is created. If label contains underscore characters then the character following the underscore will be underlined and the character following the first underscore will be used as the mnemonic keyboard accelerator.

In PyGTK 2.4 and above the use_underline parameter is available and defaults to True. If use_underline is set to False the label text will not be parsed for mnemonic characters.

Prev Up Next
gtk.CellView Home gtk.CheckMenuItem
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkaccelgroup.html0000644000000000000000000012033211272037113024450 0ustar rootrootgtk.AccelGroup
gtk.AccelGroup
Prev The gtk Class Reference Next

gtk.AccelGroup

gtk.AccelGroup — a group of accelerators for a Window hierarchy

Synopsis

class gtk.AccelGroup(gobject.GObject):
    gtk.AccelGroup()
    def lock()
    def unlock()
    def connect(accel_key, accel_mods, accel_flags, callback)
    def connect_group(accel_key, accel_mods, accel_flags, callback)
    def connect_by_path(accel_path, callback)
    def disconnect_key(accel_key, accel_mods)
    def get_is_locked()
    def get_modifier_mask()
Functions

    def gtk.accelerator_valid(keyval, modifiers)
    def gtk.accelerator_parse(accelerator)
    def gtk.accelerator_name(accelerator_key, accelerator_mods)
    def gtk.accelerator_set_default_mod_mask(default_mod_mask)
    def gtk.accelerator_get_default_mod_mask()
    def gtk.accelerator_get_label(accelerator_key, accelerator_mods)
    def gtk.accel_groups_from_object(object)

Ancestry

+-- gobject.GObject
  +-- gtk.AccelGroup

gtk.AccelGroup Signal Prototypes

"accel-activate"

 def callback(accelgroup, acceleratable, accel_key, accel_mods, user_param1, ...)

"accel-changed"

 def callback(accelgroup, accel_key, accel_mods, closure, user_param1, ...)

Description

A gtk.AccelGroup object groups all the accelerators for the associated window hierarchy (either gtk.Window (or a descendant) or gtk.MenuShell (or a descendant)). Once the gtk.AccelGroup is associated with a window or menu (using gtk.Window.add_accel_group() or gtk.Menu.set_accel_group()), accelerators can be added to the widget or one of its children by using gtk.Widget.add_accelerator() . Accelerators can also be added by using a gtk.ItemFactory.

Note that accelerators are different from mnemonics. Accelerators are shortcuts for activating a menu item; they appear alongside the menu item they're a shortcut for. For example Ctrl+Q might appear alongside the Files → Quit menu item. Mnemonics are shortcuts for GUI elements such as text entries or buttons; they appear as underlined characters. Of course, menu items can have both accelerators and mnemonics.

Constructor

    gtk.AccelGroup()

Returns :

an AccelGroup object

Creates a new gtk.AccelGroup object.

Methods

gtk.AccelGroup.lock

    def lock()

The lock() method locks the accelerator group. preventing its accelerators from being changed during runtime. Refer to gtk.accel_map_change_entry() about runtime accelerator changes.

If called more than once, the accelerator group remains locked until gtk.AccelGroup.unlock() has been called an equivalent number of times.

gtk.AccelGroup.unlock

    def unlock()

The unlock() method undoes the last call to gtk.AccelGroup.lock() for this accelerator group.

gtk.AccelGroup.connect_group

    def connect(accel_key, accel_mods, accel_flags, callback)

accel_key :

key value of the accelerator

accel_mods :

modifier combination of the accelerator

accel_flags :

a flag mask to configure this accelerator

callback :

a function or method to be executed upon accelerator activation

Note

This method is available in PyGTK 2.2 as connect() and was changed in PyGTK 2.4 and above to connect_group() to avoid conflict with the gobject.GObject.connect() method.

The connect_group() method installs an accelerator in the accelerator group. When the accelerator group is being activated, the function (or method) specified by callback will be invoked if the accelerator key and modifier key match those specified by accel_key and accel_mods.

The value of modifier is a combination of the GDK Modifier Constants. accel_flags is a combination of gtk.ACCEL_VISIBLE and gtk.ACCEL_LOCKED.

The callback function is defined as:

  def callback(accel_group, acceleratable, keyval, modifier)

where accel_group is the accelerator group, acceleratable is the object that the accel_group is attached to (e.g. a gtk.Window), keyval is the accelerator key and modifier is the key modifier. callback returns True if the accelerator was handled by callback.

Note

Due to implementation details, a single function or method can only be connected to one accelerator group.

gtk.AccelGroup.connect_by_path

    def connect_by_path(accel_path, callback)

accel_path :

path used for determining key and modifiers.

callback :

function or method to be executed upon accelerator activation

Note

This method is available in PyGTK 2.4 and above

The connect_by_path() method installs an accelerator in the accelerator group, using an accelerator path to look up the appropriate key and modifiers (see the function gtk.accel_map_add_entry()). When the accelerator group is being activated, the function (or method) specified by callback will be invoked if the accel_key and accel_mods that cause the activation match the key and modifiers for the accelerator path specified by accel_path.

The callback function is defined as:

  def callback(accel_group, acceleratable, keyval, modifier)

where accel_group is the accelerator group, acceleratable is the object that the accel_group is attached to (e.g. a gtk.Window), keyval is the accelerator key and modifier is the key modifier. callback returns True if the accelerator was handled by callback.

gtk.AccelGroup.disconnect_key

    def disconnect_key(accel_key, accel_mods)

accel_key :

key value of the accelerator

accel_mods :

modifier combination of the accelerator

Returns :

True if there was an accelerator which was removed, False otherwise

The disconnect() method removes a previously installed accelerator specified by accel_key and accel_mods from the accelerator group.

gtk.AccelGroup.get_is_locked

    def get_is_locked()

Returns :

True if there are 1 or more locks on the accel_group, False otherwise.

Note

This method is available in PyGTK 2.14 and above.

The get_is_locked() method returns the locked status. Locks are added and removed using lock() and lock().

gtk.AccelGroup.get_modifier_mask

    def get_modifier_mask()

Returns :

the modifier mask for this accel group.

Note

This method is available in PyGTK 2.14 and above.

The get_modifier_mask() method gets a GdkModifierType representing the mask for this accel_group. For example, gtk.gdk.CONTROL_MASK, gtk.gdk.SHIFT_MASK, etc.

Functions

gtk.accelerator_valid

    def gtk.accelerator_valid(keyval, modifiers)

keyval :

a key value

modifiers :

a modifier mask

Returns :

True if the accelerator is valid

The gtk.accelerator_valid() function returns True if the specified keyval and modifiers constitute a valid keyboard accelerator. For example, the ord('a') keyval plus gtk.gdk.CONTROL_MASK is valid - this is a Control+a accelerator. The value of modifiers is a combination of the GDK Modifier Constants.

gtk.accelerator_parse

    def gtk.accelerator_parse(accelerator)

accelerator :

a string representing an accelerator

Returns :

a 2-tuple containing the keyval and modifier mask of the accelerator

The gtk.accelerator_parse() function parses the specified accelerator string and returns a 2-tuple containing the keyval and modifier mask corresponding to accelerator. The format looks like "<Control>a" or "<Shift><Alt>F1" or "<Release>z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "<Ctl>" and "<Ctrl>". If the parse fails, the tuple values will both be 0 (zero). See the gtk.accelerator_valid() function for more details.

gtk.accelerator_name

    def gtk.accelerator_name()

accelerator_key :

a key value

accelerator_mods :

a modifier mask

Returns :

a string representing the accelerator or None if not a valid accelerator

The gtk.accelerator_name() function converts the accelerator keyval and modifier mask (specified by accelerator_key and accelerator_mods) into a string parseable by the gtk.accelerator_parse() function. For example, if you pass in ord('q') and gtk.gdk.CONTROL_MASK, this function returns "<Control>q".

gtk.accelerator_set_default_mod_mask

    def gtk.accelerator_set_default_mod_mask(default_mod_mask)

default_mod_mask :

the new default accelerator modifier mask

The gtk.accelerator_set_default_mod_mask() function sets the modifiers (specified by default_mod_mask) that will be considered significant for keyboard accelerators. The default mod mask is gtk.gdk.CONTROL_MASK | gtk.gdk.SHIFT_MASK | gtk.gdk.MOD1_MASK, that is, Control, Shift, and Alt. Other modifiers will by default be ignored by gtk.AccelGroup. You must include at least the three default modifiers in any value you pass to this function. The default mod mask should be changed on application startup, before using any accelerator groups. The value of default_mod_mask is a combination of the GDK Modifier Constants.

gtk.accelerator_get_default_mod_mask

    def gtk.accelerator_get_default_mod_mask()

Returns :

the default accelerator modifier mask

The gtk.accelerator_get_default_mod_mask() function returns the default accelerator modifier mask as set by the gtk.accelerator_set_default_mod_mask() function. See the gtk.accelerator_set_default_mod_mask() function for more detail on modifier masks.

gtk.accelerator_get_label

    def gtk.accelerator_get_label(accelerator_key, accelerator_mods)

accelerator_key :

a key value

accelerator_mods :

a modifier mask

Returns :

a string representing the accelerator

Note

This function is available in PyGTK 2.6 and above.

The gtk.accelerator_get_label() function converts the accelerator keyval and modifier mask specified by accelerator_key and accelerator_mods respectively into a string which can be used to represent the accelerator to the user. The value of accelerator_mods is a combination of the GDK Modifier Constants.

gtk.accel_groups_from_object

    def gtk.accel_groups_from_object(object)

object :

a GObject usually a gtk.Window

Note

This function is available in PyGTK 2.4 and above.

The gtk.accel_groups_from_object() function returns a list of all the gtk.AccelGroup objects attached to the object specified by object.

Signals

The "accel-activate" gtk.AccelGroup Signal

    def callback(accelgroup, acceleratable, accel_key, accel_mods, user_param1, ...)

accelgroup :

the accelgroup that received the signal

acceleratable :

the object that the accelerator is associated with

accel_key :

the accelerator key value

accel_mods :

the accelerator modifiers

user_param1 :

the first user parameter (if any) specified with the gobject.GObject.connect() method

... :

additional user parameters (if any)

Returns :

True if the accelerator was handled

The "accel-activate" signal is emitted when an accelerator is activated.

The "accel-changed" gtk.AccelGroup Signal

    def callback(accelgroup, accel_key, accel_mods, closure, user_param1, ...)

accelgroup :

the accelgroup that received the signal

accel_key :

the key value of the accelerator

accel_mods :

the modifiers of the accelerator

closure :

the closure of the accelerator

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "accel-changed" signal is emitted when an accelerator is added or removed from an accelerator group.

Prev Up Next
gtk.AboutDialog Home gtk.AccelLabel
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkhbox.html0000644000000000000000000001623611272037113023273 0ustar rootrootgtk.HBox
gtk.HBox
Prev The gtk Class Reference Next

gtk.HBox

gtk.HBox — a horizontal container box

Synopsis

class gtk.HBox(gtk.Box):
    gtk.HBox(homogeneous=False, spacing=0)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Box
          +-- gtk.HBox

Implemented Interfaces

gtk.HBox implements gtk.Buildable

gtk.HBox Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Box Properties

gtk.HBox Style Properties

gtk.Widget Style Properties

gtk.HBox Child Properties

gtk.Box Child Properties

gtk.HBox Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

The gtk.HBox is a container subclassed from gtk.Box that organizes its child widgets into a single horizontal row. The gtk.Box methods are used to manage the order, spacing, width and alignment of the child widgets though all widgets are allocated the same height.

Constructor

    gtk.HBox(homogeneous=False, spacing=0)

homogeneous :

If True all children are given equal space allocations.

spacing :

The additional horizontal space between children in pixels

Returns :

a new hbox widget

Creates a new gtk.HBox widget.

Prev Up Next
gtk.HandleBox Home gtk.HButtonBox
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkgammacurve.html0000644000000000000000000002167111272037113024461 0ustar rootrootgtk.GammaCurve
gtk.GammaCurve
Prev The gtk Class Reference Next

gtk.GammaCurve

gtk.GammaCurve — subclass of gtk.Curve for editing gamma curves.

Synopsis

class gtk.GammaCurve(gtk.VBox):
    gtk.GammaCurve()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Box
          +-- gtk.VBox
            +-- gtk.GammaCurve

Implemented Interfaces

gtk.GammaCurve implements gtk.Buildable

gtk.GammaCurve Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Box Properties

gtk.GammaCurve Style Properties

gtk.Widget Style Properties

gtk.GammaCurve Child Properties

gtk.Box Child Properties

Attributes

"table"ReadThe gtk.Table containing the gtk.GammaCurve widgets.
"curve"ReadThe gtk.Curve widget.
"gamma"ReadThe gamma value (float)
"gamma_dialog"ReadThe gtk.Dialog that prompts for the gamma value.
"gamma_text"ReadThe gtk.Entry containing the gamma value in the gamma dialog

gtk.GammaCurve Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

Note

This widget is considered too specialized or little-used for PyGTK, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, it will eventually move out of the PyGTK distribution.

The gtk.GammaCurve widget is a variant of gtk.Curve specifically for editing gamma curves, which are used in graphics applications such as the Gimp. The gtk.GammaCurve widget shows a curve which the user can edit with the mouse just like a gtk.Curve widget. On the right of the curve it also displays 5 buttons, 3 of which change between the 3 curve modes (spline, linear and free), and the other 2 set the curve to a particular gamma value, or reset it to a straight line.

Constructor

    gtk.GammaCurve()

Returns :

a new gammacurve widget

Creates a new gtk.GammaCurve widget.

Prev Up Next
gtk.Frame Home gtk.GenericCellRenderer
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkborder.html0000644000000000000000000001202211272037113023575 0ustar rootrootgtk.Border
gtk.Border
Prev The gtk Class Reference Next

gtk.Border

gtk.Border — an object containing data for a border (new in PyGTK 2.4)

Synopsis

class gtk.Border(gobject.GBoxed):
    def copy()
    def free()

Description

Note

This object is available in PyGTK 2.4 and above.

A gtk.Border object contains the integer values for the left, right, top and bottom values of a border. gtk.Border is used in gtk.Style specifications. gtk.Border has two methods: copy() and free().

Methods

gtk.Border.copy

    def copy()

Returns :

a copy of the border.

Note

This method is available in PyGTK 2.4 and above.

The copy() method returns a copy of the border object.

gtk.Border.free

    def free()

Note

This method is available in PyGTK 2.4 and above.

Warning

This method is deprecated and should not be used since it can crash your application.

The free() method frees the memory used by the border.

Prev Up Next
gtk.Bin Home gtk.Box
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkfilefilter.html0000644000000000000000000005740211272037113024460 0ustar rootrootgtk.FileFilter
gtk.FileFilter
Prev The gtk Class Reference Next

gtk.FileFilter

gtk.FileFilter — a filter for selecting a file subset (new in PyGTK 2.4)

Synopsis

class gtk.FileFilter(gtk.Object):
    gtk.FileFilter()
    def set_name(name)
    def get_name()
    def add_mime_type(mime_type)
    def add_pattern(pattern)
    def add_custom(needed, func, data)
    def get_needed()
    def filter(filter_info)
    def add_pixbuf_formats()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.FileFilter

gtk.FileFilter Properties

gtk.Object Properties

gtk.FileFilter Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

Description

Note

This widget is available in PyGTK 2.4 and above.

A gtk.FileFilter is an object that filters files based on a set of rules that it contains. The categories of information that gtk.FileFilter uses to accept or reject the file are given by the GTK FileFilter Flags Constants:

gtk.FILE_FILTER_FILENAME

The full path name of the file.

gtk.FILE_FILTER_URI

The URI of the file.

gtk.FILE_FILTER_DISPLAY_NAME

The simple name of the file as displayed in a file chooser.

gtk.FILE_FILTER_MIME_TYPE

The MIME type of the file.

The add_pattern() method adds a rule that only uses the display name (gtk.FILE_FILTER_DISPLAY_NAME) for filtering. The add_mime_type() method adds a rule that only uses the mime type (gtk.FILE_FILTER_MIME_TYPE) for filtering. To use the file URI (gtk.FILE_FILTER_URI) or filename (gtk.FILE_FILTER_FILENAME) you have to create a custom filter rule using a callback function that is registered with the add_custom() method.

The pattern rule uses file globbing to match the file display name:

  • '*' matches any combination of characters e.g.. "a*c" matches "abc", "a bridge tic", "aaabbbc" and so on.
  • '?' matches any single character e.g. "a?c" matches "abc", aZc" and so on but not "abbc".
  • '[' and ']' enclose a set of characters that can be matched; ranges of characters can be included by separating the start and end with a dash (e.g. "a-z" include all the lowercase letters). e.g. "a[0-9]c" matches "a3c" and "a9c" but not "a28c" or "abc".
  • '\' escapes the next character to allow "*", "?", "[" and "]" to be matched literally.

The MIME type requires an exact match (no pattern matching).

Constructor

    gtk.FileFilter()

Returns :

a new gtk.FileFilter

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.FileFilter with no rules added to it. Such a filter doesn't pass any files, so it's not particularly useful until you add rules with the add_mime_type(), add_pattern() or add_custom() methods. To create a filter that accepts any file, use:

  filter = gtk.FileFilter()
  filter.add_pattern("*")

Methods

gtk.FileFilter.set_name

    def set_name(name)

name :

the human-readable-name for the filter.

Note

This method is available in PyGTK 2.4 and above.

The set_name() method sets the human-readable name of the filter to the string in name. The string in name will be displayed in the file chooser user interface if there is a selectable list of filters.

gtk.FileFilter.get_name

    def get_name()

Returns :

The human-readable name of the filter, or None.

Note

This method is available in PyGTK 2.4 and above.

The get_name() method returns the human-readable name for the filter or None if the name has not been set. See the set_name() method.

gtk.FileFilter.add_mime_type

    def add_mime_type(mime_type)

mime_type :

the name of a MIME type

Note

This method is available in PyGTK 2.4 and above.

The add_mime_type() method adds a rule allowing the mime type specified by mime_type to be matched. Sets the needs value to gtk.FILE_FILTER_MIME_TYPE (see the get_needed() method for more information).

gtk.FileFilter.add_pattern

    def add_pattern(pattern)

pattern :

a shell style glob pattern

Note

This method is available in PyGTK 2.4 and above.

The add_pattern() method adds a rule allowing the shell style glob pattern specified by pattern to filter file names. Sets the needs value to gtk.FILE_FILTER_DISPLAY_NAME (see the get_needed() method for more information).

The pattern rule uses file globbing to match the file display name:

  • '*' matches any combination of characters e.g.. "a*c" matches "abc", "a bridge tic", "aaabbbc" and so on.
  • '?' matches any single character e.g. "a?c" matches "abc", aZc" and so on but not "abbc".
  • '[' and ']' enclose a set of characters that can be matched; ranges of characters can be included by separating the start and end with a dash (e.g. "a-z" include all the lowercase letters). e.g. "a[0-9]c" matches "a3c" and "a9c" but not "a28c" or "abc".
  • '\' escapes the next character to allow "*", "?", "[" and "]" to be matched literally.

gtk.FileFilter.add_custom

    def add_custom(needed, func, data)

needed :

a bitfield of flags indicating the information that the custom filter function needs.

func :

a callback function; if the function returns True, then the file will be displayed.

data :

the data to pass to func

Note

This method is available in PyGTK 2.4 and above.

The add_custom() method adds a rule to a filter that allows files to be filtered based on a custom callback function specified by func. The bitfield needed provides information about what sorts of information that the filter function needs; this allows GTK+ to avoid retrieving expensive information when it isn't needed by the filter. needed is a combination of:

gtk.FILE_FILTER_FILENAME

The full path name of the file.

gtk.FILE_FILTER_URI

The URI of the file.

gtk.FILE_FILTER_DISPLAY_NAME

The simple name of the file as displayed in a file chooser.

gtk.FILE_FILTER_MIME_TYPE

The MIME type of the file.

The signature of func is:

  def filefilterfunction(filter_info, data):

where filter_info is a 4-tuple where each item is either a string or None. The strings correspond to: the full pathname of the file, the URI of the file, the display name of the file and the MIME type of the file. data is the value passed in as the data parameter in the add_custom() method. Using a custom filter function is the only way to filter files based on file URIs or full file pathnames.

gtk.FileFilter.get_needed

    def get_needed()

Returns :

a bitfield of flags indicating the needed fields when calling filter()

Note

This method is available in PyGTK 2.4 and above.

The get_needed() method returns the information that is needed by the gtk.FileFilter to filter the file info using the filter()

This method is not typically used by applications; it is intended principally for use in the implementation of gtk.FileChooser.

gtk.FileFilter.filter

    def filter(filter_info)

filter_info :

a 4-tuple containing the information about a file.

Returns :

True if the file should be displayed

Note

This method is available in PyGTK 2.4 and above.

The filter() method tests whether a file should be displayed according to the file filter rules. The 4-tuple filter_info should include the fields returned from the get_needed() method:

  • the full pathname of the file if needs includes gtk.FILE_FILTER_FILENAME
  • the URI of the file is needs includes gtk.FILE_FILTER_URI
  • the display name (without the path) if the file if needs includes gtk.FILE_FILTER_DISPLAY_NAME
  • the MIME type of the file if needs includes gtk.FILE_FILTER_MIME_TYPE

This method will not typically be used by applications; it is intended principally for use in the implementation of gtk.FileChooser.

gtk.FileFilter.add_pixbuf_formats

    def add_pixbuf_formats()

Note

This method is available in PyGTK 2.6 and above.

The add_pixbuf_formats() method adds a rule allowing image files in the formats supported by gtk.gdk.Pixbuf.

Prev Up Next
gtk.FileChooserWidget Home gtk.FileSelection
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkpixbufloader.html0000644000000000000000000010125611272037113024774 0ustar rootrootgtk.gdk.PixbufLoader
gtk.gdk.PixbufLoader
Prev The gtk.gdk Class Reference Next

gtk.gdk.PixbufLoader

gtk.gdk.PixbufLoader — an object providing application-driven progressive image loading

Synopsis

class gtk.gdk.PixbufLoader(gobject.GObject):
    gtk.gdk.PixbufLoader(image_type=None)
    def write(buf, count=-1)
    def get_pixbuf()
    def get_animation()
    def close()
    def set_size(width, height)
    def get_format()
Functions

    def gtk.gdk.pixbuf_loader_new_with_mime_type(mime_type)

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.PixbufLoader

Signal Prototypes

"area-prepared"

 def callback(pixbufloader, user_param1, ...)

"area-updated"

 def callback(pixbufloader, x, y, width, height, user_param1, ...)

"closed"

 def callback(pixbufloader, user_param1, ...)

"size-prepared"

 def callback(pixbufloader, width, height, user_param1, ...)

Description

A gtk.gdk.PixbufLoader provides a way for applications to drive the process of loading an image, by letting them send the image data directly to the loader instead of having the loader read the data from a file. Applications can use this instead of the gtk.gdk.pixbuf_new_from_file function or the gtk.gdk.PixbufAnimation constructor when they need to parse image data in small chunks. For example, it should be used when reading an image from a (potentially) slow network connection, or when loading an extremely large file.

To use gtk.gdk.PixbufLoader to load an image, just create a new one, and call the write() method to send the data to it. When done, the close() method should be called to end the stream and finalize everything. The loader will emit two important signals throughout the process. The first, "area-prepared", will be called as soon as the image has enough information to determine the size of the image to be used. The application can call the get_pixbuf() method to retrieve the pixbuf. No actual image data will be in the pixbuf, so it can be safely filled with any temporary graphics (or an initial color) as needed.

The "area-updated" signal is emitted every time a region is updated. This way you can update a partially completed image. Note that you do not know anything about the completeness of an image from the area updated. For example, in an interlaced image, you need to make several passes before the image is done loading.

Loading an Animation

Loading an animation is almost as easy as loading an image. Once the first "area-prepared" signal has been emitted, you can call the get_animation() method to get the gtk.gdk.PixbufAnimation object and the gtk.gdk.PixbufAnimation.get_iter() method to get an gtk.gdk.PixbufAnimationIter for displaying it.

Constructor

    gtk.gdk.PixbufLoader(image_type=None)

image_type :

the name of the image format or None

Returns :

A new gtk.gdk.PixbufLoader object.

Creates a new gtk.gdk.PixbufLoader object. If image_type is not specified or is None the image type will be automatically deduced from the image data. If image_type is specified the gtk.gdk.PixbufLoader attempts to parse the image data as if it were an image of the specified type. Identifying the image type is useful if you want an error if the image isn't the expected type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific type.

This constructor raises the GError exception if an error occurs trying to load the module for image_type.

Methods

gtk.gdk.PixbufLoader.write

    def write(buf, count=-1)

buf :

a string containing some portion of the image data.

count :

the length of buf in bytes.

Returns :

True if the write was successful.

The write() method causes the pixbuf loader to parse the bytes of an image contained in the string specified by buf. If count is specified and is in the range (0, len(buf)) only count bytes of buf are used. This method returns True if the image data was loaded successfully. If an error occurred this method raises the GError exception and will not accept further writes. The loader may or may not be closed depending on the error.

gtk.gdk.PixbufLoader.get_pixbuf

    def get_pixbuf()

Returns :

the gtk.gdk.Pixbuf that the loader is creating, or None if not enough data has been read to determine how to create the image buffer.

The get_pixbuf() method returns the gtk.gdk.Pixbuf that a pixbuf loader is currently creating. In general it only makes sense to call this method after the "area-prepared" signal has been emitted by the loader which means that enough data has been read to know the size of the image that will be allocated. If the loader has not received enough data via the write() method, this method returns None. The same pixbuf will be returned in all future calls to this method. Also, if the loader is an animation, it will return the "static image" of the animation (see the gtk.gdk.PixbufAnimation.get_static_image() method).

gtk.gdk.PixbufLoader.get_animation

    def get_animation()

Returns :

the gtk.gdk.PixbufAnimation that the loader is loading, or None if not enough data has been read to determine the information.

The get_animation() method returns the gtk.gdk.PixbufAnimation that the pixbuf loader is currently creating. In general it only makes sense to call this method after the "area-prepared" signal has been emitted by the loader. If the loader doesn't have enough bytes yet (hasn't emitted the "area-prepared" signal) this method will return None.

gtk.gdk.PixbufLoader.close

    def close()

Returns :

True if all image data written so far was successfully passed out via the "area_update" signal

The close() method informs the pixbuf loader that no further writes using the write() will occur, so that it can free its internal loading structures. Also, the pixbuf loader tries to parse any data that hasn't yet been parsed and if the remaining data is partial or corrupt, the GError exception will be raised.

gtk.gdk.PixbufLoader.set_size

    def set_size(width, height)

width :

The desired width for the image being loaded.

height :

The desired height for the image being loaded.

Note

This method is available in PyGTK 2.4 and above.

The set_size() method causes the image to be scaled to the size specified by width and height while it is being loaded. The desired image size can be determined relative to the original size of the image by calling the set_size() from a signal handler for the "size-prepared" signal.

Attempts to set the desired image size are ignored after the emission of the "size-prepared".

gtk.gdk.PixbufLoader.get_format

    def get_format()

Returns :

a Python dict containing the image format information or None

Note

This method is available in PyGTK 2.4 and above.

The get_format() method returns the available information about the format of the currently loading image file. This method returns None if their is no information available e.g. before the image has started loading.

Functions

gtk.gdk.pixbuf_loader_new_with_mime_type

    def gtk.gdk.pixbuf_loader_new_with_mime_type(mime_type)

mime_type :

 the mime type to be loaded

Returns :

a new gtk.gdk.PixbufLoader object.

Note

This function is available in PyGTK 2.4 and above.

The gtk.gdk.pixbuf_loader_new_with_mime_type() function creates a new pixbuf loader object that always attempts to parse image data as if it were an image of the mime type specified by mime_type, instead of identifying the type automatically. Useful if you want an error if the image isn't the expected mime type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific mime type.

This function raises the GError exception if an error occurs during the loading of the mime type image module.

Signals

The "area-prepared" gtk.gdk.PixbufLoader Signal

    def callback(pixbufloader, user_param1, ...)

pixbufloader :

the pixbufloader that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "area-prepared" signal is emitted when sufficient image data has been received and parsed to determine the size of the image.

The "area-updated" gtk.gdk.PixbufLoader Signal

    def callback(pixbufloader, x, y, width, height, user_param1, ...)

pixbufloader :

the pixbufloader that received the signal

x :

the X coordinate of the region

y :

the Y coordinate of the region

width :

the width of the region

height :

the height of the region

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "area-updated" signal is emitted when sufficient image data has been received and parsed to allow the region specified by x, y, width and height to be displayed.

The "closed" gtk.gdk.PixbufLoader Signal

    def callback(pixbufloader, user_param1, ...)

pixbufloader :

the pixbufloader that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "closed" signal is emitted when the pixbufloader is closed by calling the close() method.

The "size-prepared" gtk.gdk.PixbufLoader Signal

    def callback(pixbufloader, width, height, user_param1, ...)

pixbufloader :

the pixbufloader that received the signal

width :

the original width of the image

height :

he original height of the image

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.2 and above.

The "size-prepared" signal is emitted when the pixbuf loader has been fed the initial amount of data that is required to figure out the size of the image that it will create. Applications can call the set_size() method in response to this signal to set the desired size of the image.

Prev Up Next
gtk.gdk.PixbufAnimationIter Home gtk.gdk.Pixmap
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkimmulticontext.html0000644000000000000000000001443611272037113025420 0ustar rootrootgtk.IMMulticontext
gtk.IMMulticontext
Prev The gtk Class Reference Next

gtk.IMMulticontext

gtk.IMMulticontext — an input method context object that manages the use of multiple input method contexts for a widget

Synopsis

class gtk.IMMulticontext(gtk.IMContext):
    gtk.IMMulticontext()
    def append_menuitems(menushell)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.IMContext
      +-- gtk.IMMulticontext

gtk.IMMulticontext Signal Prototypes

gobject.GObject Signal Prototypes

gtk.IMContext Signal Prototypes

Description

The gtk.IMMulticontext class is a subclass of gtk.IMContext that manages the use of multiple input method contexts for a widget including the ability to switch between contexts on the fly. A gtk.IMMulticontext object will proxy the method calls and signals to and from the object implementing the input method.

Constructor

    gtk.IMMulticontext()

Returns :

a new gtk.IMMulticontext object.

Creates a new gtk.IMMulticontext object.

Methods

gtk.IMMulticontext.append_menuitems

    def append_menuitems(menushell)

menushell :

a gtk.MenuShell widget

The append_menuitems() method adds menuitems for various available input methods to a menu; the menuitems, when selected, will switch the input method for the context and the global default input method.

Prev Up Next
gtk.IMContextSimple Home gtk.InputDialog
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pygtktreemodelrow.html0000644000000000000000000001745111272037113025414 0ustar rootrootgtk.TreeModelRow
gtk.TreeModelRow
Prev The gtk Class Reference Next

gtk.TreeModelRow

gtk.TreeModelRow — an object representing a row in a gtk.TreeModel

Synopsis

class gtk.TreeModelRow:
    def iterchildren()

Ancestry

+-- gobject.GBoxed
    +-- gtk.TreeModelRow

Attributes

"next"ReadThe next gtk.TreeModelRow or None
"parent"ReadThe parent gtk.TreeModelRow of this row or None
"model"ReadThe gtk.TreeModel that the row is part of.
"path"ReadThe tree path of the row
"iter"ReadA gtk.TreeIter pointing at the row.

Description

A gtk.TreeModelRow object represents a row in a gtk.TreeModel. A gtk.TreeModelRow is created by taking the mapping of a gtk.TreeModel. For example:

  treemodelrow = liststore[0]
  treemodelrow = liststore[(0,)]
  treemodelrow = liststore['0']

all create a gtk.TreeModelRow for the first row in liststore. The gtk.TreeModelRow implements some of the Python sequence protocol that makes the row behave like a sequence of objects. Specifically a tree model row has the capability of:

  • getting and setting column values,
  • returning a tuple or list containing the column values, and
  • getting the number of values in the row i.e. the number of columns

For example to get and set the value in the second column of a row, you could do the following:

  value = treemodelrow[1]
  treemodelrow[1] = value

You can use the Python len() function to get the number of columns in the row and you can retrieve all the column values as a list (tuple) using the Python list() (tuple()) function.

The gtk.TreeModelRow supports one method: the iterchildren() method that returns a gtk.TreeModelRowIter for iterating over the children of the row.

Methods

gtk.TreeModelRow.iterchildren

    def iterchildren()

Returns :

a gtk.TreeModelRowIter for the row's children or None

The iterchildren() method returns a gtk.TreeModelRowIter for iterating over the children of the row or None if the row has no children.

Prev Up Next
gtk.TreeModelSort Home gtk.TreeModelRowIter
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkradioaction.html0000644000000000000000000004221311272037113024621 0ustar rootrootgtk.RadioAction
gtk.RadioAction
Prev The gtk Class Reference Next

gtk.RadioAction

gtk.RadioAction — an action that can be grouped so that only one can be active (new in PyGTK 2.4)

Synopsis

class gtk.RadioAction(gtk.ToggleAction):
    gtk.RadioAction(name, label, tooltip, stock_id, value)
    def set_group(group)
    def get_group()
    def get_current_value()

Ancestry

+-- gobject.GObject
  +-- gtk.Action
    +-- gtk.ToggleAction
      +-- gtk.RadioAction

Implemented Interfaces

gtk.RadioAction implements gtk.Buildable

gtk.RadioAction Properties

gtk.Action Properties

gtk.ToggleAction Properties

"current-value"Read-WriteThe value property of the currently active member of the group to which this action belongs. This property is available in GTK+ 2.10 and above.
"group"WriteSets a new group for a radio action. This property is available in GTK+ 2.4 and above
"value"Read-WriteThe value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an "activate" or "changed" signal handler. See the get_current_value() and the gtk.ActionGroup.add_radio_actions() methods for convenient ways to get and set this property. This property is available in GTK+ 2.4 and above

gtk.RadioAction Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Action Signal Prototypes

gtk.ToggleAction Signal Prototypes

"changed"

 def callback(radioaction, current, user_param1, ...)

Description

Note

This object is available in PyGTK 2.4 and above.

A gtk.RadioAction is a subclass of gtk.ToggleAction and similar to gtk.RadioMenuItem. A number of radio actions can be linked together so that only one may be active at any one time.

Constructor

    gtk.RadioAction(name, label, tooltip, stock_id, value)

name :

A unique name for the action

label :

The label displayed in menu items and on buttons

tooltip :

A tooltip for this action

stock_id :

The stock icon to display in widgets representing this action

value :

A unique integer value that get_current_value() should return if this action is selected.

Returns :

a new gtk.RadioAction

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.RadioAction object suing the properties specified by: name, label, tooltip, stock_id and value. To add the action to a gtk.ActionGroup and set the accelerator for the action, call the gtk.ActionGroup.add_action_with_accel().

Methods

gtk.RadioAction.set_group

    def set_group(group)

group :

another gtk.RadioAction or None

Note

This method is available in PyGTK 2.4 and above.

The set_group() method sets the radio group for the radio action to the same group as the gtk.RadioAction specified by group i.e. the radio action joins the group.

In PyGTK 2.6.2 and above, if group is None the radio action is removed from its current group.

gtk.RadioAction.get_group

    def get_group()

Returns :

a list containing the radio actions in the group or None

Note

This method is available in PyGTK 2.4 and above.

The get_group() method returns a list containing the group that the radio action belongs to or None if the radio action is not part of a group.

gtk.RadioAction.get_current_value

    def get_current_value()

Returns :

The value of the currently active group member

Note

This method is available in PyGTK 2.4 and above.

The get_current_value() method returns the "value" property of the the currently active member of the group that the radio action belongs to.

Signals

The "changed" gtk.RadioAction Signal

    def callback(radioaction, current, user_param1, ...)

radioaction :

the radioaction that received the signal

current :

the currently active gtk.RadioAction in the group

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.4 and above.

The "changed" signal is emitted on every member of a radio group when the active member is changed. The signal gets emitted after the "activate" signals for the previous and current active members.

Prev Up Next
gtk.ProgressBar Home gtk.RadioButton
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkvruler.html0000644000000000000000000001471011272037113023645 0ustar rootrootgtk.VRuler
gtk.VRuler
Prev The gtk Class Reference Next

gtk.VRuler

gtk.VRuler — a vertical ruler.

Synopsis

class gtk.VRuler(gtk.Ruler):
    gtk.VRuler()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Ruler
        +-- gtk.VRuler

Implemented Interfaces

gtk.VRuler implements gtk.Buildable

gtk.VRuler Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Ruler Properties

gtk.VRuler Style Properties

gtk.Widget Style Properties

gtk.VRuler Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

Description

Note

This widget is considered too specialized or little-used for PyGTK, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, it will eventually move out of the PyGTK distribution.

The gtk.VRuler widget is arranged vertically creating a ruler that is used in conjunction with other widgets such as a text widget. The ruler is used to show the location of the mouse on the window and to show the size of the window in specified units. The available units of measurement are gtk.PIXELS (the default), gtk.INCHES and gtk.CENTIMETERS. See the gtk.Ruler description for more information on the methods that are used to manage a gtk.VRuler.

Constructor

    gtk.VRuler()

Returns :

a new gtk.VRuler widget

Creates a new gtk.VRuler widget.

Prev Up Next
gtk.VPaned Home gtk.VScale
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcellrendererspin.html0000644000000000000000000002060211272037113025663 0ustar rootrootgtk.CellRendererSpin
gtk.CellRendererSpin
Prev The gtk Class Reference Next

gtk.CellRendererSpin

gtk.CellRendererSpin — an object that renders a spin button in a cell (new in PyGTK 2.10)

Synopsis

class gtk.CellRendererSpin(gtk.CellRendererText):
    gtk.CellRendererSpin()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.CellRenderer
      +-- gtk.CellRendererText
        +-- gtk.CellRendererSpin

gtk.CellRendererSpin Properties

gtk.Object Properties

gtk.CellRenderer Properties

gtk.CellRendererText Properties

"adjustment"Read-WriteThe gtk.Adjustment that holds the value of the spinbutton. This must be non-None for the cell renderer to be editable. Default value: None. Available in GTK+ 2.10 and above.
"climb-rate"Read-WriteThe acceleration rate when you hold down a button. Range: [0.0,MAXDOUBLE]. Default value: 0.0. Available in GTK+ 2.10 and above.
"digits"Read-WriteThe number of decimal places to display. Range: [0,20]. Default value: 0. Available in GTK+ 2.10 and above.

gtk.CellRendererSpin Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.CellRenderer Signal Prototypes

gtk.CellRendererText Signal Prototypes

Description

gtk.CellRendererSpin renders text in a cell like gtk.CellRendererText from which it is derived. But while gtk.CellRendererText offers a simple entry to edit the text, gtk.CellRendererSpin offers a gtk.SpinButton widget. Of course, that means that the text has to be parseable as a floating point number.

The range of the spinbutton is taken from the "adjustment" property of the cell renderer, which can be set explicitly or mapped to a column in the tree model. Like all properties of cellrenderers. gtk.CellRendererSpin also has properties for the "climb-rate" and the number of "digits" to display. Other gtk.SpinButton properties can be set in a handler for the "gtk.CellRenderer.editing-started" signal.

Constructor

gtk.CellRendererSpin

    gtk.CellRendererSpin()

Returns :

a new gtk.CellRendererSpin

Note

This constructor is available in PyGTK 2.10 and above.

Creates a new gtk.CellRendererSpin.

Prev Up Next
gtk.CellRendererProgress Home gtk.CellRendererText
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkrecentinfo.html0000644000000000000000000006713211272037113024470 0ustar rootrootgtk.RecentInfo
gtk.RecentInfo
Prev The gtk Class Reference Next

gtk.RecentInfo

gtk.RecentInfo — information found when looking up an entry of the recently used files list. (new in PyGTK 2.10)

Synopsis

class gtk.RecentInfo(gobject.GBoxed):
    def get_uri()
    def get_display_name()
    def get_description()
    def get_mime_type()
    def get_added()
    def get_modified()
    def get_visited()
    def get_private_hint()
    def get_application_info(app_name)
    def get_applications()
    def last_application()
    def has_application(app_name)
    def get_groups()
    def has_group(group_name)
    def get_icon(size)
    def get_short_name()
    def get_uri_display()
    def get_age()
    def is_local()
    def exists()
    def match(info_b)

Description

A gtk.RecentInfo contains the information about an entry in a gtk.RecentManager.

Methods

gtk.RecentInfo.get_uri

    def get_uri()

Returns :

the URI of the resource.

Note

This method is available in PyGTK 2.10 and above.

Returns the URI of the resource.

gtk.RecentInfo.get_display_name

    def get_display_name()

Returns :

the display name of the resource.

Note

This method is available in PyGTK 2.10 and above.

Returns the name of the resource. If none has been defined, the basename of the resource is obtained.

gtk.RecentInfo.get_description

    def get_description()

Returns :

the description of the resource.

Note

This method is available in PyGTK 2.10 and above.

Returns the (short) description of the resource.

gtk.RecentInfo.get_mime_type

    def get_mime_type()

Returns :

the MIME type of the resource.

Note

This method is available in PyGTK 2.10 and above.

Returns the MIME type of the resource.

gtk.RecentInfo.get_added

    def get_added()

Returns :

the number of seconds elapsed from system's Epoch when the resource was added to the list, or -1 on failure.

Note

This method is available in PyGTK 2.10 and above.

Returns the timestamp (seconds from system's Epoch) when the resource was added to the recently used resources list.

gtk.RecentInfo.get_modified

    def get_modified()

Returns :

the number of seconds elapsed from system's Epoch when the resource was last modified, or -1 on failure.

Note

This method is available in PyGTK 2.10 and above.

Returns the timestamp (seconds from system's Epoch) when the resource was last modified.

gtk.RecentInfo.get_visited

    def get_visited()

Returns :

the number of seconds elapsed from system's Epoch when the resource was last visited, or -1 on failure.

Note

This method is available in PyGTK 2.10 and above.

Returns the timestamp (seconds from system's Epoch) when the resource was last visited.

gtk.RecentInfo.get_private_hint

    def get_private_hint()

Returns :

True if the private flag was found.

Note

This method is available in PyGTK 2.10 and above.

Returns the value of the "private" flag. Resources in the recently used list that have this flag set to True should only be displayed by the applications that have registered them.

gtk.RecentInfo.get_application_info

    def get_application_info(app_name)

app_name :

the name of the application that has registered this item

Returns :

a 3-tuple (containing the command line, the number of times this item was registered and the timestamp this item was last registered for this application) if an application named app_name has registered this resource inside the recently used list, or None otherwise.

Note

This method is available in PyGTK 2.10 and above.

Returns a 3-tuple containg the data regarding the application that has registered this resource. The 3-tuple contains the command line, the number of times this item was registered and the timestamp this item was last registered for this application

If the command line contains any escape characters defined inside the storage specification, they will be expanded.

gtk.RecentInfo.get_applications

    def get_applications(length)

Returns :

a list of application name strings.

Note

This method is available in PyGTK 2.10 and above.

Returns the list of applications that have registered this resource.

gtk.RecentInfo.last_application

    def last_application()

Returns :

an application name.

Note

This method is available in PyGTK 2.10 and above.

Returns the name of the last application that has registered the recently used resource.

gtk.RecentInfo.has_application

    def has_application(app_name)

app_name :

a string containing an application name

Returns :

True if an application with the name app_name was found, False otherwise.

Note

This method is available in PyGTK 2.10 and above.

Checks whether an application registered this resource using app_name.

gtk.RecentInfo.get_groups

    def get_groups(length)

Returns :

a list of group names.

Note

This method is available in PyGTK 2.10 and above.

Returns a list containing the names of all groups registered for the recently used item.

gtk.RecentInfo.has_group

    def has_group(group_name)

group_name :

the name of a group

Returns :

True if the group was found.

Note

This method is available in PyGTK 2.10 and above.

Checks whether group_name appears inside the groups registered for the recently used item.

gtk.RecentInfo.get_icon

    def get_icon(size)

size :

the size of the icon in pixels

Returns :

a gtk.gdk.Pixbuf containing the icon, or None.

Note

This method is available in PyGTK 2.10 and above.

Retrieves the icon of size size associated to the resource MIME type.

gtk.RecentInfo.get_short_name

    def get_short_name()

Returns :

the short name as a UTF-8 string

Note

This method is available in PyGTK 2.10 and above.

Computes a valid UTF-8 string that can be used as the name of the item in a menu or list. For example, calling this function on an item that refers to "file:///foo/bar.txt" will yield "bar.txt".

gtk.RecentInfo.get_uri_display

    def get_uri_display()

Returns :

a UTF-8 string containing the resource's URI or None

Note

This method is available in PyGTK 2.10 and above.

Gets a displayable version of the resource's URI.

gtk.RecentInfo.get_age

    def get_age()

Returns :

a positive integer containing the number of days elapsed since the time this resource was last modified.

Note

This method is available in PyGTK 2.10 and above.

Returns the number of days elapsed since the last update of the resource.

gtk.RecentInfo.is_local

    def is_local()

Returns :

True if the resource is local.

Note

This method is available in PyGTK 2.10 and above.

Checks whether the resource is local or not by looking at the scheme of its URI.

gtk.RecentInfo.exists

    def exists()

Returns :

True if the resource exists

Note

This method is available in PyGTK 2.10 and above.

Checks whether the resource still exists. At the moment this check is done only on resources pointing to local files.

gtk.RecentInfo.match

    def match(info_b)

info_b :

a gtk.RecentInfo

Returns :

True if info_b matches this recent info.

Note

This method is available in PyGTK 2.10 and above.

Checks if info_b matches this recent info.

Prev Up Next
gtk.RecentFilter Home gtk.RecentManager
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkaccellabel.html0000644000000000000000000004276111272037113024404 0ustar rootrootgtk.AccelLabel
gtk.AccelLabel
Prev The gtk Class Reference Next

gtk.AccelLabel

gtk.AccelLabel — a label which displays accelerator info to the right of the text

Synopsis

class gtk.AccelLabel(gtk.Label):
    gtk.AccelLabel(string)
    def accelerator_width()
    def get_accel_widget()
    def get_accel_width()
    def set_accel_widget(accel_widget)
    def refetch()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Misc
        +-- gtk.Label
          +-- gtk.AccelLabel

Implemented Interfaces

gtk.AccelLabel implements gtk.Buildable

gtk.AccelLabel Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Misc Properties

gtk.Label Properties

"accel-closure"Read-WriteThe closure to be monitored for accelerator changes
"accel-widget"Read-WriteThe widget associated with the accelerator label

gtk.AccelLabel Style Properties

gtk.Widget Style Properties

gtk.AccelLabel Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Label Signal Prototypes

Description

The gtk.AccelLabel widget is a subclass of gtk.Label that displays an accelerator string to the right of the label text, e.g. Ctrl+S. It is commonly used in menus to show the keyboard shortcuts for commands. The accelerator string to display is not set explicitly; instead, the gtk.AccelLabel displays the accelerators which have been added to the associated widget. A widget is associated with the accelerator label by calling set_accel_widget().

For example, a gtk.MenuItem widget may have an accelerator added to emit the "activate" signal when the Ctrl+S key combination is pressed. A gtk.AccelLabel is created and added to the gtk.MenuItem, and set_accel_widget() is called with the gtk.MenuItem as the first argument. The gtk.AccelLabel will now display Ctrl+S after its label.

Creating a gtk.MenuItem with the gtk.MenuItem() function (or one of the similar functions gtk.CheckMenuItem() and gtk.RadioMenuItem()) and specifying a label, automatically adds a gtk.AccelLabel to the gtk.MenuItem and calls set_accel_widget() to set it up for you.

A gtk.AccelLabel will only display accelerators which have gtk.ACCEL_VISIBLE set. A gtk.AccelLabel can display multiple accelerators and even signal names, though it is almost always used to display just one accelerator.

The following code fragment creates a simple menu item with an accelerator and enables the display of the accelerator key string in the menu item label:

Example 1. Creating a simple menu item with an accelerator key.

    # Create an accelgroup and add it to the window
    accel_group = gtk.AccelGroup()
    window.add_accel_group(accel_group)

    # Create the menu item
    save_item = gtk.MenuItem("Save")
    save_item.show()
    menu.add(save_item)

    # Now add the accelerator to the menu item. Note that since we created
    # the menu item with a label the AccelLabel is automatically setup to 
    # display the accelerators.
    save_item.add_accelerator("activate", accel_group, ord("S"),
                              gtk.gdk.CONTROL_MASK, gtk.ACCEL_VISIBLE)

Constructor

    gtk.AccelLabel(string)

string :

the label string

Returns :

a new gtk.AccelLabel object

gtk.AccelLabel() creates a new gtk.AccelLabel object. The string parameter specifies the text to be displayed by the label. The accelerator text is automatically added by the associated widget.

Methods

gtk.AccelLabel.accelerator_width

    def accelerator_width()

Returns :

the width in pixels needed

The accelerator_width() method returns the width in pixels needed to display the accelerator(s). It is used by menus to align all of the gtk.MenuItem widgets, and isn't usually needed by applications.

Note

accelerator_width() is deprecated - use the get_accel_width() method instead.

gtk.AccelLabel.get_accel_widget

    def get_accel_widget()

Returns :

the widget associated with the accelerator label, or None.

The get_accel_widget() method retrieves the widget associated with this accelerator label. See gtk.AccelLabel.set_accel_widget().

gtk.AccelLabel.get_accel_width

    def get_accel_width()

Returns :

the width in pixels needed

The get_accel_width() method returns the width in pixels needed to display the accelerator(s). It is used by menus to align all of the gtk.MenuItem widgets, and isn't usually needed by applications.

gtk.AccelLabel.set_accel_widget

    def set_accel_widget(accel_widget)

accel_widget :

the widget to be associated.

The set_accel_widget() method associates the accelerator label with the widget specified by accel_widget.

gtk.AccelLabel.refetch

    def refetch()

Returns :

False

The refetch() method recreates the accelerator label string holding the accelerator information when the accelerator is changed. The size of the string is also recalculated.

This method is not usually needed by applications since the accelerator label string is automatically updated whenever accelerators are added or removed from the associated widget.

Prev Up Next
gtk.AccelGroup Home gtk.AccelMap
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkimage.html0000644000000000000000000001764611272037113023415 0ustar rootrootatk.Image
atk.Image
Prev The atk Class Reference Next

atk.Image

atk.Image — the ATK Interface implemented by components that expose image or pixmap content on-screen.

Synopsis

class atk.Image(gobject.GInterface):
    def get_image_description()
    def get_image_size()
    def set_image_description(description)
    def get_image_position(coord_type)

Description

atk.Image should be implemented by atk.Object subtypes on behalf of components which display image/pixmap information onscreen, and which provide information (other than just widget borders, etc.) via that image content. For instance, icons, buttons with icons, toolbar elements, and image viewing panes typically should implement atk.Image.

atk.Image primarily provides two types of information: coordinate information (useful for screen review mode of screenreaders, and for use by onscreen magnifiers), and descriptive information. The descriptive information is provided for alternative, text-only presentation of the most significant information present in the image.

Methods

atk.Image.get_image_description

    def get_image_description()

Returns :

a string representing the image description

Get a textual description of this image.

atk.Image.get_image_size

    def get_image_size()

Returns :

a 2-tuple containing the width and height of the image

Get the width and height in pixels for the specified image. The width and height are returned as -1 if the values cannot be obtained.

atk.Image.set_image_description

    def set_image_description(description)

description :

a string description to set for image

Returns :

True if operation could be completed.

Sets the textual description for this image.

atk.Image.get_image_position

    def get_image_position(coord_type)

coord_type :

specifies whether the coordinates are relative to the screen or to the components top level window - one of the Atk Coord Type Constants

Returns :

a 2-tuple containing the x and y coordinates of the image

Gets the position of the image in the form of a point specifying the images top-left corner. The values of x and y are returned as -1 if the values cannot be obtained.

Prev Up Next
atk.Hypertext Home atk.Implementor
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcellrendererpixbuf.html0000644000000000000000000002015311272037113026210 0ustar rootrootgtk.CellRendererPixbuf
gtk.CellRendererPixbuf
Prev The gtk Class Reference Next

gtk.CellRendererPixbuf

gtk.CellRendererPixbuf — an object that renders a pixbuf into a gtk.TreeView cell

Synopsis

class gtk.CellRendererPixbuf(gtk.CellRenderer):
    gtk.CellRendererPixbuf()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.CellRenderer
      +-- gtk.CellRendererPixbuf

gtk.CellRendererPixbuf Properties

gtk.Object Properties

gtk.CellRenderer Properties

"follow-state"Read-WriteIf True the rendered pixbuf should be colorized according to the GTK CellRenderer State Constants. This property is available in GTK+ 2.8 and above.
"gicon"Read-WriteIf True the GIcon representing the icon to display. If the icon theme is changed, the image will be updated automatically. This property is available in GTK+ 2.14 and above.
"icon-name"Read-WriteThe name of the themed icon to display. This property only has an effect if not overridden by "stock_id" or "pixbuf" properties. This property is available in GTK+ 2.8 and above.
"pixbuf"Read/WriteThe pixbuf to render.
"pixbuf-expander-closed"Read/WritePixbuf for closed expander.
"pixbuf-expander-open"Read/WritePixbuf for open expander.
"stock-detail"Read/WriteRender detail to pass to the theme engine
"stock-id"Read/WriteThe stock ID of the stock icon to render
"stock-size"Read/WriteThe size of the rendered icon

gtk.CellRendererPixbuf Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.CellRenderer Signal Prototypes

Description

The gtk.CellRendererPixbuf manages the rendering of a pixbuf into a gtk.TreeView cell.

Constructor

    gtk.CellRendererPixbuf()

Returns :

the new cell renderer

Creates a new gtk.CellRendererPixbuf. Rendering parameters are adjusted using the object properties. The object properties can be set globally (with set_property()). Also, with gtk.TreeViewColumn, you can bind a property to a value in a gtk.TreeModel. For example, you can bind the "pixbuf" property on the cell renderer to a pixbuf value in the model, thus rendering a different image in each row of the gtk.TreeView.

Prev Up Next
gtk.CellRendererCombo Home gtk.CellRendererProgress
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcellrenderercombo.html0000644000000000000000000002733311272037113026021 0ustar rootrootgtk.CellRendererCombo
gtk.CellRendererCombo
Prev The gtk Class Reference Next

gtk.CellRendererCombo

gtk.CellRendererCombo — an object that renders a gtk.ComboBoxEntry into a gtk.TreeView cell (new in PyGTK 2.6)

Synopsis

class gtk.CellRendererCombo(gtk.CellRendererText):
    gtk.CellRendererCombo()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.CellRenderer
      +-- gtk.CellRendererText
        +-- gtk.CellRendererCombo

gtk.CellRendererCombo Properties

gtk.Object Properties

gtk.CellRenderer Properties

gtk.CellRendererText Properties

"has-entry"Read/WriteIf False, don't allow entering strings other than the given ones. Default value: True. Available in GTK+ 2.6 and above.
"model"Read/WriteThe tree model containing the possible values for the combo box entry. Available in GTK+ 2.6 and above.
"text-column"Read/WriteA column in the data source model to get the strings from. Allowed values: >= -1. Default value: -1. Available in GTK+ 2.6 and above.

gtk.CellRendererCombo Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.CellRenderer Signal Prototypes

gtk.CellRendererText Signal Prototypes

"changed"

 def callback(combo, path_string, new_iter, user_param1, ...)

Description

Note

This object is available in PyGTK 2.6 and above.

The gtk.CellRendererCombo manages the rendering of a gtk.ComboBoxEntry into a gtk.TreeView cell.

Constructor

    gtk.CellRendererCombo()

Returns :

the new cell renderer

Note

This constructor is available in PyGTK 2.6 and above.

Creates a new gtk.CellRendererCombo. Rendering parameters are adjusted using the object properties. The object properties can be set globally (with set_property()). Also, with gtk.TreeViewColumn, you can bind a property to a value in a gtk.TreeModel. For example, you can bind the "text" property on the cell renderer to a string value in the model, thus rendering a different string in each row of the gtk.TreeView.

Signals

The "changed" gtk.Calendar Signal

    def callback(combo, path_string, new_iter, user_param1, ...)

combo :

the object on which the signal is emitted

path_string :

a string of the path identifying the edited cell (relative to the tree view model)

new_iter :

the new iter selected in the combo box (relative to the combo box model)

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "changed" signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys. Contrary to GtkComboBox, GtkCellRendererCombo::changed is not emitted for changes made to a selected item in the entry. The argument new_iter corresponds to the newly selected item in the combo box and it is relative to the GtkTreeModel set via the model property on GtkCellRendererCombo.

Note that as soon as you change the model displayed in the tree view, the tree view will immediately cease the editing operating. This means that you most probably want to refrain from changing the model until the combo cell renderer emits the edited or editing_canceled signal.

Note

This method is available in PyGTK 2.14 and above.

Prev Up Next
gtk.CellRendererAccel Home gtk.CellRendererPixbuf
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkobject.html0000644000000000000000000013021611272037113023566 0ustar rootrootatk.Object
atk.Object
Prev The atk Class Reference Next

atk.Object

atk.Object — the base object class for the Accessibility Toolkit API.

Synopsis

class atk.Object(gobject.GObject):
    def get_name()
    def get_description()
    def get_parent()
    def get_n_accessible_children()
    def ref_accessible_child(i)
    def ref_relation_set()
    def get_role()
    def get_layer()
    def get_mdi_zorder()
    def ref_state_set()
    def get_index_in_parent()
    def set_name(name)
    def set_description(description)
    def set_parent(parent)
    def set_role(role)
    def remove_property_change_handler(handler_id)
    def add_relationship(relationship, target)
    def remove_relationship(relationship, target)

Ancestry

+-- gobject.GObject
  +-- atk.Object

atk.Object Properties

"accessible-component-layer"ReadThe accessible layer of this object. Allowed values: >= 0. Default value: 0.
"accessible-component-mdi-zorder"ReadThe accessible MDI value of this object. Default value: -2147483648
"accessible-description"Read-WriteDescription of an object, formatted for assistive technology access. Default value: None.
"accessible-hypertext-nlinks"ReadThe number of links which the current atk.Hypertext has. Allowed values: >= 0. Default value: 0.
"accessible-name"Read-WriteObject instance's name formatted for assistive technology access. Default value: None.
"accessible-parent"Read-WriteIs used to notify that the parent has changed.
"accessible-role"Read-WriteThe accessible role of this object. Allowed values: >= 0. Default value: 0.
"accessible-table-caption"Read-WriteIs used to notify that the table caption has changed; this property should not be used. "accessible-table-caption-object" should be used instead. Default value: None.
"accessible-table-caption-object"Read-WriteIs used to notify that the table caption has changed
"accessible-table-column-description"Read-WriteIs used to notify that the table column description has changed. Default value: None.
"accessible-table-column-header"Read-WriteIs used to notify that the table column header has changed
"accessible-table-row-description"Read-WriteIs used to notify that the table row description has changed. Default value: None.
"accessible-table-row-header"Read-WriteIs used to notify that the table row header has changed
"accessible-table-summary"Read-WriteIs used to notify that the table summary has changed
"accessible-value"Read-WriteIs used to notify that the value has changed. Allowed values: >= 0. Default value: 0.

atk.Object Signal Prototypes

gobject.GObject Signal Prototypes

"active-descendant-changed"

 def callback(atkobject, object, user_param1, ...)

"children-changed"

 def callback(atkobject, index, child, user_param1, ...)

"focus-event"

 def callback(atkobject, has_focus, user_param1, ...)

"property-change"

 def callback(atkobject, value, user_param1, ...)

"state-change"

 def callback(atkobject, state, is_set, user_param1, ...)

"visible-data-changed"

 def callback(atkobject, user_param1, ...)

Description

This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects that are instances of atk.Object (or instances of atk.Object-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of atk.Object may also be queried as to whether they implement other ATK interfaces (e.g. atk.Action, atk.Component, etc.), as appropriate to the role which a given UI component plays in a user interface.

All UI components in an applicationthat provide useful information or services to the user must provide corresponding atk.Object instances on request (in GTK+, for instance, usually on a call to the gtk.Widget.get_accessible() method), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited atk.Object implementation is insufficient, via instances of a new atk.Object subclass.

Methods

atk.Object.get_name

    def get_name()

Returns :

a character string representing the accessible name of the object.

Gets the accessible name of the accessible.

atk.Object.get_description

    def get_description()

Returns :

a character string representing the accessible description of the accessible.

Gets the accessible description of the accessible.

atk.Object.get_parent

    def get_parent()

Returns :

a atk.Object representing the accessible parent of the accessible

Gets the accessible parent of the accessible.

atk.Object.get_n_accessible_children

    def get_n_accessible_children()

Returns :

an integer representing the number of accessible children of the accessible.

Gets the number of accessible children of the accessible.

atk.Object.ref_accessible_child

    def ref_accessible_child(i)

i :

an integer representing the position of the child, starting from 0

Returns :

an atk.Object representing the specified accessible child of the accessible.

Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.

atk.Object.ref_relation_set

    def ref_relation_set()

Returns :

an atk.RelationSet representing the relation set of the object.

Gets the atk.RelationSet associated with the object.

atk.Object.get_role

    def get_role()

Returns :

one of the Atk Role Constants which is the role of the accessible

Gets the role of the accessible.

atk.Object.get_layer

    def get_layer()

Returns :

one of the Atk Layer Constants which is the layer of the accessible

Note

This method is deprecated. Use the atk.Component.get_layer() method instead.

Gets the layer of the accessible.

atk.Object.get_mdi_zorder

    def get_mdi_zorder()

Returns :

an integer which is the zorder of the accessible, i.e. the depth at which the component is shown in relation to other components in the same container.

Note

This method is deprecated. Use the atk.Component.get_mdi_zorder() method instead.

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not atk.LAYER_MDI.

atk.Object.ref_state_set

    def ref_state_set()

Returns :

a reference to an atk.StateSet which is the state set of the accessible

Gets a reference to the state set of the accessible.

atk.Object.get_index_in_parent

    def get_index_in_parent()

Returns :

an integer which is the index of the accessible in its parent

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

atk.Object.set_name

    def set_name(name)

name :

a character string to be set as the accessible name

Sets the accessible name of the accessible.

atk.Object.set_description

    def set_description(description)

description :

a character string to be set as the accessible description

Sets the accessible description of the accessible.

atk.Object.set_parent

    def set_parent(parent)

parent :

an atk.Object to be set as the accessible parent

Sets the accessible parent of the accessible.

atk.Object.set_role

    def set_role(role)

role :

one of the Atk Role Constants to be set as the role

Sets the role of the accessible.

atk.Object.remove_property_change_handler

    def remove_property_change_handler(handler_id)

handler_id :

an integer that identifies the handler to be removed.

Removes a property change handler.

atk.Object.add_relationship

    def add_relationship(relationship, target)

relationship :

one of the Atk Relation Type Constants

target :

The atk.Object which is to be the target of the relation.

Returns :

True if the relationship is added.

Adds a relationship of the specified type with the specified target.

atk.Object.remove_relationship

    def remove_relationship(relationship, target)

relationship :

one of the Atk Relation Type Constants

target :

The atk.Object which is the target of the relation to be removed.

Returns :

True if the relationship is removed.

Removes a relationship of the specified type with the specified target.

Signals

The "active-descendant-changed" atk.Object Signal

    def callback(atkobject, obj, user_param1, ...)

atkobject :

the object which received the signal.

obj :

the newly focused object.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "active-descendant-changed" signal is emitted by an object which has the state atk.STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.

The "children-changed" atk.Object Signal

    def callback(atkobject, index, child, user_param1, ...)

atkobject :

the object which received the signal.

index :

The index of the added or removed child

child :

The child which was added or removed

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The signal "children-changed" is emitted when a child is added or removed form an object. It supports two details: "add" and "remove"

The "focus-event" atk.Object Signal

    def callback(atkobject, has_focus, user_param1, ...)

atkobject :

the object which received the signal.

has_focus :

A boolean value which indicates whether the object gained or lost focus.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The signal "focus-event" is emitted when an object gains or loses focus.

The "property-change" atk.Object Signal

    def callback(atkobject, value, user_param1, ...)

atkobject :

the object that received the signal.

value :

The new value of the property that changed.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The signal "property-change" is emitted when an object's property value changes. The detail identifies the name of the property whose value has changed.

The "state-change" atk.Object Signal

    def callback(atkobject, state, is_set, user_param1, ...)

atkobject :

the object which received the signal.

state :

The name of the state which has changed

is_set :

A boolean which indicates whether the state has been set or unset.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed.

The "visible-data-changed" atk.Object Signal

    def callback(atkobject, user_param1, ...)

atkobject :

the object that received the signal.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "visible-data-changed" signal is emitted when the visual appearance of the object changed.

Prev Up Next
atk.NoOpObjectFactory Home atk.ObjectFactory
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkprintoperation.html0000644000000000000000000025144511272037113025413 0ustar rootrootgtk.PrintOperation
gtk.PrintOperation
Prev The gtk Class Reference Next

gtk.PrintOperation

gtk.PrintOperation — a high-level printing API (new in PyGTK 2.10)

Synopsis

class gtk.PrintOperation(gobject.GObject, gtk.PrintOperationPreview):
    gtk.PrintOperation()
    def set_default_page_setup(default_page_setup=None)
    def get_default_page_setup()
    def set_print_settings(print_settings=None)
    def get_print_settings()
    def set_job_name(job_name)
    def set_n_pages(n_pages)
    def set_current_page(current_page)
    def set_use_full_page(full_page)
    def set_unit(unit)
    def set_export_filename(filename)
    def set_track_print_status(track_status)
    def set_show_progress(show_progress)
    def set_allow_async(allow_async)
    def set_custom_tab_label(label)
    def run(action, parent=None)
    def get_error()
    def get_status()
    def get_status_string()
    def is_finished()
    def cancel()

Ancestry

+-- gobject.GObject
  +-- gtk.PrintOperation (implements gtk.PrintOperationPreview)

gtk.PrintOperation Properties

"allow-async"Read-WriteIf True the print operation may run asynchronously or not. Some systems don't support asynchronous printing, but those that do will return gtk.PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and emit the done signal when the operation is actually done. This property is available in GTK+ 2.10 and above.
"current-page"Read-WriteThe current page in the document. If this is set before gtk.PrintOperation.run(), the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents. This property is available in GTK+ 2.10 and above.
"custom-tab-label"Read-WriteUsed as the label of the tab containing custom widgets. Note that this property may be ignored on some platforms. If this is None, GTK+ uses a default label. This property is available in GTK+ 2.10 and above.
"default-page-setup"Read-WriteThe gtk.PageSetup used by default. This page setup will be used by gtk.PrintOperation.run(), but it can be overridden on a per-page basis by connecting to the "request-page-setup" signal. This property is available in GTK+ 2.10 and above.
"export-filename"Read-WriteThe name of a file file to generate instead of showing the print dialog. Currently, PDF is the only supported format. The intended use of this property is for implementing "Export to PDF" actions. "Print to PDF" support is independent of this and is done by letting the user pick the "Print to PDF" item from the list of printers in the print dialog. This property is available in GTK+ 2.10 and above.
"job-name"Read-WriteA string used to identify the job (e.g. in monitoring applications like eggcups). If you don't set a job name, GTK+ picks a default one by numbering successive print jobs. This property is available in GTK+ 2.10 and above.
"n-pages"Read-WriteThe number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a "begin-print" signal hander. Note that the page numbers passed to the "request-page-setup" and "draw-page" signals are 0-based, i.e. if the user chooses to print all pages, the last "draw-page" signal will be for page n_pages - 1. This property is available in GTK+ 2.10 and above.
"print-settings"Read-WriteThe gtk.PrintSettings used for initializing the dialog. Setting this property is typically used to re-establish print settings from a previous print operation, see the gtk.PrintOperation.run() method. This property is available in GTK+ 2.10 and above.
"show-progress"Read-WriteIf True show a progress dialog during the print operation. This property is available in GTK+ 2.10 and above.
"status"ReadThe status of the print operation. This property is available in GTK+ 2.10 and above.
"status-string"ReadA string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a gtk.Statusbar. See the "status" property for a status value that is suitable for programmatic use. This property is available in GTK+ 2.10 and above.
"track-print-status"Read-WriteIf True, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer. However, this is often implemented using polling, and should not be enabled unless needed. This property is available in GTK+ 2.10 and above.
"unit"Read-WriteThe transformation for the cairo context obtained from gtk.PrintContext is set up in such a way that distances are measured in units of unit. This property is available in GTK+ 2.10 and above.
"use-full-page"Read-WriteIf True, the transformation for the cairo context obtained from gtk.PrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins). This property is available in GTK+ 2.10 and above.

gtk.PrintOperation Signal Prototypes

gobject.GObject Signal Prototypes

gtk.PrintOperationPreview Signal Prototypes

"begin-print

 def callback(operation, context, user_param1, ...)

"create-custom-widget

 def callback(operation, user_param1, ...)

"custom-widget-apply

 def callback(operation, widget, user_param1, ...)

"done

 def callback(operation, result, user_param1, ...)

"draw-page

 def callback(operation, context, page_nr, user_param1, ...)

"end-print

 def callback(operation, context, user_param1, ...)

"paginate

 def callback(printoperation, context, user_param1, ...)

"preview

 def callback(operation, preview, context, parent, user_param1, ...)

"request-page-setup

 def callback(operation, context, page_nr, setup, user_param1, ...)

"status-changed

 def callback(operation, printoperation, user_param1, ...)

Description

gtk.PrintOperation is the high-level, portable printing API. It looks a bit different than other GTK+ dialogs such as the gtk.FileChooser, since some platforms don't expose enough infrastructure to implement a good print dialog. On such platforms, gtk.PrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK+ uses its own, see gtkunixprint.PrintUnixDialog.

The typical way to use the high-level printing API is to create a gtk.PrintOperation object with the gtk.PrintOperation constructor when the user selects to print. Then you set some properties on it, e.g. the page size, any gtk.PrintSettings from previous print operations, the number of pages, the current page, etc.

Then you start the print operation by calling the gtk.PrintOperation.run() method. It will then show a dialog, let the user select a printer and options. When the user finished the dialog various signals will be emitted on the gtk.PrintOperation, the main one being "draw-page", which you are supposed to catch and render the page on the provided gtk.PrintContext using Cairo.

Example 3. The high-level printing API

settings = None

def do_print():
  print_op = gtk.PrintOperation()

  if settings != None: 
    print_op.set_print_settings(settings)

  print_op.connect("begin_print", begin_print)
  print_op.connect("draw_page", draw_page)

  res = print_op.run(gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG, main_window)

  if res == gtk.PRINT_OPERATION_RESULT_APPLY:
      settings = print_op.get_print_settings()

Printing support was added in GTK+ 2.10.

Constructor

gtk.PrintOperation

    gtk.PrintOperation()

Returns :

a new gtk.PrintOperation

Note

This constructor is available in PyGTK 2.10 and above.

Creates a new gtk.PrintOperation.

Methods

gtk.PrintOperation.set_default_page_setup

    def set_default_page_setup(default_page_setup=None)

default_page_setup :

a gtk.PageSetup, or None

Note

This method is available in PyGTK 2.10 and above.

The set_default_page_setup() method makes default_page_setup the default page setup.

This page setup will be used by the gtk.PrintOperation.run() method, but it can be overridden on a per-page basis by connecting to the "request-page-setup" signal.

gtk.PrintOperation.get_default_page_setup

    def get_default_page_setup()

Returns :

the default page setup

Note

This method is available in PyGTK 2.10 and above.

The get_default_page_setup() method returns the default page setup, see the gtk.PrintOperation.set_default_page_setup() method.

gtk.PrintOperation.set_print_settings

    def set_print_settings(print_settings=None)

print_settings :

gtk.PrintSettings, or None

Note

This method is available in PyGTK 2.10 and above.

The set_print_settings() method sets the print settings. This is typically used to re-establish print settings from a previous print operation, see the gtk.PrintOperation.run() method.

gtk.PrintOperation.get_print_settings

    def get_print_settings()

Returns :

the current print settings.

Note

This method is available in PyGTK 2.10 and above.

The get_print_settings() method returns the current print settings.

Note that the return value is None until either the gtk.PrintOperation.set_print_settings() or gtk.PrintOperation.run() methods have been called.

gtk.PrintOperation.set_job_name

    def set_job_name(job_name)

job_name :

a string that identifies the print job

Note

This method is available in PyGTK 2.10 and above.

The set_job_name() method sets the name of the print job. The name is used to identify the job (e.g. in monitoring applications like eggcups).

If you don't set a job name, GTK+ picks a default one by numbering successive print jobs.

gtk.PrintOperation.set_n_pages

    def set_n_pages(n_pages)

n_pages :

the number of pages

Note

This method is available in PyGTK 2.10 and above.

The set_n_pages() >method sets the number of pages in the document.

This must be set to a positive number before the rendering starts. It may be set in a "begin-print" signal hander.

Note that the page numbers passed to the "request-page-setup" and "draw-page" signals are 0-based, i.e. if the user chooses to print all pages, the last "draw-page" signal will be for page n_pages - 1.

gtk.PrintOperation.set_current_page

    def set_current_page(current_page)

current_page :

the current page, 0-based

Note

This method is available in PyGTK 2.10 and above.

The set_current_page() method sets the current page.

If this is called before gtk.PrintOperation.run(), the user will be able to select to print only the current page.

Note that this only makes sense for pre-paginated documents.

gtk.PrintOperation.set_use_full_page

    def set_use_full_page(full_page)

full_page :

True to set up the gtk.PrintContext for the full page

Note

This method is available in PyGTK 2.10 and above.

The set_use_full_page() method sets the "full-page" property to the value of full_page. If full_page is True, the transformation for the cairo context obtained from gtk.PrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins).

gtk.PrintOperation.set_unit

    def set_unit(unit)

unit :

the unit to use

Note

This method is available in PyGTK 2.10 and above.

The set_unit() method sets up the transformation for the cairo context such distances are measured in units of unit.

gtk.PrintOperation.set_export_filename

    def set_export_filename(filename)

filename :

the filename for the exported file

Note

This method is available in PyGTK 2.10 and above.

The set_export_filename() method sets up the gtk.PrintOperation to generate a file instead of showing the print dialog. The intended use of this method is for implementing "Export to PDF" actions. Currently, PDF is the only supported format.

"Print to PDF" support is independent of this and is done by letting the user pick the "Print to PDF" item from the list of printers in the print dialog.

gtk.PrintOperation.set_track_print_status

    def set_track_print_status(track_status)

track_status :

if True track status after printing

Note

This method is available in PyGTK 2.10 and above.

The set_track_print_status() method sets the "track-print-status" to the value of track_status. If track_status is True, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer.

This method is often implemented using some form of polling, so it should not be enabled unless needed.

gtk.PrintOperation.set_show_progress

    def set_show_progress(show_progress)

show_progress :

if True show a progress dialog

Note

This method is available in PyGTK 2.10 and above.

The set_show_progress() method sets the "show-progress" property to the value of show_progress. If show_progress is True, the print operation will show a progress dialog during the print operation.

gtk.PrintOperation.set_allow_async

    def set_allow_async(allow_async)

allow_async :

if True allow asynchronous operation

Note

This method is available in PyGTK 2.10 and above.

The set_allow_async() method sets the "allow-async" to the value of allow_async. If allow_async is True the gtk.PrintOperation.run() may return before the print operation is completed. Note that some platforms may not allow asynchronous operation.

gtk.PrintOperation.set_custom_tab_label

    def set_custom_tab_label(label)

label :

Note

This method is available in PyGTK 2.10 and above.

The set_custom_tab_label() method sets the label for the tab holding custom widgets.

gtk.PrintOperation.run

    def run(action, parent=None)

action :

the action to start - one of the GTK Print Operation Action Constants

parent :

Transient parent of the dialog, or None

Returns :

the result of the print operation - one of the GTK Print Operation Result Constants. A return value of gtk.PRINT_OPERATION_RESULT_APPLY indicates that the printing was completed successfully. In this case, it is a good idea to obtain the used print settings with the gtk.PrintOperation.get_print_settings() method and store them for reuse with the next print operation. A value of gtk.PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running asynchronously, and will emit the "done" signal when done.

Note

This method is available in PyGTK 2.10 and above.

The run() method runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document.

Normally that this method does not return until the rendering of all pages is complete. You can connect to the "status-changed" signal to obtain some information about the progress of the print operation. Furthermore, it may use a recursive mainloop to show the print dialog.

If you call the gtk.PrintOperation.set_allow_async() method or set the "allow-async" property the operation will run asyncronously if this is supported on the platform. The "done" signal will be emitted with the operation results when the operation is done (i.e. when the dialog is canceled, or when the print succeeds or fails).

      if settings != None:
        print.set_print_settings( settings)
        
      if page_setup != None:
        print.set_default_page_setup(page_setup)
        
      print.connect( "begin-print", begin_print, data)
      print.connect("draw-page", draw_page, data)
       
      res = print.run(gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG, parent)
       
      if res == gtkprint_OPERATION_RESULT_ERROR:
         error_dialog = gtk.MessageDialog(parent,
                                          gtk.DIALOG_DESTROY_WITH_PARENT,
                                          gtk.MESSAGE_ERROR,
      					  gtk.BUTTONS_CLOSE,
      					  "Error printing file:\n")
         error_dialog.connect("response", lambda w,id: w.destroy())
         error_dialog.show()
      elif res == gtk.PRINT_OPERATION_RESULT_APPLY:
         settings = print.get_print_settings()

gtk.PrintOperation.get_error

    def get_error()

Returns :

the error message or None

Note

This method is available in PyGTK 2.10 and above.

The get_error() method returns the error message or None. Call this when the result of a print operation is gtk.PRINT_OPERATION_RESULT_ERROR, either as returned by the gtk.PrintOperation.run() method, or in the "done" signal handler.

gtk.PrintOperation.get_status

    def get_status()

Returns :

the status of the print operation

Note

This method is available in PyGTK 2.10 and above.

The get_status() method returns the status of the print operation as one of the GTK Print Status Constants. Also see the gtk.PrintOperation.get_status_string() method.

gtk.PrintOperation.get_status_string

    def get_status_string()

Returns :

a string representation of the status of the print operation

Note

This method is available in PyGTK 2.10 and above.

The get_status_string() method returns a string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a gtk.Statusbar.

Use the gtk.PrintOperation.get_status() method to obtain a status value that is suitable for programmatic use.

gtk.PrintOperation.is_finished

    def is_finished()

Returns :

True, if the print operation is finished.

Note

This method is available in PyGTK 2.10 and above.

The method returns True if the print operation is completed. This is a convenience method to find out if the print operation is finished, either successfully (gtk.PRINT_STATUS_FINISHED) or unsuccessfully (gtk.PRINT_STATUS_FINISHED_ABORTED).

Note

When you enable print status tracking, the print operation can be in a non-finished state even after done has been called, as the operation status then tracks the print job status on the printer.

gtk.PrintOperation.cancel

    def cancel()

Note

This method is available in PyGTK 2.10 and above.

The cancel() method cancels a running print operation. This method may be called from a "begin-print", "paginate" or "draw-page" signal handler to stop the currently running print operation.

Signals

The "begin-print" gtk.PrintOperation Signal

    def callback(operation, context, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

context :

the gtk.PrintContext for the current operation

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "begin-print" signal is emitted after the user has finished changing print settings in the dialog, before the actual rendering starts.

A typical use for this signal is to use the parameters from the gtk.PrintContext and paginate the document accordingly, and then set the number of pages with gtk.PrintOperation.set_n_pages().

The "create-custom-widget" gtk.PrintOperation Signal

    def callback(operation, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Returns :

A custom widget that gets embedded in the print dialog, or None

Note

This signal is available in GTK+ 2.10 and above.

The "create-custom-widget" signal is emitted when displaying the print dialog. If you return a widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a container widget with multiple widgets in it.

The print dialog owns the returned widget, and its lifetime isn't controlled by the app. However, the widget is guaranteed to stay around until the "custom-widget-apply" signal is emitted on the operation. Then you can read out any information you need from the widgets.

The "custom-widget-apply" gtk.PrintOperation Signal

    def callback(operation, widget, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

widget :

the custom widget added in create-custom-widget

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "custom-widget-apply" signal is emitted right before "begin-print" if you added a custom widget in the "create-custom-widget" handler. When you get this signal you should read the information from the custom widgets, as the widgets are not guaraneed to be around at a later time.

The "done" gtk.PrintOperation Signal

    def callback(operation, result, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

result :

the result of the print operation

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "done" signal is emitted when the print operation run has finished doing everything required for printing. result (one of the GTK Print Operation Result Constants) gives you information about what happened during the run. If result is gtk.PRINT_OPERATION_RESULT_ERROR then you can call the gtk.PrintOperation.get_error() method for more information.

If you enabled print status tracking then the gtk.PrintOperation.is_finished() method may still return False after this was emitted.

The "draw-page" gtk.PrintOperation Signal

    def callback(operation, context, page_nr, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

context :

the gtk.PrintContext for the current operation

page_nr :

the number of the currently printed page

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "draw-page" signal is emitted for every page that is printed. The signal handler must render the page_nr's page onto the cairo context obtained from context using gtk.PrintContext.get_cairo_context().

def draw_page(operation, context, page_nr, user_data):
        cr = context.get_cairo_context()
        width = context.get_width()
        
        cr.rectangle(0, 0, width, HEADER_HEIGHT)
        
        cr.set_source_rgb(0.8, 0.8, 0.8);
        cr.fill()
        
        layout = context.create_pango_layout()
        
        desc = pango.FontDescription("sans 14")
        layout.set_font_description(desc)
        
        layout.set_text("some text")
        layout.set_width(width)
        layout.set_alignment(pango.ALIGN_CENTER)
           		      
        x,layout_height = layout.get_size()
        text_height = layout_height / pango.SCALE
        
        cr.move_to(width / 2,  (HEADER_HEIGHT - text_height) / 2)
        cr.show_layout(layout)

Use the gtk.PrintOperation.set_use_full_page() and gtk.PrintOperation.set_unit() methods before starting the print operation to set up the transformation of the cairo context according to your needs.

The "end-print" gtk.PrintOperation Signal

    def callback(operation, context, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

context :

the gtk.PrintContext for the current operation

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "end-print" signal is emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the "begin-print" handler.

The "paginate" gtk.PrintOperation Signal

    def callback(printoperation, context, user_param1, ...)

printoperation :

the object which received the signal.

context :

the gtk.PrintContext for the current operation

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Returns :

Note

This signal is available in GTK+ 2.10 and above.

The "paginate" signal is emitted after the "begin-print" signal, but before the actual rendering starts. It keeps getting emitted until it returns False.

This signal is intended to be used for paginating the document in small chunks, to avoid blocking the user interface for a long time. The signal handler should update the number of pages using the gtk.PrintOperation.set_n_pages() method, and return True if the document has been completely paginated.

If you don't need to do pagination in chunks, you can simply do it all in the "begin-print" handler, and set the number of pages from there.

The "preview" gtk.PrintOperation Signal

    def callback(operation, preview, context, parent, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

preview :

the GtkPrintPreviewOperation for the current operation

context :

the gtk.PrintContext that will be used

parent :

the gtk.Window to use as window parent, or None

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Returns :

True if the listener wants to take over control of the preview

Note

This signal is available in GTK+ 2.10 and above.

The "preview" signal is emitted when a preview is requested from the native dialog. If you handle this you must set the cairo context on the printing context.

If you don't override this, a default implementation using an external viewer will be used.

The "request-page-setup" gtk.PrintOperation Signal

    def callback(operation, context, page_nr, setup, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

context :

the gtk.PrintContext for the current operation

page_nr :

the number of the currently printed page

setup :

the gtk.PageSetup

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "request-page-setup" signal is emitted once for every page that is printed, to give the application a chance to modify the page setup. Any changes done to setup will be in force only for printing this page.

The "status-changed" gtk.PrintOperation Signal

    def callback(operation, printoperation, user_param1, ...)

operation :

the gtk.PrintOperation on which the signal was emitted

printoperation :

the object which received the signal.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "status-changed" signal is emitted at between the various phases of the print operation. See the GTK Print Status Constants for the phases that are being discriminated. Use the gtk.PrintOperation.get_status() method to find out the current status.

Prev Up Next
gtk.PrintContext Home gtk.PrintOperationPreview
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/0000755000000000000000000000000011272037205020741 5ustar rootroot./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_redo_rtl_24.png0000644000000000000000000000142711272037113024773 0ustar rootrootPNG  IHDRw=bKGD pHYs AetIME *)IDATxMHQ}?+}e%$hUZ-m Yh!Q`Vh#a*Q苊RAɬ޴ƙQǠ ;oΙsg΅3~!u|ms4iA LJYP@_^T "35<D˭(޼T|Le ,Zo6,ON4FG&~Sw7/]9GɖܴC$E4L/LW vT) eh݃mvu1[>=Dvr<; B q)ldmi .b{`׶{vk `~:oE 0SZ\I(^Ε5Ȑ))QwQYeWXPNH[š5 )3ܦ6-S~@e[cc _+:# ~ՑM'JgXMA HDr9 ) ЀDcx>h ^j]?B0B,`%P ͆ |DKxx/C_L1o9aԞ9>Wf9[Ch,Tm1gY7hVq~Y Q=v0KWXGqIzIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_file_24.png0000644000000000000000000000136511272037112024100 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs )ItIME 58|rIDATxڽnA{! KHAI(RPHHpD$mr .N@bI|,;m驎F#]г3=88P2кQGq*^G$ ,qSD(,ަ:D+y"n漺A!MS9<<;n\ߎpH s8::x+'[Pş͘DxBeb{ <^38g LiC'\^^2蟟s킓O }5CB"ȠRDVmvvvs, jbwoRVL iq3Q0Zn؊dMNhES-Z oc"IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_copy_24.png0000644000000000000000000000120611272037112024125 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  ~tIME IDATxڽP?y}- t+Ac1A݊n% A.DG I6K͋-\=ss?@\蟁 F/c5B*B>t:ac& it(Jݡ( 2 fI,|}4MCAVq.zM+9 z'5h4Vvl3UX뺘y m\.(_*|R V(x#Dk]$/o` 쁛ЌRtY~VQGܗSrX$O 'FIcMDߖ&)@Mp*g\5őC}gIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_align_right_24.png0000644000000000000000000000100711272037112025441 0ustar rootrootPNG  IHDRw=bKGDIDATxڭj@QD$ҫ }G~[SZ5&$182`s y@3L2"Hjt:V/B)%R-8nìk* =d2ڰ^(O Fu,LDUUGK FYFco@0X,':S*D~oQ g`&1QbQqE2, 0 P(g0 ,Fk  xk*pu!sݹ+r@{,K:Y.`\ޗ{nz:eIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_undelete_rtl_24.png0000644000000000000000000000264011272037113025645 0ustar rootrootPNG  IHDRw=bKGD pHYs  tIME5۞-IDATxmL[u-p7a&M':Mt,,~0,0]2QʌlYfʈ FM s8C&C\Aca+/Kvy ?6ٸi i*pX, $Qdss| \g@w>-ÞWX\r܋hrjIee( EE%M:99l?>J]*:6Rn]/^ ŋcͩ]Pr<$*No&W"WG2QSazkkHsO[[[YJJд$Cx<p;`M}K)Dܗ2[3'BD Ȳ nG N't0`5Or[aoп%K*ikۏb&dQ%21wh/$o6/g泥C DILU2fP\ }F<)SUUƯ8a/[ٳ)dde|db$B2aϫ N鑑d ss*P9C&hñ2d(-Z2$RUUFm2VIC3CzD#9ilcd>>$ӡqJ$ =/<PHZz\Fph4R_ @-" QX3d9RkEv{>+o[N]]-$CC_4ht~-֬k0". Ɂ0$b^ĀG}IBMw;@0 Eubq4M#DU; Ma~*̷(X MܼyM4:KuRB)BiTU<ɹ ibIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_jump_to_rtl_24.png0000644000000000000000000000210511272037112025510 0ustar rootrootPNG  IHDRw=bKGD pHYs @StIME 4IDATx]hUf7$t6$FIb }jJ^'B[ h)R|HkP+-QcbRk4M3s36i };?s`>Q?EY=Y Hl7l#ȁ?\Y_ H%"  B+DȗEYh]gETg닇{OO^hCEc/̕AkAOE'm}ɤEe!ҸGvw.\os[< @Sqq-5]wżEٔ+`D ȁ9̍w{6|ǓA5:LL[=#rbT1@Xl"<3'vs+x3F +G_U16AQV$")]ΟkWDxDZn F`=|_F+ J)Ѷw_ɧQ:@?h^[InƲ bQ!hAT [j*t{9X;,dsdsܽ7ŭTՖ{qmܼO 7ihm~yPcXVR #ܙ^ϙ<3f e(p5&thJ_0-#-PB /Vn3^iU5Q()?Ebgqi nOs3;őy)GVKXɘ**];{Qؿ&UD/n\k1M#W#NF~+(A%BE,y MJ7Va;kQ 6xp6z$D eO9 Xw'ϳIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_print_report_24.png0000644000000000000000000000220211272037113025700 0ustar rootrootPNG  IHDRw=sBIT|d pHYs B(xtEXtSoftwarewww.inkscape.org<IDATHKhW|d2X>\EfӥhB)},]+)tRЍMK`HI5>3n3N3FQz]ϹJkf?Q5JJmj}{ 6 { jUSL&~*"`QDegό"JD%Us%B֭K^ߒC 6o~_e b, ">}\PsTeA_oo 2QJ=:"jAqj bзAFAU;uVn[~M%燇q7<ۻ j>v\VlS6?-'W3>9 WMs7=Kq]67pr]`BC`EMSEǸ־ rFk\r_7L܎H'4ƔE!uqRRI|SD(.Ymİ?xAM-95E ?het50 Lq/aG)PpBNH q.J)e~6wiik 5'@@Q3_rYPJ)Raf۪v^joOL39s֕xaLWk ~6,=LB2+C{AsL( iXxыTBy6 uu;^8ַessWך%!~7>˗%˻rejߏ?x5/ID$q皘Wi,]%2q5_ @`K726IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_index_24.png0000644000000000000000000000165511272037112024272 0ustar rootrootPNG  IHDRw=bKGDbIDATxڵK#g?ɌN)MYZWZfggT*mМ`ddO ```D!BtNpzzqr...!re,vONNn@&iX|LkfzzU(Mw]!JRms,IGGG,// Cޣj[8%QP/ 0 CEquuUK_,WgeQmj[b}}MbccC4^m7\b!,T.0@!'L\]9hĻ&ui}ۃO93Wd@]ˁiuNIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_search_24.png0000644000000000000000000000215011272037113024420 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs @StIME 8IDATxڽ_h\E3&M6b1J!lc6iPK 56 >(om}() +-,$``M }$XHӤf;3>lM6*x.s2|g̙?ڛXm366f\53̍7Loo0 ʁ.h\%j5L˲B477oYA%pcL)j\r3g~bzz219ɭ?oq( %8ys裫k'6Sd.;G  HKӴ7.B)[5Z)FFe˳_e%uihxGB m$ uuDE@pEPZqyslqJCJT-Rx| JZ݇,@md~/\wqI&illbǎrxG>!DkM˲XUtw%WGskYQZ[hKͷTWUf+w8 ĥK_;^ F#BN`0H{ILOc6Z'f(E@)* !J1L&hƓ͛r޽KUUue$j,1soZkhcBX4J*e#Y 2 $шh1  ?~mwq?rYx%10*IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_preferences_24.png0000644000000000000000000000215411272037113025460 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  d_tIME IDATxڭmh[eI6Ӹf5ި+خ-LuNΑaAS@ +cv,`nv05 `]m7t%](- &iҦK&-!}{Ϲyn˛>Y `: K|h$W^.R%su۷Dge$g9 ˀ2倸[U2\!vp(ԧ9R@3"/Y!Zz=6Lc_~B"1Gt*đC]S!-M:Q~?6 (ZξRZˆƂӮF5P(lVݞd:3ɶ%%%$/@Q|2pg! &ɤ`0SdeaodA' fc3K88߯WI/NW^FUl k; "SawMөW[ez@/3(R% N Ezd"hWlӂxu* ]U+NF&6ZTiiѭn?NEF0ZΜ?bD<G:Sb7!.wk7~yw1>>.pԪkfr5ػ7RɤFJł'ʶQc9t03+5Xj!֚GO̩~ Lfztl)}ˆR|sat]\:>g^bxx_\<٤8pOvPa2Dx^F|~N' }7{j+t?@M]}:~`FFbޞ&/ZK'&2 eyYЄdg]WAWt%;ۍwhw KpH)G0Z]G{1Z_!I0(3 f^HvRϦ ͪ (q;/EMiR*[K|IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_convert_24.png0000644000000000000000000000272711272037112024644 0ustar rootrootPNG  IHDRw=bKGDIDATxڥ]l\Gs~{w]k{;M|4uHi ) npS "B( !BTHhqI(iq$6^wcaqg4sg`exPG4F" *qe{{ճRJPW& z?o>ta쎖|(o8d}\ ׵cZ^m X2kGO[\7Zy;\ǭsڢ5צ ݈<~ >-pu6;|w6_->~B5$H4BA=#5V_{- cYz)sG?ڕM=Ctu$ +D)T-7R". fhݐO[]$Ҥ|$3kBxJdU\y16|KԖ!} jEoa㉶uCBT+ٔgZJCjk^,(oe]/U;qmR뺉]p- k\,y匇aw)%|J]wЛumR)C\[}g6|M NWݱA ׮V_^ 9q>K3/R.OW Ψz}0Ӛ/Qal"]!:z8M)dXw ԼD8c ( lLo_op律 S›307(TSHR>o9tj[Zog}}=xeC'rABA/x,8yh< ^xݞm\y]X8[n_>c{9hCύ%dᕳ88Qx=;ty8]ٙM=9\dZ9Z[[4\.9=sRXX,8Re(K֢l{{v6ޜǮT1+ MxEn4n.)wdJ["x@"> YD#ɪstg} "a#;{ua:uRf"%(bHreKYWwLǛU*h0b6(SR⬔,hdNy*WIBM?;R)iY&IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_sort_descending_24.png0000644000000000000000000000056311272037113026333 0ustar rootrootPNG  IHDRw=bKGD(IDATxc`#zc&# 9?.uLt ɤ,t?{Τ*Bx}l D[fFxәeHp'Y_1f&~#T @t##1.eLnLcxu #^> uj B<g0[8!b?߿202\l8fYUHFF6VKLi#B o/Z`HQ ەIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_align_left_24.png0000644000000000000000000000103211272037112025254 0ustar rootrootPNG  IHDRw=bKGDIDATxڭ͊A4&[  Y)*.2¿,j[zle7hAE{.n4_" <,ZCD2p`\l6MऔB)ua#zbr9Dtaf)"Za?(21̢Z@4c'םN'8Yf(iJTMӌe("A" -Z+ &I$IuvA" lƲ{?+J q{zDض})1b1FD9$`߳nr|>0[(pqQ  ץ?@k撢V+YAx縮KPkf3pZ(_ {kUׅ /uoxY(y\7 WB+㜲ڔzB8;IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_fullscreen_24.png0000644000000000000000000000124211272037112025315 0ustar rootrootPNG  IHDRw=bKGDWIDATxڵ;kAk2 ]ڐ1.SSe ,@B~D¸XM:ٸ)$Hip#%\(ذR+#4]ieDp̹sϞy&&N/D|>L;V/$๮Rϊlnn 4 v1`R'áxI|G'GdᷨOMX>B NRB)%aU5c8 l`ww7)%(0M3FcYKnfRY f9to?z}" ?~+ɤ >g4f<#g8Fpi"x"EF3vvv(x뺸y\^^deQVST,A0T*Q.Ukiz,,x4(:^y1;vvW?IEZ4p= 0 RZ-lێhzRJPJNh4r! 4M(aT*5Gӣ,:)kLJd]EΟ ~;I!IѾo4Vo[@GWW[H,`_iU*o-S}IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_cancel_20.png0000644000000000000000000000070611272037112024400 0ustar rootrootPNG  IHDR bKGDiBըIDATx=0_q2ݑܼw q+[@Llt 4Hi\%WOmqM3d'8{i1uQbXnѶ HХW>J= V8r JFk\@-6WkU3Ljjvpyk@Dh];R a^`>蓀d-|.Zfm؅EzTXtSoftwarexsPMLOMLLV033Q7070TH.,.t(-H,L/J|jx3zTXtSignaturex3HL1643H233J43JK447H57J66H42H$Q;IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_exec_24.png0000644000000000000000000000210611272037112024077 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  ~tIME 7 iIDATxڥ]lSe]׭&S3$&F(A"e b+;cfh"7. !~ě%#f)q8m̪[mn9]onk⛼zy2vn5}@y JgE@:erYI$8E'u@ RTP] |$j| n*ݠƒ1J%WuUKuu5/]O?7!eZ\ (cwWTdѨV._0U$>#`Ռ\;oM6 9+dvUVk=ᡨ,$0'PvԐDQVNٹNtsS'gggp:K5Ԁg~`r4 L/B2GQ5@P!h-niRsZ  1>~pGM?5ݸ MJYacpY}@,սY@j!?bĆGyn ~^=GHV.MzUSgV /yuw?r32ghh~hnX)>9zOly73=5Iۯ"9yG8#ivN`[_Q\2zDbU/$pRfzP)?͟p]F$ˉ/'&h ,=Ձbj6\mۧ]yWt4B j '=_1цKc V}EJԒpYYbpkCXanubxKj2*g>{'jŽlԝUŷB4-A?{-_akhtLv<# ;N0W=H_KYvOɗR T\E}!FΞ0HM^d,mQ[]})J(sin{EIRRHHYRDD e\Ll)QN?`;gLԥKXd u_lu>Xi7H)I4lE@SSE9 \<3zr=!/.wNnWԊSJ @LN~&u'466ko.5ٻ$RiHa)..RԝTUUKcc#:8k 0 I@\"tIZZڬ!ڴi{&gi)555p7b!d.7?I0h+mB| ݥH  DihhoZh>&P(Dii)ՑPI)q}_1 $())aۮcdg%xx "0YR DXHa NNaX>g1ޜrͻ<8lSLqj2DH$C7Nh8HK -+!BXH!-ϼH_XyUhʚ\ %hœ8N<^_2cQC"ok.bz*GY RDxxݶ>>!CC(X- ,|.{@)Hq 2M22Cni2l)$X)eBeqɛö-D ­3.n…1[bhh4EYd`qK*T(1sپCU2,`0H?u\NAĈIŁ0㘺DJÙ\rMe H4Gobny^4ߞ&)Of @ IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_home_24.png0000644000000000000000000000156211272037112024110 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  d_tIME 2IDATx͕KQ?͌`/6!:|o̕ %UvѕMQ?@ ̤ $$/ꢂ@DHBTe–V`tm{9y}fbelY,炢2IzΟ].,c0p:C&9wBaa!vzL&dI v;Ѐ,XV:::d2 I |UUq:nEl6S\\ UUU1_p8˅bAUU4Mx<1i!9zd٨vcXZZB4VVVR[[[cxx@ i/Zi~hB # &@ AWWFqʨI388ېaaWP($&hI FIR;ZPYYD"z_E333;|nbmB, VQ\Tl'?+1<H:s=G$I|{t'\ 0::PZZ>1}tNܻpVHjCCC1Q2q~NqyrMIJM6uo[n@F0c;0אָ$^f۽loEd~nv>gy-%3ݥHM(Ӧ4"@x'd~~8diB"6IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_leave_fullscreen_24.png0000644000000000000000000000100711272037112026470 0ustar rootrootPNG  IHDRw=bKGD pHYs  tIME/#_5tEXtComment(c) 2004 Jakub Steiner Created with The GIMPًoSIDATx?J@!A A H,<pmK,+)%3a,YcLD-aoރ2nR퐟"ZFO#ݎ[h~T74+7W nDM]B>mI! ER )%RJR$IB# 1-T`% \N)p~yɰr$2R[Q%_$yijgv^Tϓ!k(M?׶!Ó6/P㉳F!\Ǿ0IrG/m3`3c Eנmc IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_text_bold_24.png0000644000000000000000000000134211272037113025141 0ustar rootrootPNG  IHDRw=bKGDIDATxڭOK`i͞jE*,xY(G=U~~=q D "**RfB4I&Mm30$< @ x( sww%+L>}ߧZ 4@L4:Φ233DbP٦R%zR0??lY*X $qq]׉KT>qj/A2"BxN<QJpmmh;&bpzzudX(( ꊓ 1> YA VEٌ \%h4])nnnm|`zz[4M+BMցˡ):88yTU%NuXE,˒'jblnnNܶqq]W<ϓN~m[ 0BdR# r`{{fI²,lۦX,F}gooo-v-iJѐŲ,m[8#٬HەPz(<-͉u2z1Ph<UU:ggg?Ho8E3Q>S(TK4G , x xJ/)>WslmIIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_no_20.png0000644000000000000000000000151711272037113023571 0ustar rootrootPNG  IHDR gAMA1_IDATx͔oUc;v$YkoVf0:%PiJ8  m6>{koSZY)L*qr(@a+⥙20G?>^&]߸B 7=C$[.c{h҄XJ2'J>V)NU=a.ZJ$ "I!dUYs>*mF6ɠO#xx0DFF"1OU&5HOk.n'.aMH)Z#SM(MWO7eqBu)5(I: H!~%G$IB4y&?6{R02F!? #8IڀQZ^%;Uޝc"o^͠e?Q+E qqWC>s_;'Ҽ0ƅX-qLtMQ;U%S> Zd-KDJ)惶).k`/l|BmbS&n~m޹pN6k /7(x^WMq E~|ˍ;|3ۿK1F-@6{νqJvDڎ$EGggS~ei`-rug*;t2"sTgOpfPD%⡥+@BCzZbjWid:$l?rB@0*uxkx-eK}Ʀi  G~fUϾ<dskX `Tx`J)$C#]C3}@|n70z'Wzt]7pɃRnKQ4e]ؗp2:`rtqz蚶'qBo^Or+=4nh :6 ̤bƫdPGϼ<o^,J,EH'*I k-MWV{wc-X@Y5[ RcRz O`wv6;̃T*u>bM0H`۴plUw9[&Wρ1O<lݴm@^=yd(tdڎ.¶JbX(\' w΃Z޻m6=uo^zd  a ݳ+a!Usx cwcIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_spellcheck_24.png0000644000000000000000000000133511272037113025274 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  ~tIME  _ZIDATxkSA&6P Js-HEGZhѭ#i1;Qi!v"!Jckqs&ý1ځ=9s2ws,+tpP l 8% @;vͰ?Fa>'ߤ0+|2>lYC1`IvYY~^f#AnEXDk+ u~"v״D,{LlMIUa[~NCRF;E"a(.d(Idfx\@;Gg@ ۍwI5xDTGZp=S*'HǼ޻~ % 3i_ Pouf!@e*9~F𥠆_ fdOa:X^x)T6_d*V:ן{G7oIk'c[r+Qd>>S[\ihD:3 M<ٷ woMtN:k>y/6Lg32gӷ(rm3VIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_media_forward_24.png0000644000000000000000000000074011272037112025760 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs  d_tIME5d ]IDATx.Q|LkZ?jMZ7²[Q a%a2Ea:gtg7LN|{9?#H';@ ʨqaKgfXcLAOy&}&4Οl0cn`9:aTnRLAj cM54 Ÿ6 eksM lnm['5U=)pǻHAfd?3OeHO~CMIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_down_arrow_24.png0000644000000000000000000000111511272037112025333 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  d_tIME IDATxOk@o&A~mc%C{z+X&x(ăAUAZKKnO=,t&3;^&KHcvPO dϓ? =N 1:w|'I67'1bS|nvF@ TDt! ?Ŀ0'8DDxMd"@XQ8nڲa9"޺lP˫7yk% 5DX^x';` K3w$MD$bXaKET4Y}h?^xʧItBf,vr/ @ Į{XZØP:#/-\ȋ|l3Bi{eoq\{|9q{CflqLWoHJB7uWIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_media_next_24.png0000644000000000000000000000077611272037112025303 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs  ~tIME!3{IDATx1OQy]7X,&l!kХЍZjDkh $;LƂ`kk(gkdf$Ӽ9;}p I ~; <S@[BTNJ `w~a@)]9Gݮc67J!ii=yn49W "(s>~k6PAUQQr 0iC jVW`}98/d5@Qkyl\BDQvK㘇#`#^=*B=baq)~ecӴ0@ALTh6x{]~9lvuQamǜzl"u'0g_}b?u/ IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_undelete_24.png0000644000000000000000000000271311272037113024765 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  d_tIME'mHIDATxyhTWo%dsf3Ƙj,&NB֪`l* ں?6JEB TZ J*K\Z0U(jtb2I&&2yC'F[<{9|^ o+r Pp8E{{hll/^uuu:!;P򪤳= Ξ.N.W{DWgՄM\8\,^X0jhE;ojBQdZ[4\Iz7nq⒉,^'OAլC:;Yv3@pEˁl޴45^]nAK Y&O*aٲ)++§ )CM&ӆw9{b/_mGJƸ(A(@^`re1EUPU= QM}n]TsCpq\䣚ޚ6)S(rhO/9V0"ǣե lQey8u|/wiVO.V~qys]AU 4b~ $23D"14Mi Urgu" EC ,Ig3g -D@k=VpP8v,f֐jŔ`7qb\S?.O=>Ȓ,8tt7h-caDZ0)zmcϮL&?JjX,W!hj~ĩ>܃!߸mla.Nl9YiMX:MHO߿7).~-Ayn\QrŒ"*К7 lb„BQV6^̜9Y B ?;#N7ve,r3nh=6ҟs-Y 0{NFSQ$==Sr2&x\H/83fhlc{O&N,nAd$ ,T ÎŒ͖=ē2((X/篛볔gڴ 22ζ0vl>IIfd'm0SE"`$IB$vƂk; ]l6#>x? ĩ$Izu:r*f ]9@ЙP4  hbIc` dd2 2BD7 Hx|UL&f`6/so4&fxr `ݮ]Ţܹs`O ( /(xnz @$H< 8`G8h<^o7^ bTJCh5R TJ/Jbmm !N2ɜ{33 lr3ְ{/kkgH&gH$LLNۣ&&&+WlP@ ޽!\wC2b1^xa@6]5@ MDES's"Z0-dzeSm47!NǏ?ZYKa2ͳᏫS? r;.D J X%3]?  ]yrD~Νd"R Q(s:@$2HMM )= 2*\DJ?~`p'Xv߿@a J0߹#/-ɤ>QF-//=Q|p].Tm+l[cޖbgpTmmVKT3HLyL&gFO߲KU.\( 4{Ã܏ >q|6k%u}W潡{tުi E_.~ IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_jump_to_24.png0000644000000000000000000000211111272037112024624 0ustar rootrootPNG  IHDRw=gAMA abKGD z pHYs )ItIME  #zIDATxKhu?l$yhBIR,}`6z*V b)iA|""jڢz0@"=<ꡩiݦyovٝCf¦M~)=٠'Ze=D[VQw˄R9 cs,g΄e"k+ID79;Mۧ˽P8&ˡK{8ĔõTWp:43vT~WZeJL](F{fzrgE3@fgr*OqK<0 8Fsqyl--OJ9T~)kֆڮ9m6 d7'ƱF]RD?;NT$C`*\":tbgA ,g°t G? ڳMqBai`p7~kq]a2r3V*[?և,x4IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_refresh_24.png0000644000000000000000000000216211272037113024614 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs )ItIME 7P}IDATxڭH]e?{ν]Vm#6 `Z(0XQUVk)MiKJ]NW?|8h텗y|>}Wy(!@$Q x޸ORx%$zjs |@ — Qyц?6-r6Q\f?R\TB /7}b$xqw*.VJB+M5% 8U_lgd8=],*`p QhPZc*gFzxlHLaSyu@ p3;ݽ ev!  Ҋ!5z` 0-^>ЖxÉ>@㕏R\փ 9 `{K~0#l  S)2 dܰS$g⛚ eo4Oc@X*nUi60V\MgW'cI(mR#\*>u #> l\8J`=O<q p܂ƏFbD#Ql@DRR)ҩf[n% GesR]Ii,!cgɐN;D,yTl{Kͻ_s%;\!/YA:=Hrxr( C=dfg9"|r Bmy(c0!/DSt揮A+پj>4>S`@z/Z6Jk<8i{rp/{"k-1Ē V% ,Kh$쫥(iz S`]ۗ;7oň{IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_dialog_warning_48.png0000644000000000000000000000431211272037112026146 0ustar rootrootPNG  IHDR00WbKGDIDATx{W?. [X Ei*HK#&ElJFc#hLFG(j)j-+/AX](>fgv޿73;3+TIn~{{=;|(4ik=o |t֣H2pi1Vb'SNu,ߌi(8?//V0~N>..kK~dmd]HE )%"i,)n^?$TȾm[r8$P.B^Kc8np%ٞ@xf9aRGiN }#Ԩ0H[0}p9.j7n`CtLGTF!\AHLX5b I+qvNA|i!Of:" f%Xne"1M(\o;U*k)6ncaq9ԭ|݆b&Z_bUY_g_k]<:SQNGɲYQaFSS]# 6c֯Α3!BO )sP_W Dirh6@B Q95W/@kGm!UDR";g=cq=}AoΟLAN)E2LCcd/Vtr 4mM<dh{{7J"?V &:-Z}0عN~otz_ePsWVI|vy#įRNd&`u&|~JV)ow> 9tx,KGAZ,jQ-=ǥa꣗]5 Ze[A+>S]9_D?s9*t"MMۋhwk׵!R![15GjAV*|VX_@΀܉ UZ:ip/g8ޕUN ]ih=WO7d}Ϋ!OA:RzYL摮>Q%)@Pә/OlZk.{xhm-!ܿ($g0݋t8;W/kA&)g\_SY @ijN Q!WW*ĸVڥu5@Řι&X,t:Y|$S38ӓlƲ.ñ4%7.|9abnide. W{WN\ѧޢ7@8U6!!ʇװWњfbJcu Wz_;&H\ìk!"r,p͜VQE.%[+'-*F#1H:*s,η*sb7:X2zd6UG}tgqx\ZGJI*--KB \U0jRVmU&s X̞gJ]Eix%Ns .S㏝K*@L>ETq`3\'>O mAv8]Y胖; l@Z.EPVpQ!X[n0p8nf3d# HdªFfT`*gjn-&s*'QC6"1`HI[D:nO2۲W8Lx,L 2q>ycv2.m3u^5Tp)iPc6}XKWH83Q*3ŭ8W߰lcF2*W 6m2h)U8pN[Rc< ?-%5$o<;"VIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_new_24.png0000644000000000000000000000136511272037113023753 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs )ItIME 58|rIDATxڽnA{! KHAI(RPHHpD$mr .N@bI|,;m驎F#]г3=88P2кQGq*^G$ ,qSD(,ަ:D+y"n漺A!MS9<<;n\ߎpH s8::x+'[Pş͘DxBeb{ <^38g LiC'\^^2蟟s킓O }5CB"ȠRDVmvvvs, jqI􈥽NV| lۖ6b^ @`cg͞ywWAy1Xz%epr 9#{ %ݽ":;:^:h3)`R L6S7';vXh%ow"l(iO^#_011ȟ:~s(q˓KX~7~cs|-yEm%%%n&D"M;7lLX1sޮ8jzJOρt›Jj`C^Uu|巧&8s 7Ey-{f_0k [Ȥ!xlhX7C\133 Q]!lŝ;sZԄ ?_Y  RxmmkW_VH$R8)=- gYf}c֭wdSR9,-e3ӷ?KODlt۪'l`PA(Gt(~aIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_print_error_24.png0000644000000000000000000000215211272037113025522 0ustar rootrootPNG  IHDRw=sBIT|d pHYs B(xtEXtSoftwarewww.inkscape.org<IDATHKLTW{gx V J&2"MMӘ&n1mL Mݴ55]k\TI5QĢ q4ZsbǔMsϹW1be{թc@{ԤD+8_~MϛXJ98vnpXܽk޵]wf<DfvY*{C7qAb*^UB̉0WX}ؾt48KV <Z33;bDD,$-+_GRxA@)ϭٴ ǒ$`[ēO<Lp*+Z1 y }%\_N;557TWWmq= \F /Bf&g.#Zps~\ ڵ{W[uUQsK6$cFȋFytfL~/<~ge $x ~ETRe`N^IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_align_center_24.png0000644000000000000000000000102011272037112025577 0ustar rootrootPNG  IHDRw=bKGDIDATxڭϊ@QDt^e`a^acoYš&A=VKOZX.Dt:_Ns)Lxygv;QI4vi$$aLS*ʎ F#|'|։f3!_`PnkxJ"pT!#HݩXe\4KdLaR zWySIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_font_24.png0000644000000000000000000000135011272037112024121 0ustar rootrootPNG  IHDRw=bKGDIDATxڭOKaﻛ&d(B!~POa "A[@,|B[777_CB n?&b6M4AO"|~I)pvv2h)|WN~{/;ӕR:LKvww br9bh |T) 8<7<ȝ $I٬SoJYa)t͢o4 |>ߋf;aB|Ý$sЬ-Z_joE:P%xm8%IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_save_24.png0000644000000000000000000000200311272037113024106 0ustar rootrootPNG  IHDRw=gAMA abKGDV pHYs )ItIME  5 ?5IDATxڽKhU7MD H7%U| Z E)ⶊˆ(Fwݻ* R Z {93.#M4Ù9?93?3% <W~gKy1 aƇn<*3|?ξ>0D X;שּׂ@)JH*`3nOذc\:ז&+z"+A^hBguhn4+x*Dy/O):0P<'1 6\yf$rjq҃mQDnn8 |$@Cj1;;{`zvn!E zQUT$xP8ʣ>909%Ar[cl7@8?IUAÐhv4SQ`wQ5^#QT7䓌Z0CfGKat;[67HqtǹysǏ!Ѭ BēOQ,yX[mFQ?ʥO|Q2S gU=X*S{>X6YڣqdZubĠ̭յC!Nq,6W4gTkLNAX _Sy4#퓃L]+diBanX5I1g4B$qIJNE? gs/?\^{S RV%r6$qLƤF!a?9,Ɂ2094 NjpԗЙRIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_media_pause_24.png0000644000000000000000000000055711272037113025440 0ustar rootrootPNG  IHDRw=gAMA abKGDV pHYs  ~tIME4 TJIDATx1n1EwưWV H&G.7KOi#;_~S|ϗlCK@ 3nf_ι"wN (M `^=fix!^KCOby65U!0jxmӄ&*f`xmlE_Du=EEe=T"ۙ%@D%z.58a>/qݯJfr _IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_undo_24.png0000644000000000000000000000136211272037113024124 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs @StIME  (}oIDATxڵkSQ?%y6ZERkjupPlqp TT("Cps절j\UihKjm~%6/)><={\ϟQYߣc*1=:9Lٛe@^ ,gF~V2:Ok[ \ځu K;ZHħHCA`HY _Z|%#?uFC!, K#ghPCD_}v ) YqIA\fc? pNH ]2Z`JBk6dzGO9=ߢp8_ tJD(MS+HK$M Ym?\:y-Mb&0MK^ۜ0ʍ]:ё>`/pP!5 pr@ 4- "֖fO~+h4MKAl^R!V&?}).@x˒<:ϯ^,gMrD0?p~nߍsrf6ԝqubv?p.E'$X˛GP)7|kxϻoTA{|IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_remove_24.png0000644000000000000000000000044311272037113024453 0ustar rootrootPNG  IHDRw=bKGDIDATxӽJAgE4V"ށ`z -,EAB64B663I3 oL3wW,kk㹇 vQ*`:Ѻw.OB]6v G_i m_+tSޕ8[уK}hzPf۶ uhSu B_4~_|bJg`9ɬ KnIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_search_replace_24.png0000644000000000000000000000244411272037113026121 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs @StIME 0IDATxڽ[lTE9g/=l/["4rQl Ɛ(i7 && Mi1DP B4BZҀP \[wgƇۈ8<<pݯ:bF2T]]]jժU m46mHf<hxKK ˖- 'GNEj8rRJ$Ilۦz8=zT͘ڸ}ux^54lTUUUSSJ$yqRJyxG)m1˗/`2iIYY֬yDpPSSCcc#^1K)ii+28rq fZٷY=Fcض=}K3Z 4E@48_0\Fc͛7YxݿuǸr*zWH]K!}1`(/)%H?.yI)LDJ7eee,^tӤNyg$oBtp 3  'r9aʔPH^a 7:=wh3gN6l`ikkv |4q:RJE% ]C_ YE@)4MsyARCH!Q(,"P\\8?Lg6Cg펲sO~ ڳdJ)֭[@^)J)7N( ûg%w^e3K=Yiڱn]]UUOb&- )%a`Y=Di7g߱ q̢0FWݦM(--mYA~?^'s]wQT\JLn꾽ˮl`$d5TR n7"1 c DKx`}+!'DQQ۶1ͱ])qH ymǍk!ЀHSV0u'MQ8 b\^dMeYhH!@$8pϷ~a 0P04 5?"}ZR躎x,u6璟mp*%'Qoo/vpluil~?|^,BB!@J5p:>KCC!@3aR 40 $@阰 /D ޞ~ MBIw-7IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_print_24.png0000644000000000000000000000205711272037113024315 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  d_tIME  :IDATxŖKcW+~YђhZVqȦ)BwBAqP0`R S )JG[+. " 5 ΌIޜsI3G˽y} SL9-8V.uU\Vu0/c%!U)(UB_.]J` TUz{{avv1^MjW@D3vYjdiZjn3$!n߾dkkk!`yy6|>_sGgY񏢺r[9t1iI,dMӈH$ĶmbHF ?PS5(J?fQR* m@p.``Y+++d20,.. b}}fU^t{{ÆSys8'Yv^#᭷༒zkQ(ԋFN7\{w j )$h ð.jMG)%2n{LouؾA(CW{wnRpt:M$& GGG\}Ll_q*(?zX5J" xё7DhNlpb E)E4W"RA3 1BrAӵGdAJ)t]GA0D J N+A\99c"?! P,B`Su8i膎(qr kߣB׸J+x<" , ϋ˲0 BbqD>m#ZA٧7^4-KRJ StMRq<&\&Ƙ$h|k Aʭ2ֶv.ۙ39>g\)&Fv>[]lj,.Sw׭ ZѴ !"UOd1!r=p pk~ QETQPF;T}Z/JѫgnשV"UeV 5?Η6>NC?Oh T7.v݋/1]C 5IJꗎO~ߤvꟈՖ0$nvq% Nyl0P~~slbs_8t.AH[ ǽ.I\=// x{׉0;OX6%i]\jLr %_U'Jka4M==d73J$j>՛L^;7#Gz^|9hUx7b V_c kDO2Į'.[L;(Y N[R  HJ7 Q=s5ړ6*O*w$w l`wһuw]}f$G+Nd'i̮e 9}0VQc\-FR ꖴU@ȸLFNc} j} 6p_/7bor 4ZkL&w}-Afck&PRCy;w2<<*Kl9x+si)ipWB lr\g2*"a+}Od: ,CSp6]ٍ(z_r"BezQTJI!'Zp%?GFiH+61-|A@R~-[ >^wTW[VRd-P%>Da;tG-tyn-/B"\%b@5F@Y`~f4䙻KVoOx`p&O/A,%5_eG@V#P~. x+=C/NڱeZh@l8LG .<[`Qtˁ׋ Ķյ(SVQ8*L1w/ Z,|t-cscE e @ L2.0p s!+lp=sX-]h wcؗRC2CwC -)BS6ޣ͉Ҭ)uhN5%H&&hj@@#Q8E6+ډD:%"> E^e2KIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_properties_24.png0000644000000000000000000000165711272037113025362 0ustar rootrootPNG  IHDRw=bKGDdIDATxڽAOWFa~bLTj i!*_,JtMTt 2"U,*!Θ`qql{YlEP4<=~߽3ϸ5_^ fʊs-)VRySVzqqу| `\P*fprrB2eBk}qV(xO'˱ `4Z }xx/^:^ d2B!_8rzzJRT*q eb5g0== `eZ/RH)b5Ij!RL|`ii 00 c_M:::qvvvdC.#8R*f:ONN0 4w~@P@yeD)u5@J黶m b:;-@cYB.7JK@Pi Rtww8^Z)1 5GGGm333C(u]) )ܸߺ$<~K m.L"D˲x_ D7i$߯fC54IS@>ﲱWC_oL&qh* ]]:tk^J355U39NJm)%|i7}'o[<| Vd|Ņ;/<)J R)t靎m7..BUZWn.'7ǽzva" DAŗB9`[Lژejz2kǴ $uo ~OLA ZaC4MľC!Gv)_OE'> P l|_~GkrpӪuIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_text_italic_24.png0000644000000000000000000000124411272037113025467 0ustar rootrootPNG  IHDRw=bKGDYIDATxڭjQVHZn B) >AC˸dS\č@!ne%K>Tf,H֌ݨ%0ý~\x\go{ pqssr1 !eYA0_Z-Zyn/ \xb|UU|rzj+U@yɫHp:\__#U$R\.G4t>䄝bjTy X=|>ߴv$),S<GGG!888Z.Ul6KR!M0 nkKNC:sxx8]4 `S[^/jBW0 2 pvib&vUUuݶn f7&T~O"X8ErK" ")%RJE!L"x>k u}ao@^Gߪ-͉O@ETKIXH+c?lR,ʀ58Kkx < `՘Li ܋OӔ,ݢ_BIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_help_24.png0000644000000000000000000000324311272037112024106 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs @StIME&:kkZ IDATx}ylsw׵NJ}ԄV@X!J%ԨIS(MC B!Su IjڄPBmdׅ>8|{ȭP_W<=3#qR{{vdj:upp!*WtZ$(<,^"dYN߹n]0a`x x`֮nWiiH2SHE<ZtVhgD44#?xA /oε@!p ؝}  {?=‡;=+H%u 4-̌"$5.7Q]kn^SؐP:zos5ET^Gv-DD26(HOn B2i~:2&eYq 8m]VuPjӡcIg~pYB>C~pyNYb[P g5w|DH_FbbpSlehp ࿺PS[Zm򊃷9`<[]#s]Ls!cFv+]{DY뷡.DU`#eY1-뇶tr׮ 3mԆZ|u"(XCu"£"nzALƉ[`>"x;h<2:6ve˖-"H˚pQ,W`yC=ʓS>S%1QdEQ0V  iى='ocYLD7t^" (2iH,8*EYigN[UUI:bNqixx$+ Ñ[P%% )*Zlx1pԖֆ#ȲL&c 8'Ova{:Jee兾>$$ 󕲣۪Ǐ+|`CuUX JKij#\Y^| =FUT]N #m&jme9 |≝il#NiC7 @Fj{`ۭ_}}ljnw"RAZ[os8`ѣ%ey ڶE+V#p Of~f$@mZ<r55/ÅX=$?y{' %c;\,[d z.;6\\OБ$ SvD1[l_`?sc #-]jд0x)Ǹh)W<.i$K6^ c{@,P5?1\R%x4V"b1 @Ӣȯs3L d3sfvIB~)^3`cv??cPnX _?x6&f.E;s69tTٸu yflvY"`~dEڠya8{V.$7IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_print_preview_24.png0000644000000000000000000000221511272037113026052 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  d_tIME  YED IDATxŖmh[u&͒&iM;[vF]uZF`Ia 29!_ė`8q +v JHP6d[{_^?]ޔr<yx'f 0o7@d^7"0M4 I|" >P__(~f%" l@tttiUUU477s***& qQ7:a'̺S$9̆Z/gYft% :;;&`Xz283ǎo+Q 05"g?$MMMƞ=lRKYcٺzz4 MӲeR>xcbbnٰa >#?(*RRRJxYs'#dOŋEel,,(ʵz!"Hp8 [o|d-SB;'{OޑFX,l b-$e7(_gA%/6Y5 ^eL$ ~ISS=>=^/^ʦM1Ͽh%PۃsC<߲Nj)*7`/o9sG֯O>O?BENukV7ή]8}4M;Zض9JK|: _LW_{DIQn #C*BS3i@H3<'H$}j-!9ua33ӈH2S`}D8.Fϻ py($#jIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_text_underline_24.png0000644000000000000000000000134711272037113026213 0ustar rootrootPNG  IHDRw=bKGDIDATxڭMKQNnl.\b .\(NYE)[\-:ąnD BW E53qI˜Ɉp; ˀx!|^,|SU($IJn~ \. 0s ÐL&+Ȳ{! r9VEO(idYfff( Ǧ[$WWWQIrnWD  aݵnaHXddd~3M+++]M!J~qzzJTbbb'L 4טeYXmĪ虢j>q,lnnR;H%pkk ݖmb8Z ]ׅb||\J"lZMߋz.K)y}_A 0lu[:Inj PA Le'UE˲byJs#Ͷϋ <#Jv^9 h(=gr |T1)o-9|RA!<hRĞVU՟IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_sort_ascending_24.png0000644000000000000000000000054111272037113026157 0ustar rootrootPNG  IHDRw=bKGDIDATxc`#2HGM.K }5y뷏Xp)R 01dd8-`&8ʂg$3*1&PXI3z3 ?rYAwɛoэZD5u c`feca3VgicPR4-M ec`ޛ >Bw-#\?o׬6Nx# ZB3Ñ pJ!.)Oۃ X_X$lIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_top_24.png0000644000000000000000000000067711272037113023771 0ustar rootrootPNG  IHDRw=bKGDCtIDATxՔJ@ B] څ}ݸt% /ѵ+ąECl.iKlӴIЪ֢Llf w\`ރlښR8>TKTk ^gnzݏGF`rEn2zOnn8Ӣ4] ?ϐ/쀥PG-ll. "f!T**4lj4fV`X,NJBh^נu8ۀ{XByeQHv[f,D @i4<<f!qu~Ty*9yy 9<IdQ{ȏM ?1*\H)=5@J**oCM2I@;4?Tg3+,IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_cdrom_24.png0000644000000000000000000000273211272037112024264 0ustar rootrootPNG  IHDRw=bKGDIDATxڭ]lTs/lӖ()]9t&HJP"RԦ1*tF\pQ@h՟VE$ jD 8ű -`5aomws¬8m.P_Hs||ӵe˖k7nLkkk޶mѣG(L&+3:2jrϙ9s?Z(xb?Z[[/m=tj7JyDP$55|9]f_uo;pg1O.ou> h)0J3)V^;>`ՍO.ZA{{ŖUɗ^ƛo1y.Nh]=H6 JӅ""$ns5UƘt'Vpرdwwߥ~ 7':3Sf<!RP*c,8|[8'N$|==H l1nʵͬh*jX d& =@[ ! r$mq?x~7ز iLea'XYV8uԷ?6m{u_؅@J1>%X(,|}2F)įr&~µ+ަ^nP1߶FJ,7L6y . ~Y#zzzny"A,$RRfLұ l+9~hAbO+NXԯS7`C32v k~B&:tG }u% 6d*D޽{UWךU u*IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_zoom_1_24.png0000644000000000000000000000216311272037113024363 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  ~tIME +JrIDATxڵkTW?IL3 _hFE> ¸FȦۅ 0vV A/A&y. IR.}ZL&- \)Q"0|‹/ʕ+'_~}Dzsq4Zk2EC166ۿtuueKCu㽽###wnnf5I.;933˥KW^:ijjt:M*"Jq1<ϳ^z?rϫ]aR)hnn&JH$bb1uuu$Iژfgg:uttd1bѼyƔJ%sEEQJR(fmm\p,--B`Mcccc-rf:td2I___NBA6%!@˗2 k pϞ=m\v46ӳc]Aww7J)&@)uD"ɶ ?ãGv1 @A<G)1!DueJ1(RE?{o]k)%RJr\nG0 B)X`~)!Zk1aHhQJ!aBkMA@XDk=\S"˲ B|>O{{{UBp=T*;o߾ɓ'ZcO{.mcYm#q&Jjׯ_gbbb&aY7߿N8Q;0<0}* ܾ} |*ֶbhjj*KWo齱$nbttT+`SB;eu;w3g ϟ?ٳgC !fWo>8@p]E`x@WeI@,,,X@d6>i.c{@t)X۔˧o޼\ו:qh!%@#/e##cIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_broken_image_24.png0000644000000000000000000000155111272037112025600 0ustar rootrootPNG  IHDRw=bKGDIDATxڽk\U?eޛ3#]>{B \.(ҪUĖ6l"&13s\/X-xr=?>_/%mO6 looϖ H7i~FB$MS8faa ςժ%g391YZkkk (I#VU> sevwvxxhffZƥQU&1f*\Bף^tXZZb}}P/Ijc{`f3f v{>27""=\y3rttDc;yW7.|S !"Dml,& ZsgHA`nh#!EH0s4'p8p s`qVsxv:un5 w EY"TVd͔4{fFE*sY>WYK_WIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_media_play_24.png0000644000000000000000000000057611272037113025271 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs  ~tIME!%9XxIDATxA.QzӼX !Lwp $CvBf9[W_UŘa6af͢IZ!fbbҍaý 1"4GmQD!* $Q`S,9Y5\v0 p뭷Vjc][h&!I(!H,+Y6^n _3<#<ǩjaH$r9|U0Fldg(H0=Qӈ| +ԽSa^z%^}U àݻwOTҥKJx%_ xK<`:npWXΤ.յT6 (rQ4,o>zi~aTU'#l@8r(&y` A@2;9Yvt}9ضMgg߯FFF>NZ*30\DWl+eEi:o8lٲd2+ @ggg@(T*m̢(8gp T7lkjeA鏆-.4;8jAUUxE0 LMM8$ejچBg>Bh)lðrk&LRfa:Bkuq QĺV׹曹{صk>r q]Ç36Uwݻٴi kweeL-aA:@iO;* ˆB}"tu>NX$022mtuueYu]qB~P5fKi` q=\ 9+dyRmlEarrcǎq)(Xӷ$;wQVpm uk~X 40Y}&Cgzz e@ @.駟f||˲ٳgg$A QմȨ:rB |!G.*9B m 3}$/_n2W9͑N$￟~}u]E.`TJ㦀 /nL<'.^&IW8Zѫ8uԪZX+/>}L&(R !Iw LIeK?Jz4 IgsJEI;N:8X UUE'N4#F&(IFn+c.'օDZ/!"-ZV펢$2mL[$UC^+]X,J:tu<6&~=j'a#]Yll\VkȢ@zvȎ D573 Ia:;;ٹs'`hhs]I"c(>I>ճҋ}&`_Ib55?hxAe.gCCC  V%p`0B \GN,#>lpӳ8<ڮ85kduB$! qCO@Z]yEQ$y( Rq)huNVp6ctZKa_U6?@7%kwm81;W,DYaK{g[3ڶ,* 4#O`0HC"iP1LUޞ]̪}ofll=i>oS疲w I\8{7&10ܵn!L299IP`hh}yfbXS[mmmȲE9jT\d}Ik@Ȩ?%8.oϗ+۶5B,S,y2n\khm۶;d``۷3<<"\JDT~]`PaXu69k8EIp dI}-& gרӆKnf"" }LӤVuVzzzY6#2~v}9!]՘,U86P}Pk['=)7ۣM\(Lq"mcY( X EQEH$B,ò,ƾOx)J8AQ_G'3%m?7L[kkFULi#t6Wvw<Fq萠xa"l޼`0$I,(B$Ae 9f^WEqjǨS1L.b>}T:̶K MxWFE8|:[(; tEBxC{PRtl>6(M^xDϥ2?khŹf{󹷁>_g}mh-(#/uĴ?x(vm&#J3hMvh}Dz)9`ucxK08bQ{o>s>|yZb}KO|+TeߦMz:h(+Nb653 EOgSgJ?w<A. hN/C`Afʵ%AYPрL@=yi/dL_/?Ѓs@)G%4$ڕҧ--k{BXP!PGMu˅u!WJMԟjst݅i*[Ư昵YtD^, DBaAFuͲ9>5V 沚1"]͟܈4WvN|$@ɟ#]dїײ)|nDz*-$DdHv[JFa|Q $rg+YUO*WZf%26E|IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_dnd_32.png0000644000000000000000000000217211272037112023722 0ustar rootrootPNG  IHDR szzbKGD/IDATxOW?m eo6DV/{h|U! MqᏘ W£F g1YK2c P+垳ŇJKMnm{sN΁<b .^ftzӧ|(Gqxt.l$?mb/^WKKKYl6K:FZ~f3x<>>)@wj+cShO(XeXPΪJ^iW5pv͕b@--n*ܬ M τdtd؜JD"{g5<2hho%[`5]W2$=bQ}FzM#SȜ ųo:o~Ȑo$ʀ#:4tu UUU21ёa9tT_.[M~!m-DXRsxoE ޾W/ۀR ?U]tŷn Y.% @)q):LƁWw3@崧MUN{hӂ+Y}?VIG^Ṭ:(ƀ;Z:ؠeTP/x+a7$>GT4☎ PQc:vXm\[N:?)h(;5ϩ;fK:5&&"LR:9ESUuqj+&pj4A|)?KF5IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_clear_24.png0000644000000000000000000000142711272037112024246 0ustar rootrootPNG  IHDRw=gAMA aIDATxݒMHTQ mi~O6:hP,EDdajaE9E`i"a@t"I}#b$YE=6u.νmזV8o-3 )) J J Emm*(vmņk!@X1-@zb7 IM Z6=y8WN{ UHNN@I)BCu) s)68m"cgho2uϛ e#&EFɺrR7 K0i-Hs9^JO+>^XfQ{z2]3µ"+/StN#xamLLN1*XXX$mSiS#il*"cR Q^KdQ X,hEq[f8<}FjcoYjڅ.Ƶi؄bv3ɉAHNz#3Yjݻfi׮j<arӐewΨ۷\ ğbp~tX+ \#'Qe``+g(շ Q] v3+rtc1Y̏;PQeIDT88Vc sլZE72fIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_connect_24.png0000644000000000000000000000112211272037112024601 0ustar rootrootPNG  IHDRw=bKGDIDATxMhSQPzVbt*AHPFp!EBԕEE\"5TX+D &A7O_sQ 5yVt\!!XBh-Bh+h;z w,z1_΁@Z;=}ۢ} <#Bʓǽm*Bh RhOO;1Vsî:;/#v./?*3N JUj>e?>rWQ/2;=s2_*Ys&Zx< <]q=REw RU _%#`b퐮+Ul(H29LScafor27;C.ZwvɎʨ_[}چJ-+R%H-k~CEm5hvB=HZ 5Y+,J(Q@T119XIl/ Yf`Sե:ef_6 /Vv=5["aS7vܦ-k`ch:@x"8J5ȗAkT3eہOBFG8*,@7o:W<ϲφ1n"#2 <ScIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_left_arrow_24.png0000644000000000000000000000110711272037112025317 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  d_tIME lyIDATx.,AU]Z X]٘x  biMIn2M,g 1L`L]fLwPI%ݧίΩ:D։ v`wv`7n@G;GyLĶЯMo*}ŚDieH RJDAZ}_ PJs~xuHWЅ"b#5Rku"mN'uc"3h4J*T2|(։5]\Zs ;uR c#R.gjӃ‡5%)Ex7WEyXt( Uf@9 O۴Rhx|x6;,M*!cO.^Zs$ir yƁZEDmuä2!KזaOo)IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_zoom_out_24.png0000644000000000000000000000206211272037113025030 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  ~tIME ԸIDATxڵKcWF4( n'nKuYd.fj0.J+hWҎA4~L!׍y8 s8>!Ng ˜i8mJ)#`ѣG`||[) OU$ ($ D"".766ZZZ~<`YxH$B,H$B("BDQ0?fwwW}i$@WWWu݁ jkkb$ @)%RJ"$N6LE@Pd2455C!grE:F4> h!y'eM!Rm*T[kk+P><< |.BPJ<v@)m8m۟eOa{ss3m#`zzگu98R 0m˲A)uT-aea&ezY60uݷRE2NTBO4MJ/i:*eY 588X˲mϢ +zy`ISJ7粻o^9~yJWWWye߹*\ !wvv>| [[[],׬8@ ~o]'⭔r^R,..0_\_' |ڍ!:zR-@|Q6$>lс˖|ȧ7 \MMM)M (>$fd2i?4&Pr XcIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_zoom_fit_24.png0000644000000000000000000000211611272037113025003 0ustar rootrootPNG  IHDRw=gAMA abKGD pHYs  ~tIME K<IDATxڵKI?]=bc`3[P@Wh%s<!C.'AM4UDDW4FߙǏwggh6Be{{{ӧ555S]]MMM w!QVVFYYض-߿2^|u4Mׯ_ca `zz ' <^z˗ 2hnnN988ȭ[F @4a_~Dx!t :El/LRWW۷e22Lxff[Ass3D۶1ۉFQApaqA Ui> +"0Z'O###anr9Ǚ+"-lmmzJKKq]7q,bss1>}$pyqbM!:;::hkkX\\X^o`uN L>|!@CC& gm+t:lzQe~MB Yǽ  RG7?r fŗIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_dialog_info_48.png0000644000000000000000000000553511272037112025444 0ustar rootrootPNG  IHDR00WbKGD IDATx͚yluμGR4)ы6,9*R-P*l,+i9AiQw Wiq Fn\^buE[ɒBUU17q7s9c#1e;lwhXaŠ ܆+\g-EX ( j:p5`fVX!Y mnݷ{w6omͺu;{mŤi >}C^W@@"'r`>~ "(*x8q_?s@qՒ2Сy__uNr/lWyUz"zy柿mRR*EJ(XkQD29``ͷnػNMMN w ؐ]ۻwߟ=~juQ[8΀fsUIhEv/j]~lo YJ*!sOlpSdž8QUS㜠\xQ+> ru߇ &! {ol۶ZxK~4rQ5(wr<Qjb^W=ΝQd(EU}edd]H=4jSBZ-Q[9^&50|^~."KI$E"f>go60f& I ϟ:y),)T{s-i;O/IB;uIf}o2c3;.ZRrQhx'UO*)w39~Ki\ {RiFhf ?^ eN@|駞{XeRMIq)mh;G4ɋlE,`EkG2F SXxӏ?4<2DI% #!E}T"Aw3f>0 C tN|hr!h#ǧ2QISng/`Ȫ`K7N ><4-GL/p_/g$S't{O ^p"Icyw3NUH6B*u6md]ЈwM ^-` hY"8w_|oZ&#gH}BwjD\2KJdR)”'#^s:"M`0XvE%^|޽ѯg7]`Q%(gM6ej<_k_3\@k_"q `HS%2-"ڈՍO9vy> _ ;r#uh\viō poB{&DYE}Xk R28CN%h"P kQ+bmȷSP~dL c $fvMl9&jtc_nyꗸ1f*$C\fc6h5W\m[zHq_*5Oyܰi ׾HC\B-?uxz_D+625z Q-|{V}VB$TkmZm*ӃLk j4fh* ı~ܹ]9z_jSu?VoE5Aõh FM'jKrʭL7mb'5  I;9O2:Qlʡ]/ PȵzWjҬѨMnHRG;qiAz$zM7_S`g] B2K8%*L a|L/i4?:rzSUQ٪#M*xTKP[W.~]~螮U+{pITk;VkmɊ<+@gM+`wq?l*^3::::ah-Q LB<7l_z8ccc9|8Yhf|<WadIit9\9䖿7Zyt9r7ˉ_mrYx/ڥ>1WIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_text_strikethrough_24.png0000644000000000000000000000140011272037113027116 0ustar rootrootPNG  IHDRw=bKGDIDATxڭKQNl Q.\J +;H-Z#n\qF!EY2d>L&c>:Yw;{. +'-(vX>66F7Ey};PSu];֨vM2 D"5*VUP{ ;h9HQ os6%LRV9>>~TCSЏ4MNNNdjjݑIНqX]]e}} P3>>2Lbɣ(BPꊍ TUeaat:M6q$ ۶1MJx +@rLT"J1==M؈Zkm|uP(J%\ɇ^XbaeYX);;;}__/hiiT*) abX%mmReffFT*q]W<ϓV%kZ-24M8#KV0dnnNΉ8#fS\ו[dqqQ|ߗv-!(fI/gNyugyh<蓼7yZ /#gr|Ɣ`8>SH ,hP*J, 7 mw~V-rPIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_media_previous_24.png0000644000000000000000000000107411272037113026172 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs  ~tIME; ¯lIDATx핱nPcF:VRROE KZZfDyb` PD1Ƈ!AŎc&=wc3r70ԀY1㏪jvݳY]yokcMd(9(*Ov ÐZN_p;+S\j ι\Ǐen/Xg3wwxfs`>(}E=`@b &&ׁ/~^PJ74\d9HsppH9zJD YApjSՍ4c9k7WՍm{j79`<ߛnY$4`X~fyIiTS"JU۲+nmGg> dM+PuUy{?&a)IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_undo_rtl_24.png0000644000000000000000000000131511272037113025003 0ustar rootrootPNG  IHDRw=bKGD pHYs AetIME #)ZIDATx=hSQ$mc)i֤RR\t"'G'dI&ş8 "mb1M9_{rsor;p{};G/w5 dL@c) t*{Vh!,}zS}!~!@)=f-ċjwŻ3ɤ$2?o#ڈ 1. X,T' 9,zO@' KfdtlW\eM\):y7IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_media_record_24.png0000644000000000000000000000163511272037113025577 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs  ~tIME &!J$q&IDATxk\U?ͼ&Ώ3I4q1D 4J.Tb AQ| ?Bp]*NŠWQAFI#CckGG_ڴ=r>s9b?dAl>@A9`xAf0</>vT#V++]F&>T* .eOhgg`x} Wʗkor9v;@65$N=f7=1H`>x>Cj|#to+S mmm}`;gcIGSL8Ij$uԨF Өf5Gf)^xTZ;/&) wo`& BAhDv4O"ύammmQRѲp㳃qba.A  Bx:2pG@.yXt~ `GBNBCn`A`,m_!aFPӿ[r @ٵ!Gc:&L~ݞ^M׈v*wkr -M<wB`dn2- ?3p @|cl:@B(D@dž~2As2< H凴|C7o B^u]"GMgff֏ q̀ zͧ2L>,reYo:]ZZ$@z'99ֻCYHKҪ* rGP(u]mllJKږEي/j!FIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_dnd_multiple_32.png0000644000000000000000000000230111272037112025627 0ustar rootrootPNG  IHDR szzbKGDvIDATxŗkSg?7 V]eŚ6a*0eM'/+ oWEAj",iMmihg眽Mn9ss5Y DUW}MOOH$-䪪Tb-j(͘D"*UcP(h>BGGGP(b380 U˲(rT9ղxW&ՠ;1]oaiiB! {epp @l5R)l&Nmc6"B2C&qb@ DU%xzZ9{,ccK& P, lۦ&(ΝcaaU.H\p6:;;rKp ``ii޳"ܥ{^zvǎ} p5UNcLE0mv(Tht}UeqqP(Dww7/^dbbDÇBDۀw(%@CfOi3_x}DLEweQUzzzAUxdUȑ#9sb*{S?xʸt;UinPU>؃:(39$T7՚<`ƍ?~BWNDݛDDhGv62t;͖mPU'*-M,C[[R~/_ 6sF(lhhl6 cӦM46bțܹ?ϧf2:%7nFbIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_print_warning_24.png0000644000000000000000000000211311272037113026033 0ustar rootrootPNG  IHDRw=sBIT|d pHYs B(xtEXtSoftwarewww.inkscape.org<IDATHoL[U G38A'AJD4jd&LF,YęE3bՄE#"*OC`_4&s0PvҾBR-s}wyRSL&=a)_+Bn1iy}%J%CF 0W P[l%P)eZ)%j\)S {)BJ c!%)ӗImWy@J-0@JջDHKXWTT @QZx$BhR)ׂRRJoH(s$V@]]e[.(G=DBy.gzC<_7uvv/斴to;wFxJD<-!`<_b`g7T[ۇs殮cf==]UYgzJx<+>08Lz`k4ax0eO'~M?t: @`Ѣ2=6)_2MMoFd1A -sbΏ _eR;q"?Ks-wB!r.AR1VޙЅgn7-Ə6@$wwϝ0Y@&ʢAZIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_edit_24.png0000644000000000000000000000210411272037112024076 0ustar rootrootPNG  IHDRw=bKGD pHYs  ~tIME  ^tEXtCommentCreated with The GIMPd%nIDATxڭ_hUwv64nڲ*'1UfmB^5E)F`|Ajq[ͣmĚ6i5*M(IH̽3;gڢ\ff9=?Аu?Ͻ2NWFFFnڎ@\.˿⺎#bQ KOOOl}IY[[ӧ󲼼,""SSS4؍ LOOEPJ!"Z8KT"J0008Ǟ؈/chy#2>>݌Fj!:)1%_p5KKEۥ9NOJsS1V*M!,*>7⵱LvhΟ  -1Q~vF> ! AY 1uD釨.M9y2pn /DJx<{v^Xe"oʧ} 8q9җCLhîݸ7sSw/0ܾu[w03aJsa*)FطW=F;Ci=SH!Ƙ&])qoי_e/d2<Ͳr';=t0P}Y>'&scBD]@kMHqmx^G}OIvvfIPJa)FkfggC`.?rsgFYNl;I[[D"R[{7$6DJE58'DkxhRB)mﰻ&R(@ "cQ28!&پeG "A$h#& j+xs{'[Õd<`XxX L IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_add_24.png0000644000000000000000000000105411272037112023704 0ustar rootrootPNG  IHDRw=bKGDIDATxՕNQ3RAD6X! \ "a.H$Ȓ° e*ۖně@pL99X6NOd"tB7v zۖy!Ab" XS@ 5aط( IBL#-uxRӖj5/7Ew HIYk?B*Ut` x,K\:G 7aHvzu' ;uQR\_S&%`1j.BU8< 9If`'CT\e:{@ðTP5``.TuZؤď5W]kN. 4Q5nZ8gvSS-;fz" u0 d; V4 <v=PB845PdE'[p?{IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_apply_20.png0000644000000000000000000000070411272037112024276 0ustar rootrootPNG  IHDR bKGDiBըIDATxc`DP1l =0)6S Wn_Aqjx5óIsŢWL/A7Bg1 ]@Ɗ%pCʼVMH a@@T!5_c#cM Ãkg0a!=x]:+;+a@ZYaC]G,ٚ7e(5 frTI EzTXtSoftwarexsPMLOMLLV033Q7070TH.,.t(-H,L/J|jx3zTXtSignaturex3O104K411HH2532H33N140NI6NKw/oAIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_disconnect_24.png0000644000000000000000000000110511272037112025302 0ustar rootrootPNG  IHDRw=bKGDIDATx픱kSQ/Ƣ ? TP%sNUp 8H PDP J MA(yCDPĘTikA|ssœ0Ozq:vJZӯa~fT*PJ%]os :^X\VfLMϟKU~E;u7К^kq痉MNQ]Z:@ G\C'&ƻz&h/vv~a=}A*0Q7_5v{wVtul~0=})Vq'g|k|9-Z:u F 9};Gޖ@o 8|\xLbV HSJQ"y[=<ԧ6ҷ?~ʗjVl !LCe3h6_@s/_ N4#BE0?`%16IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_network_24.png0000644000000000000000000000164611272037113024655 0ustar rootrootPNG  IHDRw=bKGD pHYs  ~tIME  -,_>tEXtCommentCreated with The GIMP (c) 2003 Jakub 'jimmac' Steiner'3XIDATxڵ=La ^dp) ``i\ $,dR RP$.RcrZ[>ס7ssy=Ū [MIsBᮮ.Z[[ihV`7oPHFG>'Cv(WF,P {&iDQfg>|z@śtS(%E$1 Xi'R 'I@W g/'X)Vf/immNVVyWl@D())y;44b2:TsR5}ڲYpjf&'XXX.e74\IRI1O4v(JF1Oqx^"~?#bHa04_*bTX&C׀$_̅q^`,9| 89Nw@ ΌL&rp||Vq 4Dscv*ty )j9r0RWW{5O 8NnA\.6ƻ(Fauu58P <{3Cs>QMl[ml>) UŅT~>" Y|zIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_color_picker_25.png0000644000000000000000000000040011272037112025622 0ustar rootrootPNG  IHDRcbKGD pHYs  ~tIME)0T2IDATxA01a<T`bԐ%K4%G"bN}Nkgk*Tmuxn @4[';h^U6(0iOȃx,Mn#gP $4œOG7ZIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_revert_24.png0000644000000000000000000000251011272037113024462 0ustar rootrootPNG  IHDRw=gAMA abKGDV pHYs )ItIME  +IDATxڵmhesngg縷rDsk"7$ZR>ؚD0aQPۇ"C,&fei褘3QwvA n_}]" HSjJ?ǦQ@T@NW[]&×ޗ\(&=/4཮M*G~܏5C8yzk`[ 䮨8]?~Kãwxe2VB}Hs3@Yi s+tӏWCL$!96.#N.z9wgcHBMV,>K:=+_59ۿ!ʡb)XdQ˖VAzz.cTOTcK#,y 4-БvTUE8VpTF9hvw;c煋-088i!rjv]'OSxyJi cAcc#qX.?C8FuezƦ4`,üռPKMM 7n$_OX,F$3%B%O =˗a U+ٹ(MMMx^|>'#I)_:ihhDu{KG"es4gnFjhʙٵgZ[[inn&4mV8u,Wb.zvTVV200@gg'ů)躞Aqq1mcA~ eL e`w˵>oz-zr( SKq~&^ۑ-IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_text_unindent_24.png0000644000000000000000000000112711272037113026046 0ustar rootrootPNG  IHDRw=bKGD IDATxڭϊA=q\LKt: `h4m\>l6{`pH8eQY,v;Q4MMnB`YZ|=; jvMӢw d۝-05Et:~.X)j "qJrcXřc/K~bS6N# ㏺cF*, H){Z?By|2__(c `)`Ws/γ- [8zeȁ.^=IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_colorselector_24.png0000644000000000000000000000206511272037112026036 0ustar rootrootPNG  IHDRw=bKGDIDATxڽ[hed74l. jMmR*6$^jL[VЂO*_DŠ+"{ЋiMn[ݝ&>s߹|g࿓&f(wFxʙ&͚> pM] ^9C+CSո"1;>~F.xjkJ{ȪeFt"r[J%`YXJŔ墿`r4IijxiBƿF rŜ ?&2eß0#H+ AoCl>Bi#$R8BB 㗗\ֺup~+nV4Qs pexxd2N}ۜk3ƦI_ri!S !Pf A{Zr$+X9GAP2|q,|`= xXŞemJg{RL^P[RO.`jQZAEqS׃$A9rS_[xLE =þ+rZeS@,8mT)i<ұ@0LS]5I0u MDáx(MS'9wnǴ,2$PdщI&}A27M"i#a5rzC1q:`Mk kV{H28Yflŗĺ8>ӑ0k>0ѴP滛‰cCtw?J(I4J…鰵r.ujIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_media_rewind_24.png0000644000000000000000000000071411272037113025606 0ustar rootrootPNG  IHDRw=gAMA abKGDC pHYs  ~tIME;nIIDATxԿNPs2HI11I[Yx E &FGp˜9ѥFű1vp$~ڴ4!to(t]#Qd7QAP3pvmc2b$TŽv ""UC +ҙ4"G#_:FuyF5U#4/.l?IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_stop_24.png0000644000000000000000000000254311272037113024146 0ustar rootrootPNG  IHDRw=bKGDIDATxڍ[lUE}vϥ^(X(\,FhVL%Q /j"yИ/hLx( +D4 QPZ.=Z=3ˇ[[NVg2̚_R y#s< 4&Tѓ &Tx.Z\c@W]7;z`N Sgߌ3+qw_ħg+Jujc|e{~]#6?LeS*Z!tBhba{]CEˣ@n||`Ը:ɷ.s ǦO`'?V#gyBQqyT_~0)| @)(lXOz0\fFo[.\ {trrT)кj颥@bFJ~fbxSٓ5fc5Ha_cs;uߜ uKG^\uBiiKw"h:^lo~v}{}+;֒jj᷃_bDqgX~KWB_/ (]O# 8ly}h+G%;Uǯ]=,yY̙@1C`#x(x >j+(Ş7_c]`mdOVʈH>hi 4^cc!0Zł?76]9iFN@T:}Tl88' ρ^2ue-k"{RqŒ պu:ݻ', .Z+g`@n Gv6LPzes}=d`P)QZr09r)Dq4f_[zo ;)I"B%# :Xo:˄R뮝6 '\ GtU:6"tg r J?@! 2' ]™.7<:/@"t " ®tYٱȏ:'Jxws ;-hE+KbP x8I? @0p8)ĕk+Д#hM"%G첶D2ֶǭšIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_directory_24.png0000644000000000000000000000206411272037112025162 0ustar rootrootPNG  IHDRw=bKGDIDATxݕoUUmy^Z,jMihDF>908r&*Fc!,CЦmoo{k{rp(8M%+g眕ouւ>exQWXE ᖲF?GΜbcvF~]'۷ R(δliyi>@ +/ v (k'?能J'y(<ޮ zJ=u;FQԪZK<$׏;Jk0 QJqx ˗/("6w6cۺgs~֚A NpNb-la)E&!ʄ~@To3<܎r`qa=|~L&KRA) klD-Cj6H+(O!a`eeut~~llTƱR(h'Iaie=@! ?] jȥ1F¶֙&1hm0C[/f"@R)ݹˏEڄ1nڐ):BwzM;gBsADZg?"% i.񽅟rclt\.홋P JetΡT},9W`EkC5iR,qsb0={:.iZ#I 8qx:s{X0ڀRIu{/7r'.XK1(q\qwe[[5Ju'0Tn$FP$GUXk[4%tN@cFT ?3;;aEY*iv "_Bk1qXֵ*Y2IRnrjVq7[0 8'{zz|uAl[% Fbc)QI)jwkٝٙnZx33?w5@,?`xbhhH.}8s8p/eHƨio[lN#s bi)Qiٹ:U E xRzV`zNYAK|>Fմ=PHE&RǺ_].]7j's~\e=-lHtx !p.C l&bN< p(פ%jU X]GU%z{א̒0ͿO{0,KU]*UY@e 2IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_text_indent_24.png0000644000000000000000000000110611272037113025500 0ustar rootrootPNG  IHDRw=bKGDIDATxڭϪP'm b.Pʍ"誻nv.!Dt"t).5$M&Ichnu`8g&3g^Jx<nL&߄i6bAut]AfT*#87 B(r#\q+9D˝GFe,^V%,ˉp#I aj`#D*JhPG*h6 /H׋UϸnG+0MT*EІ!FAJrfG.N<4M/h4Ye<;AAN[+V IJt:E4Wt: PiVdJ$ #{L&\k*bxf4 ۶CJ%gnY>_q'op3 l!i߀?Cv@^كeIݦl(`SX0|z9ȒK$g._O4Nwq6)x6N*f;*hxm2d2LLL0=5?$I(BWW7Ν% IR dY4 ,/#"ި@ٳQܹC:ˢ+u5Qe2|>=drq|>_qȣG&Hpp MQdEQ,PQ^=M300PN'߿_ BضM_]8FǁuMg~~`ek-_@{C8f@zWsVֻRhSX@pm^|;QkSrpIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_bottom_24.png0000644000000000000000000000073411272037112024464 0ustar rootrootPNG  IHDRw=bKGDCIDATxՔ.AfC-WKb# ;Yx#"YB$̴Mgk?kOMjUSuϹ{ͽ.FR-<%(UJ NjٵE@rT ~i 0*D*a50 SRK"k ?CPoPJմ@oy_c%yNVgnLaEubA&WyI~vҝw`nR\"l abv1"wvu$ س lmD cǵtOOE iu.r{ib?S^!in{}# Ɔ]L&t:NF!H0==M7}Ʋ/db:6@^)dhhjv;cz'-@q;H">),@DRBZZ"pU7v'p}krKU,( G"~ЊHJCqE=O2t|7!R fb+sO|sj㚫EH)Rb0ذ^jjj(XY@8[g z 1{3s"h\GNn.yyYe ??LxbSE\{#dj2T1b6Tr:1˘/0e[S+=G;ZJZ"KM[Ej6ܘ8A"#;G 2|ߵdd.,f(y^qKg8!+oa[G@r[JɆ=Xwvq;=ܺ9YY-ۚ|^92@"BQ "uK5DfZp~T҇%qIDATxڭ[he5d4[D))mAb|EX>%}1`+,=IDbmڤbڦRk]ldv.Ň$ x;1gnΙ,T @Lt}D jqˬݡe~v 0 <8U#N7:mcF{Q#Yda @֯Iضy5@(;5or77ƙ8L@ CH2A2;0}^dߑ!zs, .^:Q : 4D)AbXA;iVCpy5$/>ݸXN"%jY':@jq4 Y#εw K[[v&Hb]6}[Ԃ+)JUz&<8B 90S1` $MP@)E cY1&Xh%)JtttT]b~>C__inn&#\k466Sc6׵r3,|v:Vzspp*`Yccch Ðׯ׃_Y` D5RB@r92 qzVСCHQ2*Jeǎ)+3mXlNZEa:`"C(w)aIRc c㇒l:H*$㔃`EьB0~,l\[B4ZI ( =Qd햭ܵUdb81㛞qtJnQ ˜:M L9eupI%Ak)oxd*ޣx}x=:W`l#>)Ǡ1h` īzLIUg^[7J VT. q*BkV졕"$7 C$ ,wL26!ZYʆC?1bLKM=PRի&4--!H>Z+ $ ZWݵG~lKpjl{e+-f81Jc\p`BPȟV ]3]U_@ʚ%vuGw Uſ':\BlͦIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_up_arrow_24.png0000644000000000000000000000114511272037113025014 0ustar rootrootPNG  IHDRw=gAMA abKGD z pHYs  d_tIME !S IDATxMkQ{ӦV)Z *da qU ]K 4љ4Z|bd&u;g|ͽY.(pvQPx'l:[3ryWo~#yk ۭMBkiV^N 1 +$qD,AFr088ьV :;;ꢦE~~>Ifz~3= f࣡ }2a^n6UUU#-- 8q|YtyƔ1 יK<~3?#Id(\e2tr߷]ECC`PWO? n^ ')_y*4IAvV099i9璡fdYAUmFlrfHwU!_ f^Ed@zLz5- "scF!P8u>W?][lAC`kJbFCe  s/IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_dialog_authentication_48.png0000644000000000000000000000510511272037112027521 0ustar rootrootPNG  IHDR00WbKGD IDATx]]{sΝdƪ'#b@-KA/5ARZ| UCK?SE)5-MX$νZ}8^o&މ}=w bwsaNF_C=YORJI pMY'p=jq>oy9{'6;;ksss{ٛoi>9 XvyѠ x9w/̮]t:xQURJ)%RJt]x nπHt`;}{geΝxI)#)%T(ؽ{7ǏfF8~3|غu+^n ͱD4*9xTUU۷s.O.U;v:t^zw޹cǎ;?|㯼Jȑ#va;t落/ݻ x&`*m6|Vs?=z(333t]yWOs= ]u!1'[o(P}fgg1rw`f?sZm3^rWYXX`{)9ﯺ˯ʉ r-<,2ND7rf7p ǎo9ܻwzXUUl߾iv܉sW3:ϣ`]Otzqz[pX0Zsٳg-MOO333C# O8giطo_ ,e#S Jίsgyf( t:\s5-9hs f*GY[Mh {ꩧVUbrrr`r]DWdY*fFcyy05<| h= "(˒2:(Y[1f䋼mmm,13Kd~X:֛,ƈi"%ךVoFA/}vbN ]yu+/KHI8*zczݥRgo}`ٹS=}0%SHSc"AM1 =K}~74:>&$ӯy'Gge[Z_1S^N< ˠ }GS9jHDzHƥSH#kk X?ّUTdEC!.ZH u "1%$%L?.Νh3C-aIPi{MA:ŭzc*xw-OBL= MzQDmR"}um#n ImLQpb"mLy918-8x$ALA>˼. Ӷ`ѺAci!ʧ4&YDR$i"ֽy!Ķ} J$\nԘ jmJ/B;EQp(Cx:p^Zp-̀ӘyX2$^PHf{ bZTER#VkNH5]bMLo.+p!(UiU#~$V%5p2ѽXcAh|{ _Pu&0[I!HFN+d:*I<>hjpl~X76H u/CXG%bZX1QѶyk3S8D^=rs9Bȉ9 Hrt lh"ypvIŽ&h4C}ˁe>v恤/`-%+gi OtzQ]tY}n"Djib~ے8 fu;}ĠWK=Ư)G@`$|(S3`mvARL5w"| ƒ%$ՈFذ10420凥JXB]G B ڴ fX-}.9 NJ 3VJs=^6NPVBVi wѺ(]r+|*|DNHQQE1 Pņ9C] (gxic6Ju[}bHEb=$E#dșvnz4;!!M&Bܔ s|g u{/P$PNnھfeF*~!lԉ ڠKHD4)g@ p"%eYS2Ŗmԑ'OpL`4Kv#"B,$4J"FRP{lr`Qp&,%Pk5}y.S9oUp߭|ؗ>\KXNnggSOZ{h`[doFvY3m;uwK28gW? 2S-W/IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_open_24.png0000644000000000000000000000206411272037113024120 0ustar rootrootPNG  IHDRw=bKGDIDATxݕoUUmy^Z,jMihDF>908r&*Fc!,CЦmoo{k{rp(8M%+g眕ouւ>exQWXE ᖲF?GΜbcvF~]'۷ R(δliyi>@ +/ v (k'?能J'y(<ޮ zJ=u;FQԪZK<$׏;Jk0 QJqx ˗/("6w6cۺgs~֚A NpNb-la)E&!ʄ~@To3<܎r`qa=|~L&KRA) klD-Cj6H+(O!a`eeut~~llTƱR(h'Iaie=@! ?] jȥ1F¶֙&1hm0C[/f"@R)ݹˏEڄ1nڐ):BwzM;gBsADZg?"% i.񽅟rclt\.홋P JetΡT},9W`EkC5iR,qsb0={:.iZ#I 8qx:s{X0ڀRIu{/7r'.XK1(q\qwe[[5Ju'0Tn$FP$GUXk[4%tN@cFT ?3;;aEY*iv "_Bk1qXֵ*Y2IRnrjVq7[0 8'{zz|uA\?< , >ϮH;٥4>dfP|9'gNhu8h?{zQ$Xgf8,S1::vioO|u<nNl[ax4O^ 1ѩ8G>tw(l09#iwwi@[w+S7>`&Ӏa`3tad (`*u;>Ec46k +v1meN'߽eF`QZ[mk:`#P/5( SK5$ج%Y%|@he*q,$MiAk51ƊrO^U/~KIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_last_24.png0000644000000000000000000000072411272037112024122 0ustar rootrootPNG  IHDRw=bKGDIDATx=KA0&MF+ A,D- ,DEPG@pq6~ŘdexaCt6@i@Է0D9/*at@Ԃخ]] =l]OaVOsI1102 Ojg6`sqK<. 9˜#Y9 1 h%ab1VPQJ"$(Caa DZ"tǙY,Kʠ.N9Ǵ,-oC q)wIF |#!&XkiHy"3<_~LvD/,ϭUM#iX+3%)qmӳ>H OIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_yes_20.png0000644000000000000000000000144611272037113023756 0ustar rootrootPNG  IHDR gAMA1_IDATxՔ[oE=ރ۩8NڴQQJn@F޴ P$"JSPLJ8>΁ВK$^iG7J 0_e\է|W3:TfxC\Fd)=!Ɉ7O Cw}ڇ &}r#psxϷwߡρׯv ER4e_F!-52,cv^6AՏc:K=5&(yG0cQ[\ȿ Y|Y( "aJT%,G Fn^_/ '`K,-0|ɽ[3?yx6gNIENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/icons/stock_ok_20.png0000644000000000000000000000122511272037113023562 0ustar rootrootPNG  IHDR bKGDiBըIDATxڭN@ .!^1F_ån} .;х1DWDR(E,!g\(5EV=ɗ9t&YytV d[kƬ0%ux])ժuer֚sۣذp ʉ{y;VA8sPy60눚KDn.#hA 8;T*[H3\*RJ,u]r,..8r]]ӵ_57u||Bajjj(--Eضi|ϟDჃk lǏljD"TUUǩ& ô`|Ƚ{~<===P(uibbp8L4p8L0$D"B-S ֖r]gllr(xMR ۶q۶޽köm`~~qPJa&mS(E)uxm<[YZZ4M eQ(|u]\mibeaYr-@Jd2dY c/E@>Ų, `ggM"iڷ=hM>!Wlmm-7MoRʭ>~(e_|>333:@UẮ&Xܔ>??g{{i^~yKubBgRʞEcc#z/_,Og=?$/@2DeCO#m@^6$n>'t0/˖˧7MMM)] 8KH1+3NۉD¾kU1 !/Ԏ^7IENDB`./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangocontext.html0000644000000000000000000005132311272037113024332 0ustar rootrootpango.Context
pango.Context
Prev The pango Class Reference Next

pango.Context

pango.Context — stores global information used to control rendering.

Synopsis

class pango.Context(gobject.GObject):
    def list_families()
    def load_font(desc)
    def load_fontset(desc, language)
    def get_metrics(desc, language)
    def set_font_description(desc)
    def get_font_description()
    def get_language()
    def set_language(language)
    def set_base_dir(direction)
    def get_base_dir()

Ancestry

+-- gobject.GObject
  +-- pango.Context

Description

A pango.Context object contains global information used to control the rendering process. The information accessible using the pango.Context methods includes:

A pango.Context can be created with the gtk.Widget.create_pango_context() method. The pango.Context associated with a gtk.Widget is retrieved using the gtk.Widget.get_pango_context()) method.

Methods

pango.Context.list_families

    def list_families()

Returns :

a tuple containing a set of pango.FontFamily objects.

The list_families() method returns a tuple containing the list of all the pango.FontFamily objects for a context.

pango.Context.load_font

    def load_font(desc)

desc :

a pango.FontDescription describing the font to load

Returns :

the pango.Font loaded, or None if no font matched.

The load_font() method loads and returns the pango.Font from one of the fontmaps in the context that is the closest match for the pango.FontDescription specified by desc.

pango.Context.load_fontset

    def load_fontset(desc, language)

desc :

a pango.FontDescription describing the fonts to load

language :

a pango.Language the fonts will be used for

Returns :

the pango.FontSet, or None if no font matched.

The load_fontset() method loads and returns a set of fonts (in a pango.FontSet) from the context that can be used to render a font matching the pango.FontDescription specified by desc with the pango.Language specified by language.

pango.Context.get_metrics

    def get_metrics(desc, language)

desc :

a pango.FontDescription object

language :

the pango.Language that determines the script to get the metrics for, or None to get the metrics for the entire font.

Returns :

a pango.FontMetrics object.

The get_metrics() method returns the overall metric information for the font described by the pango.FontDescription specified by desc. Since the metrics may be substantially different for different scripts, a pango.Language (specified by language) can be provided to indicate that the metrics should correspond to the script(s) used by that language. If the value of language is None, the returned pango.FontMetrics covers the entire font.

The family name in the pango.FontDescription may be a comma separated list of families. If characters from multiple of these families would be used to render the string, then the returned fonts would be a composite of the metrics for the fonts loaded for the individual families.

pango.Context.set_font_description

    def set_font_description(desc)

desc :

a pango.FontDescription object

The set_font_description() method sets the default pango.FontDescription (specified by desc) for the context.

pango.Context.get_font_description

    def get_font_description()

Returns :

the default font description of the context.

The get_font_description() method returns the default pango.FontDescription for the context.

pango.Context.get_language

    def get_language()

Returns :

the global pango.Language.

The get_language() method returns the global pango.Language for the context.

pango.Context.set_language

    def set_language(language)

language :

a pango.Language.

The set_language() method sets the global pango.Language for the context to the value specified by language.

pango.Context.set_base_dir

    def set_base_dir(direction)

direction :

the new base direction

The set_base_dir() method sets the base text direction for the context to the value specified by direction. The value of direction must be one of:

pango.DIRECTION_LTR

The text is written left-to-right

pango.DIRECTION_RTL

The text is written right-to-left

pango.DIRECTION_TTB_LTR

The text is written vertically top-to-bottom, with the rows ordered from left to right.

pango.DIRECTION_TTB_RTL

The text is written vertically top-to-bottom, with the rows ordered from right to left.

pango.Context.get_base_dir

    def get_base_dir()

Returns :

the base direction for the context.

The get_base_dir() method returns the base text direction for the context. See the set_base_dir() method for more information.

Prev Up Next
pango.Color Home pango.Font
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkfilechooserdialog.html0000644000000000000000000003021211272037113026003 0ustar rootrootgtk.FileChooserDialog
gtk.FileChooserDialog
Prev The gtk Class Reference Next

gtk.FileChooserDialog

gtk.FileChooserDialog — a file chooser dialog, suitable for "File/Open" or "File/Save" commands(new in PyGTK 2.4)

Synopsis

class gtk.FileChooserDialog(gtk.Dialog, gtk.FileChooser):
    gtk.FileChooserDialog(title=None, parent=None, action=gtk.FILE_CHOOSER_ACTION_OPEN, buttons=None, backend=None)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Window
            +-- gtk.Dialog
              +-- gtk.FileChooserDialog

Implemented Interfaces

gtk.FileChooserDialog implements gtk.Buildable gtk.FileChooser

gtk.FileChooserDialog Properties

gtk.FileChooser Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Window Properties

gtk.Dialog Properties

gtk.FileChooserDialog Style Properties

gtk.Widget Style Properties

gtk.Dialog Style Properties

gtk.FileChooserDialog Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.Window Signal Prototypes

gtk.Dialog Signal Prototypes

gtk.FileChooser Signal Prototypes

Description

Note

This widget is available in PyGTK 2.4 and above.

gtk.FileChooserDialog is a dialog box suitable for use with "File/Open" or "File/Save as" commands. This widget works by putting a gtk.FileChooserWidget inside a gtk.Dialog. It implements the gtk.FileChooser interface, so you can use all of the gtk.FileChooser methods, signals and properties on the file chooser dialog as well as those for gtk.Dialog.

Note that gtk.FileChooserDialog does not have any methods of its own. Instead, you should use the methods and signals that work on a gtk.FileChooser.

Constructor

    gtk.FileChooserDialog(title=None, parent=None, action=gtk.FILE_CHOOSER_ACTION_OPEN, buttons=None, backend=None)

title :

The title of the dialog

parent :

The transient parent of the dialog, or None

action :

The open or save mode for the dialog - one of: gtk.FILE_CHOOSER_ACTION_OPEN, gtk.FILE_CHOOSER_ACTION_SAVE, gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER or gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER.

buttons :

a tuple containing button label-response id pairs or None

backend :

The name of the specific filesystem backend to use.

Returns :

a new gtk.FileChooserDialog

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.FileChooserDialog. The constructor can be invoked with the optional parameters: title, parent, action, buttons and backend. This constructor is analogous to the gtk.Dialog() constructor.

Prev Up Next
gtk.FileChooserButton Home gtk.FileChooserWidget
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktreerowreference.html0000644000000000000000000002622711272037113025702 0ustar rootrootgtk.TreeRowReference
gtk.TreeRowReference
Prev The gtk Class Reference Next

gtk.TreeRowReference

gtk.TreeRowReference — an object maintaining a persistent reference to a gtk.TreeModel row (new in PyGTK 2.4)

Synopsis

class gtk.TreeRowReference(gobject.GBoxed):
    gtk.TreeRowReference(model, path)
    def get_path()
    def get_model()
    def valid()
    def copy()
    def free()

Description

Note

This object is available in PyGTK 2.4 and above.

A gtk.TreeRowReference is an object that points to a row in a gtk.TreeModel similar to a gtk.TreeIter. A gtk.TreeRowReference, unlike a gtk.TreeIter, maintains a persistent reference in spite of changes in the model.

Constructor

    gtk.TreeRowReference(model, path)

model :

a gtk.TreeModel

path :

a valid tree path to monitor

Returns :

a gtk.TreeRowReference, or None

Note

This constructor is available in PyGTK 2.4 and above.

Creates a row reference pointing to the treemodel row specified by model and path. This reference will continue pointing to the node in spite of changes in model. It listens to all signals emitted by model, and updates its path appropriately. If path isn't a valid path in model, None is returned.

Methods

gtk.TreeRowReference.get_path

    def get_path()

Returns :

A current path, or None.

Note

This method is available in PyGTK 2.4 and above.

The get_path() method returns the path that the row reference currently points to, or None if the path pointed to is no longer valid.

gtk.TreeRowReference.get_model

    def get_model()

Returns :

the model, or None.

Note

This method is available in PyGTK 2.8 and above.

The get_model() method returns the model that the row reference currently monitors, or None if the model is not set.

gtk.TreeRowReference.valid

    def valid()

Returns :

True if the row reference points to a valid path.

Note

This method is available in PyGTK 2.4 and above.

The valid() method returns True if the row reference is not None and refers to a current valid path.

gtk.TreeRowReference.copy

    def copy()

Returns :

a copy of the row reference

Note

This method is available in PyGTK 2.4 and above.

The copy() method returns a copy of the tree row reference.

gtk.TreeRowReference.free

    def free()

Note

This method is available in PyGTK 2.4 and above.

Warning

This method is deprecated and should not be used since it may crash your application.

The free() method frees the tree row reference. The row reference may be None.

Prev Up Next
gtk.TreeModelRowIter Home gtk.TreeSelection
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktextattributes.html0000644000000000000000000003225611272037113025426 0ustar rootrootgtk.TextAttributes
gtk.TextAttributes
Prev The gtk Class Reference Next

gtk.TextAttributes

gtk.TextAttributes — an object containing the attributes set on some text

Synopsis

class gtk.TextAttributes(gobject.GBoxed):
    gtk.TextAttributes()
    def copy()
    def copy_values(dest)

Attributes

"bg_color"ReadThe background color
"fg_color"ReadThe foreground color
"bg_stipple"ReadThe background stipple bitmap
"fg_stipple"ReadThe foreground stipple bitmap
"rise"ReadThe subscript or superscript rise
"underline"ReadThe style of underline - one of: pango.UNDERLINE_NONE, pango.UNDERLINE_SINGLE, pango.UNDERLINE_DOUBLE, pango.UNDERLINE_LOW
"strikethrough"ReadIf True strikethrough the text
"draw_bg"ReadIf True some background attributes are set
"justification"ReadThe type of justification - one of: gtk.JUSTIFY_LEFT, gtk.JUSTIFY_RIGHT, gtk.JUSTIFY_CENTER, gtk.JUSTIFY_FILL
"direction"ReadThe text direction - one of: gtk.TEXT_DIR_NONE, gtk.TEXT_DIR_LTR, gtk.TEXT_DIR_RTL
"font"ReadA pango.FontDescription
"font_scale"ReadThe scale of the font e.g. 2.5
"left_margin"ReadThe width of the left margin in pixels
"indent"ReadThe width of the paragraph indent in pixels
"right_margin"ReadThe width of the right margin
"pixels_above_lines"ReadThe number of pixels space above a paragraph
"pixels_below_lines"ReadThe number of pixels space below a paragraph
"pixels_inside_wrap"ReadThe number of pixels of space between wrapped lines in a paragraph
"tabs"ReadA set of tabs contained in a pango.TabArray
"wrap_mode"ReadThe wrap mode - one of: gtk.WRAP_NONE, gtk.WRAP_CHAR, gtk.WRAP_WORD
"language"ReadThe pango.Language object describing the text language
"invisible"ReadIf True the text is hidden (Not implemented in PyGTK2)
"bg_full_height"ReadIf True the background is fit to the full line height
"editable"ReadIf True the text is editable
"realized"ReadIf True the text has been realized
"pad1"Read 
"pad2"Read 
"pad3"Read 
"pad4"Read 

Description

A gtk.TextAttributes object holds a set of attributes that describe the properties of a section of text. A gtk.TextAttributes object is usually obtained by calling either of the gtk.TextIter.get_attributes() or gtk.TextView.get_default_attributes() methods to retrieve the attributes in effect.

A gtk.TextAttributes object created with gtk.TextAttributes() cannot be applied within PyGTK because there is no way to set the attributes. Likewise, the copy() and copy_values() methods can create a new copy or copy the attributes but there are no methods in PyGTK that take a gtk.TextAttributes object as an argument. The most effective way to use a gtk.TextAttributes object is to read its attributes and use them to set the properties of a gtk.TextTag.

Constructor

    gtk.TextAttributes()

Returns :

a new gtk.TextAttributes

Creates a gtk.TextAttributes object, that contains a set of attributes of some text.

Methods

gtk.TextAttributes.copy

    def copy()

Returns :

a copy of the gtk.TextAttributes object

The copy() method copies the text attributes and returns a new gtk.TextAttributes object.

gtk.TextAttributes.copy_values

    def copy_values(dest)

dest :

the gtk.TextAttributes whose attributes will be set

The copy_values() method copies the values from the gtk.TextAttributes object to dest so that dest has the same values. Frees existing values in dest.

Prev Up Next
gtk.TearoffMenuItem Home gtk.TextBuffer
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/gdk-constants.html0000644000000000000000000024007311272037113023277 0ustar rootrootgtk.gdk Constants
gtk.gdk Constants
Prev The gtk.gdk Class Reference Next

gtk.gdk Constants

gtk.gdk Constants — the built-in constants of the gtk.gdk module

Synopsis

GDK Drag Action Constants
GDK Device Axis Use Constants
GDK Byte Order Constants
GDK Cap Style Constants
GDK Crossing Mode Constants
GDK Cursor Type Constants
GDK Drag Protocol Constants
GDK Event Mask Flag Constants
GDK Event Type Constants
GDK Extension Mode Constants
GDK Fill Constants
GDK Fill Rule Constants
GDK Filter Return Constants
GDK Function Constants
GDK GC Values Mask Flag Constants
GDK Gravity Constants
GDK Image Type Constants
GDK Input Condition Flag Constants
GDK Input Mode Constants
GDK Input Source Constants
GDK Join Style Constants
GDK Line Style Constants
GDK Modifier Constants
GDK Notify Type Constants
GDK Overlap Type Constants
GDK Owner Change Constants
GDK Parent Relative Constant
GDK Pixbuf Rotation Constants
GDK Property Mode Constants
GDK Property State Constants
GDK RGB Dither Constants
GDK Scroll Direction Constants
GDK Setting Action Constants
GDK Subwindow Mode Constants
GDK Visibility State Constants
GDK Visual Type Constants
GDK Window Class Constants
GDK Window Edge Constants
GDK Window Hints Constants
GDK Window State Flag Constants
GDK Window Type Constants
GDK Window Type Hint Constants
GDK WM Decoration Constants
GDK WM Function Constants

Description

GDK Drag Action Constants

The Drag Action constants are used by gtk.gdk.DragContext objects to indicate what the destination should do with the dropped data.

gtk.gdk.ACTION_DEFAULT

gtk.gdk.ACTION_COPY

Copy the data.

gtk.gdk.ACTION_MOVE

Move the data, i.e. first copy it, then delete it from the source using the DELETE target of the X selection protocol.

gtk.gdk.ACTION_LINK

Add a link to the data. Note that this is only useful if source and destination agree on what it means.

gtk.gdk.ACTION_PRIVATE

Special action which tells the source that the destination will do something that the source doesn't understand.

gtk.gdk.ACTION_ASK

Ask the user what to do with the data.

GDK Device Axis Use Constants

The Device Axis constants describing the way in which a device axis (valuator) maps onto predefined valuator types.

gtk.gdk.AXIS_IGNORE

the axis is ignored.

gtk.gdk.AXIS_X

the axis is used as the x axis.

gtk.gdk.AXIS_Y

the axis is used as the y axis.

gtk.gdk.AXIS_PRESSURE

the axis is used for pressure information.

gtk.gdk.AXIS_XTILT

the axis is used for x tilt information.

gtk.gdk.AXIS_YTILT

the axis is used for y tilt information.

gtk.gdk.AXIS_WHEEL

the axis is used for wheel information.

gtk.gdk.AXIS_LAST

a constant equal to the numerically highest axis value.

GDK Byte Order Constants

The Byte Order constants specify a set of values describing the possible byte-orders for storing pixel values in memory.

gtk.gdk.LSB_FIRST

The values are stored with the least-significant byte first. For instance, the 32-bit value 0xffeecc would be stored in memory as 0xcc, 0xee, 0xff, 0x00.

gtk.gdk.MSB_FIRST

The values are stored with the most-significant byte first. For instance, the 32-bit value 0xffeecc would be stored in memory as 0x00, 0xcc, 0xee, 0xff.

GDK Cap Style Constants

The Cap Style constants specify how the end of lines are drawn.

gtk.gdk.CAP_NOT_LAST

The same as gtk.gdk.CAP_BUTT for lines of non-zero width but for zero width lines, the final point on the line will not be drawn.

gtk.gdk.CAP_BUTT

The ends of the lines are drawn squared off and extending to the coordinates of the end point.

gtk.gdk.CAP_ROUND

The ends of the lines are drawn as semicircles with the diameter equal to the line width and centered at the end point.

gtk.gdk.CAP_PROJECTING

The ends of the lines are drawn squared off and extending half the width of the line beyond the end point.

GDK Crossing Mode Constants

The Crossing Mode constants specify the crossing mode for the Crossing gtk.gdk.Event

GDK Cursor Type Constants

The Cursor Type constants specify the set of standard cursors available.

gtk.gdk.X_CURSOR

gtk.gdk.ARROW

gtk.gdk.BASED_ARROW_DOWN

gtk.gdk.BASED_ARROW_UP

gtk.gdk.BOAT

gtk.gdk.BOGOSITY

gtk.gdk.BOTTOM_LEFT_CORNER

gtk.gdk.BOTTOM_RIGHT_CORNER

gtk.gdk.BOTTOM_SIDE

gtk.gdk.BOTTOM_TEE

gtk.gdk.BOX_SPIRAL

gtk.gdk.CENTER_PTR

gtk.gdk.CIRCLE

gtk.gdk.CLOCK

gtk.gdk.COFFEE_MUG

gtk.gdk.CROSS

gtk.gdk.CROSS_REVERSE

gtk.gdk.CROSSHAIR

gtk.gdk.DIAMOND_CROSS

gtk.gdk.DOT

gtk.gdk.DOTBOX

gtk.gdk.DOUBLE_ARROW

gtk.gdk.DRAFT_LARGE

gtk.gdk.DRAFT_SMALL

gtk.gdk.DRAPED_BOX

gtk.gdk.EXCHANGE

gtk.gdk.FLEUR

gtk.gdk.GOBBLER

gtk.gdk.GUMBY

gtk.gdk.HAND1

gtk.gdk.HAND2

gtk.gdk.HEART

gtk.gdk.ICON

gtk.gdk.IRON_CROSS

gtk.gdk.LEFT_PTR

gtk.gdk.LEFT_SIDE

gtk.gdk.LEFT_TEE

gtk.gdk.LEFTBUTTON

gtk.gdk.LL_ANGLE

gtk.gdk.LR_ANGLE

gtk.gdk.MAN

gtk.gdk.MIDDLEBUTTON

gtk.gdk.MOUSE

gtk.gdk.PENCIL

gtk.gdk.PIRATE

gtk.gdk.PLUS

gtk.gdk.QUESTION_ARROW

gtk.gdk.RIGHT_PTR

gtk.gdk.RIGHT_SIDE

gtk.gdk.RIGHT_TEE

gtk.gdk.RIGHTBUTTON

gtk.gdk.RTL_LOGO

gtk.gdk.SAILBOAT

gtk.gdk.SB_DOWN_ARROW

gtk.gdk.SB_H_DOUBLE_ARROW

gtk.gdk.SB_LEFT_ARROW

gtk.gdk.SB_RIGHT_ARROW

gtk.gdk.SB_UP_ARROW

gtk.gdk.SB_V_DOUBLE_ARROW

gtk.gdk.SHUTTLE

gtk.gdk.SIZING

gtk.gdk.SPIDER

gtk.gdk.SPRAYCAN

gtk.gdk.STAR

gtk.gdk.TARGET

gtk.gdk.TCROSS

gtk.gdk.TOP_LEFT_ARROW

gtk.gdk.TOP_LEFT_CORNER

gtk.gdk.TOP_RIGHT_CORNER

gtk.gdk.TOP_SIDE

gtk.gdk.TOP_TEE

gtk.gdk.TREK

gtk.gdk.UL_ANGLE

gtk.gdk.UMBRELLA

gtk.gdk.UR_ANGLE

gtk.gdk.WATCH

gtk.gdk.XTERM

GDK Drag Protocol Constants

The Drag Protocol constants specify the protocol for a gtk.gdk.DragContext according to which DND is done.

gtk.gdk.DRAG_PROTO_MOTIF

The Motif DND protocol.

gtk.gdk.DRAG_PROTO_XDND

The Xdnd protocol.

gtk.gdk.DRAG_PROTO_ROOTWIN

An extension to the Xdnd protocol for unclaimed root window drops.

gtk.gdk.DRAG_PROTO_NONE

no protocol.

gtk.gdk.DRAG_PROTO_WIN32_DROPFILES

The simple WM_DROPFILES protocol.

gtk.gdk.DRAG_PROTO_OLE2

The complex OLE2 DND protocol (not implemented).

gtk.gdk.DRAG_PROTO_LOCAL

Intra-application DND.

GDK Event Mask Flag Constants

The Event Mask flag constants are a set of bit-flags that specify the events a window is to receive. Most of these masks map onto one or more of the Event Type Constants.

gtk.gdk.EXPOSURE_MASK

gtk.gdk.POINTER_MOTION_MASK

gtk.gdk.POINTER_MOTION_HINT_MASK

gtk.gdk.BUTTON_MOTION_MASK

gtk.gdk.BUTTON1_MOTION_MASK

gtk.gdk.BUTTON2_MOTION_MASK

gtk.gdk.BUTTON3_MOTION_MASK

gtk.gdk.BUTTON_PRESS_MASK

gtk.gdk.BUTTON_RELEASE_MASK

gtk.gdk.KEY_PRESS_MASK

gtk.gdk.KEY_RELEASE_MASK

gtk.gdk.ENTER_NOTIFY_MASK

gtk.gdk.LEAVE_NOTIFY_MASK

gtk.gdk.FOCUS_CHANGE_MASK

gtk.gdk.STRUCTURE_MASK

gtk.gdk.PROPERTY_CHANGE_MASK

gtk.gdk.VISIBILITY_NOTIFY_MASK

gtk.gdk.PROXIMITY_IN_MASK

gtk.gdk.PROXIMITY_OUT_MASK

gtk.gdk.SUBSTRUCTURE_MASK

gtk.gdk.SCROLL_MASK

gtk.gdk.ALL_EVENTS_MASK

GDK Event Type Constants

The Event Type constants specify the type of an event.

gtk.gdk.NOTHING

a special code to indicate a null event.

gtk.gdk.DELETE

the window manager has requested that the toplevel window be hidden or destroyed, usually when the user clicks on a special icon in the title bar.

gtk.gdk.DESTROY

the window has been destroyed.

gtk.gdk.EXPOSE

all or part of the window has become visible and needs to be redrawn.

gtk.gdk.MOTION_NOTIFY

the pointer (usually a mouse) has moved.

gtk.gdk.BUTTON_PRESS

a mouse button has been pressed.

gtk.gdk._2BUTTON_PRESS

a mouse button has been double-clicked (clicked twice within a short period of time). Note that each click also generates a gtk.gdk.BUTTON_PRESS event.

gtk.gdk._3BUTTON_PRESS

a mouse button has been clicked 3 times in a short period of time. Note that each click also generates a gtk.gdk.BUTTON_PRESS event.

gtk.gdk.BUTTON_RELEASE

a mouse button has been released.

gtk.gdk.KEY_PRESS

a key has been pressed.

gtk.gdk.KEY_RELEASE

a key has been released.

gtk.gdk.ENTER_NOTIFY

the pointer has entered the window.

gtk.gdk.LEAVE_NOTIFY

the pointer has left the window.

gtk.gdk.FOCUS_CHANGE

the keyboard focus has entered or left the window.

gtk.gdk.CONFIGURE

the size, position or stacking order of the window has changed. Note that PyGTK discards these events for gtk.gdk.WINDOW_CHILD windows.

gtk.gdk.MAP

the window has been mapped.

gtk.gdk.UNMAP

the window has been unmapped.

gtk.gdk.PROPERTY_NOTIFY

a property on the window has been changed or deleted.

gtk.gdk.SELECTION_CLEAR

the application has lost ownership of a selection.

gtk.gdk.SELECTION_REQUEST

another application has requested a selection.

gtk.gdk.SELECTION_NOTIFY

a selection has been received.

gtk.gdk.PROXIMITY_IN

an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet).

gtk.gdk.PROXIMITY_OUT

an input device has moved out of contact with a sensing surface.

gtk.gdk.DRAG_ENTER

the mouse has entered the window while a drag is in progress.

gtk.gdk.DRAG_LEAVE

the mouse has left the window while a drag is in progress

gtk.gdk.DRAG_MOTION

the mouse has moved in the window while a drag is in progress.

gtk.gdk.DRAG_STATUS

the status of the drag operation initiated by the window has changed.

gtk.gdk.DROP_START

a drop operation onto the window has started.

gtk.gdk.DROP_FINISHED

the drop operation initiated by the window has completed.

gtk.gdk.CLIENT_EVENT

a message has been received from another application.

gtk.gdk.VISIBILITY_NOTIFY

the window visibility status has changed.

gtk.gdk.NO_EXPOSE

indicates that the source region was completely available when parts of a drawable were copied. This is not very useful.

gtk.gdk.SCROLL

a scroll had occurred for a window

gtk.gdk.WINDOW_STATE

the window state has changed

gtk.gdk.SETTING

a setting has changed

GDK Extension Mode Constants

The Extension Mode constants specify which extension events are desired for a particular widget.

gtk.gdk.EXTENSION_EVENTS_NONE

No extension events are desired.

gtk.gdk.EXTENSION_EVENTS_ALL

All extension events are desired.

gtk.gdk.EXTENSION_EVENTS_CURSOR

Extension events are desired only if a cursor will be displayed for the device.

GDK Fill Constants

The Fill constants specify how primitives are drawn.

gtk.gdk.SOLID

draw with the foreground color.

gtk.gdk.TILED

draw with a tiled pixmap.

gtk.gdk.STIPPLED

draw using the stipple bitmap. Pixels corresponding to bits in the stipple bitmap that are set will be drawn in the foreground color; pixels corresponding to bits that are not set will be left untouched.

gtk.gdk.OPAQUE_STIPPLED

draw using the stipple bitmap. Pixels corresponding to bits in the stipple bitmap that are set will be drawn in the foreground color; pixels corresponding to bits that are not set will be drawn with the background color.

GDK Fill Rule Constants

The Fill Rule constants specify the method for determining which pixels are included in a region, when creating a GdkRegion from a polygon. The fill rule is only relevant for polygons which overlap themselves. Not used in PyGTK.

gtk.gdk.EVEN_ODD_RULE

Areas which are overlapped an odd number of times are included in the region, while areas overlapped an even number of times are not.

gtk.gdk.WINDING_RULE

Overlapping areas are always included.

GDK Filter Return Constants

The Filter Return constants specify the result of filtering a native event. See the gtk.gdk.Window.add_filter() method for more information.

gtk.gdk.FILTER_CONTINUE

Event not handled, continue processing.

gtk.gdk.FILTER_TRANSLATE

Native event translated and stored into the gtk.gdk.Event passed in.

gtk.gdk.FILTER_REMOVE

Event handled, terminate processing.

GDK Function Constants

The Function constants specify how the bit values for the source pixels are combined with the bit values for destination pixels to produce the final result. The sixteen values here correspond to the 16 different possible 2x2 truth tables. Only a couple of these values are usually useful; for colored images, only gtk.gdk.COPY, gtk.gdk.XOR and gtk.gdk.INVERT are generally useful. For bitmaps, gtk.gdk.AND and gtk.gdk.OR are also useful.

gtk.gdk.COPY

gtk.gdk.INVERT

gtk.gdk.XOR

gtk.gdk.CLEAR

gtk.gdk.AND

gtk.gdk.AND_REVERSE.

gtk.gdk.AND_INVERT

gtk.gdk.NOOP

gtk.gdk.OR

gtk.gdk.EQUIV

gtk.gdk.OR_REVERSE

gtk.gdk.COPY_INVERT

gtk.gdk.OR_INVERT

gtk.gdk.NAND

gtk.gdk.NOR

gtk.gdk.SET

GDK GC Values Mask Flag Constants

The GC Values Mask flag constants are a set of bit flags used to specify which fields GdkGCValues structure are set. These are only used internally by PyGTK.

gtk.gdk.GC_FOREGROUND

the foreground is set.

gtk.gdk.GC_BACKGROUND

the background is set.

gtk.gdk.GC_FONT

the font is set.

gtk.gdk.GC_FUNCTION

the function is set.

gtk.gdk.GC_FILL

the fill is set.

gtk.gdk.GC_TILE

the tile is set.

gtk.gdk.GC_STIPPLE

the stipple is set.

gtk.gdk.GC_CLIP_MASK

the clip_mask is set.

gtk.gdk.GC_SUBWINDOW

the subwindow_mode is set.

gtk.gdk.GC_TS_X_ORIGIN

the ts_x_origin is set.

gtk.gdk.GC_TS_Y_ORIGIN

the ts_y_origin is set.

gtk.gdk.GC_CLIP_X_ORIGIN

the clip_x_origin is set.

gtk.gdk.GC_CLIP_Y_ORIGIN

the clip_y_origin is set.

gtk.gdk.GC_EXPOSURES

the graphics_exposures is set.

gtk.gdk.GC_LINE_WIDTH

the line_width is set.

gtk.gdk.GC_LINE_STYLE

the line_style is set.

gtk.gdk.GC_CAP_STYLE

the cap_style is set.

gtk.gdk.GC_JOIN_STYLE

the join_style is set.

GDK Gravity Constants

The Gravity constants specify the reference point of a window and the meaning of coordinates passed to the gtk.Window.move() method.

gtk.gdk.GRAVITY_NORTH_WEST

The reference point is at the top left corner.

gtk.gdk.GRAVITY_NORTH

The reference point is in the middle of the top edge.

gtk.gdk.GRAVITY_NORTH_EAST

The reference point is at the top right corner.

gtk.gdk.GRAVITY_WEST

The reference point is at the middle of the left edge.

gtk.gdk.GRAVITY_CENTER

The reference point is at the center of the window.

gtk.gdk.GRAVITY_EAST

The reference point is at the middle of the right edge.

gtk.gdk.GRAVITY_SOUTH_WEST

The reference point is at the lower left corner.

gtk.gdk.GRAVITY_SOUTH

The reference point is at the middle of the lower edge.

gtk.gdk.GRAVITY_SOUTH_EAST

The reference point is at the lower right corner.

gtk.gdk.GRAVITY_STATIC

The reference point is at the top left corner of the window itself, ignoring window manager decorations.

GDK Image Type Constants

The Image Type constants specify the type of a gtk.gdk.Image.

gtk.gdk.IMAGE_NORMAL

The original X image type, which is quite slow since the image has to be transferred from the client to the server to display it.

gtk.gdk.IMAGE_SHARED

A faster image type, which uses shared memory to transfer the image data between client and server. However this will only be available if client and server are on the same machine and the shared memory extension is supported by the server.

gtk.gdk.IMAGE_FASTEST

Specifies that gtk.gdk.IMAGE_SHARED should be tried first, and if that fails then gtk.gdk.IMAGE_NORMAL will be used.

GDK Input Condition Flag Constants

The Input Condition constants are a set of bit-flags that specify conditions for which an input callback will be triggered. The three members of this enumeration correspond to the readfds, writefds, and exceptfds arguments to the select system call.

gtk.gdk.INPUT_READ

The file descriptor has become available for reading. (Or, as is standard in Unix, a socket or pipe was closed at the other end; this is the case if a subsequent read on the file descriptor returns a count of zero.)

gtk.gdk.INPUT_WRITE

The file descriptor has become available for writing.

gtk.gdk.INPUT_EXCEPTION

An exception was raised on the file descriptor.

GDK Input Mode Constants

The Input Mode constants specify the mode of an input device.

gtk.gdk.MODE_DISABLED

the device is disabled and will not report any events.

gtk.gdk.MODE_SCREEN

the device is enabled. The device's coordinate space maps to the entire screen.

gtk.gdk.MODE_WINDOW

the device is enabled. The device's coordinate space is mapped to a single window. The manner in which this window is chosen is undefined, but it will typically be the same way in which the focus window for key events is determined.

GDK Input Source Constants

The Input Source constants specify the type of an input device in general terms.

gtk.gdk.SOURCE_MOUSE

the device is a mouse. (This will be reported for the core pointer, even if it is something else, such as a trackball.)

gtk.gdk.SOURCE_PEN

the device is a stylus of a graphics tablet or similar device.

gtk.gdk.SOURCE_ERASER

the device is an eraser. Typically, this would be the other end of a stylus on a graphics tablet.

gtk.gdk.SOURCE_CURSOR

the device is a graphics tablet "puck" or similar device.

GDK Join Style Constants

The Join Style constants specify how the joins between segments of a polygon are drawn.

gtk.gdk.JOIN_MITER

The sides of each line are extended to meet at an angle.

gtk.gdk.JOIN_ROUND

The sides of the two lines are joined by a circular arc.

gtk.gdk.JOIN_BEVEL

The sides of the two lines are joined by a straight line which makes an equal angle with each line.

GDK Line Style Constants

The Line Style constants specify how lines are drawn.

gtk.gdk.LINE_SOLID

Lines are drawn solid.

gtk.gdk.LINE_ON_OFF_DASH

Lines are drawn dashed where even segments are drawn but odd segments are not drawn.

gtk.gdk.LINE_DOUBLE_DASH

Lines are drawn dashed where even segments are drawn normally but odd segments are drawn in the background color if the fill style is gtk.gdk.SOLID, or in the background color masked by the stipple if the fill style is gtk.gdk.STIPPLED.

GDK Modifier Constants

The Modifier constants are a set of bit-flags to indicate the state of modifier keys and mouse buttons in various event types. Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

gtk.gdk.SHIFT_MASK

The Shift key.

gtk.gdk.LOCK_MASK

A Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock).

gtk.gdk.CONTROL_MASK

The Control key.

gtk.gdk.MOD1_MASK

The fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key).

gtk.gdk.MOD2_MASK

The fifth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

gtk.gdk.MOD3_MASK

The sixth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

gtk.gdk.MOD4_MASK

The seventh modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

gtk.gdk.MOD5_MASK

The eighth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

gtk.gdk.BUTTON1_MASK

The first mouse button.

gtk.gdk.BUTTON2_MASK

The second mouse button.

gtk.gdk.BUTTON3_MASK

The third mouse button.

gtk.gdk.BUTTON4_MASK

The fourth mouse button.

gtk.gdk.BUTTON5_MASK

The fifth mouse button.

gtk.gdk.RELEASE_MASK

Differentiates between (keyval, modifiers) pairs from key press and release events.

gtk.gdk.MODIFIER_MASK

all of the above

GDK Notify Type Constants

The Notify Type constants specify the kind of crossing for the Crossing gtk.gdk.Event

gtk.gdk.NOTIFY_ANCESTOR

the window is entered from an ancestor or left toward an ancestor.

gtk.gdk.NOTIFY_VIRTUAL

the pointer moves between an ancestor and an inferior of the window.

gtk.gdk.NOTIFY_INFERIOR

the window is entered from an inferior or left toward an inferior.

gtk.gdk.NOTIFY_NONLINEAR

 the window is entered from or left toward a window which is neither an ancestor nor an inferior.

gtk.gdk.NOTIFY_NONLINEAR_VIRTUAL

the pointer moves between two windows which are not ancestors of each other and the window is part of the ancestor chain between one of these windows and their least common ancestor.

gtk.gdk.NOTIFY_UNKNOWN

???

GDK Overlap Type Constants

The Overlap Type constants specify the possible values returned by the gtk.gdk.Region.rect_in() method.

gtk.gdk.OVERLAP_RECTANGLE_IN

The rectangle is inside the GdkRegion.

gtk.gdk.OVERLAP_RECTANGLE_OUT

The rectangle is outside the GdkRegion.

gtk.gdk.OVERLAP_RECTANGLE_PART

The rectangle is partly inside the GdkRegion.

GDK Owner Change Constants

The Owner Change constants specify the possible values indicating why selection ownership changed. These are used by the gdk.OWNER_CHANGE type gtk.gdk.Event "owner" attribute.

gtk.gdk.OVERLAP_RECTANGLE_IN

The rectangle is inside the GdkRegion.

gtk.gdk.OVERLAP_RECTANGLE_OUT

The rectangle is outside the GdkRegion.

gtk.gdk.OVERLAP_RECTANGLE_PART

The rectangle is partly inside the GdkRegion.

GDK Parent Relative Constant

Note

This constant is available in PyGTK 2.10 and above.

The Parent Relative constant is a special value (equivalent to 1L) for gtk.gdk.Pixmap variables, indicating that the background pixmap for a window should be inherited from the parent window.

gtk.gdk.PARENT_RELATIVE

the background pixmap for a window should be inherited from the parent window.

GDK Pixbuf Rotation Constants

The Pixbuf Rotation constants specify the angles that a pixbuf can be rotated using the gtk.gdk.Pixbuf.rotate_simple() method.

gtk.gdk.PIXBUF_ROTATE_NONE

No rotation. Rotate by 0 degrees.

gtk.gdk.PIXBUF_ROTATE_COUNTERCLOCKWISE

Rotate by 90 degrees.

gtk.gdk.PIXBUF_ROTATE_UPSIDEDOWN

Rotate by 180 degrees.

gtk.gdk.PIXBUF_ROTATE_CLOCKWISE

Rotate by 270 degrees.

GDK Property Mode Constants

The Property Mode constants specify how existing data is combined with new data when using the the gtk.gdk.Window.property_change() method.

gtk.gdk.PROP_MODE_REPLACE

The new data replaces the existing data.

gtk.gdk.PROP_MODE_PREPEND

The new data is prepended to the existing data.

gtk.gdk.PROP_MODE_APPEND

The new data is appended to the existing data.

GDK Property State Constants

The Property State constants specify the type of a property change for a Property gtk.gdk.Event

gtk.gdk.PROPERTY_NEW_VALUE

the property value was changed.

gtk.gdk.PROPERTY_DELETE

the property was deleted.

GDK RGB Dither Constants

The RGB Dither constants specify the type of dithering to apply to the image on display.

gtk.gdk.RGB_DITHER_NONE

Never use dithering.

gtk.gdk.RGB_DITHER_NORMAL

Use dithering in 8 bits per pixel (and below) only.

gtk.gdk.RGB_DITHER_MAX

Use dithering in 16 bits per pixel and below.

GDK Scroll Direction Constants

The Scroll Direction constants specify the direction for the Scroll.gtk.gdk.Event

gtk.gdk.SCROLL_UP

the window is scrolled up.

gtk.gdk.SCROLL_DOWN

the window is scrolled down.

gtk.gdk.SCROLL_LEFT

the window is scrolled to the left.

gtk.gdk.SCROLL_RIGHT

the window is scrolled to the right.

GDK Setting Action Constants

The Setting Action constants specify the kind of modification applied to a setting in a Setting gtk.gdk.Event

gtk.gdk.SETTING_ACTION_NEW

A setting was added.

gtk.gdk.SETTING_ACTION_CHANGED

A setting was changed.

gtk.gdk.SETTING_ACTION_DELETED

A setting was deleted.

GDK Subwindow Mode Constants

The Subwindow Mode constants specify how drawing onto a window will affect child windows of that window.

gtk.gdk.CLIP_BY_CHILDREN

only draw onto the window itself not the subwindows.

gtk.gdk.INCLUDE_INFERIORS

draw onto the window and child windows.

GDK Visibility State Constants

The Visibility State constants specify the visibility status of a window for the Visibility gtk.gdk.Event

gtk.gdk.VISIBILITY_UNOBSCURED

the window is completely visible.

gtk.gdk.VISIBILITY_PARTIAL

the window is partially visible.

gtk.gdk.VISIBILITY_FULLY_OBSCURED

the window is not visible at all.

GDK Visual Type Constants

The Visual Type constants specify a set of values that describe the manner in which the pixel values for a visual are converted into RGB values for display.

gtk.gdk.VISUAL_STATIC_GRAY

Each pixel value indexes a grayscale value directly.

gtk.gdk.VISUAL_GRAYSCALE

Each pixel is an index into a color map that maps pixel values into grayscale values. The color map can be changed by an application.

gtk.gdk.VISUAL_STATIC_COLOR

Each pixel value is an index into a predefined, unmodifiable color map that maps pixel values into RGB values.

gtk.gdk.VISUAL_PSEUDO_COLOR

Each pixel is an index into a color map that maps pixel values into rgb values. The color map can be changed by an application.

gtk.gdk.VISUAL_TRUE_COLOR

Each pixel value directly contains red, green, and blue components. The red_mask, green_mask, and blue_mask fields of the gtk.gdk.Visual structure describe how the components are assembled into a pixel value.

gtk.gdk.VISUAL_DIRECT_COLOR

Each pixel value contains red, green, and blue components as for gtk.gdk.TRUE_COLOR, but the components are mapped via a color table into the final output table instead of being converted directly.

GDK Window Class Constants

The Window Class constants specify the class of window. gtk.gdk.INPUT_OUTPUT windows are the standard kind of window you might expect. gtk.gdk.INPUT_ONLY windows are invisible; they are used to trap events, but you can't draw on them.

gtk.gdk.INPUT_OUTPUT

A window for graphics and events.

gtk.gdk.INPUT_ONLY

A window for events only.

GDK Window Edge Constants

The Window Edge constants specify window edge or corner.

gtk.gdk.WINDOW_EDGE_NORTH_WEST

The top left corner.

gtk.gdk.WINDOW_EDGE_NORTH

The top edge.

gtk.gdk.WINDOW_EDGE_NORTH_EAST

The top right corner.

gtk.gdk.WINDOW_EDGE_WEST

The left edge.

gtk.gdk.WINDOW_EDGE_EAST

The right edge.

gtk.gdk.WINDOW_EDGE_SOUTH_WEST

The lower left corner.

gtk.gdk.WINDOW_EDGE_SOUTH

The lower edge.

gtk.gdk.WINDOW_EDGE_SOUTH_EAST

The lower right corner.

GDK Window Hints Constants

The Window Hints constants specify the fields of a GdkGeometry struct should be paid attention to. Also, the presence/absence of gtk.gdk.HINT_POS, gtk.gdk.HINT_USER_POS, and gtk.gdk.HINT_USER_SIZE is significant, though they don't directly refer to GdkGeometry fields. gtk.gdk.HINT_USER_POS will be set automatically by gtk.Window if you call the gtk.Window.move() method. gtk.gdk.HINT_USER_POS and gtk.gdk.HINT_USER_SIZE should be set if the user specified a size/position using a --geometry command-line argument; the gtk.Window.parse_geometry() method automatically sets these flags. These constants aren't useful in PyGTK.

gtk.gdk.HINT_POS

Indicates that the program has positioned the window

gtk.gdk.HINT_MIN_SIZE

Min size fields are set

gtk.gdk.HINT_MAX_SIZE

Max size fields are set

gtk.gdk.HINT_BASE_SIZE

Base size fields are set

gtk.gdk.HINT_ASPECT

Aspect ratio fields are set

gtk.gdk.HINT_RESIZE_INC

Resize increment fields are set

gtk.gdk.HINT_WIN_GRAVITY

Window gravity field is set

gtk.gdk.HINT_USER_POS

Indicates that the window's position was explicitly set by the user

gtk.gdk.HINT_USER_SIZE

Indicates that the window's size was explicitly set by the user

GDK Window State Flag Constants

The Window State flag constants are a set of bit-flags that specify the state of a toplevel window.

gtk.gdk.WINDOW_STATE_WITHDRAWN

The window is not shown.

gtk.gdk.WINDOW_STATE_ICONIFIED

The window is minimized.

gtk.gdk.WINDOW_STATE_MAXIMIZED

The window is maximized.

gtk.gdk.WINDOW_STATE_STICKY

The window is sticky.

gtk.gdk.WINDOW_STATE_FULLSCREEN

The window is maximized without decorations. Available in PyGTK 2.2 and above.

gtk.gdk.WINDOW_STATE_ABOVE

The window is kept above other windows. Available in PyGTK 2.4 and above.

gtk.gdk.WINDOW_STATE_BELOW

The window is kept below other windows. Available in PyGTK 2.4 and above.

GDK Window Type Constants

The Window Type constants specify the type of window.

gtk.gdk.WINDOW_ROOT

The root window; this window has no parent, covers the entire screen, and is created by the window system.

gtk.gdk.WINDOW_TOPLEVEL

A toplevel window (used to implement gtk.Window).

gtk.gdk.WINDOW_CHILD

A child window (used to implement widgets e.g. gtk.Entry).

gtk.gdk.WINDOW_DIALOG

A useless/deprecated compatibility type.

gtk.gdk.WINDOW_TEMP

An override redirect temporary window (used to implement gtk.Menu).

gtk.gdk.WINDOW_FOREIGN

A foreign window (see the gtk.gdk.window_foreign_new() function).

GDK Window Type Hint Constants

The Window Type Hint constants specify hints for the window manager that indicate what type of function the window has. The window manager can use this when determining decoration and behavior of the window. The hint must be set before mapping the window.

gtk.gdk.WINDOW_TYPE_HINT_NORMAL

A normal toplevel window.

gtk.gdk.WINDOW_TYPE_HINT_DIALOG

A dialog window.

gtk.gdk.WINDOW_TYPE_HINT_MENU

A window used to implement a menu.

gtk.gdk.WINDOW_TYPE_HINT_TOOLBAR

A window used to implement a toolbar.

gtk.gdk.WINDOW_TYPE_HINT_SPLASHSCREEN

A window used to implement a splash screen

gtk.gdk.WINDOW_TYPE_HINT_UTILITY

gtk.gdk.WINDOW_TYPE_HINT_DOCK

A window used to implement a docking bar.

gtk.gdk.WINDOW_TYPE_HINT_DESKTOP

A window used to implement a desktop.

GDK WM Decoration Constants

The WM Decoration constants are bit-flags that specify the hints that the window manager can use when determining how to decorate the window. The hints must be set before mapping the window.

gtk.gdk.DECOR_ALL

All decorations should be applied.

gtk.gdk.DECOR_BORDER

A frame should be drawn around the window.

gtk.gdk.DECOR_RESIZEH

The frame should have resize handles.

gtk.gdk.DECOR_TITLE

A titlebar should be placed above the window.

gtk.gdk.DECOR_MENU

A button for opening a menu should be included.

gtk.gdk.DECOR_MINIMIZE

A minimize button should be included.

gtk.gdk.DECOR_MAXIMIZE

A maximize button should be included.

GDK WM Function Constants

The WM Function constants specify hints originally defined by the Motif toolkit. The window manager can use them when determining the functions to offer for the window. The hint must be set before mapping the window.

gtk.gdk.FUNC_ALL

All functions should be offered.

gtk.gdk.FUNC_RESIZE

The window should be resizable.

gtk.gdk.FUNC_MOVE

The window should be movable.

gtk.gdk.FUNC_MINIMIZE

The window should be minimizable.

gtk.gdk.FUNC_MAXIMIZE

The window should be maximizable.

gtk.gdk.FUNC_CLOSE

The window should be closeable.
Prev Up Next
gtk.gdk Functions Home The gtk.glade Class Reference
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/pygtk-introduction.html0000644000000000000000000004051411272037113024373 0ustar rootrootIntroduction
Introduction
Prev   Next

Introduction

Table of Contents

Major Changes since Version 1.9
Reference Page Format

This document describes most of the PyGTK version 2.0 through 2.10 classes and their methods and associated functions. Deprecated classes, functions and methods have been specifically left out of this reference though classes that have become deprecated since PyGTK 2.0 have been left in but annotated with a deprecation warning. This document attempts to document as much of the PyGTK API as possible but there are undoubtedly errors and omissions. If you discover any of these please file a bug report at bugzilla.gnome.org for the pygtk project. Specific areas that have not been documented include:

  • The Cairo classes

This reference describes the API for PyGTK as of version 2.9.0+ and assumes that the additional API changes for version 2.10 may not be significant. There will undoubtedly be changes that are not reflected in this reference. The differences in the API between version 2.0 and previous versions are denoted in this reference with a Note that describes the availability of the object, constructor, method or function. Any of these that do not have a notation can be assumed to be available in all versions of PyGTK from 2.0 and up. In the case of properties and signals the availability is dependent on the version of the underlying GTK+, GDK or Pango libraries. These will be annotated appropriately in a similar fashion. The source code must be consulted if this reference and your version of PyGTK seem to differ. You are encouraged to use the latest version of PyGTK that is available. See the PyGTK homepage for more information and more resources on how to use PyGTK as well as help in its development.

The Reference contains a chapter for each PyGTK module (that corresponds to the underlying GTK+ library) containing the class descriptions. The second chapter illustrates the PyGTK class hierarchy covering the gobject, gtk, gtk.gdk and pango modules.

The class descriptions are arranged alphabetically within the chapters. Currently there are five module chapters:

The atk module

The classes that are included in the atk module of PyGTK and are accessed similar to: atk.Object. These classes are the base object classes that provide accessibility support for the gtk module classes.

The gtk module

The classes that are included in the gtk module of PyGTK and are accessed similar to: gtk.Widget. These classes are the "higher" level widget classes that provide most of the user interface widgets used for application development.

The gtk.gdk module

The classes that are included in the gtk.gdk module of PyGTK. These classes are "lower" level classes that provide more fundamental capabilities that the gtk module widgets are built upon. These classes provide an abstract interface to the underlying window system (either X Window System or Microsoft Windows).

The gtk.glade module

The classes that are included in the gtk.glade module of PyGTK. These classes provide access to the libglade functions that allow the dynamic loading of user interfaces from XML descriptions.

The pango module

The classes that are included in the pango module of PyGTK. These classes provide access to the Pango text layout and rendering engines. PyGTK supports a subset of the full Pango capability: mainly the high level layout capabilities exposed by the pango.Layout objects. The low level rendering capabilities have not been exposed mostly because there isn't a full GObject interface to the underlying Pango data structures. It's also likely that the rendering capabilities require more performance that Python can provide.

The gobject module is documented in the PyGObject Reference Manual.

Major Changes since Version 1.9

The major changes in this document since version 1.9 include:

Prev   Next
PyGTK 2.0 Reference Manual Home Reference Page Format
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkwindowgroup.html0000644000000000000000000001616211272037113024715 0ustar rootrootgtk.WindowGroup
gtk.WindowGroup
Prev The gtk Class Reference Next

gtk.WindowGroup

gtk.WindowGroup — a group of gtk.Window widgets

Synopsis

class gtk.WindowGroup(gobject.GObject):
    gtk.WindowGroup()
    def add_window(window)
    def remove_window(window)

Ancestry

+-- gobject.GObject
  +-- gtk.WindowGroup

gtk.WindowGroup Signal Prototypes

gobject.GObject Signal Prototypes

Description

A gtk.WindowGroup object contains a set of gtk.Window widgets that are managed together by some PyGTK functions and methods.

Constructor

    gtk.WindowGroup()

Returns :

a new gtk.WindowGroup.

Creates a new gtk.WindowGroup object. Grabs added with gtk.Widget.grab_add() only affect windows within the same gtk.WindowGroup.

Methods

gtk.WindowGroup.add_window

    def add_window(window)

window :

the gtk.Window to add

The add_window() method adds the gtk.Window specified by window to the windowgroup.

gtk.WindowGroup.remove_window

    def remove_window(window)

window :

the gtk.Window to remove

The remove_window() method removes the gtk.Window specified by window from the windowgroup.

Prev Up Next
gtk.Window Home gtk Functions
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcalendar.html0000644000000000000000000013342211272037113024101 0ustar rootrootgtk.Calendar
gtk.Calendar
Prev The gtk Class Reference Next

gtk.Calendar

gtk.Calendar — a widget that displays a calendar and allows the user to select a date.

Synopsis

class gtk.Calendar(gtk.Widget):
    gtk.Calendar()
    def select_month(month, year)
    def select_day(day)
    def mark_day(day)
    def unmark_day(day)
    def clear_marks()
    def get_display_options()
    def set_display_options(flags)
    def get_detail_height_rows()
    def set_detail_height_rows(rows)
    def get_detail_width_chars()
    def set_detail_width_chars(chars)
    def display_options(flags)
    def get_date()
    def freeze()
    def thaw()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Calendar

Implemented Interfaces

gtk.Calendar implements gtk.Buildable

gtk.Calendar Properties

gtk.Object Properties

gtk.Widget Properties

Note

These properties are available in GTK+ 2.4 and above.

"day"Read-WriteThe selected day (as a number between 1 and 31, or 0 to unselect the currently selected day).
"detail-height-rows"Read-WriteHeight of a detail cell, in rows. A value of 0 allows any width. See gtk_calendar_set_detail_func(). Allowed values: [0,127]. Default value: 0 .This property is available in GTK+ 2.14 and above.
"detail-width-chars"Read-WriteWidth of a detail cell, in characters. A value of 0 allows any width. See gtk_calendar_set_detail_func(). Allowed values: [0,127] Default value: 0. This property is available in GTK+ 2.14 and above.
"month"Read-WriteThe selected month (as a number between 0 and 11).
"no-month-change"Read-WriteIf True the selected month cannot be changed.
"show-day-names"Read-WriteIf True, day names are displayed.
"show-details"Read-WriteDetermines whether details are shown directly in the widget, or if they are available only as tooltip. When this property is set days with details are marked. Default value: True. This property is available in GTK+ 2.14 and above.
"show-heading"Read-WriteIf True, a heading is displayed.
"show-week-numbers"Read-WriteIf True, week numbers are displayed.
"year"Read-WriteThe selected year.

gtk.Calendar Style Properties

gtk.Widget Style Properties

gtk.Calendar Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

"day-selected"

 def callback(calendar, user_param1, ...)

"day-selected-double-click"

 def callback(calendar, user_param1, ...)

"month-changed"

 def callback(calendar, user_param1, ...)

"next-month"

 def callback(calendar, user_param1, ...)

"next-year"

 def callback(calendar, user_param1, ...)

"prev-month"

 def callback(calendar, user_param1, ...)

"prev-year"

 def callback(calendar, user_param1, ...)

Description

The gtk.Calendar is a widget that displays a simple calendar, one month at a time. In addition, the calendar can display the days of the week and navigation controls that allow a user to change the month and year displayed by calling the display_options() (set_display_options() in PyGTK 2.4 and above) method. The possible display options are:

gtk.CALENDAR_SHOW_HEADING

Specifies that the month and year should be displayed.

gtk.CALENDAR_SHOW_DAY_NAMES

Specifies that three letter day descriptions should be present.

gtk.CALENDAR_NO_MONTH_CHANGE

Prevents the user from switching months with the calendar.

gtk.CALENDAR_SHOW_WEEK_NUMBERS

Displays each week numbers of the current year, down the left side of the calendar.

gtk.CALENDAR_WEEK_START_MONDAY

Starts the calendar week on Monday, instead of the default Sunday.

The month and year currently displayed are programatically changed by calling the select_month() method. The exact day is selected from the displayed month using the select_day() method.

To place a visual marker on a particular day, use the mark_day() method and to remove the marker, the unmark_day() method. All marks are cleared by calling the clear_marks() method.

The selected date can be retrieved from a gtk.Calendar using the get_date() method. If performing many 'mark' operations, the calendar can be frozen to prevent flicker, using the freeze() method, and 'thawed' again using the thaw() method.

Note

Note that month is zero-based (i.e it allowed values are 0-11) while selected_day is one-based (i.e. allowed values are 1-31).

Constructor

    gtk.Calendar()

Returns :

a calendar object

Creates a calendar object that displays the current month and year with the current day selected. The default calendar display style is: gtk.CALENDAR_SHOW_HEADING | gtk.CALENDAR_SHOW_DAY_NAMES that shows the days of the week and the month and year heading with navigation controls.

Methods

gtk.Calendar.select_month

    def select_month(month, year)

month :

the new month number between 0 and 11

year :

the new year number

Returns :

True if the month is set

The select_month() method changes the calendar display to the specified month and year.

gtk.Calendar.select_day

    def select_day(day)

day :

the new day number between 1 and 31 - 0 removes the current selection

The select_day() method selects the specified day on the calendar when day has a value between 1 and 31. If day is 0 then the current day selection is removed.

gtk.Calendar.mark_day

    def mark_day(day)

day :

the number of the day to be marked

Returns :

True

The mark_day() method marks the specified month day with a visual marker (typically by making the number bold). If the calendar month and year are changed the marked days remain marked.

gtk.Calendar.unmark_day

    def unmark_day(day)

day :

the number of the day to be unmarked

Returns :

True

The unmark_day() method unmarks the specified month day.

gtk.Calendar.clear_marks

    def clear_marks()

The clear_marks() method clears all marked days.

gtk.Calendar.get_display_options

    def get_display_options()

Returns :

the calendar display options

Note

This method is available in PyGTK 2.4 and above.

The get_display_options() method returns the current calendar display options. See the set_display_options() method for more information.

gtk.Calendar.set_display_options

    def set_display_options(flags)

flags :

the new calendar display options

Note

This method is available in PyGTK 2.4 and above.

The set_display_options() method sets the calendar display options to the value specified by flags. The possible display options are a combination of:

gtk.CALENDAR_SHOW_HEADING

Specifies that the month and year should be displayed.

gtk.CALENDAR_SHOW_DAY_NAMES

Specifies that three letter day descriptions should be present.

gtk.CALENDAR_NO_MONTH_CHANGE

Prevents the user from switching months with the calendar.

gtk.CALENDAR_SHOW_WEEK_NUMBERS

Displays each week numbers of the current year, down the left side of the calendar.

gtk.CALENDAR_WEEK_START_MONDAY

Starts the calendar week on Monday, instead of the default Sunday.

The display options can be removed by passing 0 as the value of flags.

gtk.Calendar.get_detail_height_rows

    def get_detail_height_rows()

Returns :

The height of detail cells, in rows.

Note

This method is available in PyGTK 2.14 and above.

The get_detail_height_rows() method queries the height of detail cells, in rows. See the "detail-width-chars" property.

gtk.Calendar.set_detail_height_rows

    def set_detail_height_rows(rows)

rows :

detail height in rows.

Note

This method is available in PyGTK 2.14 and above.

The set_detail_height_rows() method updates the height of detail cells. See the "detail-height-rows" property.

gtk.Calendar.get_detail_width_chars

    def get_detail_width_chars()

Returns :

The width of detail cells, in characters.

Note

This method is available in PyGTK 2.14 and above.

The get_detail_width_chars() method queries the width of detail cells, in characters. See the "detail-width-chars" property.

gtk.Calendar.set_detail_width_chars

    def set_detail_width_chars(chars)

chars :

detail width in characters.

Note

This method is available in PyGTK 2.14 and above.

The set_detail_width_chars() method updates the width of detail cells. See the "detail-width-chars" property.

gtk.Calendar.display_options

    def display_options(flags)

flags :

the new calendar display options

Warning

This method is deprecated in PyGTK 2.4 and should be replaced by the set_display_options() method.

The display_options() method sets the calendar display options to the value specified by flags. The possible display options are a combination of:

gtk.CALENDAR_SHOW_HEADING

Specifies that the month and year should be displayed.

gtk.CALENDAR_SHOW_DAY_NAMES

Specifies that three letter day descriptions should be present.

gtk.CALENDAR_NO_MONTH_CHANGE

Prevents the user from switching months with the calendar.

gtk.CALENDAR_SHOW_WEEK_NUMBERS

Displays each week numbers of the current year, down the left side of the calendar.

gtk.CALENDAR_WEEK_START_MONDAY

Starts the calendar week on Monday, instead of the default Sunday.

The display options can be removed by passing 0 as the value of flags.

gtk.Calendar.get_date

    def get_date()

Returns :

a tuple containing the year, month and day

The get_date() method retrieves the calendar's current year, month and selected day numbers as a tuple (year, month, day).

Note

Note that month is zero-based (i.e it allowed values are 0-11) while selected_day is one-based (i.e. allowed values are 1-31).

gtk.Calendar.freeze

    def freeze()

The freeze() method stops the update of the calendar display until the thaw() method is called. This method is used to reduce calendar flicker when doing a large number of updates to the calendar.

gtk.Calendar.thaw

    def thaw()

The thaw() method reenables the update of the calendar after a freeze() method is called. All changes made since the last freeze() are displayed

Signals

The "day-selected" gtk.Calendar Signal

    def callback(calendar, user_param1, ...)

calendar :

the calendar that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "day-selected" signal is emitted when a day is selected either by the user or programatically.

The "day-selected-double-click" gtk.Calendar Signal

    def callback(calendar, user_param1, ...)

calendar :

the calendar that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "day-selected-double-click" signal is emitted when a calendar day is doubled-clicked by the user.

The "month-changed" gtk.Calendar Signal

    def callback(calendar, user_param1, ...)

calendar :

the calendar that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "month-changed" signal is emitted when the calendar month is changed programatically or by the user.

The "next-month" gtk.Calendar Signal

    def callback(calendar, user_param1, ...)

calendar :

the calendar that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "next-month" signal is emitted when the user clicks the "next-month" navigation control in the calendar header.

The "next-year" gtk.Calendar Signal

    def callback(calendar, user_param1, ...)

calendar :

the calendar that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "next-year" signal is emitted when the user clicks the "next-year" navigation control in the calendar header.

The "prev-month" gtk.Calendar Signal

    def callback(calendar, user_param1, ...)

calendar :

the calendar that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "prev-month" signal is emitted when the user clicks the "prev-month" navigation control in the calendar header.

The "prev-year" gtk.Calendar Signal

    def callback(calendar, user_param1, ...)

calendar :

the calendar that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "prev-year" signal is emitted when the user clicks the "prev-year" navigation control in the calendar header.

Prev Up Next
gtk.ButtonBox Home gtk.CellEditable
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkexpander.html0000644000000000000000000010067711272037113024144 0ustar rootrootgtk.Expander
gtk.Expander
Prev The gtk Class Reference Next

gtk.Expander

gtk.Expander — a container that can hide its child (new in PyGTK 2.4)

Synopsis

class gtk.Expander(gtk.Bin):
    gtk.Expander(label=None)
    def set_expanded(expanded)
    def get_expanded()
    def set_spacing(spacing)
    def get_spacing()
    def set_label(label)
    def get_label()
    def set_use_underline(use_underline)
    def get_use_underline()
    def set_use_markup(use_markup)
    def get_use_markup()
    def set_label_widget(label_widget)
    def get_label_widget()
Functions

    def gtk.expander_new_with_mnemonic(label=None)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Expander

Implemented Interfaces

gtk.Expander implements gtk.Buildable

gtk.Expander Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"expanded"Read-WriteIf True, the expander has been opened to reveal the child widget.
"label"Read-WriteThe text of the expander's label.
"label-widget"Read-WriteA widget to display in place of the usual expander label.
"spacing"Read-WriteThe space to put between the label and the child.
"use-markup"Read-WriteIf True, the text of the label includes Pango markup. See the pango.parse_markup() function.
"use-underline"Read-WriteIf True, n underline in the text indicates the next character should be used for the mnemonic accelerator key.

gtk.Expander Style Properties

gtk.Widget Style Properties

"expander-size"ReadThe size of the expander arrow.
"expander-spacing"ReadThe spacing around expander arrow.

gtk.Expander Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

"activate"

 def callback(expander, user_param1, ...)

Description

Note

This widget is available in PyGTK 2.4 and above.

A gtk.Expander allows the user to hide or show its child by clicking on an expander triangle similar to the triangles used in a gtk.TreeView.

Normally you use an expander as you would use any other descendant of gtk.Bin; you create the child widget and use gtk.Container.add() to add it to the expander. When the expander is toggled, it will take care of showing and hiding the child automatically.

Special Usage

There there are situations in which you may prefer to show and hide the expanded widget yourself, such as when you want to actually create the widget at expansion time. In this case, create a gtk.Expander but do not add a child to it. The expander widget has the "expanded" property that can be used to monitor its expansion state. You should watch this property with a signal connection as follows:

  expander = gtk.expander_new_with_mnemonic("_More Options")
  expander.connect("notify::expanded", expander_callback)

  ...

  def expander_callback(expander, param_spec, user_data):
    if expander.get_expanded():
      # Show or create widgets
    else:
      # Hide or destroy widgets

The "activate" signal can also be used to track the expansion though it occurs before the "expanded" property is changed so the logic of the expander_callback() function would have to be reversed.

Constructor

    gtk.Expander(label=None)

label :

the text of the label or None

Returns :

a new gtk.Expander widget.

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new expander using label as the text of the label. If label is None or not specified, no label will be created.

Methods

gtk.Expander.set_expanded

    def set_expanded(expanded)

expanded :

if True, the child widget is revealed

Note

This method is available in PyGTK 2.4 and above.

The set_expanded() method sets the "expanded" property to the value of expanded. If expanded is True, the child widget is revealed; if False, the child widget is hidden.

gtk.Expander.get_expanded

    def get_expanded()

Returns :

True if the child is revealed.

Note

This method is available in PyGTK 2.4 and above.

The get_expanded() method returns the value of the "expanded" property. If "expanded" is True the child widget is revealed.

gtk.Expander.set_spacing

    def set_spacing(spacing)

spacing :

the distance between the expander and child in pixels.

Note

This method is available in PyGTK 2.4 and above.

The set_spacing() method sets the "spacing" property to the value of spacing that sets is the number of pixels to place between expander and the child.

gtk.Expander.get_spacing

    def get_spacing()

Returns :

the spacing between the expander and child.

Note

This method is available in PyGTK 2.4 and above.

The get_spacing() method returns the value of the "spacing" property set by the set_spacing() method.

gtk.Expander.set_label

    def set_label(label)

label :

a string to use as the label or None

Note

This method is available in PyGTK 2.4 and above.

The set_label() method sets the "label" property to the value of label and sets the text of the label of the expander. Any previously set label will be cleared. If label is None the expander will have no label.

gtk.Expander.get_label

    def get_label()

Returns :

the text of the label widget.

Note

This method is available in PyGTK 2.4 and above.

The get_label() method returns the value of the "label" property that contains the text of the expander label, as set by the set_label() method. If the label text has not been set the return value will be None.

gtk.Expander.set_use_underline

    def set_use_underline(use_underline)

use_underline :

True if underlines in the text indicate mnemonics

Note

This method is available in PyGTK 2.4 and above.

The set_use_underline() method sets the "use_underline" property to the value of use_underline. If use_underline is True, an underline in the text of the expander label indicates the next character should be used for the mnemonic accelerator key.

gtk.Expander.get_use_underline

    def get_use_underline()

Returns :

True if an embedded underline in the expander label indicates the mnemonic accelerator keys.

Note

This method is available in PyGTK 2.4 and above.

The get_use_underline() method returns the value of the "use-underline" property. If "use-underline" is True an embedded underline in the expander label indicates a mnemonic. See the set_use_underline() method.

gtk.Expander.set_use_markup

    def set_use_markup(use_markup)

use_markup :

if True, the label's text should be parsed for markup

Note

This method is available in PyGTK 2.4 and above.

The set_use_markup() method sets the "use-markup" property to the value of use_markup. If use_markup is True the text of the label contains markup in the Pango text markup language. See the gtk.Label.set_markup() method for more information.

gtk.Expander.get_use_markup

    def get_use_markup()

Returns :

True if the label's text will be parsed for markup

Note

This method is available in PyGTK 2.4 and above.

The get_use_markup() method returns the value of the "use-markup" property. If "use-markup" is True, the label's text is interpreted as marked up with the Pango text markup language. See the set_use_markup() method.

gtk.Expander.set_label_widget

    def set_label_widget(label_widget)

label_widget :

the new label widget or None

Note

This method is available in PyGTK 2.4 and above.

The set_label_widget() method sets the expander to use the widget specified by label_widget as the label instead of a gtk.Label. This widget appears embedded alongside the expander arrow. If label_widget is None, the expander will have no label.

gtk.Expander.get_label_widget

    def get_label_widget()

Returns :

the label widget, or None if there is none.

Note

This method is available in PyGTK 2.4 and above.

The get_label_widget() method retrieves the expander's label widget. See the set_label_widget() method.

Functions

gtk.expander_new_with_mnemonic

    def gtk.expander_new_with_mnemonic(label=None)

label :

 the text of the label with an underscore in front of the mnemonic character or None

Returns :

 a new gtk.Expander widget.

Note

This function is available in PyGTK 2.4 and above.

The gtk.expander_new_with_mnemonic() function creates a new gtk.Expander using label as the text of the label. If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use '__' (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt with that key activates the button. If label is None the expander will have no label.

Signals

The "activate" gtk.Expander Signal

    def callback(expander, user_param1, ...)

expander :

the expander that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.4 and above.

The "activate" signal is emitted when the expander is activated by the user clicking on the expander toggle. Using the "notify:expanded" signal may be more appropriate in some cases as noted in the Special Usage description.

Prev Up Next
gtk.EventBox Home gtk.FileChooser
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangolayout.html0000644000000000000000000016437211272037113024174 0ustar rootrootpango.Layout
pango.Layout
Prev The pango Class Reference Next

pango.Layout

pango.Layout — an object representing a paragraph of text with attributes.

Synopsis

class pango.Layout(gobject.GObject):
    pango.Layout(context)
    def copy()
    def get_context()
    def set_attributes(attrs)
    def get_attributes()
    def set_text(text)
    def get_text()
    def set_markup(markup)
    def set_markup_with_accel(markup, accel_marker)
    def get_font_description()
    def set_font_description(desc)
    def set_width(width)
    def get_width()
    def set_wrap(wrap)
    def get_wrap()
    def set_indent(indent)
    def get_indent()
    def set_spacing(spacing)
    def get_spacing()
    def set_justify(justify)
    def get_justify()
    def set_alignment(alignment)
    def get_alignment()
    def set_tabs(tabs)
    def get_tabs()
    def set_single_paragraph_mode(setting)
    def get_single_paragraph_mode()
    def context_changed()
    def index_to_pos(index)
    def get_cursor_pos(index)
    def move_cursor_visually(strong, old_index, old_trailing, direction)
    def xy_to_index(x, y)
    def get_extents()
    def get_pixel_extents()
    def get_size()
    def get_pixel_size()
    def get_line_count()
    def get_line(line)
    def get_iter()

Ancestry

+-- gobject.GObject
  +-- pango.Layout

Description

A pango.Layout object represents a paragraph of text with a pango.Context, a UTF-8 text string and a set of attributes for that string. The set of formatted lines can be extracted from the object, the layout can be rendered, and conversion between logical character positions within the layout's text, and the physical position of the resulting glyphs can be made. Also there are a number of attributes that adjust the formatting of the layout.

Constructor

    pango.Layout(context)

context :

a pango.Context

Returns :

a new pango.Layout.

Creates a new pango.Layout object with attributes initialized to the default values of the pango.Context specified by context.

Methods

pango.Layout.copy

    def copy()

Returns :

a new pango.Layout that is a copy of the layout

The copy() method returns a pango.Layout that is a deep copy-by-value of the layout. The attribute list, tab array, and text from the layout are all copied by value.

pango.Layout.get_context

    def get_context()

Returns :

the pango.Context for the layout.

The get_context() method returns the pango.Context used for this layout.

pango.Layout.set_attributes

    def set_attributes(attrs)

attrs :

a pango.AttrList

The set_attributes() method sets the pango.AttrList for the layout object to the value specified by attrs.

pango.Layout.get_attributes

    def get_attributes()

Returns :

a pango.AttrList

The get_attributes() method returns the pango.AttrList for the layout, if any.

pango.Layout.set_text

    def set_text(text)

text :

a UTF8-string

The set_text() method sets the text of the layout to the value specified by text.

pango.Layout.get_text

    def get_text()

Returns :

the text in the layout

The get_text() method returns the text in the layout.

pango.Layout.set_markup

    def set_markup(markup)

markup :

marked-up text

The set_markup() method is the same as the set_markup_with_accel() method but the markup text isn't scanned for accelerators.

pango.Layout.set_markup_with_accel

    def set_markup_with_accel(markup, accel_marker)

markup :

some marked-up text (see the Pango Markup Language reference page)

accel_marker :

marker for accelerators in the text

Returns :

the accelerator character if any

The set_markup_with_accel() method sets the layout text and attribute list from marked-up text to the value specified by markup_format (see the Pango Markup Language reference page). The current text and attribute list of the layout are replaced. If accel_marker is nonzero the markup will be parsed for the marker and the character following the first marker becomes the accelerator character. For example, if the accelerator marker is an underscore, the character after the first underscore will be the accelerator character. All characters marked as an accelerator will be displayed with a pango.UNDERLINE_LOW attribute, and the accelerator character will be returned in accel_char. A literal accel_marker character can be put in the markup by using two accel_marker characters together.

pango.Layout.get_font_description

    def get_font_description()

Returns :

the layout's font description, or None if the font description from the layout's context is inherited.

The get_font_description() method returns the font description for the layout, if any

pango.Layout.set_font_description

    def set_font_description(desc)

desc :

the new pango.FontDescription, or None to unset the current font description.

The set_font_description() method set the default pango.FontDescription for the layout to the value specified by desc. If no font description is set on the layout, the font description from the layout's context is used.

pango.Layout.set_width

    def set_width(width)

width :

the desired width, or -1 to indicate that no wrapping should be performed.

The set_width() method sets the wrap width for the lines of the pango.Layout to the value specified by width. If the value of width is -1 no wrapping should be performed.

pango.Layout.get_width

    def get_width()

Returns :

the width

The get_width() method returns the width at which the lines of the pango.Layout should be wrapped.

pango.Layout.set_wrap

    def set_wrap(wrap)

wrap :

the wrap mode

The set_wrap() method sets the wrap style to the value specified by wrap. The value of wrap must be one of:

pango.WRAP_WORD

Wrap lines at word boundaries.

pango.WRAP_WORD_CHAR

wrap lines at word boundaries, but fall back to character boundaries if there is not enough space for a full word.

pango.WRAP_CHAR

Wrap lines at character boundaries.

The wrap style is in effect if a width is set on the layout with the pango.Layout.set_width(). To turn off wrapping, set the width to -1.

pango.Layout.get_wrap

    def get_wrap()

Returns :

Active wrap mode.

The get_wrap() method returns the value of the wrap mode for the layout. See the set_wrap() method for more information.

pango.Layout.set_indent

    def set_indent(indent)

indent :

the amount by which to indent

The set_indent() method sets the indentation of the first line of the layout to the value specified by indent. The value of indent may be negative to provide a hanging indent.

pango.Layout.get_indent

    def get_indent()

Returns :

the indent

The get_indent() method returns the amount of indentation of the first line of the layout.

pango.Layout.set_spacing

    def set_spacing(spacing)

spacing :

the amount of spacing (in 1/pango.SCALE of a device unit)

The set_spacing() method sets the amount of spacing between the lines of the layout to the value specified by spacing.

pango.Layout.get_spacing

    def get_spacing()

Returns :

the spacing (in 1/pango.SCALE of a device unit)

The get_spacing() method returns the amount of spacing between the lines of the layout.

pango.Layout.set_justify

    def set_justify(justify)

justify :

if True the lines in the layout should be justified.

The set_justify() method sets the justification attribute to the value of justify. If justify is True each complete line should be stretched to fill the entire width of the layout. This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.

pango.Layout.get_justify

    def get_justify()

Returns :

True if justification will be used

The get_justify() method returns True if each complete line should be stretched to fill the entire width of the layout.

pango.Layout.set_alignment

    def set_alignment(alignment)

alignment :

the new alignment

The set_alignment() method sets the alignment (how partial lines are positioned within the horizontal space available) for the layout to the value specified by alignment. The value of alignment must be one of:

pango.ALIGN_LEFT

Put all available space on the right

pango.ALIGN_CENTER

Center the line within the available space

pango.ALIGN_RIGHT

Put all available space on the left

pango.Layout.get_alignment

    def get_alignment()

Returns :

the alignment value

The get_alignment() method returns the alignment (how partial lines are positioned within the horizontal space available) for the layout. See the set_alignment() method for more information.

pango.Layout.set_tabs

    def set_tabs(tabs)

tabs :

a pango.TabArray

The set_tabs() method sets the tabs to the value specified by tabs thereby overriding the default tabs (every 8 spaces). If tabs is None, the default tabs are reinstated.

pango.Layout.get_tabs

    def get_tabs()

Returns :

a copy of the tabs for this layout, or None

The get_tabs() method returns the current pango.TabArray used by this layout. If no pango.TabArray has been set, then the default tabs (every 8 spaces) are in use and None is returned

pango.Layout.set_single_paragraph_mode

    def set_single_paragraph_mode(setting)

setting :

if True newlines, etc. are not treated as paragraph separators.

The set_single_paragraph_mode() method sets the single paragraph mode attribute to the value specified by setting. If setting is True, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. Used when you want to allow editing of newlines on a single text line.

pango.Layout.get_single_paragraph_mode

    def get_single_paragraph_mode()

Returns :

True if the layout does not break paragraphs at paragraph separator characters

The get_single_paragraph_mode() method returns the value set by the set_single_paragraph_mode() method.

pango.Layout.context_changed

    def context_changed()

The context_changed() method forces recomputation of any state in the pango.Layout that might depend on the layout's context. This method should be called if you make changes to the pango.Context subsequent to creating the layout.

pango.Layout.index_to_pos

    def index_to_pos(index)

index :

byte index within the layout

Returns :

a 4-tuple representing the grapheme's position

The index_to_pos() method converts from the specified index within a pango.Layout to the onscreen position corresponding to the grapheme at that index, which is represented as a 4-tuple (x, y, width, height). Note that x is always the leading edge of the grapheme and x + width the trailing edge of the grapheme. If the directionality of the grapheme is right-to-left, then width will be negative.

pango.Layout.get_cursor_pos

    def get_cursor_pos(index)

index :

the byte index of the cursor

Returns :

a 2-tuple containing two 4-tuples representing the strong and weak cursor positions

The get_cursor_pos() method returns a 2-tuple containing two 4-tuples representing the strong and weak cursor positions of the specified index within a layout. The position of each cursor is stored as a zero-width rectangle represented by a 4-tuple (x, y, width, height). The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted.

pango.Layout.move_cursor_visually

    def move_cursor_visually(strong, old_index, old_trailing, direction)

strong :

if True the moving cursor is the strong cursor; otherwise, the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout.

old_index :

the byte index of the grapheme for the old index

old_trailing :

if 0, the cursor was at the trailing edge of the grapheme indicated by old_index, if > 0, the cursor was at the leading edge.

direction :

direction to move cursor. A negative value indicates motion to the left.

Returns :

a 2-tuple containing: the new cursor byte index (a value of -1 indicates that the cursor has been moved off the beginning of the layout while a value of G_MAXINT indicates that the cursor has been moved off the end of the layout); and, the number of characters to move forward (from the new cursor position) to get the position where the cursor should be displayed.

The move_cursor_visually() returns a 2-tuple containing:

  • a new cursor position calculated from an old position (specified by old_index) and the specified direction to move visually
  • the number of characters to move forward (from the new cursor position) to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the end of the preceding line. the first value is always on the line where the cursor should be displayed.

If direction is positive, then the new strong cursor position will be one position to the right of the old cursor position. If direction is negative then the new strong cursor position will be one position to the left of the old cursor position.

In the presence of bidirectional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.

Motion here is in cursor positions, not in characters, so a single call to the move_cursor_visually() method may move the cursor over multiple characters when multiple characters combine to form a single grapheme.

pango.Layout.xy_to_index

    def xy_to_index(x, y)

x :

the X offset (in 1/pango.SCALE of a device unit) from the left edge of the layout.

y :

the Y offset (in 1/pango.SCALE of a device unit) from the top edge of the layout

Returns :

a 2-tuple containing the calculated byte index and an integer indicating where in the grapheme the user clicked (it will either be zero, or the number of characters in the grapheme - 0 represents the trailing edge of the grapheme).

The xy_to_index() method returns the byte index of the character at the specified x and y position within a layout. If the position is not inside the layout, the closest position is chosen (the (x, y) position will be clamped inside the layout).

pango.Layout.get_extents

    def get_extents()

Returns :

a 2-tuple containing two 4-tuples representing the as drawn and logical extents rectangles of the layout

The get_extents() method returns a 2-tuple containing two 4-tuples representing the ink and logical extents rectangles of the layout in device units (one pixel = pango.SCALE device units). Logical extents are usually what you want for positioning things. The extents are given in layout coordinates which begin at the top left corner of the layout.

pango.Layout.get_pixel_extents

    def get_pixel_extents()

Returns :

a 2-tuple containing two 4-tuples representing the as drawn (ink) and logical extents rectangles of the layout

The get_pixel_extents() method returns a 2-tuple containing two 4-tuples representing the logical and ink extents rectangles of the layout in pixel units. See the get_extents() method for more information. This method just calls the get_extents() and then converts the extents to pixels (one pixel = pango.SCALE device units).

pango.Layout.get_size

    def get_size()

Returns :

a 2-tuple containing the logical width and height of the pango.Layout

The get_size() method returns a 2-tuple containing the logical width and height of the pango.Layout in pango device units (one pixel = pango.SCALE device units).

pango.Layout.get_pixel_size

    def get_pixel_size()

Returns :

a 2-tuple containing the logical width height of the pango.Layout

The get_pixel_size() method returns a 2-tuple containing the logical width and height of the pango.Layout in pixels (one pixel = pango.SCALE device units). (The get_size() returns the width and height in device units.)

pango.Layout.get_line_count

    def get_line_count()

Returns :

the line count

The get_line_count() method returns the count of lines in the layout.

pango.Layout.get_line

    def get_line(line)

line :

the index of a line, which must be between 0 and layout.get_line_count() - 1, inclusive.

Returns :

the requested pango.LayoutLine, or None if the index is out of range.

Note

This method is available in PyGTK 2.8 and above.

The get_line() method returns the line with the index number specified by line from the layout. The returned layout line will become invalid if changes are made to the pango.Layout.

pango.Layout.get_iter

    def get_iter()

Returns :

a new pango.LayoutIter object

Note

This method is available in PyGTK 2.6 and above.

The get_iter() method returns a pango.LayoutIter object that can be used to iterate over the visual extents of the layout.

Prev Up Next
pango.Language Home pango.LayoutIter
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkvscale.html0000644000000000000000000001715611272037113023612 0ustar rootrootgtk.VScale
gtk.VScale
Prev The gtk Class Reference Next

gtk.VScale

gtk.VScale — a vertical slider widget used to select a value from a range.

Synopsis

class gtk.VScale(gtk.Scale):
    gtk.VScale(adjustment=None)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Range
        +-- gtk.Scale
          +-- gtk.VScale

Implemented Interfaces

gtk.VScale implements gtk.Buildable

gtk.VScale Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Range Properties

gtk.Scale Properties

gtk.VScale Style Properties

gtk.Widget Style Properties

gtk.Range Style Properties

gtk.Scale Style Properties

gtk.VScale Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Range Signal Prototypes

gtk.Scale Signal Prototypes

Description

The gtk.VScale is subclassed from gtk.Scale to provide a widget that allows a user to select a value using a horizontal slider. See the gtk.Scale description for more information on the methods available to manage a gtk.VScale.

Constructor

    gtk.VScale(adjustment=None)

adjustment :

a gtk.Adjustment or None

Returns :

a new gtk.VScale widget

Creates a new gtk.VScale widget and associates a gtk.Adjustment specified by adjustment with it. The default value of adjustment is None which creates the vscale with no gtk.Adjustment.

Prev Up Next
gtk.VRuler Home gtk.VScrollbar
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkfilechooserwidget.html0000644000000000000000000002272011272037113026034 0ustar rootrootgtk.FileChooserWidget
gtk.FileChooserWidget
Prev The gtk Class Reference Next

gtk.FileChooserWidget

gtk.FileChooserWidget — a file chooser widget that can be embedded in other widgets(new in PyGTK 2.4)

Synopsis

class gtk.FileChooserWidget(gtk.VBox, gtk.FileChooser):
    gtk.FileChooserWidget(action=gtk.FILE_CHOOSER_ACTION_OPEN, backend=None)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Box
          +-- gtk.VBox
            +-- gtk.FileChooserWidget

Implemented Interfaces

gtk.Bin implements gtk.Buildable gtk.FileChooser

gtk.FileChooserWidget Properties

gtk.FileChooser Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Box Properties

gtk.FileChooserWidget Style Properties

gtk.Widget Style Properties

gtk.FileChooserWidget Child Properties

gtk.Box Child Properties

gtk.FileChooserWidget Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.FileChooser Signal Prototypes

Description

Note

This widget is available in PyGTK 2.4 and above.

The gtk.FileChooserWidget is a widget suitable for selecting files. It is the main building block of a gtk.FileChooserDialog. Most applications will only need to use the latter; you can use gtk.FileChooserWidget as part of a larger window if you have special needs.

Note that gtk.FileChooserWidget does not have any methods, signals or properties of its own. Instead, you should use the methods, signals and properties of the gtk.FileChooser.

Constructor

    gtk.FileChooserWidget(action=gtk.FILE_CHOOSER_ACTION_OPEN, backend=None)

action :

The open or save mode for the widget or None.

backend :

The name of the specific filesystem backend to use or None.

Returns :

a new gtk.FileChooserWidget

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.FileChooserWidget. This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by gtk.FileChooserDialog.

Prev Up Next
gtk.FileChooserDialog Home gtk.FileFilter
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkadjustment.html0000644000000000000000000011645411272037113024514 0ustar rootrootgtk.Adjustment
gtk.Adjustment
Prev The gtk Class Reference Next

gtk.Adjustment

gtk.Adjustment — an object representing an adjustable bounded value

Synopsis

class gtk.Adjustment(gtk.Object):
    gtk.Adjustment(value=0, lower=0, upper=0, step_incr=0, page_incr=0, page_size=0)
    def set_all(value, lower, upper, step_increment, page_increment, page_size)
    def changed()
    def value_changed()
    def clamp_page(lower, upper)
    def get_value()
    def set_value(value)
    def configure(value, lower, upper, step_increment, page_increment, page_size)
    def get_lower()
    def set_lower(lower)
    def get_page_increment()
    def set_page_increment(page_increment)
    def get_page_size()
    def set_page_size(page_size)
    def get_step_increment()
    def set_step_increment(step_increment)
    def get_upper()
    def set_upper(upper)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Adjustment

gtk.Adjustment Properties

gtk.Object Properties

Note

These properties are available in GTK+ 2.4 and above. The GTK+ version is contained in the 3-tuple gtk.gtk_version.

"lower"Read-WriteThe minimum value of the adjustment. (float)
"page-increment"Read-WriteThe page increment of the adjustment. (float)
"page-size"Read-WriteThe page size of the adjustment. (float)
"step-increment"Read-WriteThe step increment of the adjustment. (float)
"upper"Read-WriteThe maximum value of the adjustment. (float)
"value"Read-WriteThe value of the adjustment. (float)

Attributes

"value"Read-Writethe current value (float)
"lower"Read-Writethe minimum value (float)
"upper"Read-Writethe maximum value (float)
"step_increment"Read-Writethe increment to use to make minor changes to the value. In a gtk.Scrollbar this increment is used when the mouse is clicked on the arrows at the top and bottom of the scrollbar, to scroll by a small amount. (float)
"page_increment"Read-Writethe increment to use to make major changes to the value. In a gtk.Scrollbar this increment is used when the mouse is clicked in the trough, to scroll by a large amount. (float)
"page_size"Read-Writea widget specific size. In a gtk.Scrollbar this is the size of the area which is currently visible. (float)

gtk.Adjustment Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

"changed"

 def callback(adjustment, user_param1, ...)

"value-changed"

 def callback(adjustment, user_param1, ...)

Description

The gtk.Adjustment object contains a value which has an associated lower and upper bound, together with step and page increments, and a page size. It is used in conjunction with several PyGTK widgets, including gtk.SpinButton, gtk.Viewport, and gtk.Range (which is a base class for gtk.HScrollbar, gtk.VScrollbar, gtk.HScale, and gtk.VScale).

A gtk.Adjustment can be shared by multiple widgets. The gtk.Adjustment object does not update the value itself. Instead it is left up to the associated widget(s) that use the gtk.Adjustment to control the value.

The widget using the gtk.Adjustment typically calls the value_changed() or changed() methods after changing the value or its bounds. This results in the emission of the "value_changed" or "changed" signal respectively.

A gtk.Adjustment object contains several attributes that provide access to its value and bounds:

  • value
  • lower
  • upper
  • step_increment
  • page_increment
  • page_size

The attribute values can be retrieved and set similar to:

  adjustment.upper = 25.0
  lower = adjustment.lower

Constructor

    gtk.Adjustment(value=0, lower=0, upper=0, step_incr=0, page_incr=0, page_size=0)

value :

the initial value.

lower :

the minimum value.

upper :

the maximum value.

step_incr :

the step increment.

page_incr :

the page increment.

page_size :

the page size.

Returns :

a new gtk.Adjustment object

gtk.Adjustment() creates a new gtk.Adjustment object with the specified attributes. Any attributes not specified are set to 0.0 by default.

Methods

gtk.Adjustment.set_all

    def set_all(value, lower, upper, step_increment, page_increment, page_size)

value :

the new value.

lower :

the new minimum value.

upper :

the new maximum value.

step_increment :

the new step increment.

page_increment :

the new page increment.

page_size :

the new page size.

The set_all() method sets the attributes of the adjustment to the specified values.

gtk.Adjustment.changed

    def changed()

The changed() method emits a "changed" signal from the adjustment. This must typically be called if any of the adjustment attributes other than value has changed so that the widget(s) using the adjustment can reflect the changes. Applications usually will not need to use this method since setting the attributes directly will automatically invoke this method.

gtk.Adjustment.value_changed

    def value_changed()

The value_changed() method emits a "value_changed" signal from the adjustment. This must typically be called after the value attribute of the adjustment has changed. Applications usually will not need to use this method since setting the attribute directly will automatically invoke this method as will using the set_value() method.

gtk.Adjustment.clamp_page

    def clamp_page(lower, upper)

lower :

the lower value

upper :

the upper value

The clamp_page() method updates the adjustment value to ensure that the range between lower and upper is in the current page (i.e. between value and value + page_size). If the range is larger than the page size, then only the start of it will be in the current page. A "changed" signal will be emitted if the value is changed.

gtk.Adjustment.get_value

    def get_value()

Returns :

The current value of the adjustment.

The get_value() method gets the current value of the adjustment.

gtk.Adjustment.set_value

    def set_value(value)

value :

the new value

The set_value() method sets the value of the adjustment to the specified value.

gtk.Adjustment.get_lower

    def get_lower()

Returns :

The current minimum value of the adjustment.

Note

This method is available in PyGTK 2.14 and above.

The get_lower() method gets the current minimum value of the adjustment.

gtk.Adjustment.set_lower

    def set_lower(lower)

lower :

the new minimum value

Note

This method is available in PyGTK 2.14 and above.

The set_lower() method sets the minimum value of the adjustment.

When setting multiple adjustment properties via their individual setters, multiple "changed" signals will be emitted. However, since the emission of the "changed" signal is tied to the emission of the "GObject::notify" signals of the changed properties, it's possible to compress the "changed" signals into one by calling gobject.Gobject.freeze_notify() and gobject.Gobject.thaw_notify() around the calls to the individual setters.

Alternatively, using gtk.Adjustment.configure() has the same effect of compressing "changed" emissions.

gtk.Adjustment.get_page_increment

    def get_page_increment()

Returns :

The current page increment of the adjustment.

Note

This method is available in PyGTK 2.14 and above.

The get_page_increment() method gets the current page increment of the adjustment.

gtk.Adjustment.set_page_increment

    def set_page_increment(page_increment)

page_increment :

the new page increment value

Note

This method is available in PyGTK 2.14 and above.

The set_page_increment() method sets the page increment of the adjustment.

See gtk.Adjustment.get_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.

gtk.Adjustment.get_page_size

    def get_page_size()

Returns :

The current page size of the adjustment.

Note

This method is available in PyGTK 2.14 and above.

The get_page_size() method gets the current page size of the adjustment.

gtk.Adjustment.set_page_size

    def set_page_size(page_size)

page_size :

the new page size value

Note

This method is available in PyGTK 2.14 and above.

The set_page_size() method sets the page size of the adjustment.

See gtk.Adjustment.get_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.

gtk.Adjustment.get_step_increment

    def get_step_increment()

Returns :

The current step increment of the adjustment.

Note

This method is available in PyGTK 2.14 and above.

The get_step_increment() method gets the current step increment of the adjustment.

gtk.Adjustment.set_step_increment

    def set_step_increment(step_increment)

step_increment :

the new step increment value

Note

This method is available in PyGTK 2.14 and above.

The set_step_increment() method sets the step increment of the adjustment.

See gtk.Adjustment.get_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.

gtk.Adjustment.get_upper

    def get_upper()

Returns :

The current minimum value of the adjustment.

Note

This method is available in PyGTK 2.14 and above.

The get_upper() method gets the current minimum value of the adjustment.

gtk.Adjustment.set_upper

    def set_upper(upper)

upper :

the new maximum value

Note

This method is available in PyGTK 2.14 and above.

The set_upper() method sets the maximum value of the adjustment.

Note that values will be restricted by upper - page-size if the page-size property is nonzero.

See gtk.Adjustment.get_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.

Signals

The "changed" gtk.Adjustment Signal

    def callback(adjustment, user_param1, ...)

adjustment :

the object that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "changed" signal is emitted when one (or more) of the adjustment attributes (except the value attribute) has changed.

The "value-changed" gtk.Adjustment Signal

    def callback(adjustment, user_param1, ...)

adjustment :

the object that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "value-changed" signal is emitted when the adjustment value attribute has changed.

Prev Up Next
gtk.ActionGroup Home gtk.Alignment
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkrecentaction.html0000644000000000000000000003364311272037113025012 0ustar rootrootgtk.RecentAction
gtk.RecentAction
Prev The gtk Class Reference Next

gtk.RecentAction

gtk.RecentAction — An action of which represents a list of recently used files (new in PyGTK 2.12)

Synopsis

class gtk.RecentAction(gtk.Action):
    gtk.RecentAction(name, label, tooltip, stock_id)
    def get_show_numbers()
    def set_show_numbers(show_numbers)
Functions
 
    def gtk.recent_action_new_for_manager(name, label, tooltip, stock_id, manager)

Ancestry

+-- gobject.GObject
  +-- gtk.Action
    +-- gtk.RecentAction

Description

A gtk.RecentAction represents a list of recently used files, which can be shown by widgets such as gtk.RecentChooserDialog or gtk.RecentChooserMenu.

To construct a submenu showing recently used files, use a gtk.RecentAction as the action for a <menuitem>. To construct a menu toolbutton showing the recently used files in the popup menu, use a gtk.RecentAction as the action for a <toolitem> element.

Constructor

gtk.RecentAction

    gtk.RecentAction(name, label, tooltip, stock_id)

name :

a unique name for the action

label :

the label displayed in menu items and on buttons, or None.

tooltip :

a tooltip for the action, or None.

stock_id :

the stock icon to display in widgets representing the action, or None.

Returns :

a new gtk.RecentAction

Note

This constructor is available in PyGTK 2.12 and above.

Creates a new gtk.RecentAction object. To add the action to a gtk.ActionGroup and set the accelerator for the action, call gtk.ActionGroup.add_action_with_accel().

Methods

gtk.RecentAction.get_show_numbers

    def get_show_numbers()

Returns :

True if numbers should be shown.

Note

This method is available in PyGTK 2.12 and above.

The get_show_numbers() method returns the value set by gtk.RecentAction.set_show_numbers().

gtk.RecentAction.set_show_numbers

    def set_show_numbers(show_numbers)

show_numbers :

True if the shown items should be numbered.

Note

This method is available in PyGTK 2.12 and above.

The set_show_numbers() method sets whether a number should be added to the items shown by the widgets representing action. The numbers are shown to provide a unique character for a mnemonic to be used inside the menu item's label. Only the first ten items get a number to avoid clashes.

Functions

gtk.recent_action_new_for_manager

    def recent_action_new_for_manager(name, label, tooltip, stock_id, manager)

name :

a unique name for the action

label :

the label displayed in menu items and on buttons, or None.

tooltip :

a tooltip for the action, or None.

stock_id :

the stock icon to display in widgets representing the action, or None.

manager :

a gtk.RecentManager, or None for using the default gtk.RecentManager

Note

This function is available in PyGTK 2.12 and above.

The recent_action_new_for_manager() function creates a new gtk.RecentAction object. To add the action to a gtk.ActionGroup and set the accelerator for the action, call gtk.ActionGroup.add_action_with_accel().

Prev Up Next
gtk.RcStyle Home gtk.RecentChooserDialog
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkimplementor.html0000644000000000000000000000667311272037113024664 0ustar rootrootatk.Implementor
atk.Implementor
Prev The atk Class Reference Next

atk.Implementor

atk.Implementor

Synopsis

class atk.Implementor(gobject.GInterface):
    def ref_accessible()

Description

Methods

atk.Implementor.ref_accessible

    def ref_accessible()

Returns :

a reference to an object's atk.Object implementation

Gets a reference to an object's atk.Object implementation, if the object implements atk.Object

Prev Up Next
atk.Image Home atk.NoOpObject
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtklayout.html0000644000000000000000000006653111272037113023653 0ustar rootrootgtk.Layout
gtk.Layout
Prev The gtk Class Reference Next

gtk.Layout

gtk.Layout — infinite scrollable area containing child widgets and custom drawing

Synopsis

class gtk.Layout(gtk.Container):
    gtk.Layout(hadjustment=None, vadjustment=None)
    def put(child_widget, x, y)
    def move(child_widget, x, y)
    def set_size(width, height)
    def get_size()
    def get_hadjustment()
    def get_vadjustment()
    def set_hadjustment(adjustment)
    def set_vadjustment(adjustment)
    def get_bin_window()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Layout

Implemented Interfaces

gtk.Layout implements gtk.Buildable

gtk.Layout Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"hadjustment"Read-WriteThe gtk.Adjustment for the horizontal position.
"height"Read-Writethe layout height
"vadjustment"Read-WriteThe gtk.Adjustment for the vertical position.
"width"Read-Writethe layout width

gtk.Layout Style Properties

gtk.Widget Style Properties

gtk.Layout Child Properties

"x"Read-Writethe X position of the child
"y"Read-Writethe Y position of the child

Attributes

"bin_window"Readthe window of a layout to draw into

gtk.Layout Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

"set-scroll-adjustments"

 def callback(layout, hadjustment, vadjustment, user_param1, ...)

Description

The gtk.Layout is a simple container widget similar to the gtk.Fixed container widget. Like the gtk.Fixed the gtk.Layout places a child widget at a specific position within the container. The gtk.Layout offers two features beyond the gtk.Fixed widget:

  • a very large width and height for the container - limited by the size of an unsigned integer.
  • horizontal and vertical adjustments can be specified for use with scrollbars, etc.

The gtk.Layout can also be drawn on similar to drawing on a gtk.DrawingArea. When handling expose events on a gtk.Layout, you must draw to the window specified by the bin_window attribute rather than the widget window attribute.

Constructor

    gtk.Layout(hadjustment=None, vadjustment=None)

hadjustment :

horizontal adjustment, or None

vadjustment :

vertical adjustment, or None

Returns :

a new gtk.Layout

Creates a new gtk.Layout. Usually the hadjustment and vadjustment arguments are not specified or are specified as None, so that new adjustments are created.

Methods

gtk.Layout.put

    def put(child_widget, x, y)

child_widget :

the child widget

x :

the X position of child widget

y :

the Y position of child widget

The put() method adds child_widget to the layout and places its upper, left corner at the position specified by x and y.

gtk.Layout.move

    def move(child_widget, x, y)

child_widget :

a current child of the layout

x :

the X position to move child_widget to

y :

the Y position to move child_widget to

The move() method moves a current child of the layout (specified by child_widget) to the new position specified by x and y. The upper, left corner of child_widget will be placed at (x, y).

gtk.Layout.set_size

    def set_size(width, height)

width :

width of the layout area

height :

height of the layout area

The set_size() method sets the size of the virtual area of the layout to the values specified by width and height. The "width" and "height" properties are also set by this method.

gtk.Layout.get_size

    def get_size()

Returns :

a tuple containing the width and height set on layout

The get_size() method returns a tuple that contains the width and height of the virtual size that has been set on the layout. See set_size().

gtk.Layout.get_hadjustment

    def get_hadjustment()

Returns :

a horizontal adjustment

The get_hadjustment() method returns the value of the "hadjustment" property that contains the horizontal adjustment object associated with the layout. This function should only be called after the layout has been placed in a gtk.ScrolledWindow or has otherwise been configured for scrolling. See gtk.ScrolledWindow, gtk.Scrollbar, gtk.Adjustment for details.

gtk.Layout.get_vadjustment

    def get_vadjustment()

Returns :

a vertical adjustment

The get_vadjustment() method returns the "vadjustment" property that contains the vertical adjustment object associated with the layout. This function should only be called after the layout has been placed in a gtk.ScrolledWindow or has otherwise been configured for scrolling. See gtk.ScrolledWindow, gtk.Scrollbar, gtk.Adjustment for details.

gtk.Layout.set_hadjustment

    def set_hadjustment(adjustment)

adjustment :

a horizontal adjustment

The set_hadjustment() method sets the horizontal adjustment for the layout (and the "hadjustment" property) to the value of adjustment. See gtk.ScrolledWindow, gtk.Scrollbar, gtk.Adjustment for details.

gtk.Layout.set_vadjustment

    def set_vadjustment(adjustment)

adjustment :

a vertical adjustment

The set_vadjustment() method sets the vertical adjustment for the layout (and the "vadjustment" property) to the value of adjustment. See gtk.ScrolledWindow, gtk.Scrollbar, gtk.Adjustment for details.

gtk.Layout.get_bin_window

    def get_bin_window()

Returns :

a gtk.gdk.Window.

Note

This method is available in PyGTK 2.14 and above.

The get_bin_window() method retrieve the bin window of the layout used for drawing operations.

Signals

The "set-scroll-adjustments" gtk.Layout Signal

    def callback(layout, hadjustment, vadjustment, user_param1, ...)

layout :

the layout that received the signal

hadjustment :

the horizontal adjustment associated with the layout.

vadjustment :

the horizontal adjustment associated with the layout.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "set-scroll-adjustments" signal is emitted when one of the adjustments associated with a layout is changed.

Prev Up Next
gtk.Label Home gtk.LinkButton
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktexttag.html0000644000000000000000000007307311272037113024015 0ustar rootrootgtk.TextTag
gtk.TextTag
Prev The gtk Class Reference Next

gtk.TextTag

gtk.TextTag — an object used to apply attributes to text in a gtk.TextBuffer

Synopsis

class gtk.TextTag(gobject.GObject):
    gtk.TextTag(name=None)
    def get_priority()
    def set_priority(priority)
    def event(event_object, event, iter)

Ancestry

+-- gobject.GObject
  +-- gtk.TextTag

gtk.TextTag Properties

"accumulative-margin"Read-WriteWhether the margins accumulate or override each other. When set to True the margins of this tag are added to the margins of any other non-accumulative margins present. When set to False the margins override one another (the default). Default value: False This property is available in GTK+ 2.12 and above.
"background"WriteThe background color as a string
"background-full-height"Read-WriteIf True, the background color fills the entire line height
"background-full-height-set"Read-WriteIf True, this tag affects background height
"background-gdk"Read-WriteThe background color as a (possibly unallocated) gtk.gdk.Color
"background-set"Read-WriteIf True, this tag affects the background color
"background-stipple"Read-WriteThe bitmap to use as a mask when drawing the text background
"background-stipple-set"Read-WriteIf True, this tag affects the background stipple
"direction"Read-WriteThe text direction: gtk.TEXT_DIR_NONE, gtk.TEXT_DIR_LTR or gtk.TEXT_DIR_RTL
"editable"Read-WriteIt True the text can be modified by the user
"editable-set"Read-WriteIf True, this tag affects text editability
"family"Read-WriteThe name of the font family, e.g. Sans, Helvetica, Times, Monospace
"family-set"Read-WriteIf True, this tag affects the font family
"font"Read-WriteThe font description as a string, e.g. "Sans Italic 12"
"font-desc"Read-WriteThe font description as a pango.FontDescription object
"foreground"WriteThe foreground color as a string
"foreground-gdk"Read-WriteThe foreground color as a (possibly unallocated) gtk.gdk.Color
"foreground-set"Read-WriteIf True, this tag affects the foreground color
"foreground-stipple"Read-WriteThe bitmap to use as a mask when drawing the text foreground
"foreground-stipple-set"Read-WriteIf True, this tag affects the foreground stipple
"indent"Read-WriteThe amount to indent the paragraph, in pixels
"indent-set"Read-WriteIf True, this tag affects indentation
"invisible"Read-WriteIf True, this text is hidden
"invisible-set"Read-WriteIf True, this tag affects text visibility
"justification"Read-WriteThe text justification: gtk.JUSTIFY_LEFT, gtk.JUSTIFY_RIGHT, gtk.JUSTIFY_CENTER or gtk.JUSTIFY_FILL
"justification-set"Read-WriteIf True, this tag affects paragraph justification
"language"Read-WriteThe language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If you don't understand this parameter, you probably don't need it.
"language-set"Read-WriteIf True, this tag affects the language the text is rendered as
"left-margin"Read-WriteThe width of the left margin in pixels
"left-margin-set"Read-WriteIf True, this tag affects the left margin
"name"Read-WriteThe name of the texttag or None if anonymous
"paragraph-background"WriteThe paragraph background color as a string. This property is available in GTK+ 2.8 and above.
"paragraph-background-gdk"Read-WriteThe paragraph background color as a as a (possibly unallocated) gtk.gdk.Color. This property is available in GTK+ 2.8 and above.
"paragraph-background-set"Read-Writeif True this tag affects the paragraph background color
"pixels-above-lines"Read-WriteThe number of pixels of blank space above paragraphs
"pixels-above-lines-set"Read-WriteIf True, this tag affects the number of pixels above lines
"pixels-below-lines"Read-WriteThe number of pixels of blank space below paragraphs
"pixels-below-lines-set"Read-WriteIf True, this tag affects the number of pixels above lines
"pixels-inside-wrap"Read-WriteThe number of pixels of blank space between wrapped lines in a paragraph
"pixels-inside-wrap-set"Read-WriteIf True, this tag affects the number of pixels between wrapped lines
"right-margin"Read-WriteThe width of the right margin in pixels
"right-margin-set"Read-WriteIf True, this tag affects the right margin
"rise"Read-WriteThe offset of text above the baseline (below the baseline if rise is negative) in pixels
"rise-set"Read-WriteIf True, this tag affects the rise
"scale"Read-WriteThe font size as a scale factor relative to the default font size. This properly adapts to theme changes etc. so is recommended. Pango predefines some scales such as pango.SCALE_XX_SMALL, pango.SCALE_X_SMALL, pango.SCALE_SMALL, pango.SCALE_MEDIUM, pango.SCALE_LARGE, pango.SCALE_X_LARGE, pango.SCALE_XX_LARGE.
"scale-set"Read-WriteIf True, this tag scales the font size by a factor
"size"Read-WriteThe font size in Pango units.
"size-points"Read-WriteThe font size in points
"size-set"Read-WriteIf True, this tag affects the font size
"stretch"Read-WriteThe font stretch - one of: pango.STRETCH_ULTRA_CONDENSED, pango.STRETCH_EXTRA_CONDENSED, pango.STRETCH_CONDENSED, pango.STRETCH_SEMI_CONDENSED, pango.STRETCH_NORMAL, pango.STRETCH_SEMI_EXPANDED, pango.STRETCH_EXPANDED, pango.STRETCH_EXTRA_EXPANDED, pango.STRETCH_ULTRA_EXPANDED
"stretch-set"Read-WriteIf True, this tag affects the font stretch
"strikethrough"Read-WriteIf True, strike through the text
"strikethrough-set"Read-WriteIf True, this tag affects strikethrough
"style"Read-WriteThe font style - one of: pango.STYLE_NORMAL, pango.STYLE_OBLIQUE or pango.STYLE_ITALIC.
"style-set"Read-WriteIf True, this tag affects the font style
"tabs"Read-WriteThe custom tabs for this text
"tabs-set"Read-WriteIf True, this tag affects tabs
"underline"Read-WriteThe style of underline for this text: pango.UNDERLINE_NONE, pango.UNDERLINE_SINGLE, pango.UNDERLINE_DOUBLE or pango.UNDERLINE_LOW
"underline-set"Read-WriteIf True, this tag affects underlining
"variant"Read-WriteThe font variant - either pango.VARIANT_NORMAL or pango.VARIANT_SMALL_CAPS.
"variant-set"Read-WriteIf True, this tag affects the font variant
"weight"Read-WriteThe font weight as an integer: pango.WEIGHT_ULTRALIGHT = 200, pango.WEIGHT_LIGHT = 300, pango.WEIGHT_NORMAL = 400, pango.WEIGHT_BOLD = 700, pango.WEIGHT_ULTRABOLD = 800, pango.WEIGHT_HEAVY = 900.
"weight-set"Read-WriteIf True, this tag affects the font weight
"wrap-mode"Read-WriteThe wrap mode of the text: gtk.WRAP_NONE, gtk.WRAP_CHAR or gtk.WRAP_WORD
"wrap-mode-set"Read-WriteIf True, this tag affects line wrap mode

gtk.TextTag Signal Prototypes

gobject.GObject Signal Prototypes

"event"

 def callback(texttag, widget, event, iter, user_param1, ...)

Description

A gtk.TextTag object holds attributes that can be applied to a range of text in a gtk.TextBuffer. A texttag can be associated with more than one gtk.TextBuffer by adding it to the gtk.TextTagTable objects of the textbuffers. The attributes of a texttag can be set using the GObject.set_property() method or as part of texttag creation using the gtk.TextBuffer.create_tag() method. Since not every attribute property of a gtk.TextTag may be set each attribute property has a boolean property that indicates whether the attribute property is set by this texttag. Therefore before retrieving an attribute value from a texttag you have to check if the associated boolean property of the attribute property is True.

Constructor

    gtk.TextTag(name=None)

name :

tag name, or None if the texttag is anonymous

Returns :

a new gtk.TextTag

Creates a gtk.TextTag with the name specified by name. If name is None the texttag will be anonymous. The texttag attributes are configured using the GObject.set_property() method.

Methods

gtk.TextTag.get_priority

    def get_priority()

Returns :

the texttag's priority.

The get_priority() method returns the priority or the texttag.

gtk.TextTag.set_priority

    def set_priority(priority)

priority :

the new priority

The set_priority() method sets the priority of a gtk.TextTag to the value specified by priority. Valid priorities start at 0 and go to one less than the value returned by the gtk.TextTagTable.get_size() method. Each texttag in a table has a unique priority; setting the priority of one texttag shifts the priorities of all the other texttags in the table to maintain a unique priority for each texttag. Higher priority tags "win" if two texttags both set the same text attribute for a range of text. When adding a texttag to a gtk.TextTagTable, it will be assigned the highest priority in the table by default; so normally the precedence of a set of texttags is the order in which they were added to the table, or created with the gtk.TextBuffer.create_tag() method, that adds the texttag to the buffer's table automatically.

gtk.TextTag.event

    def event(event_object, event, iter)

event_object :

the object that received the event, such as a widget

event :

the event

iter :

the location where the event was received

Returns :

the result of signal emission (whether the event was handled)

The event() method emits the "event" signal on the gtk.TextTag for the widget specified by event_object with the event specified by event at the textbuffer location specified by iter. This method returns True if the event was handled.

Signals

The "event" gtk.TextTag Signal

    def callback(texttag, widget, event, iter, user_param1, ...)

texttag :

the texttag that received the signal

widget :

the widget that received event

event :

the event

iter :

the gtk.TextIter pointing to the location where the event was received

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "event" signal is emitted when an event occurs in a range of text that is enclosed in the texttag. The widget that the event occurred in is specified by widget. iter holds the location that the event occurred at and event describes the event.

Prev Up Next
gtk.TextMark Home gtk.TextTagTable
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkselection.html0000644000000000000000000003612411272037113024310 0ustar rootrootatk.Selection
atk.Selection
Prev The atk Class Reference Next

atk.Selection

atk.Selection — the ATK interface implemented by container objects whose atk.Object children can be selected.

Synopsis

class atk.Selection(gobject.GInterface):
    def add_selection(i)
    def clear_selection()
    def ref_selection(i)
    def get_selection_count()
    def is_child_selected(i)
    def remove_selection(i)
    def select_all_selection()

atk.Selection Signal Prototypes

"selection-changed"

 def callback(atkselection, user_param1, ...)

Description

atk.Selection should be implemented by UI components with children which are exposed by the ref_accessible_child() and get_n_accessible_children() methods, if the use of the parent UI component ordinarily involves selection of one or more of the objects corresponding to those atk.Object children - for example, selectable lists.

Note that other types of "selection" (for instance text selection) are accomplished a other ATK interfaces - atk.Selection is limited to the selection/deselection of children.

Methods

atk.Selection.add_selection

    def add_selection(i)

i :

an index specifying the child index.

Returns :

True if success, False otherwise.

Adds the specified accessible child of the object to the object's selection.

atk.Selection.clear_selection

    def clear_selection()

Returns :

True if success, False otherwise.

Clears the selection in the object so that no children in the object are selected.

atk.Selection.ref_selection

    def ref_selection(i)

i :

an index specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Returns :

an atk.Object representing the selected accessible , or None if the selection does not implement this interface.

Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on None or on a zero value for indication of whether the atk.Selection interface is implemented.

atk.Selection.get_selection_count

    def get_selection_count()

Returns :

an integer representing the number of items selected, or 0 if the selection does not implement this interface.

Gets the number of accessible children currently selected. Note: callers should not rely on None or on a zero value for indication of whether the atk.Selection interface is implemented.

atk.Selection.is_child_selected

    def is_child_selected(i)

i :

an index specifying the child index.

Returns :

True if the specified child is selected, or 0 if the selection does not implement this interface.

Determines if the current child of this object is selected Note: callers should not rely on None or on a zero value for indication of whether the atk.Selection interface is implemented.

atk.Selection.remove_selection

    def remove_selection(i)

i :

an index specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

Returns :

True if success, False otherwise.

Removes the specified child of the object from the object's selection.

atk.Selection.select_all_selection

    def select_all_selection()

Returns :

True if success, False otherwise.

Causes every child of the object to be selected if the object supports multiple selections.

Signals

The "selection-changed" atk.Selection Signal

    def callback(atkselection, user_param1, ...)

atkselection :

the object which received the signal.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "selection-changed" signal is emitted by an object which implements atk.Selection interface when the selection changes.

Prev Up Next
atk.RelationSet Home atk.StateSet
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkrelationset.html0000644000000000000000000003033311272037113024650 0ustar rootrootatk.RelationSet
atk.RelationSet
Prev The atk Class Reference Next

atk.RelationSet

atk.RelationSet — a set of atk.Relation objects, normally the set of atk.Relation objects that an atk.Object has.

Synopsis

class atk.RelationSet(gobject.GObject):
    atk.RelationSet()
    def contains(relationship)
    def remove(relation)
    def add(relation)
    def get_n_relations()
    def get_relation(i)
    def get_relation_by_type(relationship)

Ancestry

+-- gobject.GObject
  +-- atk.RelationSet

atk.RelationSet Signal Prototypes

gobject.GObject Signal Prototypes

Description

The atk.RelationSet held by an object establishes its relationships with objects beyond the normal "parent/child" hierarchical relationships that all user interface objects have. atk.RelationSet objects establish whether objects are labelled or controlled by other components, share group membership with other components (for instance within a radio-button group), or share content which "flows" between them, among other types of possible relationships.

Constructor

atk.RelationSet

    atk.RelationSet()

Returns :

a new atk.RelationSet

Creates a new empty relation set.

Methods

atk.RelationSet.contains

    def contains(relationship)

relationship :

one of the Atk Relation Type Constants.

Returns :

True if relationship is the relationship type.

Determines whether the relation set contains a relation that matches the type specified by relationship.

atk.RelationSet.remove

    def remove(relation)

relation :

an atk.Relation

Removes a relation from the relation set.

atk.RelationSet.add

    def add(relation)

relation :

an atk.Relation

Add a new atk.Relation to the current relation set if it is not already present.

atk.RelationSet.get_n_relations

    def get_n_relations()

Returns :

an integer representing the number of relations in the set.

Returns the number of relations in a relation set.

atk.RelationSet.get_relation

    def get_relation(i)

i :

an index representing a position in the set, starting from 0.

Returns :

the atk.Relation, that is the relation at position i in the set.

Determines the relation at the specified position in the relation set.

atk.RelationSet.get_relation_by_type

    def get_relation_by_type(relationship)

relationship :

one of the Atk Relation Type Constants.

Returns :

an atk.Relation, which is a relation matching the specified type.

Finds a relation that matches the specified type.

Prev Up Next
atk.Relation Home atk.Selection
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkitemfactory.html0000644000000000000000000007136311272037113024663 0ustar rootrootgtk.ItemFactory
gtk.ItemFactory
Prev The gtk Class Reference Next

gtk.ItemFactory

gtk.ItemFactory — creates menus, menubars and option menus from a data description.

Synopsis

class gtk.ItemFactory(gtk.Object):
    gtk.ItemFactory(container_type, path, accel_group=None)
    def construct(container_type, path, accel_group)
    def get_item(path)
    def get_widget(path)
    def get_widget_by_action(action)
    def get_item_by_action(action)
    def create_items(entries, callback_data=None)
    def delete_item(path)
    def popup(x, y, mouse_button, time=GDK_CURRENT_TIME)
Functions

    def gtk.item_factory_from_widget(widget)
    def gtk.item_factory_path_from_widget(widget)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.ItemFactory

gtk.ItemFactory Properties

gtk.Object Properties

gtk.ItemFactory Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

Description

Warning

gtk.ItemFactory is deprecated in PyGTK 2.4 and above. The gtk.UIManager should be used instead.

The gtk.ItemFactory provides a convenient way to create and manage menus, menubars and option menus from a data description. The data description is a tuple or list containing a list of entry tuples that each describe an individual menu, menuitem, etc. Each entry tuple may contain the following entry fields though only the path must be specified; the other fields are optional:

  • A path that defines the logical position of the menu or menuitem in the menu hierarchy. a path is similar to a file path in that it starts with a slash (/) character and all components are joined by a slash (/) character. The last component may have an underscore that indicates that the following character is to be used as the accelerator mnemonic.

  • An accelerator that defines a key sequence that will activate the menuitem. The key sequence is a set of zero or more modifiers followed by a single key. The modifier keys are:

    "<alt>"

    		Alt-Lor Alt-R

    "<ctl>", "<ctrl>", "<control>"

    		Ctrl-Lor Ctrl-R

    "<shift>", "<shft>"

    		Shift-Lor Shift-R

  • A callback function or method that will be invoked when the menu item is activated or the accelerator key sequence is pressed. The callback function is defined as either:

        def callback(callback_data, callback_action, widget)
    def callback(callback_action, widget)

    where callback_action is the callback action defined below, callback_data is the data passed with the create_items() method and widget is the menuitem widget. The second definition must be used if no callback_data argument is specified by the call to create_items().

  • A callback action that is an arbitrary integer value.

  • An item type is a string describing the type of the item:

    "None", "", "Item"

    		a simple menu item

    "<Title>"

    		a title item

    "<ImageItem>"

    		an image item

    "<StockItem>"

    		an item holding a stock image

    "<CheckItem>"

    		a check item

    "<ToggleItem>"

    		a toggle item

    "<RadioItem>"

    		a radio item

    <path>

    		the path of a radio item group to add item to

    "<Separator>"

    		a separator

    "<Tearoff>"

    		a tearoff separator

    "<Branch>"

    		an item to hold sub items

    "<LastBranch>"

    		a right justified item to hold sub items
  • extra data that is either a gtk.gdk.Pixbuf or a stock ID

Constructor

    gtk.ItemFactory(container_type, path, accel_group=None)

container_type :

the kind of menu to create; one of: gtk.MenuBar, gtk.Menu or gtk.OptionMenu.

path :

the path of the new item factory, a string of the form "<name>"

accel_group :

a gtk.AccelGroup to which the accelerators for the menu items will be added, or None to create a new one

Returns :

a new gtk.ItemFactory

Creates a new gtk.ItemFactory object.

Methods

gtk.ItemFactory.construct

    def construct(container_type, path, accel_group)

container_type :

the kind of menu to create; one of: gtk.MenuBar, gtk.Menu or gtk.OptionMenu.

path :

the path of the item factory, a string of the form "<name>"

accel_group :

a gtk.AccelGroup to which the accelerators for the menu items will be added, or None to create a new one

The construct() method initializes an item factory.

gtk.ItemFactory.get_item

    def get_item(path)

path :

the path to the menu item

Returns :

the menu item with the specified path, or None if path doesn't lead to a menu item

The get_item() method returns the menu item that corresponds to path. If the widget corresponding to path is a menu item that opens a submenu, then the item is returned. If you are interested in the submenu, use the get_widget() method instead.

gtk.ItemFactory.get_widget

    def get_widget(path)

path :

the path to the widget

Returns :

the widget associated with the specified path, or None if path doesn't lead to a widget

The get_widget() method returns the widget that corresponds to path. If the widget corresponding to path is a menu item that opens a submenu, then the submenu is returned. If you are interested in the menu item, use get_item() instead.

gtk.ItemFactory.get_widget_by_action

    def get_widget_by_action(action)

action :

a callback action value

Returns :

the widget that corresponds to the given action, or None if no widget was found

The get_widget_by_action() method returns the widget that is associated with the specified action. If there are multiple items with the same action, the result is undefined.

gtk.ItemFactory.get_item_by_action

    def get_item_by_action(action)

action :

a callback action value

Returns :

the menu item that corresponds to the specified action, or None if no menu item was found

The get_item_by_action() returns the menu item that is associated with the specified action.

gtk.ItemFactory.create_items

    def create_items(entries, callback_data=None)

entries :

a tuple or list of item factory entries

callback_data :

optional data passed to the callback functions of all entries

The create_items() method creates the menu items from the specified item factory entries. If no callback_data is specified it will not be passed to the callback functions i.e the callback functions will be passed one less argument.

gtk.ItemFactory.delete_item

    def delete_item(path)

path :

a path

The delete_item() method deletes the menu item that was created with the specified path.

gtk.ItemFactory.popup

    def popup(x, y, mouse_button, time=0L)

x :

the x position

y :

the y position

mouse_button :

the mouse button that was pressed to initiate this action

time :

an optional timestamp for this action; default is 0L which means use the current time

The popup() method pops up the menu constructed from the item factory at the specified location (x, y). This method is generally invoked in response to a "button_press_event" so the arguments are retrieved from the event information.

Functions

gtk.item_factory_from_widget

    def gtk.item_factory_from_widget(widget)

widget :

a gtk.Widget object

Returns :

the gtk.ItemFactory that created widget

The gtk.item_factory_from_widget() function returns the gtk.ItemFactory object that created the gtk.Widget specified by widget.

gtk.item_factory_path_from_widget

    def gtk.item_factory_path_from_widget(widget)

widget :

a gtk.Widget object

Returns :

the full path to the gtk.ItemFactory that created widget

The gtk.item_factory_path_from_widget() function returns the full path to the gtk.ItemFactory that created the gtk.Widget specified by widget.

Prev Up Next
gtk.Item Home gtk.Label
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcolorselection.html0000644000000000000000000007526211272037113025363 0ustar rootrootgtk.ColorSelection
gtk.ColorSelection
Prev The gtk Class Reference Next

gtk.ColorSelection

gtk.ColorSelection — a widget used to select a color.

Synopsis

class gtk.ColorSelection(gtk.VBox):
    gtk.ColorSelection()
    def get_has_opacity_control()
    def set_has_opacity_control(has_opacity)
    def get_has_palette()
    def set_has_palette(has_palette)
    def set_current_color(color)
    def set_current_alpha(alpha)
    def get_current_color()
    def get_current_alpha()
    def set_previous_color(color)
    def set_previous_alpha(alpha)
    def get_previous_color()
    def get_previous_alpha()
    def is_adjusting()
Functions

    def gtk.color_selection_palette_from_string(str)
    def gtk.color_selection_palette_to_string(colors)

Ancestry

+-- gobject.GObject
  +--gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Box
          +-- gtk.VBox
            +-- gtk.ColorSelection

Implemented Interfaces

gtk.ColorSelection implements gtk.Buildable

gtk.ColorSelection Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Box Properties

"current-alpha"Read/WriteThe current opacity value (0 fully transparent, 65535 fully opaque)
"current-color"Read/WriteThe current color as a gtk.gdk.Color
"has-opacity-control"Read/WriteIf True, the color selector should allow setting opacity
"has-palette"Read/WriteIf True, a palette should be used

gtk.ColorSelection Style Properties

gtk.Widget Style Properties

gtk.ColorSelection Child Properties

gtk.Box Child Properties

gtk.ColorSelection Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

"color-changed"

 def callback(colorselection, user_param1, ...)

Description

The gtk.ColorSelection is a widget that is used to select a color. It consists of a color wheel and entry boxes for color parameters such as hue, saturation, value, red, green, blue, and color name and optionally an opacity control and/or a color palette. It is found on the standard color selection dialog box gtk.ColorSelectionDialog. The color wheel can be manipulated to set a new color or new entries can be made in the entry boxes. The new color is displayed next to the previous color. An eyedropper button is available to allow the selection of a color from a pixel location on the display.

Constructor

    gtk.ColorSelection()

Returns :

a new gtk.ColorSelection

Creates a new gtk.ColorSelection widget.

Methods

gtk.ColorSelection.get_has_opacity_control

    def get_has_opacity_control()

Returns :

True if the colorsel has an opacity control; False if it doesn't.

The get_opacity() method determines whether the colorselection is displaying an opacity control.

gtk.ColorSelection.set_has_opacity_control

    def set_has_opacity_control(has_opacity)

has_opacity :

If True the colorselection will display the opacity control.

The set_has_opacity_control() method sets the "has-opacity-control" property to the value of has_opacity. If has_opacity is True the colorselection will display the opacity control slider and entry box; otherwise the opacity control is not displayed.

gtk.ColorSelection.get_has_palette

    def get_has_palette()

Returns :

True if the selector has a palette; False if it hasn't.

The get_has_palette() method returns the value of the "has-palette" property that determines whether the color selector displays a color palette.

gtk.ColorSelection.set_has_palette

    def set_has_palette(has_palette)

has_palette :

If True the color palette is displayed.

The set_has_palette() method sets the "has-palette" property to the value of has_palette. If has_palette is True the palette will be displayed; otherwise the palette will be hidden.

gtk.ColorSelection.set_current_color

    def set_current_color(color)

color :

A gtk.gdk.Color to set the current color with.

The set_current_color() method sets the current color to the value of color. The first time this is called, it will also set the previous color to the value of color too.

gtk.ColorSelection.set_current_alpha

    def set_current_alpha(alpha)

alpha :

an integer between 0 and 65535.

The set_current_alpha() method sets the "current-alpha" property (the opacity) to the value of alpha. The alpha (opacity) is displayed in the range of 0 to 255 in the colorselection. The first time this is called, it will also set the previous opacity to the value of alpha too.

gtk.ColorSelection.get_current_color

    def get_current_color()

Returns :

a gtk.gdk.Color representing the current color.

The get_current_color() method retrieves the current color in the colorselection.

gtk.ColorSelection.get_current_alpha

    def get_current_alpha()

Returns :

the current alpha value in the range 0 to 65535.

The get_current_alpha() method returns the value of the "current_alpha" property that controls the opacity value.

gtk.ColorSelection.set_previous_color

    def set_previous_color(color)

color :

a gtk.gdk.Color to set the previous color with.

The set_previous_color() method sets the 'previous' color to the value of color. Applications usually do not call this method. The first time set_current_color() the 'previous' color will be set.

gtk.ColorSelection.set_previous_alpha

    def set_previous_alpha(alpha)

alpha :

an integer between 0 and 65535.

The set_previous_alpha() method sets the 'previous' alpha to the value of alpha. Applications usually do not call this method. The first time set_current_alpha() the 'previous' alpha will be set.

gtk.ColorSelection.get_previous_color

    def get_previous_color()

Returns :

a gtk.gdk.Color with the previous color value.

The get_previous_color() method retrieves the previous color value.

gtk.ColorSelection.get_previous_alpha

    def get_previous_alpha()

Returns :

an integer between 0 and 65535.

The get_previous_alpha() method returns the previous alpha value.

gtk.ColorSelection.is_adjusting

    def is_adjusting()

Returns :

True if the user is currently dragging a color around, and False if the selection has stopped.

The is_adjusting() method retrieves the current state of the colorselection. If True the user is in the process of changing the current color.

Functions

gtk.color_selection_palette_from_string

    def gtk.color_selection_palette_from_string(str)

str :

the string containing the list of colors

Returns :

a list of gtk.gdk.Color objects or None if the conversion fails

The gtk.color_selection_palette_from_string() function returns a list of gtk.gdk.Color objects corresponding to the color specifications in the string specified by str. str is a colon-separated list of color names readable by gtk.gtk.color_parse(). If str cannot be converted to a list of color this function returns None.

gtk.color_selection_palette_to_string

    def gtk.color_selection_palette_to_string(colors)

colors :

a list or tuple of gtk.gdk.Color objects

Returns :

a string containing a colon-separated list of colors

The gtk.color_selection_palette_to_string() function returns a string containing a colon-separated list of the representation of the gtk.gdk.Color objects in colors.

This function is useful to save a special palette of colors for a gtk.ColorSelection as a string that can later be used by calling the gobject.set_property() method to set the "gtk-color-palette" property on the default gtk.Settings returned from the gtk.settings_get_default()) function.

Signals

The "color-changed" gtk.ColorSelection Signal

    def callback(colorselection, user_param1, ...)

colorselection :

the colorselection that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "color-changed" signal is emitted when the current color in the colorselection changes.

Prev Up Next
gtk.ColorButton Home gtk.ColorSelectionDialog
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkinvisible.html0000644000000000000000000002124311272037113024311 0ustar rootrootgtk.Invisible
gtk.Invisible
Prev The gtk Class Reference Next

gtk.Invisible

gtk.Invisible — internally-used widget which is not displayed.

Synopsis

class gtk.Invisible(gtk.Widget):
    gtk.Invisible()
    def set_screen(screen)
    def get_screen()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Invisible

Implemented Interfaces

gtk.Invisible implements gtk.Buildable

gtk.Invisible Properties

gtk.Object Properties

gtk.Widget Properties

"screen"Read-WriteThe screen where this window will be displayed.

gtk.Invisible Style Properties

gtk.Widget Style Properties

gtk.Invisible Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

Description

The gtk.Invisible widget is used internally in GTK, and is probably not useful for application developers. It is used for reliable pointer grabs and selection handling in the code for drag-and-drop.

Constructor

    gtk.Invisible()

Returns :

a new gtk.Invisible widget

Creates a new gtk.Invisible widget.

Methods

gtk.Invisible.set_screen

    def set_screen(screen)

screen :

a gtk.gdk.Screen object

Note

This method is available in PyGTK 2.2 and above.

The set_screen() method sets the gtk.gdk.Screen (specified by screen) where the gtk.Invisible object will be displayed.

gtk.Invisible.get_screen

    def get_screen()

Returns :,  :

the associated gtk.gdk.Screen

Note

This method is available in PyGTK 2.2 and above.

The get_screen() method returns the associated gtk.gdk.Screen object.

Prev Up Next
gtk.InputDialog Home gtk.Item
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/pango-class-reference.html0000644000000000000000000001456611272037113024671 0ustar rootrootThe pango Class Reference
The pango Class Reference
Prev   Next

The pango Class Reference

Table of Contents

pango.Attribute — an attribute that applies to a section of text
pango.AttrIterator — an object pointing to a location in a pango.AttrList.
pango.AttrList — an object holding attributes that apply to a section of text
pango.Color — an object representing a RGB color
pango.Context — stores global information used to control rendering.
pango.Font — a rendering-system independent font representation.
pango.FontDescription — an object representing a description of a font.
pango.FontFace — an object representing a group of fonts varying only in size.
pango.FontFamily — an object representing a family of related font faces.
pango.FontMap — an object that represents the set of fonts available for a particular rendering system.
pango.FontMetrics — an object containing overall metric information for a font.
pango.Fontset — an object containing a set of pango.Font objects.
pango.FontsetSimple — a simple container for a set of fonts
pango.GlyphString — an object holding strings of glyphs and glyph information.
pango.Language — an object that represents a language tag.
pango.Layout — an object representing a paragraph of text with attributes.
pango.LayoutIter — an object used to iterate over the visual extents of a pango.Layout (new in PyGTK 2.6)
pango.LayoutLine — a line in a pango.Layout (new in PyGTK 2.8)
pango.Renderer — a base class for pango rendering (new in PyGTK 2.8)
pango.TabArray — an object containing an array of tab stops.
The Pango Markup Language — a simple markup language for encoding attributes with text.
pango Functions — a list of all the pango functions
pango Constants — the built-in constants of the pango module
Prev   Next
gtk.glade.XML Home pango.Attribute
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkcolormap.html0000644000000000000000000005506711272037113024134 0ustar rootrootgtk.gdk.Colormap
gtk.gdk.Colormap
Prev The gtk.gdk Class Reference Next

gtk.gdk.Colormap

gtk.gdk.Colormap — a table of color display component values

Synopsis

class gtk.gdk.Colormap(gobject.GObject):
    gtk.gdk.Colormap(visual, allocate)
    def alloc_color(color, writeable=False, best_match=True)
    def alloc_color(spec, writeable=False, best_match=True)
    def alloc_color(red, green, blue, writeable=False, best_match=True)
    def get_visual()
    def get_screen()
    def query_color(pixel)
Functions

    def gtk.gdk.colormap_get_system()

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.Colormap

Description

A gtk.gdk.Colormap contains a table mapping index values to the RGB color component values used to display the colors. The index value corresponds to the pixel value of a gtk.gdk.Color object and the RGB component values correspond to the gtk.gdk.Color red, green and blue values. The gtk.Widget.get_colormap() method is used to retrieve the colormap used by a widget. The default system colormap is retrieved by using the gtk.gdk.colormap_get_system() function. The alloc_color() method has three signatures to allow the color specification using an unallocated gtk.gdk.Color, a string or a RGB trio.

Constructor

    gtk.gdk.Colormap(visual, allocate)

visual :

the gtk.gdk.Visual to use

allocate :

if True, the newly created colormap will be a private colormap, and all colors in it will be allocated for the applications use.

Returns :

a gtk.gdk.Colormap object

Creates a new gtk.gdk.Colormap for the gtk.gdk.Visual specified by visual. If allocate is True the colormap will be a private colormap for the sole use of the application.

Methods

gtk.gdk.Colormap.alloc_color

    def alloc_color(color, writeable=False, best_match=True)

color :

an unallocated gtk.gdk.Color

writeable :

if True the colormap entry is writeable.

best_match :

if True a best match to the requested color can be used if needed.

Returns :

a new gtk.gdk.Color object

The alloc_color() method allocates the color specified by color in the colormap. The value of color should be an unallocated gtk.gdk.Color. If writeable is True the color is allocated writeable which means it can be changed after allocation but cannot be shared with another application. If best_match is True the closest match to the color will be returned if the request could not be satisfied exactly.

This method raises:

  • the ValueError (TypeError prior to PyGTK 2.4) exception if unable to parse the color specification
  • the RuntimeError exception if the color could not be allocated

gtk.gdk.Colormap.alloc_color

    def alloc_color(spec, writeable=False, best_match=True)

spec :

a string containing a color specification

writeable :

if True the colormap entry is writeable.

best_match :

if True a best match to the requested color can be used if needed.

Returns :

a gtk.gdk.Color object

The alloc_color() method allocates the color specified by spec in the colormap. The format of spec is a string containing the specification of the color either as a name (e.g. "navajowhite") as specified in the X11 rgb.txt file or as a hexadecimal string (e.g. "#FF0078"). The hexadecimal string must start with '#' and must contain 3 sets of hexadecimal digits of the same length (i.e. 1, 2 ,3 or 4 digits). For example the following specify the same color value: "#F0A", "#FF00AA", "#FFF000AAA" and "#FFFF0000AAAA". If writeable is True the color is allocated writeable which means it can be changed after allocation but cannot be shared with another application. If best_match is True the closest match to the color will be returned if the request could not be satisfied exactly.

This method raises:

  • the ValueError (TypeError prior to PyGTK 2.4) exception if unable to parse the color specification
  • the RuntimeError exception if the color could not be allocated

gtk.gdk.Colormap.alloc_color

    def alloc_color(red, green, blue, writeable=False, best_match=True)

red :

the red component of the color in the range 0-65535

green :

the green component of the color in the range 0-65535

blue :

the blue component of the color in the range 0-65535

writeable :

a gboolean

best_match :

a gboolean

Returns :

a gtk.gdk.Color object

The alloc_color() method allocates the color specified by the component values red, green and blue. If writeable is True the color is allocated writeable which means it can be changed after allocation but cannot be shared with another application. If best_match is True the closest match to the color will be returned if the request could not be satisfied exactly.

This method raises:

  • the ValueError (TypeError prior to PyGTK 2.4) exception if unable to parse the color specification
  • the RuntimeError exception if the color could not be allocated

gtk.gdk.Colormap.get_visual

    def get_visual()

Returns :

a gtk.gdk.Visual

The get_visual() method returns the visual the colormap was created for. See the gtk.gdk.Colormap constructor.

gtk.gdk.Colormap.get_screen

    def get_screen()

Returns :

a gtk.gdk.Screen

The get_screen() method returns the gtk.gdk.Screen the colormap was created for.

gtk.gdk.Colormap.query_color

    def query_color()

pixel :

a pixel value

Returns :

the gtk.gdk.Color corresponding to pixel

Note

This method is available in PyGTK 2.4 and above.

The query_color() method returns the gtk.gdk.Color corresponding to the hardware pixel value specified by pixel. pixel must be a valid pixel in the colormap. It's a programmer error to call this method with a pixel which is not in the colormap. Hardware pixels are normally obtained from the alloc_color() method, or from a gtk.gdk.Image object. (A gtk.gdk.Image contains image data in hardware format while a gtk.gdk.Pixbuf contains image data in a canonical 24-bit RGB format.)

Functions

gtk.gdk.colormap_get_system

    def gtk.gdk.colormap_get_system()

Returns :

the system' default colormap

The gtk.gdk.colormap_get_system() method returns the default colormap used by the system on the default screen. See the gtk.gdk.Screen.get_system_colormap() method for more information.

Prev Up Next
gtk.gdk.Color Home gtk.gdk.Cursor
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-hierarchy.html0000644000000000000000000005754411272037113023612 0ustar rootrootPyGTK Class Hierarchy
PyGTK Class Hierarchy
Prev   Next

PyGTK Class Hierarchy

gobject.GBoxed
    gtk.Border
    gtk.IconInfo
    gtk.IconSet
    gtk.IconSource
    gtk.Requisition
    gtk.SelectionData
    gtk.TextAttributes
    gtk.TextIter
    gtk.TreeIter
    gtk.TreeRowReference
    gtk.gdk.Color
    gtk.gdk.Cursor
    gtk.gdk.Event
    gtk.gdk.Rectangle
    pango.AttrList
    pango.Color
    pango.FontDescription
    pango.FontMetrics
    pango.GlyphString
    pango.Language
    pango.LayoutLine
    pango.TabArray
gobject.GInterface
    gtk.CellEditable
    gtk.CellLayout
    gtk.Editable
    gtk.FileChooser
    gtk.TreeDragDest
    gtk.TreeDragSource
    gtk.TreeModel
    gtk.TreeSortable
gobject.GObject
    gtk.AccelGroup
    gtk.Action
        gtk.ToggleAction
            gtk.RadioAction
    gtk.ActionGroup
    gtk.Clipboard
    gtk.EntryCompletion (implements gtk.CellLayout)
    gtk.GenericTreeModel (implements gtk.TreeModel)
    gtk.IconFactory
    gtk.IconTheme
    gtk.ListStore (implements gtk.TreeModel, gtk.TreeDragSource, gtk.TreeDragDest, gtk.TreeSortable)
    gtk.Object
        gtk.Adjustment
        gtk.CellRenderer
            gtk.CellRendererPixbuf
            gtk.CellRendererText
                gtk.CellRendererCombo
            gtk.CellRendererProgress
            gtk.CellRendererToggle
            gtk.GenericCellRenderer
        gtk.FileFilter
        gtk.IMContext
            gtk.IMContextSimple
            gtk.IMMulticontext
        gtk.Tooltips
        gtk.TreeViewColumn (implements gtk.CellLayout)
        gtk.Widget
            gtk.Calendar
            gtk.CellView
            gtk.Container
                gtk.Bin
                    gtk.Alignment
                    gtk.Button
                        gtk.ColorButton
                        gtk.FontButton
                        gtk.ToggleButton
                            gtk.CheckButton
                                gtk.RadioButton
                    gtk.ComboBox (implements gtk.CellLayout)
                        gtk.ComboBoxEntry (implements gtk.CellLayout)
                    gtk.EventBox
                    gtk.Expander
                    gtk.Frame
                        gtk.AspectFrame
                    gtk.HandleBox
                    gtk.Item
                        gtk.MenuItem
                            gtk.CheckMenuItem
                                gtk.RadioMenuItem
                            gtk.ImageMenuItem
                            gtk.SeparatorMenuItem
                            gtk.TearoffMenuItem
                    gtk.ScrolledWindow
                    gtk.ToolItem
                        gtk.SeparatorToolItem
                        gtk.ToolButton
                            gtk.MenuToolButton
                            gtk.ToggleToolButton
                                gtk.RadioToolButton
                    gtk.Viewport
                    gtk.Window
                        gtk.Dialog
                            gtk.AboutDialog
                            gtk.ColorSelectionDialog
                            gtk.FileChooserDialog (implements gtk.FileChooser)
                            gtk.FileSelection
                            gtk.FontSelectionDialog
                            gtk.InputDialog
                            gtk.MessageDialog
                        gtk.Plug
                gtk.Box
                    gtk.ButtonBox
                        gtk.HButtonBox
                        gtk.VButtonBox
                    gtk.HBox
                        gtk.FileChooserButton
                        gtk.Statusbar
                    gtk.VBox
                        gtk.ColorSelection
                        gtk.FileChooserWidget (implements gtk.FileChooser)
                        gtk.FontSelection
                        gtk.GammaCurve
                gtk.Fixed
                gtk.IconView
                gtk.Layout
                gtk.MenuShell
                    gtk.Menu
                    gtk.MenuBar
                gtk.Notebook
                gtk.Paned
                    gtk.HPaned
                    gtk.VPaned
                gtk.Socket
                gtk.Table
                gtk.TextView
                gtk.Toolbar
                gtk.TreeView
            gtk.DrawingArea
                gtk.Curve
            gtk.Entry (implements gtk.Editable, gtk.CellEditable)
                gtk.SpinButton
            gtk.Invisible
            gtk.Misc
                gtk.Arrow
                gtk.Image
                gtk.Label
                    gtk.AccelLabel
                gtk.ProgressBar
            gtk.Range
                gtk.Scale
                    gtk.HScale
                    gtk.VScale
                gtk.Scrollbar
                    gtk.HScrollbar
                    gtk.VScrollbar
            gtk.Ruler
                gtk.HRuler
                gtk.VRuler
            gtk.Separator
                gtk.HSeparator
                gtk.VSeparator
    gtk.RcStyle
    gtk.Settings
    gtk.SizeGroup
    gtk.Style
    gtk.TextBuffer
    gtk.TextChildAnchor
    gtk.TextMark
    gtk.TextTag
    gtk.TextTagTable
    gtk.TreeModelFilter (implements gtk.TreeModel, gtk.TreeDragSource)
    gtk.TreeModelSort (implements gtk.TreeModel, gtk.TreeSortable)
    gtk.TreeSelection
    gtk.TreeStore (implements gtk.TreeModel, gtk.TreeDragSource, gtk.TreeDragDest, gtk.TreeSortable)
    gtk.UIManager
    gtk.WindowGroup
    gtk.gdk.Colormap
    gtk.gdk.Device
    gtk.gdk.Display
    gtk.gdk.DisplayManager
    gtk.gdk.DragContext
    gtk.gdk.Drawable
        gtk.gdk.Pixmap
        gtk.gdk.Window
    gtk.gdk.GC
    gtk.gdk.Image
    gtk.gdk.Keymap
    gtk.gdk.Pixbuf
    gtk.gdk.PixbufAnimation
    gtk.gdk.PixbufAnimationIter
    gtk.gdk.PixbufLoader
    gtk.gdk.Screen
    gtk.gdk.Visual
    pango.Context
    pango.Font
    pango.FontFace
    pango.FontFamily
    pango.FontMap
        pangocairo.CairoFontMap
    pango.Fontset
        pango.FontsetSimple
    pango.Layout
    pango.Renderer
        gtk.gdk.PangoRenderer
gobject.GPointer
cairo.Context
    pangocairo.CairoContext
        gtk.gdk.CairoContext
Prev   Next
Reference Page Format Home The atk Class Reference
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/unixprint-functions.html0000644000000000000000000001236311272037113024565 0ustar rootrootgtkunixprint Functions
gtkunixprint Functions
Prev The gtkunixprint Class Reference Next

gtkunixprint Functions

gtkunixprint Functions — the built-in functions of the gtkunixprint module

Synopsis

    def gtkunixprint.enumerate_printers(func, data=None, wait=True)

Functions

gtkunixprint.enumerate_printers

    def gtkunixprint.enumerate_printers(func, data=None, wait=True)

func :

a function to call for each printer

data :

user data to pass to func

wait :

if True, wait in a recursive mainloop until all printers are enumerated; otherwise return early

Note

This function is available in PyGTK 2.10 and above.

Calls the function specified by func for all gtkunixprint.Printers. If func returns True, the enumeration is stopped.

The signature of func is:

  def func(printer, user_data):

where printer is a gtkunixprint.Printer object and user_data is data. Note if data is not specified user_data will not be passed to func.

Prev Up Next
gtkunixprint.PrintUnixDialog Home gtkunixprint Constants
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkkeymap.html0000644000000000000000000012033711272037113023577 0ustar rootrootgtk.gdk.Keymap
gtk.gdk.Keymap
Prev The gtk.gdk Class Reference Next

gtk.gdk.Keymap

gtk.gdk.Keymap — an object containing mappings of keys to key values.

Synopsis

class gtk.gdk.Keymap(gobject.GObject):
    def lookup_key(keycode, group, level)
    def translate_keyboard_state(keycode, state, group)
    def get_entries_for_keyval(keyval)
    def get_entries_for_keycode(hardware_keycode)
    def get_direction()
    def have_bidi_layouts()
Functions

    def gtk.gdk.keymap_get_default()
    def gtk.gdk.keymap_get_for_display(display)
    def gtk.gdk.keyval_name(keyval)
    def gtk.gdk.keyval_from_name(keyval_name)
    def gtk.gdk.keyval_convert_case(symbol)
    def gtk.gdk.keyval_to_upper(keyval)
    def gtk.gdk.keyval_to_lower(keyval)
    def gtk.gdk.keyval_is_upper(keyval)
    def gtk.gdk.keyval_is_lower(keyval)
    def gtk.gdk.keyval_to_unicode(keyval)
    def gtk.gdk.unicode_to_keyval(wc)

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.Keymap

Signal Prototypes

"direction-changed"

 def callback(gdkkeymap, user_param1, ...)

"keys-changed"

 def callback(gdkkeymap, user_param1, ...)

Description

A gtk.gdk.Keymap defines the translation from keyboard state (including a hardware key, a modifier mask, and active keyboard group) to a keyval. This translation has two phases. The first phase is to determine the effective keyboard group and level for the keyboard state; the second phase is to look up the keycode/group/level triplet in the keymap and see what keyval it corresponds to. One gtk.gdk.Keymap object exists for each user display. PyGTK supports only one display, so gtk.gdk.keymap_get_default()() returns the singleton gtk.gdk.Keymap.

A keymap is a mapping from a Keymap key to key values. You can think of a Keymap key as a representation of a symbol printed on a physical keyboard key. That is, it contains three pieces of information. First, it contains the hardware keycode; this is an identifying number for a physical key. Second, it contains the level of the key. The level indicates which symbol on the key will be used, in a vertical direction. So on a standard US keyboard, the key with the number "1" on it also has the exclamation point ("!") character on it. The level indicates whether to use the "1" or the "!" symbol. The letter keys are considered to have a lowercase letter at level 0, and an uppercase letter at level 1, though only the uppercase letter is printed. Third, the Keymap key contains a group; groups are not used on standard US keyboards, but are used in many other countries. On a keyboard with groups, there can be 3 or 4 symbols printed on a single key. The group indicates movement in a horizontal direction. Usually groups are used for two different languages. In group 0, a key might have two English characters, and in group 1 it might have two Hebrew characters. The Hebrew characters will be printed on the key next to the English characters.

Methods

gtk.gdk.Keymap.lookup_key

    def lookup_key(keycode, group, level)

keycode :

the hardware keycode.

group :

the key group

level :

the key level

Returns :

a keyval, or 0 if none was mapped to the (keycode, group, level) triplet.

Note

This method is available in PyGTK 2.4 and above.

The lookup_key() method returns the keyval mapped to the specified (keycode, group, level) triplet. This method returns 0 if no keyval is found. For normal user input, you want to use the translate_keyboard_state() method instead of this method, since the effective group or level may not be the same as the current keyboard state.

The parameters to this method are:

keycode :

the hardware keycode. This is an identifying number for a physical key.

group :

indicates movement in a horizontal direction. Usually groups are used for two different languages. In group 0, a key might have two English characters, and in group 1 it might have two Hebrew characters. The Hebrew characters will be printed on the key next to the English characters.

level :

indicates which symbol on the key will be used, in a vertical direction. So on a standard US keyboard, the key with the number "1" on it also has the exclamation point ("!") character on it. The level indicates whether to use the "1" or the "!" symbol. The letter keys are considered to have a lowercase letter at level 0, and an uppercase letter at level 1, though only the uppercase letter is printed.

gtk.gdk.Keymap.translate_keyboard_state

    def translate_keyboard_state(keycode, state, group)

keycode :

a keycode

state :

a modifier state

group :

an active keyboard group

Returns :

a 4-tuple containing the keyval, the effective group, the level and the modifiers that were used to determine the group or level

Note

This method is available in PyGTK 2.4 and above.

The translate_keyboard_state() method translates the contents of a keyboard gtk.gdk.Event (specified by keycode, state and group) into a keyval, effective group, level and consumed modifiers that affected the translation (and are unavailable for application use) which are returned in a 4-tuple. See the lookup_key() method for an explanation of groups and levels. The effective group is the group that was actually used for the translation; some keys such as Enter are not affected by the active keyboard group. The level is derived from state. For convenience, the keyboard gtk.gdk.Event already contains the translated keyval, so this method isn't as useful as you might think.

The value of state or the consumed modifiers is a combination of the GDK Modifier Constants.

Consumed Modifiers

The consumed modifiers are modifiers that should be masked out from state when comparing this key press to a hot key. For instance, on a US keyboard, the plus symbol is shifted, so when comparing a key press to a Control+plus accelerator Shift should be masked out. For example:

  # We want to ignore irrelevant modifiers like ScrollLock
  ALL_ACCELS_MASK = (gtk.gdk.CONTROL_MASK | gtk.gdk.SHIFT_MASK
                     | gtk.gdk.MOD1_MASK)
  keyval, egroup, level, consumed = keymap.translate_keyboard_state(
                   event.hardware_keycode, event.state, event.group)
  if (keyval == gtk.keysyms.plus and 
      (event.state & ~consumed & ALL_ACCELS_MASK) == gtk.gdk.CONTROL_MASK):
    # Control was pressed

Note that most keys that are affected by the Shift key will have gtk.gdk.SHIFT_MASK part of the consumed modifiers (e.g. Control+Shift+Tab).

All single modifier combinations that could affect the key for any combination of modifiers will be returned in consumed_modifiers. Multi-modifier combinations are returned only when actually found in state. When you store accelerators, you should always store them with consumed modifiers removed. Store <Control>plus, not <Control><Shift>plus,

gtk.gdk.Keymap.get_entries_for_keyval

    def get_entries_for_keyval(keyval)

keyval :

a keyval, such as GDK_a, GDK_Up, GDK_Return, etc.

Returns :

a tuple containing 3-tuple containing a keycode, a group and a level that will generate keyval.

Note

This method is available in PyGTK 2.4 and above.

The get_entries_for_keyval() method returns a tuple of (keycode, group, level) 3-tuples that will generate keyval. Groups and levels are two kinds of keyboard mode; in general, the level determines whether the top or bottom symbol on a key is used, and the group determines whether the left or right symbol is used. On US keyboards, the shift key changes the keyboard level, and there are no groups. A group switch key might convert a keyboard between Hebrew to English modes, for example, the gtk.gdk.KEY_PRESS and gtk.gdk.KEY_RELEASE gtk.gdk.Event objects contain a group attribute that indicates the active keyboard group. The level is computed from the modifier mask.

gtk.gdk.Keymap.get_entries_for_keycode

    def get_entries_for_keycode(hardware_keycode)

hardware_keycode :

a keycode

Returns :

a tuple containing 4-tuples: (keyval, keycode, group, level)

Note

This method is available in PyGTK 2.4 and above.

The get_entries_for_keycode() method returns a tuple containing 4-tuples with: the keyvals bound to hardware_keycode, the keycode, the group and the level. When a keycode is pressed by the user, the keyval from this list of entries is selected by considering the effective keyboard group and level. See the translate_keyboard_state() method for more information.

gtk.gdk.Keymap.get_direction

    def get_direction()

Returns :

a Pango direction: pango.DIRECTION_LTR or pango.DIRECTION_RTL.

The get_direction() method returns the direction of the keymap.

gtk.gdk.Keymap.have_bidi_layouts

    def have_bidi_layouts()

Returns :

True if there are layouts in both directions, FALSE otherwise.

The have_bidi_layouts() method determines if keyboard layouts for both right-to-left and left-to-right languages are in use.

Functions

gtk.gdk.keymap_get_default

    def gtk.gdk.keymap_get_default()

Returns :

the default gdk keymap for the display.

The gtk.gdk.keymap_get_default() function returns the default gtk.gdk.Keymap for the display.

gtk.gdk.keymap_get_for_display

    def gtk.gdk.keymap_get_for_display(display)

display :

a gtk.gdk.Display

Returns :

the keymap for display.

Note

This function is available in PyGTK 2.2 and above.

The gtk.gdk.keymap_get_for_display() function returns the gtk.gdk.Keymap for the gtk.gdk.Display specified by display.

gtk.gdk.keyval_name

    def gtk.gdk.keyval_name(keyval)

keyval :

a key value

Returns :

a string containing the name of the key, or None if keyval is not a valid key.

The gtk.gdk.keyval_name() function converts the key value specified by keyval into a symbolic name.

gtk.gdk.keyval_from_name

    def gtk.gdk.keyval_from_name(keyval_name)

keyval_name :

a key name

Returns :

the corresponding key value or 0 if the key name is not a valid key.

The gtk.gdk.keyval_from_name() function converts the key name specified by keyval_name to a key value.

gtk.gdk.keyval_convert_case

    def gtk.gdk.keyval_convert_case(symbol)

symbol :

a keyval

Returns :

a 2-tuple containing the lowercase and uppercase versions of symbol

Note

This function is available in PyGTK 2.4 and above.

The gtk.gdk.keyval_convert_case() function returns the lowercase and uppercase versions of the keyval specified by symbol.

gtk.gdk.keyval_to_upper

    def gtk.gdk.keyval_to_upper(keyval)

keyval :

a key value.

Returns :

the upper case form of keyval, or keyval itself if it is already in upper case or it is not subject to case conversion.

The gtk.gdk.keyval_to_upper() function converts the key value specified by keyval to upper case, if applicable.

gtk.gdk.keyval_to_lower

    def gtk.gdk.keyval_to_lower(keyval)

keyval :

the key value

Returns :

the lower case form of keyval, or keyval itself if it is already in lower case or it is not subject to case conversion.

The gtk.gdk.keyval_to_lower() function converts the key value specified by keyval to lower case, if applicable.

gtk.gdk.keyval_is_upper

    def gtk.gdk.keyval_is_upper(keyval)

keyval :

the key value

Returns :

True if keyval is in upper case or if keyval is not subject to case conversion.

The gtk.gdk.keyval_is_upper() function returns True if the key value specified by keyval is in upper case or not subject to case conversion.

gtk.gdk.keyval_is_lower

    def gtk.gdk.keyval_is_lower(keyval)

keyval :

the key value

Returns :

True if keyval is in lower case, or if keyval is not subject to case conversion.

The gtk.gdk.keyval_is_lower() function returns True if the key value specified by keyval is in lower case or is not subject to case conversion.

gtk.gdk.keyval_to_unicode

    def gtk.gdk.keyval_to_unicode(keyval)

keyval :

the key value

Returns :

 the corresponding unicode character, or 0 if there is no corresponding character.

The gtk.gdk.keyval_to_unicode() function converts the key value specified by keyval to the corresponding ISO10646 (Unicode) character.

gtk.gdk.unicode_to_keyval

    def gtk.gdk.unicode_to_keyval(wc)

wc :

 a ISO10646 encoded (unicode) character

Returns :

the corresponding key value, if one exists. or, if there is no corresponding symbol, wc | 0x01000000

The gtk.gdk.unicode_to_keyval() function converts the ISO10646 (unicode) character specified by wc to a key value.

Signals

The "direction-changed" gtk.gdk.Keymap Signal

    def callback(gdkkeymap, user_param1, ...)

gdkkeymap :

the gdkkeymap that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "direction-changed" signal is emitted when the pango text direction of gdkkeymap is changed

The "keys-changed" gtk.gdk.Keymap Signal

    def callback(gdkkeymap, user_param1, ...)

gdkkeymap :

the gdkkeymap that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.2 and above.

The "keys-changed" signal is emitted when the mapping represented by keymap changes.

Prev Up Next
gtk.gdk.Image Home gtk.gdk.PangoRenderer
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkpixbufanimation.html0000644000000000000000000003432611272037113025510 0ustar rootrootgtk.gdk.PixbufAnimation
gtk.gdk.PixbufAnimation
Prev The gtk.gdk Class Reference Next

gtk.gdk.PixbufAnimation

gtk.gdk.PixbufAnimation — an object holding an animation

Synopsis

class gtk.gdk.PixbufAnimation(gobject.GObject):
    gtk.gdk.PixbufAnimation(filename)
    def get_width()
    def get_height()
    def is_static_image()
    def get_static_image()
    def get_iter(start_time=0.0)

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.PixbufAnimation

Description

A gtk.gdk.PixbufAnimation is an object that holds an animation. An animation is conceptually a series of frames to be displayed over time. Each frame is the same size. The animation may not be represented as a series of frames internally; for example, it may be stored as a sprite and instructions for moving the sprite around a background. To display an animation you don't need to understand its representation, you just ask a gtk.gdk.PixbufAnimationIter for the next frame that should be displayed at a given point in time.

Constructor

    gtk.gdk.PixbufAnimation(filename)

filename :

the name of the file to load.

Returns :

a new gtk.gdk.PixbufAnimation object.

Creates a new gtk.gdk.PixbufAnimation by loading it from a file. The file format is detected automatically. If the file's format does not support multi-frame images, then an animation with a single frame will be created.

This constructor raises the GError exception if any of several error conditions occurred: the file could not be opened, there was no loader for the file's format, there was not enough memory to allocate the image buffer, or the image file contained invalid data.

Methods

gtk.gdk.PixbufAnimation.get_width

    def get_width()

Returns :

the width of the bounding box of the animation.

The get_width() method returns the width of the bounding box of a pixbuf animation.

gtk.gdk.PixbufAnimation.get_height

    def get_height()

Returns :

the height of the bounding box of the animation.

The get_height() method returns the height of the bounding box of a pixbuf animation.

gtk.gdk.PixbufAnimation.is_static_image

    def is_static_image()

Returns :

True if the "animation" was really just an image

The is_static_image() method returns True if you load a file containing a plain, unanimated image. Use the get_static_image() method to retrieve the image.

gtk.gdk.PixbufAnimation.get_static_image

    def get_static_image()

Returns :

the unanimated image representing the animation

The get_static_image() method returns a gtk.gdk.Pixbuf that represents a static image of the animation. If the animation is really just a plain image (has only one frame), this method returns that image. If the animation is an animation, this method returns a reasonable thing to display as a static unanimated image, which might be the first frame, or something more sophisticated. If an animation hasn't loaded any frames yet, this method will return None.

gtk.gdk.PixbufAnimation.get_iter

    def get_iter(start_time=0.0)

start_time :

the time when the animation starts playing

Returns :

a gtk.gdk.PixbufAnimationIter object

The get_iter() method returns a gtk.gdk.PixbufAnimationIter that is used to access the frames of the animation. The iterator provides the frames that should be displayed at specific times. start_time is the start time specified as a float as output from the Python time.time() function. start_time marks the beginning of the animation playback. After creating an iterator, you should immediately display the pixbuf returned by the gtk.gdk.PixbufAnimationIter.get_pixbuf() method. Then, you should install a timeout (with the gobject.timeout_add()() function) or by some other mechanism ensure that you'll update the image after the number of milliseconds specified by the gtk.gdk.PixbufAnimationIter.get_delay_time() method. Each time the image is updated, you should reinstall the timeout with the new, possibly-changed delay time. As a shortcut, if start_time is 0.0 (the default), the current time will be used.

To update the image (i.e. possibly change the result of the gtk.gdk.PixbufAnimationIter.get_pixbuf() method to a new frame of the animation), call the gtk.gdk.PixbufAnimationIter.advance() method.

If you're using a gtk.gdk.PixbufLoader, in addition to updating the image after the delay time, you should also update it whenever you receive the "area_updated" signal and the gtk.gdk.PixbufAnimationIter.on_currently_loading_frame() method returns True. In this case, the frame currently being fed into the loader has received new data, so needs to be refreshed. The delay time for a frame may also be modified after an "area_updated" signal, for example if the delay time for a frame is encoded in the data after the frame itself. So your timeout should be reinstalled after any area_updated signal. A delay time of -1 is possible, indicating "infinite."

Prev Up Next
gtk.gdk.Pixbuf Home gtk.gdk.PixbufAnimationIter
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gladexml.html0000644000000000000000000006774611272037113023436 0ustar rootrootgtk.glade.XML
gtk.glade.XML
Prev The gtk.glade Class Reference Next

gtk.glade.XML

gtk.glade.XML — Allows dynamic loading of user interfaces from XML descriptions.

Synopsis

class gtk.glade.XML(gobject.GObject):
    gtk.glade.XML(fname, root=None, domain="", typedict={})
    def signal_connect(handler_name, func)
    def signal_autoconnect(dict)
    def get_widget(name)
    def get_widget_prefix(name)
    def relative_file(filename)
Functions

    def gtk.glade.xml_new_from_buffer(buffer, size, root="", domain="", typedict={})
    def gtk.glade.get_widget_name(widget)
    def gtk.glade.get_widget_tree(widget)
    def gtk.glade.set_custom_handler(handler, user_data)
    def gtk.glade.bindtextdomain(domainname, dirname="")
    def gtk.glade.textdomain(domainname="")
    def gtk.glade.set_custom_widget_callbacks(dict)

Ancestry

+-- gobject.GObject
      +-- gtk.glade.XML

gtk.glade.XML Signal Prototypes

gobject.GObject Signal Prototypes

Description

This object represents an `instantiation' of an XML interface description. When one of these objects is created, the XML file is read, and the interface is created. The gtk.glade.XML object then provides an interface for accessing the widgets in the interface by the names assigned to them inside the XML description.

The gtk.glade.XML object can also be used to connect handlers to the named signals in the description. Libglade also provides an interface by which it can look up the signal handler names in the program's symbol table and automatically connect as many handlers up as it can that way.

Constructor

    gtk.glade.XML(fname, root=None, domain="", typedict={})

fname :

the XML file name

root :

the widget node in fname to start building from (or None)

domain :

the translation domain for the XML file (or "" for default)

typedict :

A dictionary used to lookup types (or {} for default)

Returns :

a new gtk.glade.XML object

Creates a new gtk.glade.XML object (and the corresponding widgets) from the XML file specified by fname. Optionally it will only build the interface from the widget node specified by root (if it is not None). This feature is useful if you only want to build say a toolbar or menu from the XML file, but not the window it is embedded in. Note also that the XML parse tree is cached to speed up creating another gtk.glade.XML object for the same file.

Methods

gtk.glade.XML.signal_connect

    def signal_connect(handler_name, func)

handler_name :

the signal handler name

func :

the signal handler function

In the glade interface descriptions, signal handlers are specified for widgets by name. The signal_connect() method allows you to connect a callback specified by func to all signals in the gtk.glade.XML file with the signal handler name specified by handler_name.

gtk.glade.XML.signal_autoconnect

    def signal_autoconnect(dict)

dict :

a mapping or an instance

The signal_autoconnect() method is a variation of the gtk.glade.XML.signal_connect method. It uses Python's introspective features to look at the keys (if dict is a mapping) or attributes (if dict is an instance) and tries to match them with the signal handler names given in the interface description. The callbacks referenced by each matched key or attribute are connected to their matching signals. The argument is called dict due to compatibility reasons since originally only the mapping interface was supported. The instance variant was introduced in PyGTK 2.0.

gtk.glade.XML.get_widget

    def get_widget(name)

name :

the name of the widget

Returns :

the widget matching the name or None

The get_widget() method returns a reference to the gtk.Widget specified by name in the interface description. None is returned, if name doesn't specify a widget in the interface.

gtk.glade.XML.get_widget_prefix

    def get_widget_prefix(name)

name :

the prefix the widget names or "" for all widgets

Returns :

A list of widgets that match name as the start of their name or None

The get_widget_prefix() method returns a list of interface gtk.Widget objects that have names prefixed by name. None is returned if no interface widget names match the prefix name.

gtk.glade.XML.relative_file

    def relative_file(filename)

filename :

a relative file pathname

Returns :

the absolute file pathname

The relative_file() method resolves the relative pathname specified by filename, using the directory of the XML file as a base. If filename contains an absolute pathname, then the original file name is returned.

Functions

gtk.glade.xml_new_from_buffer

    def gtk.image_new_from_buffer(buffer, size, root="", domain="", typedict={})

buffer :

the string containing the XML buffer

size :

size of the string

root :

the widget node in fname to start building from (or "")

domain :

the translation domain for the XML file (or "" for default)

typedict :

A dictionary used to lookup types (or {} for default)

Returns :

a new gtk.glade.XML object.

The gtk.glade.xml_new_from_buffer() function creates a new gtk.glade.XML object (and the corresponding widgets) from the string specified by buffer. Optionally it will only build the interface from the widget node specified by root (if it is not ""). This feature is useful if you only want to build say a toolbar or menu from the XML document, but not the window it is embedded in.

gtk.glade.get_widget_name

    def gtk.glade.get_widget_name(widget)

widget :

a gtk.Widget

Returns :

the name of the widget

The gtk.glade.get_widget_name() function returns the name of the gtk.Widget specified by widget that was generated by a gtk.glade.XML object.

gtk.glade.get_widget_tree

    def gtk.glade.get_widget_tree(widget)

widget :

a gtk.Widget

Returns :

the gtk.glade.XML object that built widget

This gtk.glade.get_widget_tree() function is used to get the gtk.glade.XML object that built the gtk.Widget specified by widget.

gtk.glade.set_custom_handler

    def gtk.glade.set_custom_handler(handler, user_data)

handler :

the custom widget handler.

user_data :

user data passed to the custom handler.

This gtk.glade.set_custom_handler() function allows you to override the default behaviour when a Custom widget is found in an interface.

gtk.glade.bindtextdomain

    def gtk.glade.bindtextdomain(domainname, dirname)

domainname :

the name of the application.

dirname :

the directory where to find locales.

Returns :

the value of dirname

This gtk.glade.bindtextdomain() function allows you to use internationalisation with glade.

gtk.glade.textdomain

    def gtk.glade.textdomain(domainname)

domainname :

the name of the application.

Returns :

the value of domainname

This gtk.glade.textdomain() function allows you to use internationalisation with glade.

gtk.glade.set_custom_widget_callbacks

    def gtk.glade.set_custom_widget_callbacks(dict)

dict :

a dictionary of function names.

This gtk.glade.set_custom_widget_callbacks() function takes a dictionary of function names->functions, for an example see PyGTK FAQ 22.7 for an example.

Prev Up Next
The gtk.glade Class Reference Home The pango Class Reference
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkimcontextsimple.html0000644000000000000000000001152711272037113025555 0ustar rootrootgtk.IMContextSimple
gtk.IMContextSimple
Prev The gtk Class Reference Next

gtk.IMContextSimple

gtk.IMContextSimple — an input method context object that supports "simple" input methods

Synopsis

class gtk.IMContextSimple(gtk.IMContext):
    gtk.IMContextSimple()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.IMContext
      +-- gtk.IMContextSimple

gtk.IMContextSimple Signal Prototypes

gobject.GObject Signal Prototypes

gtk.IMContext Signal Prototypes

Description

The gtk.IMContextSimple class is a subclass of gtk.IMContext that provides context support for "simple" input methods. gtk.IMContextSimple does direct keysym to unicode translation and table-driven composition.

Constructor

    gtk.IMContextSimple()

Returns :

a new gtk.IMContextSimple.

Creates a new gtk.IMContextSimple object.

Methods

Prev Up Next
gtk.IMContext Home gtk.IMMulticontext
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/glade-class-reference.html0000644000000000000000000000370011272037113024625 0ustar rootrootThe gtk.glade Class Reference
The gtk.glade Class Reference
Prev   Next

The gtk.glade Class Reference

Table of Contents

gtk.glade.XML — Allows dynamic loading of user interfaces from XML descriptions.
Prev   Next
gtk.gdk Constants Home gtk.glade.XML
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktreemodel.html0000644000000000000000000022166111272037113024313 0ustar rootrootgtk.TreeModel
gtk.TreeModel
Prev The gtk Class Reference Next

gtk.TreeModel

gtk.TreeModel — the tree interface used by gtk.TreeView

Synopsis

class gtk.TreeModel(gobject.GInterface):
    def get_flags()
    def get_n_columns()
    def get_column_type(index)
    def get_iter(path)
    def get_iter_from_string(path_string)
    def get_string_from_iter(iter)
    def get_iter_root()
    def get_iter_first()
    def get_path(iter)
    def get_value(iter, column)
    def iter_next(iter)
    def iter_children(parent)
    def iter_has_child(iter)
    def iter_n_children(iter)
    def iter_nth_child(parent, n)
    def iter_parent(child)
    def ref_node(iter)
    def unref_node(iter)
    def get(iter, column, ...)
    def foreach(func, user_data)
    def row_changed(path, iter)
    def row_inserted(path, iter)
    def row_has_child_toggled(path, iter)
    def row_deleted(path)
    def rows_reordered(path, iter, new_order)
    def filter_new(root=None)
Functions

    def gtk.tree_row_reference_inserted(proxy, path)
    def gtk.tree_row_reference_deleted(proxy, path)

gtk.TreeModel Signal Prototypes

"row-changed"

 def callback(treemodel, path, iter, user_param1, ...)

"row-deleted"

 def callback(treemodel, path, user_param1, ...)

"row-has-child-toggled"

 def callback(treemodel, path, iter, user_param1, ...)

"row-inserted"

 def callback(treemodel, path, iter, user_param1, ...)

"rows-reordered"

 def callback(treemodel, path, iter, new_order, user_param1, ...)

Description

The gtk.TreeModel interface defines a generic tree interface for use by the gtk.TreeView widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data type for it to be viewable by a gtk.TreeView widget.

The model is represented as a hierarchical tree of strongly-typed, columned data. In other words, the model can be seen as a tree where every node has different values depending on which column is being queried. The type of data found in a column is determined by using the Python or GObject type system (i.e. gobject.TYPE_INT, gtk.BUTTON, gobject.TYPE_STRING, etc.). The types are homogeneous per column across all nodes. It is important to note that this interface only provides a way of examining a model and observing changes. The implementation of each individual model decides how and if changes are made.

In order to make life simpler for programmers who do not need to write their own specialized model, two generic models are provided: the gtk.TreeStore and the gtk.ListStore. To use these, the developer simply pushes data into these models as necessary. These models provide the data structure as well as all appropriate tree interfaces. As a result, implementing drag and drop, sorting, and storing data is trivial. For the vast majority of trees and lists, these two models are sufficient.

Models are accessed on a node-column level of granularity. One can query for the value of a model at a certain node and a certain column on that node. A particular node in a model is referenced using a path or a gtk.TreeIter object. Most of the interface consists of operations on a gtk.TreeIter.

A path is essentially a potential node. It is a location on a model that may or may not actually correspond to a node on a specific model. A path can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path "0" refers to the root node and the path "2:4" refers to the fifth child of the third node.

By contrast, a gtk.TreeIter is a reference to a specific node on a specific model. One can convert a path to a treeiter by calling get_iter(). These treeiters are the primary way of accessing a model and are similar to the textiters used by gtk.TextBuffer. The model interface defines a set of operations using them for navigating the model.

It is expected that models fill in the treeiter with private data. For example, the gtk.ListStore model, which is internally a simple linked list, stores a list node in one of the pointers. The gtk.TreeModelSort stores an array and an offset in two of the pointers. Additionally, there is an integer field. This field is generally filled with a unique stamp per model. This stamp is for catching errors resulting from using invalid treeiters with a model.

The lifecycle of a treeiter can be a little confusing at first. treeiters are expected to always be valid for as long as the model is unchanged (and doesn't emit a signal). The model is considered to own all outstanding treeiters and nothing needs to be done to free them from the user's point of view. Additionally, some models guarantee that an treeiter is valid for as long as the node it refers to is valid (most notably the gtk.TreeStore and gtk.ListStore). Although generally uninteresting, as one always has to allow for the case where treeiters do not persist beyond a signal, some very important performance enhancements were made in the sort model. As a result, the gtk.TREE_MODEL_ITERS_PERSIST flag was added to indicate this behavior.

A gtk.TreeModel object supports some of the Python Mapping protocol that allows you to retrieve a gtk.TreeModelRow object representing a row in the model. You can also set the values in a row using the same protocol. For example, you can retrieve the second row of a gtk.TreeModel using any of:

  treemodelrow = model[1]
  treemodelrow = model[(1,)]
  treemodelrow = model['1']
  treemodelrow = model["1"]

Also if the model has two columns both containing strings then the following will set the values of the third row.

  model[(2,)] = ('new string value', 'string 2')

You can also retrieve the number of top level items in the gtk.TreeModel by using the Python len() function:

  n_rows = len(model)

A gtk.TreeModelRowIter object can be retrieved for iterating over the top level rows of a gtk.TreeModel by calling the Python iter() function:

  treemodelrowiter = iter(model)

See the PyGTK tutorial for more information.

Methods

gtk.TreeModel.get_flags

    def get_flags()

Returns :

the flags supported by this interface.

The get_flags() method returns a set of flags supported by this interface. The flags are a bitwise combination of:

gtk.TREE_MODEL_ITERS_PERSIST

Treeiters survive all signals emitted by the tree.

gtk.TREE_MODEL_LIST_ONLY

The model is a list only, and never has children

The flags supported should not change during the lifecycle of the tree_model.

gtk.TreeModel.get_n_columns

    def get_n_columns()

Returns :

The number of columns.

The get_n_columns() method returns the number of columns supported by the treemodel.

gtk.TreeModel.get_column_type

    def get_column_type(index)

index :

the column index.

Returns :

the type of the column.

The get_column_type() method returns the type of the column.

gtk.TreeModel.get_iter

    def get_iter(path)

path :

a path

Returns :

a new gtk.TreeIter that points at path.

The get_iter() method returns a new gtk.TreeIter pointing to path. This method raises a ValueError exception if path is not a valid tree path.

gtk.TreeModel.get_iter_from_string

    def get_iter_from_string(path_string)

path_string :

a string representation of a path.

Returns :

a new gtk.TreeIter that points at the path represented by path_string

The get_iter_from_string() method returns a gtk.TreeIter pointing to the path represented by path_string, if it exists. This method raises a ValueError exception if path_string does not represent a valid tree path.

gtk.TreeModel.get_string_from_iter

    def get_string_from_iter(iter)

iter :

An gtk.TreeIter.

Returns :

A string representation of iter

Note

This method is available in PyGTK 2.2 and above.

The get_string_from_iter() method returns a string representation of the path pointed to by iter. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.

gtk.TreeModel.get_iter_root

    def get_iter_root()

Returns :

a new gtk.TreeIter that points at the first path in the treemodel or None

The get_iter_root() method returns a gtk.TreeIter pointing to the path "0" or None if the tree is empty.

gtk.TreeModel.get_iter_first

    def get_iter_first()

Returns :

a new gtk.TreeIter that points at the first path in the treemodel or None

The get_iter_first() method returns a gtk.TreeIter pointing to the path "0" or None if the tree is empty.

gtk.TreeModel.get_path

    def get_path(iter)

iter :

a gtk.TreeIter.

Returns :

the tree path referenced by iter.

The get_path() method returns the tree path referenced by iter.

gtk.TreeModel.get_value

    def get_value(iter, column)

iter :

a gtk.TreeIter.

column :

the column value to retrieve.

Returns :

a value.

The get_value() method returns the value at column at the path pointed to by iter.

gtk.TreeModel.iter_next

    def iter_next(iter)

iter :

a gtk.TreeIter.

Returns :

a gtk.TreeIter pointing at the next row or None if there is no next row.

The iter_next() method returns a gtk.TreeIter pointing at the row at the current level after the row referenced by iter. If there is no next row, None is returned. iter is unchanged.

gtk.TreeModel.iter_children

    def iter_children(parent)

parent :

the gtk.TreeIter pointing to the parent or None.

Returns :

the new gtk.TreeIter to be set to the first child or None

The iter_children() method returns a new gtk.TreeIter pointing to the first child of parent. If parent has no children, None is returned. parent will remain a valid node after this method has been called.

If parent is None returns the first node, equivalent to gtk.TreeModel.get_iter_first().

gtk.TreeModel.iter_has_child

    def iter_has_child(iter)

iter :

a gtk.TreeIter to test for children.

Returns :

True if iter has children.

The iter_has_child() method returns True if iter has children, or False otherwise.

gtk.TreeModel.iter_n_children

    def iter_n_children(iter)

iter :

a gtk.TreeIter, or None.

Returns :

the number of children of iter.

The iter_n_children() method returns the number of children that iter has. As a special case, if iter is None, then the number of top level nodes is returned.

gtk.TreeModel.iter_nth_child

    def iter_nth_child(parent, n)

parent :

a gtk.TreeIter to get the child from, or None.

n :

Then index of the desired child.

Returns :

the gtk.TreeIter that is set to the nth child or None

The iter_nth_child() method returns a new gtk.TreeIter pointing to the child of parent, with the index specified by n. The first index is 0. If n is too big, or parent has no children, this method returns None. parent will remain a valid node after this function has been called. As a special case, if parent is None, then the treeiter points to the nth root node.

gtk.TreeModel.iter_parent

    def iter_parent(child)

child :

The gtk.TreeIter.

Returns :

a new gtk.TreeIter set to the parent of child or None

The iter_parent() method returns a gtk.TreeIter pointing to the parent of child. If child is at the top level, and doesn't have a parent, then None is returned. child will remain a valid node after this method has been called.

gtk.TreeModel.ref_node

    def ref_node(iter)

iter :

a gtk.TreeIter.

The ref_node() method lets the treemodel ref the node that iter points to. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. This function is primarily meant as a way for views to let the caching model know when nodes are being displayed (and hence, whether or not to cache that node.) For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view. A model should be expected to be able to get a treeiter independent of it's reffed state.

gtk.TreeModel.unref_node

    def unref_node(iter)

iter :

a gtk.TreeIter.

The unref_node() method lets the treemodel unref the node that iter points to. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see the ref_node() method. Please note that nodes that are deleted are not unreffed.

gtk.TreeModel.get

    def get(iter, column, ...)

iter :

a gtk.TreeIter pointing at the row to retrieve data value from

column :

a column number

... :

zero or more column numbers

Returns :

a tuple containing the column values

Note

This method is available in PyGTK 2.4 and above.

The get() method returns a tuple containing the values of one or more cells in the row referenced by the gtk.TreeIter specified by iter. column specifies the first column number to retrieve a value from. The additional arguments should contain integer column numbers for additional column values. For example, to get values from columns 0 and 3, you would write:

  value0, value3 = treemodel_get(iter, 0, 3)

gtk.TreeModel.foreach

    def foreach(func, user_data)

func :

a function to be called on each row

user_data :

the user data to passed to func.

The foreach() method calls func on each node in model in a depth-first fashion. user_data is passed to func each time it is called. If func returns True, then the operation ceases, and foreach() returns.

The signature of func is:

  def func(model, path, iter, user_data)

where model is the treemodel, path is the current path, and iter is a treeiter pointing to path.

If func is an object method its signature will be:

  def func(self, model, path, iter, user_data)

gtk.TreeModel.row_changed

    def row_changed(path, iter)

path :

a path pointing to the changed row

iter :

a gtk.TreeIter pointing to the changed row

The row_changed() method emits the "row-changed" signal on the treemodel with the parameters path and iter that are the path and a treeiter pointing to the path of the changed row.

gtk.TreeModel.row_inserted

    def row_inserted(path, iter)

path :

a path pointing to the inserted row

iter :

a gtk.TreeIter pointing to the inserted row

The row_inserted() method emits the "row-inserted" signal on the treemodel with the parameters path and iter that are the path and a treeiter pointing to the path of the inserted row.

gtk.TreeModel.row_has_child_toggled

    def row_has_child_toggled(path, iter)

path :

a path pointing to the changed row

iter :

a gtk.TreeIter pointing to the changed row

The row_has_child_toggled() method emits the "row-has-child-toggled" signal on the treemodel with the parameters path and iter that are the path and a treeiter pointing to the path of the changed row. This should be called by models after the child state of a node changes.

gtk.TreeModel.row_deleted

    def row_deleted(path)

path :

a path pointing to the previous location of the deleted row.

The row_deleted() method emits the "row-deleted" signal on the treemodel. This should be called by models after a row has been removed. The location pointed to by path should be the location that the deleted row was at. It may not be a valid location anymore.

gtk.TreeModel.rows_reordered

    def rows_reordered(path, iter, new_order)

path :

A tree path pointing to the tree node whose children have been reordered, or None or () or "" to indicate the top level node.

iter :

A valid gtk.TreeIter pointing to the node whose children have been reordered, or None to indicate the top level node.

new_order :

a sequence of integers containing the new indexes of the children, i.e. the former child n is now at the position specified by new_order[n].

The rows_reordered() method emits the "rows_reordered" signal on the tree model. This method should be called by a tree model when its rows have been reordered. If iter is None to indicate that the top level rows have been reordered, path should be None or () or "".

gtk.TreeModel.filter_new

    def filter_new(root=None)

root :

a tree path or None.

Returns :

A new gtk.TreeModel.

Note

This method is available in PyGTK 2.4 and above.

The filter_new() method creates a new gtk.TreeModel, with the tree model as the child_model and the virtual root specified by root.

Functions

gtk.tree_row_reference_inserted

    def gtk.tree_row_reference_inserted(proxy, path)

proxy :

a GObject

path :

a row position that was inserted

The gtk.tree_row_reference_inserted() function lets a set of row references know that the model emitted the "row_inserted" signal for the row specified by path.

gtk.tree_row_reference_deleted

    def gtk.tree_row_reference_deleted(proxy, path)

proxy :

a GObject

path :

a row position that was deleted

The gtk.tree_row_reference_deleted() function lets a set of row references know that the model emitted the "row_deleted" signal for the row specified by path.

Signals

The "row-changed" gtk.TreeModel Signal

    def callback(treemodel, path, iter, user_param1, ...)

treemodel :

the treemodel that received the signal

path :

a path

iter :

a gtk.TreeIter pointing at path

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "row-changed" signal is emitted when the row specified by path and pointed to by iter has changed in the treemodel. Usually, this means that one or more column values have changed.

The "row-deleted" gtk.TreeModel Signal

    def callback(treemodel, path, user_param1, ...)

treemodel :

the treemodel that received the signal

path :

a path

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "row-deleted" signal is emitted when the row that was specified by path is deleted from treemodel.

The "row-has-child-toggled" gtk.TreeModel Signal

    def callback(treemodel, path, iter, user_param1, ...)

treemodel :

the treemodel that received the signal

path :

a path

iter :

a gtk.TreeIter pointing at path

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "row-has-child-toggled" signal is emitted when the child state of the row specified by path and pointed to by iter has changed in treemodel.

The "row-inserted" gtk.TreeModel Signal

    def callback(treemodel, path, iter, user_param1, ...)

treemodel :

the treemodel that received the signal

path :

a path

iter :

a gtk.TreeIter pointing at path

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "row-inserted" signal is emitted when the row specified by path and pointed to by iter is inserted into treemodel. The row referenced by iter will be empty so using the get_value() method will always return None. Connect to the "row-changed" signal if you want to track value changes.

The "rows-reordered" gtk.TreeModel Signal

    def callback(treemodel, path, iter, new_order, user_param1, ...)

treemodel :

the treemodel that received the signal

path :

a path

iter :

a gtk.TreeIter pointing at path

new_order :

an array of reordered row numbers

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "rows-reordered" signal is emitted when the treemodel child rows of the row specified by path and pointed to by iter are reordered. new_order is an array of node index numbers representing the new order of the rows. The value of new_order cannot be retrieved in PyGTK because it is passed as an opaque pointer (gobject.GPointer) value. iter may be None and path an empty tuple to indicate that the top level rows were reordered.

Prev Up Next
gtk.TreeIter Home gtk.TreeModelFilter
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkbuildable.html0000644000000000000000000007264111272037113024260 0ustar rootrootgtk.Buildable
gtk.Buildable
Prev The gtk Class Reference Next

gtk.Buildable

gtk.Buildable — Interface for objects that can be built by GtkBuilder.

Synopsis

class gtk.Buildable(gobject.GInterface):
    def add_child(builder, child, type)
    def construct_child(builder, name)
    def get_internal_child(builder, childname)
    def get_name()
    def parser_finished(builder)
    def set_name(name)

Ancestry

+-- gobject.GInterface
  +-- gtk.Buildable

Known Implementation

gtk.Buildable is implementated by gtk.Bin, gtk.TreeView, gtk.ButtonBox, gtk.Paned, gtk.ColorSelectionDialog, gtk.VButtonBox, gtk.TearoffMenuItem, gtk.Entry, gtk.OptionMenu, gtk.Image, gtk.Calendar, gtk.Fixed, gtk.LinkButton, gtk.HButtonBox, gtk.InputDialog, gtk.RadioButton, gtk.VRuler, gtk.VSeparator, gtk.VBox, gtk.Curve, gtk.RadioToolButton, gtk.HRuler, gtk.ToggleButton, gtk.SeparatorMenuItem, gtk.HScale, gtk.Table, gtk.TreeViewColumn, gtk.ImageMenuItem, gtk.FileChooserButton, gtk.CheckButton, gtk.RadioMenuItem, gtk.MenuShell, gtk.StatusBar, gtk.DrawingArea, gtk.Button, gtk.IconView, gtk.Notebook, gtk.UIManager, gtk.Socket, gtk.VScale, gtk.GammaCurve, gtk.Alignment, gtk.MenuToolButton, gtk.MenuItem, gtk.PageSetupUnixDialog, gtk.RecentChooserMenu, gtk.ToolItem, gtk.HSeparator, gtk.ProgressBar, gtk.ActionGroup, gtk.Range, gtk.Assistant, gtk.FileSelection, gtk.ToolBar, gtk.AccellLabel, gtk.RecentChooserDialog, gtk.Expander, gtk.Scale, gtk.TreeStore, gtk.MessageDialog, gtk.Separator, gtk.Layout, gtk.FontSelection, gtk.CellView, gtk.Invisible, gtk.Window, gtk.SeparatorToolItem, gtk.FileChooserWidget, gtk.CheckMenuItem, gtk.ToolButton, gtk.Misc, gtk.EventBox, gtkFontButton., gtk.EntryCompletion, gtk.Dialog, gtk.HBox, gtk.Combo, gtk.AspectFrame, gtk.AboutDialog, gtk.HScrollBar, gtk.Liststore, gtk.ScaleButton, gtk.RecentChooserWidget, gtk.ToggleToolButton, gtk.ComboBox, gtk.VScroolBar, gtk.Frame, gtk.SpinButton, gtk.Label, gtk.FontSelectionDialog, gtk.ColorSelection, gtk.Item, gtk.Widget, gtk.RecentAction, gtk.VolumeButton, gtk.MenuBar, gtk.TextView, gtk.Arrow, gtk.ToggleAction, gtk.RadioAction, gtk.Plug, gtk.HPaned, gtk.Box, gtk.Menu, gtk.Action, gtk.PrintUnixDialog, gtk.ComboBoxEntry, gtk.ColorButton, gtk.FileChooserDialog, gtk.Ruler, gtk.VPaned, gtk.HandleBox, gtk.Srollbar, gtk.Container, gtk.SizeGroup, gtk.ViewPort, gtk.ScrolledWindow,

Description

In order to allow construction from a GtkBuilder UI description, an object class must implement the GtkBuildable interface. The interface includes methods for setting names and properties of objects, parsing custom tags, constructing child objects.

The GtkBuildable interface is implemented by all widgets and many of the non-widget objects that are provided by GTK+. The main user of this interface is GtkBuilder, there should be very little need for applications to call any gtk.Buildable methods.

Methods

gtk.Buildable.add_child

    def add_child(builder, child, type)

builder :

 A gtk.Builder

child :

The child to add.

type :

 The kind of child or None.

Note

This method is available in PyGTK 2.12 and above.

The add_child() method adds a child to buildable. type is an optional string describing how the child should be added.

gtk.Buildable.construct_child

    def construct_child(builder, name)

builder :

 A gtk.Builder

name :

The name of child to construct.

Returns :

The constructed child.

Note

This method is available in PyGTK 2.12 and above.

The construct_child() method constructs a child of buildable with the name name.

GtkBuilder calls this function if a "constructor" has been specified in the UI definition.

gtk.Buildable.get_internal_child

    def get_internal_child(builder, childname)

builder :

 A gtk.Builder

childname :

The name of child.

Returns :

The internal child of the buildable object.

Note

This method is available in PyGTK 2.12 and above.

The get_internal_child() method gets the internal child called childname of the buildable object.

gtk.Buildable.get_name

    def get_name()

Returns :

 The name set with set_name

Note

This method is available in PyGTK 2.12 and above.

The get_name() method gets the name of the buildable object.

GtkBuilder sets the name based on the the GtkBuilder UI description used to construct the buildable.

gtk.Buildable.parser_finished

    def parser_finished(builder)

builder :

 A gtk.Builder

Note

This method is available in PyGTK 2.12 and above.

The parser_finished() method is called when the builder finishes the parsing of a GtkBuilder UI definition. Note that this will be called once for each time add_from_file or add_from_string is called on a builder.

gtk.Buildable.set_name

    def set_name(name)

name :

The name to set.

Note

This method is available in PyGTK 2.12 and above.

The set_name() method sets the name of the buildable object.

Prev Up Next
gtk.Builder Home gtk.ButtonBox
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcellview.html0000644000000000000000000005456311272037113024152 0ustar rootrootgtk.CellView
gtk.CellView
Prev The gtk Class Reference Next

gtk.CellView

gtk.CellView — a widget displaying a single row of a gtk.TreeModel (new in PyGTK 2.6).

Synopsis

class gtk.CellView(gtk.Widget, gtk.CellLayout):
    gtk.CellView()
    def set_model(model)
    def set_displayed_row(path)
    def get_displayed_row()
    def get_size_of_row(path, requisition)
    def set_background_color(color)
    def get_cell_renderers()
Functions

    def gtk.cell_view_new_with_text(text)
    def gtk.cell_view_new_with_markup(markup)
    def gtk.cell_view_new_with_pixbuf(pixbuf)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.CellView

Implemented Interfaces

gtk.CellView implements gtk.Buildable gtk.CellLayout

gtk.CellView Properties

gtk.Object Properties

gtk.Widget Properties

"background"WriteThe background color as a string. Default value: None
"background-gdk"Read-WriteThe background color as a gtk.gdk.Color.
"background-set"Read-WriteIf True, use the "background-gdk" property to set the background color.
"model"Read-WriteThe model for cell view. Available in GTK+ 2.10 and above.

gtk.CellView Style Properties

gtk.Widget Style Properties

gtk.CellView Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

Description

Note

This widget is available in PyGTK 2.6 and above.

The gtk.CellView is a widget that displays one row of a gtk.TreeModel. gtk.CellView implements the gtk.CellLayout interface that provides for the addition and management of gtk.CellRenderer objects.

Constructor

    gtk.CellView()

Returns :

a new gtk.CellView

Note

This constructor is available in PyGTK 2.6 and above.

Creates a new gtk.CellView widget.

Methods

gtk.CellView.set_model

    def set_model(model)

model :

a gtk.TreeModel or None

Note

This method is available in PyGTK 2.6 and above.

The set_model() method sets the gtk.TreeModel used by the cell view to that specified by model. If model is None the cell view's model will be unset.

gtk.CellView.set_displayed_row

    def set_displayed_row(path)

path :

a tree path or None to unset the row

Note

This method is available in PyGTK 2.6 and above.

The set_displayed_row() method sets the row of the model that is currently displayed to the path specified by path. If path is None the display row will be unset, and the contents of the cell view "stick" at their last value. This is not normally a desired result, but may be a needed intermediate state if say, the model for the cell view becomes temporarily empty.

gtk.CellView.get_displayed_row

    def get_displayed_row()

Returns :

the path of the currently displayed row in the cell view's model

Note

This method is available in PyGTK 2.6 and above.

The get_displayed_row() method returns the path of the currently displayed row as set by the set-displayed_row() method.

gtk.CellView.get_size_of_row

    def get_size_of_row(path)

path :

the path of a row

Returns :

a gtk.Requisition containing the required size data

Note

This method is available in PyGTK 2.6 and above.

The get_size_of_row() method returns a gtk.Requisition containing the size required for displaying the row with the tree path specified by path.

gtk.CellView.set_background_color

    def set_background_color(color)

color :

Note

This method is available in PyGTK 2.6 and above.

The set_background_color() method sets the background color of the cell view to the gtk.gdk.Color specified by color.

gtk.CellView.get_cell_renderers

    def get_cell_renderers()

Returns :

a list of the gtk.CellRenderer objects of the cell view.

Note

This method is available in PyGTK 2.6 and above.

The get_cell_renderers() method returns a list containing the gtk.CellRenderer objects used by the cell view.

Functions

gtk.cell_view_new_with_text

    def gtk.cell_view_new_with_text(text)

text :

a string

Returns :

a new gtk.CellView

Note

This function is available in PyGTK 2.6 and above.

The gtk.cell_view_new_with_text() function creates a new gtk.CellView with a gtk.CellRendererText displaying the string specified by text.

gtk.cell_view_new_with_markup

    def gtk.cell_view_new_with_markup(markup)

markup :

a string containing Pango markup to be displayed.

Returns :

a new gtk.CellView

Note

This function is available in PyGTK 2.6 and above.

The gtk.cell_view_new_with_markup() function creates a new gtk.CellView with a gtk.CellRendererText displaying the Pango markup specified by markup.

gtk.cell_view_new_with_pixbuf

    def gtk.cell_view_new_with_pixbuf(pixbuf)

pixbuf :

a gtk.gdk.Pixbuf

Returns :

a new gtk.CellView

Note

This function is available in PyGTK 2.6 and above.

The gtk.cell_view_new_with_pixbuf() function creates a new gtk.CellView with a gtk.CellRendererPixbuf displaying the gtk.gdk.Pixbuf specified by pixbuf.

Prev Up Next
gtk.CellRendererToggle Home gtk.CheckButton
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktooltip.html0000644000000000000000000004633511272037113024030 0ustar rootrootgtk.Tooltip
gtk.Tooltip
Prev The gtk Class Reference Next

gtk.Tooltip

gtk.Tooltip — Add tips to your widgets (new in PyGTK 2.12)

Synopsis

class gtk.Tooltip(gobject.GObject):
    def set_custom(widget)
    def set_icon(pixbuf)
    def set_icon_from_icon_name(icon_name, size)
    def set_icon_from_stock(stock_id, size)
    def set_markup(markup)
    def set_text(text)
Functions
 
    def gtk.tooltip_trigger_tooltip_query(display)

Ancestry

+-- gobject.GObject
  +-- gtk.Tooltip

Description

gtk.Tooltip belongs to the new tooltips API that was introduced in GTK+ 2.12 and which deprecates the old gtk.Tooltips API.

Basic tooltips can be realized simply by using gtk.Widget.set_tooltip_text() or gtk.Widget.set_tooltip_markup() without any explicit tooltip object.

When you need a tooltip with a little more fancy contents, like adding an image, or you want the tooltip to have different contents per gtk.TreeView row or cell, you will have to do a little more work:

  • Set the GtkWidget:has-tooltip property to True, this will make GTK+ monitor the widget for motion and related events which are needed to determine when and where to show a tooltip.
  • Connect to the GtkWidget::query-tooltip signal. This signal will be emitted when a tooltip is supposed to be shown. One of the arguments passed to the signal handler is a gtk.Tooltip object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functions like set_icon. There are functions for setting the tooltip's markup, setting an image from a stock icon, or even putting in a custom widget.
  • Return True from your query-tooltip handler. This causes the tooltip to be show. If you return False, it will not be shown.

In the probably rare case where you want to have even more control over the tooltip that is about to be shown, you can set your own gtk.Window which will be used as tooltip window. This works as follows:

Methods

gtk.Tooltip.set_custom

    def set_custom(widget)

widget :

A gtk.Widget

Note

This method is available in PyGTK 2.12 and above.

The set_custom() method replaces the widget packed into the tooltip with custom_widget. By default a box with a gtk.Image and gtk.Label is embedded in the tooltip, which can be configured using set_markup and set_icon.

gtk.Tooltip.set_icon

    def get_value(pixbuf)

pixbuf :

A gtk.gdk.Pixbuf or None.

Note

This method is available in PyGTK 2.12 and above.

The set_icon() method sets the icon of the tooltip (which is in front of the text) to be pixbuf. If pixbuf is None, the image will be hidden.

gtk.Tooltip.set_icon_from_icon_name

    def set_icon_from_icon_name(icon_name, size)

icon_name :

an icon name, or None.

size :

A stock icon size.

Note

This method is available in PyGTK 2.14 and above.

The set_icon_from_icon_name() method sets the icon of the tooltip (which is in front of the text) to be the icon indicated by icon_name with the size indicated by size. If icon_name is None, the image will be hidden.

gtk.Tooltip.set_icon_from_stock

    def set_icon_from_stock(stock_id, size)

stock_id :

A stock icon name, or None.

size :

A stock icon size.

Note

This method is available in PyGTK 2.12 and above.

The set_icon_from_stock() method sets the icon of the tooltip (which is in front of the text) to be the stock item indicated by stock_id with the size indicated by size. If stock_id is None, the image will be hidden.

gtk.Tooltip.set_markup

    def set_markup(markup)

markup :

A markup string (see Pango markup format) or None.

Note

This method is available in PyGTK 2.12 and above.

The set_markup() method sets the text of the tooltip to be markup, which is marked up with the Pango text markup language. If markup is None, the label will be hidden.

gtk.Tooltip.set_text

    def set_text(text)

text :

A text string or None.

Note

This method is available in PyGTK 2.12 and above.

The set_text() method sets the text of the tooltip to be text. If text is None, the label will be hidden. See also set_markup.

Functions

gtk.tooltip_trigger_tooltip_query

    def tooltip_trigger_tooltip_query(display)

display :

A gtk.gdk.Display

Note

This function is available in PyGTK 2.12 and above.

The tooltip_trigger_tooltip_query() function triggers a new tooltip query on display, in order to update the current visible tooltip, or to show/hide the current tooltip. This function is useful to call when, for example, the state of the widget changed by a key press.

Prev Up Next
gtk.ToolShell Home gtk.Tooltips
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangofontdescription.html0000644000000000000000000013745211272037113026070 0ustar rootrootpango.FontDescription
pango.FontDescription
Prev The pango Class Reference Next

pango.FontDescription

pango.FontDescription — an object representing a description of a font.

Synopsis

class pango.FontDescription(gobject.GBoxed):
    pango.FontDescription(str=None)
    def copy()
    def copy_static()
    def hash()
    def set_family(family)
    def set_family_static(family)
    def get_family()
    def set_style(style)
    def get_style()
    def set_variant(variant)
    def get_variant()
    def set_weight(weight)
    def get_weight()
    def set_stretch(stretch)
    def get_stretch()
    def set_size(size)
    def get_size()
    def get_set_fields()
    def unset_fields(to_unset)
    def merge(desc_to_merge, replace_existing)
    def merge_static(desc_to_merge, replace_existing)
    def better_match(old_match, new_match)
    def to_string()
    def to_filename()
    def set_absolute_size(size)
    def get_size_is_absolute()

Description

A pango.FontDescription represents the description of an ideal font. They are used to both specify the characteristics of a font to load and to list the available fonts on the system.

Constructor

    pango.FontDescription()

Returns :

a pango.FontDescription object.

Creates a new pango.FontDescription object from the representation in the string specified by str. The format of the string representation is:

  "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]"

where FAMILY-LIST is a comma separated list of families optionally terminated by a comma, STYLE_OPTIONS is a whitespace separated list of words where each WORD describes one of style, variant, weight, or stretch, and SIZE is an decimal number (size in points). For example the following are all valid string representations:

  "sans bold 12"
  "serif,monospace bold italic condensed 16"
  "normal 10"

The commonly available font families are: Normal, Sans, Serif and Monospace. The available styles are:

Normal

the font is upright.

Oblique

the font is slanted, but in a roman style.

Italic

the font is slanted in an italic style.

The available weights are:

Ultra-Light

the ultralight weight (= 200)

Light

the light weight (=300)

Normal

the default weight (= 400)

Bold

the bold weight (= 700)

Ultra-Bold

the ultra-bold weight (= 800)

Heavy

the heavy weight (= 900)

The available variants are:

Normal

Small-Caps

The available stretch styles are:

Ultra-Condensed

the smallest width

Extra-Condensed

Condensed

Semi-Condensed

Normal

the normal width

Semi-Expanded

Expanded

Extra-Expanded

Ultra-Expanded

the widest width

Methods

pango.FontDescription.copy

    def copy()

Returns :

a new pango.FontDescription

The copy() method returns a new copy of this font description.

pango.FontDescription.copy_static

    def copy_static()

Returns :

a new pango.FontDescription..

The copy_static() method is like the copy() method, but only a shallow copy is made of the family name and other allocated attribute fields. The result can only be used until the original font description is modified or freed. This is meant to be used when the copy is only needed temporarily.

pango.FontDescription.hash

    def hash()

Returns :

the hash value.

The hash() method computes and returns a hash of the pango.FontDescription.

pango.FontDescription.set_family

    def set_family(family)

family :

a string representing the family name.

The set_family() method sets the family name attribute field of the font description to the value specified by family. The family name represents a family of related font styles, and will resolve to a particular pango.FontFamily. In some uses of pango.FontDescription, it is also possible to use a comma separated list of family names for this field.

pango.FontDescription.set_family_static

    def set_family_static(family)

family :

a string representing the family name.

The set_family_static() method is like the set_family(), except that no copy of family is made. The caller must make sure that the string passed in stays around until the font description is no longer needed or the family name is set again. This method can be used if family is only needed temporarily.

pango.FontDescription.get_family

    def get_family()

Returns :

the family name or None if not previously set.

The get_family() method returns the family name attribute field of the font description. See the set_family() method for more information.

pango.FontDescription.set_style

    def set_style(style)

style :

the style for the font description

The set_style() method sets the slant style attribute field of the pango.FontDescription to the value specified by style. The value of style must be either pango.STYLE_NORMAL, pango.STYLE_ITALIC, or pango.STYLE_OBLIQUE. Most fonts will either have a italic style or an oblique style, but not both, and font matching in Pango will match italic specifications with oblique fonts and vice-versa if an exact match is not found.

pango.FontDescription.get_style

    def get_style()

Returns :

the slant style for the font description.

The get_style() method returns the slant style attribute field of the pango.FontDescription. See the set_style() method for more details. Use the get_set_fields() method to find out if the field was explicitly set.

pango.FontDescription.set_variant

    def set_variant(variant)

variant :

the variant type for the font description.

The set_variant() method sets the variant attribute field of a font description to the value specified by variant. The value of variant must be either pango.VARIANT_NORMAL or pango.VARIANT_SMALL_CAPS.

pango.FontDescription.get_variant

    def get_variant()

Returns :

the variant style of the font description.

The get_variant() method returns the variant style of a pango.FontDescription. See the set_variant() method for more information. Use the get_set_fields() method to find out if the field was explicitly set.

pango.FontDescription.set_weight

    def set_weight(weight)

weight :

the weight for the font description.

The set_weight() method sets the weight attribute field of a font description to the value specified by weight. The value of weight specifies how bold or light the font should be in a range from 100 to 900. The predefined values of weight are:

pango.WEIGHT_ULTRALIGHT

the ultralight weight (= 200)

pango.WEIGHT_LIGHT

the light weight (=300)

pango.WEIGHT_NORMAL

the default weight (= 400)

pango.WEIGHT_BOLD

the bold weight (= 700)

pango.WEIGHT_ULTRABOLD

the ultrabold weight (= 800)

pango.WEIGHT_HEAVY

the heavy weight (= 900)

pango.FontDescription.get_weight

    def get_weight()

Returns :

the weight field for the font description.

The get_weight() method returns the value of the weight attribute of a font description. See the set_weight() method for more information. Use the get_set_fields() method to determine if the attribute was explicitly set.

pango.FontDescription.set_stretch

    def set_stretch(stretch)

stretch :

the stretch for the font description

The set_stretch() method sets the stretch attribute field of a font description to the value specified by stretch. The value of stretch specifies how narrow or wide the font should be relative to the base width of the font family:

pango.STRETCH_ULTRA_CONDENSED

the narrowest width

pango.STRETCH_EXTRA_CONDENSED

pango.STRETCH_CONDENSED

pango.STRETCH_SEMI_CONDENSED

pango.STRETCH_NORMAL

the normal (base) width

pango.STRETCH_SEMI_EXPANDED

pango.STRETCH_EXPANDED

pango.STRETCH_EXTRA_EXPANDED

pango.STRETCH_ULTRA_EXPANDED

the widest width

pango.FontDescription.get_stretch

    def get_stretch()

Returns :

the stretch field for the font description

The get_stretch() method returns the stretch attribute field of a font description. See the set_stretch() method for more details. Use the get_set_fields() method to determine if the field was explicitly set.

pango.FontDescription.set_size

    def set_size(size)

size :

the size for the font description in pango units.

The set_size() method sets the size attribute field of a font description to the value specified by size. The value of size is specified in pango units. There are pango.SCALE (1024) pango units in one device unit (the device unit is a point for font sizes).

pango.FontDescription.get_size

    def get_size()

Returns :

the size for the font description in pango units.

The get_size() method returns the value of the size attribute field of a font description. See the get_size() method for more information. There are pango.SCALE pango units in one device unit (point). If the stretch attribute field has not previously been set, 0 is returned. Use the get_set_fields() method to determine if the field was explicitly set.

pango.FontDescription.get_set_fields

    def get_set_fields()

Returns :

a bitmask with bits set corresponding to the font description attribute fields that have been set.

The get_set_fields() method returns a value that indicates which attribute fields in a font description have been set. The value returned is a combination of:

pango.FONT_MASK_FAMILY

the font family has been set.

pango.FONT_MASK_STYLE

the font slant style has been set.

pango.FONT_MASK_VARIANT

the font variant has been set.

pango.FONT_MASK_WEIGHT

the font weight has been set.

pango.FONT_MASK_STRETCH

the font stretch has been set.

pango.FONT_MASK_SIZE

the font size has been set.

pango.FontDescription.unset_fields

    def unset_fields(to_unset)

to_unset :

a bitmask of attribute fields in the font description to unset.

The unset_fields() method unsets the attribute fields (specified by to_unset) in the pango.FontDescription. Note that this merely marks the attribute fields cleared, it does not clear the settings.

pango.FontDescription.merge

    def merge(desc_to_merge, replace_existing)

desc_to_merge :

the pango.FontDescription to merge into the font description

replace_existing :

if True, replace attribute fields in the font description with the corresponding values from desc_to_merge, even if they are already exist.

The merge() method merges the attribute fields that are set in the pango.FontDescription specified by desc_to_merge into the attribute fields in the font description. If replace_existing is False, only fields in the font description that are not already set are affected. If replace_existing is True, attribute fields that are already set will also be replaced.

pango.FontDescription.merge_static

    def merge_static(desc_to_merge, replace_existing)

desc_to_merge :

the pango.FontDescription to merge from

replace_existing :

if True, replace attribute fields in the font description with the corresponding values from desc_to_merge, even if they are already exist.

The merge_static() method is similar to the merge() method, but only a shallow copy is made of the family name and other allocated fields. The font description can only be used until desc_to_merge is modified or freed. This is meant to be used when the merged font description is only needed temporarily.

pango.FontDescription.better_match

    def better_match(old_match, new_match)

old_match :

a pango.FontDescription, or None

new_match :

a pango.FontDescription

Returns :

True if new_match is a better match

The better_match() method determines if the attributes of the pango.FontDescription specified by new_match are a closer match for the font description than the pango.FontDescription specified by old_match. If old_match is None, determines if new_match is a match at all. The weight and style attribute need only match approximately but the other attributes must match exactly.

pango.FontDescription.to_string

    def to_string()

Returns :

a string representation of the font description.

The to_string() method returns a string representation of the font description. See the pango.FontDescription() constructor for a description of the format of the string representation. The family list in the string description will only have a terminating comma if the last word of the list is a valid style option.

pango.FontDescription.to_filename

    def to_filename()

Returns :

a string representation of the font description as a filename.

The to_filename() method returns a filename representation of a font description. The filename is identical to the result from calling the to_string() method, but underscores replace characters that are not typically used in filenames, and it is in lower case only.

pango.FontDescription.set_absolute_size

    def set_absolute_size(size)

size :

the new size, in Pango units. There are pango.SCALE Pango units in one device unit. For an output backend where a device unit is a pixel, a size value of 10 * pango.SCALE gives a 10 pixel font.

Note

This method is available in PyGTK 2.10 and above.

Sets the size field of a font description, in device units. This is mutually exclusive with pango.FontDescription.set_size().

pango.FontDescription.get_size_is_absolute

    def get_size_is_absolute()

Returns :

whether the size for the font description is in points or device units. Use pango.FontDescription.get_set_fields() to find out if the size field of the font description was explicitly set or not.

Note

This method is available in PyGTK 2.10 and above.

Determines whether the size of the font is in points or device units. See pango.FontDescription.set_size() and pango.FontDescription.set_absolute_size().

Prev Up Next
pango.Font Home pango.FontFace
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcombobox.html0000644000000000000000000021336511272037113024145 0ustar rootrootgtk.ComboBox
gtk.ComboBox
Prev The gtk Class Reference Next

gtk.ComboBox

gtk.ComboBox — a widget used to choose from a list of items (new in PyGTK 2.4)

Synopsis

class gtk.ComboBox(gtk.Bin, gtk.CellLayout):
    gtk.ComboBox(model=None)
    def get_wrap_width()
    def set_wrap_width(width)
    def get_row_span_column()
    def set_row_span_column(row_span)
    def get_column_span_column()
    def set_column_span_column(column_span)
    def get_button_sensitivity()
    def set_button_sensitivity(sensitivity)
    def get_active()
    def set_active(index)
    def get_active_iter()
    def set_active_iter(iter)
    def set_model(model=None)
    def get_model()
    def append_text(text)
    def insert_text(position, text)
    def prepend_text(text)
    def remove_text(position)
    def get_active_text()
    def popup()
    def popdown()
    def get_popup_accessible()
    def set_row_separator_func(func=None, data=None)
    def get_add_tearoffs()
    def set_add_tearoffs(add_tearoffs)
    def get_focus_on_click()
    def set_focus_on_click(focus_on_click)
    def get_title()
    def set_title(title)
Functions

    def gtk.combo_box_new_text()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.ComboBox

Implemented Interfaces

gtk.ComboBox implements gtk.Buildable atk.ImplementorIFace gtk.CellEditable gtk.CellLayout

gtk.ComboBox Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"active"Read-WriteThe index of the item that is currently active.. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this property has the value of the first index of the path of the item. This property is available in GTK+ 2.4 and above.
"add-tearoffs"Read-WriteIf True generated menus have tearoff menu items. Note that this only affects menu style combo boxes. Default value: False. Available in GTK+ 2.6 and above.
"button-sensitivity"Read-WriteWhether the dropdown button is sensitive when the model is empty. Default value: gtk.SENSITIVITY_AUTO. Available in GTK+ 2.14 and above.
"column-span-column"Read-WriteThe TreeModel column containing the column span values. This property is available in GTK+ 2.4 and above
"focus-on-click"Read-WriteIf True the combo box grabs focus when it is clicked with the mouse. Default value: True
"has-frame"Read-WriteIf True the combo box grabs focus when it is clicked with the mouse. Default value: True. Available in GTK+ 2.6 and above.
"model"Read-WriteThe TreeModel for the combo box. This property is available in GTK+ 2.4 and above.
"popup-shown"Read-WriteIf True the dropdown menu of the combobox is popped up. Note that this property is mainly useful, because it allows you to connect to the "notify::popup-shown" signal. Available in GTK+ 2.10 and above.
"row-span-column"Read-WriteThe TreeModel column containing the row span values. This property is available in GTK+ 2.4 and above.
"tearoff-title"Read-WriteA title that may be displayed by the window manager when the popup is torn-off. Default value: "". Available in GTK+ 2.10 and above
"wrap-width"Read-WriteThe number of columns to use to lay out the popup items. This property is available in GTK+ 2.4 and above.

gtk.ComboBox Style Properties

gtk.Widget Style Properties

"appears-as-list"Read-WriteIf True, the combo box dropdowns should look like lists rather than menus.
"arrow-size"Read-WriteSets the minimum size of the arrow in the combo box. Note that the arrow size is coupled to the font size, so in case a larger font is used, the arrow will be larger than set by arrow size. Allowed values: >= 0. Default value: 15. Available in GTK+ 2.12 and above.
"shadow-type"Read-WriteWhich kind of shadow to draw around the combo box. Default value: gtk.SHADOW_NONE. This property is available in GTK+ 2.12 and above.

gtk.ComboBox Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.CellEditable Signal Prototypes

"changed"

 def callback(combobox, user_param1, ...)

"move-active"

 def callback(combobox, scroll_type, user_param1, ...)

"popdown"

 def callback(combobox, user_param1, ...)

"popup"

 def callback(combobox, user_param1, ...)

Description

Note

This widget is available in GTK+ 2.4 and PyGTK 2.4 and above.

The gtk.ComboBox is a replacement for the gtk.OptionMenu. The gtk.ComboBox implements the gtk.CellLayout interface that provides a number of useful methods for managing the contents. A gtk.ComboBox is created with the gtk.ComboBox() constructor that is associated with the optional gtk.TreeModel. If no gtk.TreeModel is specified it can be added later with the set_model() method.

Alternatively, the gtk.combo_box_new_text() function creates a simple gtk.ComboBox and associated gtk.ListStore model. A gtk.CellRendererText is also created and packed in the new combo box. In this simple combo box each list item is a text string that can be selected. The convenience methods append_text(), prepend_text(), insert_text() and remove_text() can be used to manage the contents of the gtk.ComboBox. Using the gtk.combo_box_new_text() function is equivalent to:

  liststore = gtk.ListStore(gobject.TYPE_STRING)
  combobox = gtk.ComboBox(liststore)
  cell = gtk.CellRendererText()
  combobox.pack_start(cell, True)
  combobox.add_attribute(cell, 'text', 0)

Constructor

    gtk.ComboBox(model=None)

model :

A valid gtk.TreeModel.

Returns :

A new gtk.ComboBox.

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.ComboBox associated with the optional gtk.TreeModel specified by model. If model is not specified the combo box will not have an associated tree model.

Methods

gtk.ComboBox.get_wrap_width

    def get_wrap_width()

Returns :

The wrap width.

Note

This method is available in PyGTK 2.6 and above.

The get_wrap_width() method returns the value of the "wrap-width" property of the combo box as set by the set_wrap_width() method. The wrap width is basically the preferred number of columns to use to lay out the popup i.e. lays out the popup items in a table with width columns.

gtk.ComboBox.set_wrap_width

    def set_wrap_width(width)

width :

The preferred number of columns of width.

Note

This method is available in PyGTK 2.4 and above.

The set_wrap_width() method sets the wrap width (and the "wrap-width" property) of the combo box to the value specified by width. The wrap width is basically the preferred number of columns to use to lay out the popup i.e. lays out the popup items in a table with width columns.

gtk.ComboBox.get_row_span_column

    def get_row_span_column()

Returns :

The row span column.

Note

This method is available in PyGTK 2.6 and above.

The get_row_span_column() method returns the value of the "row-span-column" property. The "row-span-column" property indicates the column in the associated gtk.TreeModel row that contains an integer that indicates how many rows the item should span.

gtk.ComboBox.set_row_span_column

    def set_row_span_column(row_span)

row_span :

A column in the model passed during construction.

Note

This method is available in PyGTK 2.4 and above.

The set_row_span_column() method sets the "row-span-column" property to the value specified by row_span. The "row-span-column" property indicates the column in the associated gtk.TreeModel row that contains an integer that indicates how many rows the item should span.

gtk.ComboBox.get_column_span_column

    def get_column_span_column()

Returns :

The column span column.

Note

This method is available in PyGTK 2.6 and above.

The get_column_span_column() method returns the value of the "column-span-column" property. The "column-span-column" property indicates the column in the associated gtk.TreeModel row that contains an integer that indicates how many columns the item should span.

gtk.ComboBox.set_column_span_column

    def set_column_span_column(column_span)

column_span :

A column in the model passed during construction.

Note

This method is available in PyGTK 2.4 and above.

The set_column_span_column() method sets the "column-span-column" property to the value specified by column_span. The "column-span-column" property indicates the column in the associated gtk.TreeModel row that contains an integer that indicates how many columns the item should span.

gtk.ComboBox.get_button_sensitivity

    def get_button_sensitivity()

Returns :

gtk.SENSITIVITY_ON if the dropdown button is sensitive when the model is empty, gtk.SENSITIVITY_OFF if the button is always insensitive or gtk.SENSITIVITY_AUTO if it is only sensitive as long as the model has one item to be selected.

Note

This method is available in PyGTK 2.14 and above.

The get_button_sensitivity() method returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model.

gtk.ComboBox.set_button_sensitivity

    def set_button_sensitivity(sensitivity)

sensitivity :

specify the sensitivity of the dropdown button.

Note

This method is available in PyGTK 2.14 and above.

The set_button_sensitivity() method sets whether the dropdown button of the combo box should be always sensitive (gtk.SENSITIVITY_ON), never sensitive (gtk.SENSITIVITY_OFF) or only if there is at least one item to display (gtk.SENSITIVITY_AUTO).

gtk.ComboBox.get_active

    def get_active()

Returns :

An integer which is the model index of the currently active item, or -1 if there's no active item.

Note

This method is available in PyGTK 2.4 and above.

The get_active() method returns the value of the "active" property which is the index in the model of the currently active item, or -1 if there's no active item. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this method returns the first path index of the active item. For example if the path of the active item is (1, 0, 2) this method will return 1.

gtk.ComboBox.set_active

    def set_active(index)

index :

An index in the model passed during construction, or -1 to have no active item.

Note

This method is available in PyGTK 2.4 and above.

The set_active() method sets the active item of the combo_box to the item with the model index specified by index. If index is -1 the combo box will have no active item. The "active" property is also set to the value of index.

gtk.ComboBox.get_active_iter

    def get_active_iter()

Returns :

A gtk.TreeIter that points at the active item or None if there is no active item.

Note

This method is available in PyGTK 2.4 and above.

The get_active_iter() method returns a gtk.TreeIter that points to the current active item or None if there is no active item.

gtk.ComboBox.set_active_iter

    def set_active_iter(iter)

iter :

A valid gtk.TreeIter pointing at an item in the associated gtk.TreeModel.

Note

This method is available in PyGTK 2.4 and above.

The set_active_iter() method sets the current active item to be the one referenced by iter in the associated gtk.TreeModel. iter must correspond to a path of depth one. The "active" property is also set by this method.

gtk.ComboBox.set_model

    def set_model(model=None)

model :

A gtk.TreeModel.

Note

This method is available in PyGTK 2.4 and above.

The set_model() method sets the model used by the combo box to the value specified by model. The "model" property will also be set to the value of model. A previously set model will be unset. If model is None or not specified, the old model will be unset.

Note

In PyGTK 2.4.0 the model could not be None and did not default to None.

gtk.ComboBox.get_model

    def get_model()

Returns :

A gtk.TreeModel or None.

Note

This method is available in PyGTK 2.4 and above.

The get_model() method returns the value of the "model" property which contains the gtk.TreeModel that is acting as data source for the combo_box or None if no gtk.TreeModel is associated with the combo box.

gtk.ComboBox.append_text

    def append_text(text)

text :

A string.

Note

This method is available in PyGTK 2.4 and above.

The append_text() method appends the string specified by text to the list of strings stored in the combo box gtk.ListStore. Note that you can only use this method with combo boxes constructed with the gtk.combo_box_new_text() function.

gtk.ComboBox.insert_text

    def insert_text(position, text)

position :

A model index where the text should be inserted.

text :

A string.

Note

This method is available in PyGTK 2.4 and above.

The insert_text() method inserts the string specified by text in the combo box gtk.ListStore at the index specified by position. Note that you can only use this method with combo boxes constructed with the gtk.combo_box_new_text() function.

gtk.ComboBox.prepend_text

    def prepend_text(text)

text :

A string.

Note

This method is available in PyGTK 2.4 and above.

The prepend_text() method prepends the string specified by text to the list of strings stored in the gtk.ListStore associated with the combo_box. Note that you can only use this method with combo boxes constructed with the gtk.combo_box_new_text() function.

gtk.ComboBox.remove_text

    def remove_text(position)

position :

Index of the item to remove.

Note

This method is available in PyGTK 2.4 and above.

The remove_text() method removes the string at the index specified by position in the associated gtk.ListStore. Note that you can only use this function with combo boxes constructed with the gtk.combo_box_new_text() function.

gtk.ComboBox.get_active_text

    def get_active_text()

Returns :

The currently active text.

Note

This method is available in PyGTK 2.6 and above.

The get_active_text() method returns the currently active string or None if no entry is selected. Note that you can only use this function with combo boxes constructed with the gtk.combo_box_new_text() function.

gtk.ComboBox.popup

    def popup()

Note

This method is available in PyGTK 2.4 and above.

The popup() method pops up the menu or dropdown list of the combo box. This method is mostly intended for use by accessibility technologies; applications should have little use for it.

gtk.ComboBox.popdown

    def popdown()

Note

This method is available in PyGTK 2.4 and above.

The popdown() method hides the menu or dropdown list of the combo box. This method is mostly intended for use by accessibility technologies; applications should have little use for it.

gtk.ComboBox.get_popup_accessible

    def get_popup_accessible()

Returns :

the accessible object corresponding to the popup.

Note

This method is available in PyGTK 2.6 and above.

The get_popup_accessible() method gets the accessible object corresponding to the popup. This method is mostly intended for use by accessibility technologies; applications should have little use for it.

gtk.ComboBox.set_row_separator_func

    def set_row_separator_func(func=None, data=None)

func :

a function or None

data :

user data to pass to func

Note

This method is available in PyGTK 2.6 and above.

The set_row_separator_func() method sets the row separator function to func, which is used to determine if a row should be drawn as a separator. If func is None, no separators are drawn. This is the default value.

The signature of func is:

  def func(model, iter, user_data):

where model is the gtk.TreeModel used by the combo box, iter is a gtk.TreeIter pointing at a row in model and user_data is data. func returns True if the row is a separator. A common way to implement func is to have a boolean column in model, that indicates if the row is a separator.

gtk.ComboBox.get_add_tearoffs

    def get_add_tearoffs()

Returns :

True if menus should have a tearoff menuitem.

Note

This method is available in PyGTK 2.6 and above.

The get_add_tearoffs() method returns the value of the "add-tearoffs" property.

gtk.ComboBox.set_add_tearoffs

    def set_add_tearoffs(add_tearoffs)

add_tearoffs :

if True add tearoff menu items

Note

This method is available in PyGTK 2.6 and above.

The set_add_tearoffs() method sets the "add-tearoffs" property to the value of add_tearoffs. If add_tearoffs is True, the popup menu should have a tearoff menu item.

gtk.ComboBox.get_focus_on_click

    def get_focus_on_click()

Returns :

True if the combo box grabs focus when it is clicked with the mouse.

Note

This method is available in PyGTK 2.6 and above.

The get_focus_on_click() method returns the value of the "focus-on-click" property.

gtk.ComboBox.set_focus_on_click

    def set_focus_on_click(focus_on_click)

focus_on_click :

if True the combo box grabs focus when clicked with the mouse.

Note

This method is available in PyGTK 2.6 and above.

The set_focus_on_click() method sets the value of the "focus-on-click" property to the value of focus_on_click. If focus_on_click is True the combo box grabs focus when clicked with the mouse.

gtk.ComboBox.get_title

    def get_title()

Returns :

the menu's title in tearoff mode..

Note

This method is available in PyGTK 2.10 and above.

The get_title() method returns the value of the "tearoff-title" property that contains the current title of the menu in tearoff mode. See the set_add_tearoffs() method for more information.

gtk.ComboBox.set_title

    def set_title(title)

title :

a title for the menu in tearoff mode.

Note

This method is available in PyGTK 2.10 and above.

The set_title() method sets the "tearoff-title" property to the value of title. The "tearoff-title" property contains the menu's title in tearoff mode.

Functions

gtk.combo_box_new_text

    def gtk.combo_box_new_text()

Returns :

A new gtk.ComboBox for text items.

Note

This function is available in PyGTK 2.4 and above.

The gtk.combo_box_new_text() function is a convenience function that constructs a new text combo box, which is a gtk.ComboBox just displaying strings. If you use this function to create a text combo box, you should only manipulate its data source with the following convenience methods: append_text(), insert_text(), prepend_text() and remove_text().

Signals

The "changed" gtk.ComboBox Signal

    def callback(combobox, user_param1, ...)

combobox :

the combo box that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.4 and above.

The "changed" signal is emitted when a new item in the combo box is selected.

The "move-active" gtk.ComboBox Signal

    def callback(combobox, scroll_type, user_param1, ...)

combobox :

the combo box that received the signal

scroll_type :

a GTK Scroll Type Constants

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.12 and above.

The "move-active" signal is a keybinding signal which gets emitted to move the active selection.

The "popdown" gtk.ComboBox Signal

    def callback(combobox, user_param1, ...)

combobox :

the combo box that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.12 and above.

The "popdown" signal is a keybinding signal which gets emitted to popdown the combo box list. The default bindings for this signal are Alt+Up and Escape.

The "popup" gtk.ComboBox Signal

    def callback(combobox, user_param1, ...)

combobox :

the combo box that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in PyGTK 2.12 and above.

The "popup" signal is a keybinding signal which gets emitted to popup the combo box list. The default bindings for this signal are Alt+Down.

Prev Up Next
gtk.Combo Home gtk.ComboBoxEntry
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkframe.html0000644000000000000000000004517511272037113023431 0ustar rootrootgtk.Frame
gtk.Frame
Prev The gtk Class Reference Next

gtk.Frame

gtk.Frame — a bin with a decorative frame and optional label.

Synopsis

class gtk.Frame(gtk.Bin):
    gtk.Frame(label=None)
    def set_label(label)
    def get_label()
    def set_label_widget(label_widget)
    def get_label_widget()
    def set_label_align(xalign, yalign)
    def get_label_align()
    def set_shadow_type(type)
    def get_shadow_type()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Frame

Implemented Interfaces

gtk.Frame implements gtk.Buildable

gtk.Frame Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"label"Read-WriteThe text of the frame's label
"label-widget"Read-WriteThe widget to display in place of the usual frame label.
"label-xalign"Read-WriteThe horizontal alignment of the label widget in the range of 0.0 to 1.0
"label-yalign"Read-WriteThe vertical alignment of the decoration within the label widget height in the range of 0.0 to 1.0
"shadow-type"Read-WriteThe style of the frame's border; one of: gtk.SHADOW_NONE, gtk.SHADOW_IN, gtk.SHADOW_OUT, gtk.SHADOW_ETCHED_IN, gtk.SHADOW_ETCHED_OUT

gtk.Frame Style Properties

gtk.Widget Style Properties

gtk.Frame Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

The gtk.Frame widget is a gtk.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().

Constructor

    gtk.Frame(label=None)

label :

a string to use as the label text or None if no label is required.

Returns :

a new frame widget

Creates a new gtk.Frame widget with the label text specified by label. If label is None no label is created.

Methods

gtk.Frame.set_label

    def set_label(label)

label :

a string to be used as the label text

The set_label() method sets the text of the label as specified by label. If label is None the current label is removed.

gtk.Frame.get_label

    def get_label()

Returns :

the text in the label, or None if there is no label widget or the label widget is not a gtk.Label.

The get_label() method returns the text in the label widget. If there is no label widget or the label widget is not a gtk.Label the method returns None.

gtk.Frame.set_label_widget

    def set_label_widget(label_widget)

label_widget :

the new label widget

The set_label_widget() method set the label widget (usually to something other than a gtk.Label widget) for the frame. This widget will appear embedded in the top edge of the frame as a title.

gtk.Frame.get_label_widget

    def get_label_widget()

Returns :

the label widget, or None if there is no label widget.

The get_label_widget() method retrieves the label widget for the frame. See set_label_widget().

gtk.Frame.set_label_align

    def set_label_align(xalign, yalign)

xalign :

the horizontal alignment of the label widget along the top edge of the frame (in the range of 0.0 to 1.0)

yalign :

the vertical alignment of the decoration with respect to the label widget (in the range 0.0 to 1.0)

The set_label_align() method sets the alignment of the frame's label widget and decoration (defaults are 0.0 and 0.5) as specified by xalign and yalign. The xalign value specifies the fraction of free horizontal space that is allocated to the left of the label widget. The yalign value specifies the fraction of label widget height above the decoration.

gtk.Frame.get_label_align

    def get_label_align()

Returns :

a tuple containing the x and y alignments of the frame's label widget

The get_label_align() method returns a tuple containing the X and Y alignment of the frame's label widget and decoration. See the set_label_align() method.

gtk.Frame.set_shadow_type

    def set_shadow_type(type)

type :

a shadow type: gtk.SHADOW_NONE, gtk.SHADOW_IN, gtk.SHADOW_OUT, gtk.SHADOW_ETCHED_IN, gtk.SHADOW_ETCHED_OUT

The set_shadow_type() method sets the frame's shadow type to the value of type. The type must be one of: gtk.SHADOW_NONE, gtk.SHADOW_IN, gtk.SHADOW_OUT, gtk.SHADOW_ETCHED_IN, gtk.SHADOW_ETCHED_OUT

gtk.Frame.get_shadow_type

    def get_shadow_type()

Returns :

the current shadow type of the frame.

The get_shadow_type() method retrieves the shadow type of the frame; one of: gtk.SHADOW_NONE, gtk.SHADOW_IN, gtk.SHADOW_OUT, gtk.SHADOW_ETCHED_IN, gtk.SHADOW_ETCHED_OUT. See set_shadow_type().

Prev Up Next
gtk.FontSelectionDialog Home gtk.GammaCurve
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/gtk-functions.html0000644000000000000000000024401711272037113023315 0ustar rootrootgtk Functions
gtk Functions
Prev The gtk Class Reference Next

gtk Functions

gtk Functions — miscellaneous functions

Synopsis

gtk.AboutDialog Functions

    def gtk.about_dialog_set_email_hook(func, data)
    def gtk.about_dialog_set_url_hook(func, data)

gtk.AccelGroup Functions

    def gtk.accelerator_valid(keyval, modifiers)
    def gtk.accelerator_parse(accelerator)
    def gtk.accelerator_name(accelerator_key, accelerator_mods)
    def gtk.accelerator_set_default_mod_mask(default_mod_mask)
    def gtk.accelerator_get_default_mod_mask()
    def gtk.accelerator_get_label(accelerator_key, accelerator_mods)
    def gtk.accel_groups_from_object(object)

gtk.AccelMap Functions

    def gtk.accel_map_add_entry(accel_path, accel_key, accel_mods)
    def gtk.accel_map_lookup_entry(accel_path)
    def gtk.accel_map_change_entry(accel_path, accel_key, accel_mods, replace)
    def gtk.accel_map_foreach(foreach_func, data=None)
    def gtk.accel_map_foreach_unfiltered(foreach_func, data=None)
    def gtk.accel_map_get()
    def gtk.accel_map_load(file_name)
    def gtk.accel_map_save(file_name)
    def gtk.accel_map_load_fd(fd)
    def gtk.accel_map_save_fd(fd)
    def gtk.accel_map_lock_path(accel_path)
    def gtk.accel_map_unlock_path(accel_path)
    def gtk.accel_map_add_filter(filter_pattern)

gtk.CellView Functions

    def gtk.cell_view_new_with_text(text)
    def gtk.cell_view_new_with_markup(markup)
    def gtk.cell_view_new_with_pixbuf(pixbuf)

gtk.Clipboard Functions

    def gtk.clipboard_get()

gtk.ColorSelection Functions

    def gtk.color_selection_palette_from_string(str)
    def gtk.color_selection_palette_to_string(colors)

gtk.ComboBox Functions

    def gtk.combo_box_new_text()

gtk.ComboBoxEntry Functions

    def gtk.combo_box_entry_new_text()

gtk.Container Functions

    def gtk.container_class_install_child_property(klass, property_id, pspec)
    def gtk.container_class_list_child_properties(klass)

gtk.Dialog Functions

    def gtk.alternative_dialog_button_order(screen=None)

gtk.Expander Functions

    def gtk.expander_new_with_mnemonic(label)

gtk.IconFactory Functions

    def gtk.icon_factory_lookup_default(stock_id)

gtk.IconSource Functions

    def gtk.icon_size_lookup(icon_size)
    def gtk.icon_size_lookup_for_settings(settings, icon_size)
    def gtk.icon_size_register(name, width, height)
    def gtk.icon_size_register_alias(alias, target)
    def gtk.icon_size_from_name(name)
    def gtk.icon_size_get_name(size)

gtk.IconTheme Functions

    def gtk.icon_theme_get_default()
    def gtk.icon_theme_get_for_screen(screen)
    def gtk.icon_theme_add_builtin_icon(icon_name, size, pixbuf)

gtk.Image Functions

    def gtk.image_new_from_stock(stock_id, size)
    def gtk.image_new_from_icon_set(icon_set, size)
    def gtk.image_new_from_animation(animation)
    def gtk.image_new_from_icon_name(icon_name, size)

gtk.ItemFactory Functions

    def gtk.item_factory_from_widget(widget)
    def gtk.item_factory_path_from_widget(widget)

gtk.LinkButton Functions

    def gtk.link_button_set_uri_hook(func, data=None)

gtk.Object Functions

    def gtk.bindings_activate(object, keyval, modifiers)
    def gtk.bindings_activate_event(object, event)
    def gtk.binding_entry_add_signal(object, keyval, modifiers, signal_name, ...)
    def gtk.binding_entry_remove(class_type, keyval, modifiers)

gtk.PaperSize Functions

    def gtk.paper_size_new_from_ppd(ppd_name, ppd_display_name, width, height)
    def gtk.paper_size_new_cutom(name, display_name, width, height, unit)
    def gtk.paper_size_get_default()

gtk.Plug Functions

    def gtk.plug_new_for_display(display, socket_id)

gtk.RcStyle Functions

    def gtk.rc_add_default_file(filename)
    def gtk.rc_set_default_files(filenames)
    def gtk.rc_get_default_files()
    def gtk.rc_get_style_by_paths(settings, widget_path, class_path, type)
    def gtk.rc_reparse_all_for_settings(settings, force_load)
    def gtk.rc_reset_styles(settings)
    def gtk.rc_parse(filename)
    def gtk.rc_parse_string(rc_string)
    def gtk.rc_reparse_all()
    def gtk.rc_find_module_in_path(module_file)
    def gtk.rc_get_theme_dir()
    def gtk.rc_get_module_dir()
    def gtk.rc_get_im_module_path()
    def gtk.rc_get_im_module_file()

gtk.RecentManager Functions

    def gtk.recent_manager_get_default()
    def gtk.recent_manager_get_for_screen(screen)

gtk.SelectionData Functions

    def gtk.selection_owner_set_for_display(display, widget, selection, time=0)
    def gtk.target_list_add_image_targets(list=None, info=0, writable=False)
    def gtk.target_list_add_text_targets(list=None, info=0)
    def gtk.target_list_add_uri_targets(list=None, info=0)

gtk.Settings Functions

    def gtk.settings_get_default()
    def gtk.settings_get_for_screen(screen)

gtk.StatusIcon Functions

    def gtk.status_icon_new_from_pixbuf(pixbuf)
    def gtk.status_icon_new_from_file(filename)
    def gtk.status_icon_new_from_stock(stock_id)
    def gtk.status_icon_new_from_icon_name(icon_name)
    def gtk.status_icon_position_menu(menu, statusicon)

gtk.Tooltips Functions

    def gtk.tooltips_data_get(widget)

gtk.TreeModel Functions

    def gtk.tree_row_reference_inserted(proxy, path)
    def gtk.tree_row_reference_deleted(proxy, path)

gtk.Widget Functions

    def gtk.widget_push_colormap(cmap)
    def gtk.widget_push_composite_child()
    def gtk.widget_pop_composite_child()
    def gtk.widget_pop_colormap()
    def gtk.widget_get_default_style()
    def gtk.widget_set_default_colormap(colormap)
    def gtk.widget_get_default_colormap()
    def gtk.widget_get_default_visual()
    def gtk.widget_set_default_direction(dir)
    def gtk.widget_get_default_direction()
    def gtk.widget_class_list_style_properties(widget)
    def gtk.widget_class_install_style_property(widget, pspec)

gtk.Window Functions

    def gtk.window_set_default_icon(icon)
    def gtk.window_set_default_icon_from_file(filename)
    def gtk.window_set_default_icon_list(...)
    def gtk.window_get_default_icon_list()
    def gtk.window_set_auto_startup_notification(setting)
    def gtk.window_list_toplevels()
    def gtk.window_set_default_icon_name(name)

Stock Item Functions

    def gtk.stock_add(items)
    def gtk.stock_lookup(stock_id)
    def gtk.stock_list_ids()

Miscellaneous Functions

    def gtk.check_version(required_major, required_minor, required_micro)
    def gtk.draw_insertion_cursor(widget, drawable, area, location, is_primary, direction, draw_arrow)
    def gtk.get_default_language()
    def gtk.events_pending()
    def gtk.main_do_event(event)
    def gtk.main()
    def gtk.main_level()
    def gtk.main_quit()
    def gtk.main_iteration(block)
    def gtk.main_iteration_do(block)
    def gtk.grab_get_current()
    def gtk.quit_add(level, func, ...)
    def gtk.quit_remove(quit_handler_id)
    def gtk.get_current_event()
    def gtk.get_current_event_state()
    def gtk.get_current_event_time()
    def gtk.init_check()

Description

All PyGTK functions for the gtk module are listed above categorized by class. Those functions associated with a class have their descriptions included with the class reference. Those functions that are not associated with a specific class are described below.

Functions

gtk.check_version

    def gtk.check_version(required_major, required_minor, required_micro)

required_major :

the required major version number

required_minor :

the required minor version number

required_micro :

the required micro version number

Returns :

None if the underlying GTK+ library is compatible or a string describing the mismatch

The gtk.check_version() function checks the underlying GTK+ library version against the version specified by required_major, required_minor and required_micro. If the library is compatible this function returns None; otherwise it returns a string describing the mismatch.

gtk.draw_insertion_cursor

    def gtk.draw_insertion_cursor(widget, drawable, area, location, is_primary, direction, draw_arrow)

widget :

a gtk.Widget

drawable :

a gtk.gdk.Drawable

area :

the rectangle to which the output is clipped, or None if the output should not be clipped

location :

the location to draw the cursor (location.width is ignored)

is_primary :

 if True the cursor should be the primary cursor color.

direction :

the direction of the cursor; either gtk.TEXT_DIR_LTR or gtk.TEXT_DIR_RTL

draw_arrow :

if True draw a directional arrow on the cursor. Should be False unless the cursor is split.

Note

This function is available in PyGTK 2.4 and above.

The gtk.draw_insertion_cursor() function draws a text caret on the gtk.gdk.Drawable specified by drawable at the position specified by location. area specifies a clipping rectangle or is None if the output should not be clipped. If is_primary is True the cursor should be the primary cursor color. direction specifies whether the cursor is right-to-left or left-to-right. This is a convenience function for drawing the standard cursor shape.

gtk.get_default_language

    def gtk.get_default_language()

Returns :

a pango.Language object for the default language

The gtk.get_default_language() function returns a pango.Language describing the default language.

gtk.events_pending

    def gtk.events_pending()

Returns :

True if any events are pending

The gtk.events_pending() function returns True if any events are pending. This can be used to update the user interface and invoke timeouts etc. while doing some time intensive computation.

gtk.main_do_event

    def gtk.main_do_event()

event :

a gtk.gdk.Event to process

The gtk.main_do_event() function processes a single gtk.gdk.Event. This function is public only to allow filtering of events between GDK and GTK+. You will not usually need to call this function directly. While you should not call this function directly, you might want to know how exactly events are handled. So here is what this function does with the event:

  1. Compress enter/leave notify events. If the event passed builds an enter-leave pair together with the next event (peeked from GDK) both events are thrown away. This is to avoid a backlog of (de-)highlighting widgets crossed by the pointer.
  2. Find the widget which got the event. If the widget can't be determined the event is thrown away unless it belongs to a INCR transaction. In that case it is passed to gtk_selection_incr_event().
  3. Then the event is passed on a stack so you can query the currently handled event with gtk.get_current_event().

  4. The event is sent to a widget. If a grab is active all events for widgets that are not in the contained in the grab widget are sent to the latter with a few exceptions:

    • Deletion and destruction events are still sent to the event widget for obvious reasons.
    • Events which directly relate to the visual representation of the event widget.
    • Leave events are delivered to the event widget if there was an enter event delivered to it before without the paired leave event.
    • Drag events are not redirected because it is unclear what the semantics of that would be.

    Another point of interest might be that all key events are first passed through the key snooper functions if there are any. Read the description of gtk_key_snooper_install() if you need this feature.

  5. After finishing the delivery the event is popped from the event stack.

gtk.main

    def gtk.main()

The gtk.main() function runs the main loop until the gtk.main_quit() function is called. You can nest calls to gtk.main(). In that case the call to the gtk.main_quit() function will make the innermost invocation of the main loop return.

gtk.main_level

    def gtk.main_level()

Returns :

the nesting level of the current invocation of the main loop

The gtk.main_level() function returns the current nesting level of the main loop. The nesting level is increased by calling the gtk.main() function and reduced by calling the gtk.main_quit() function.

gtk.main_quit

    def gtk.main_quit()

The gtk.main_quit() function terminates the current main loop level started by the most recent call to the gtk.main() function. The nesting level of the main loop is reduced by calling this function.

gtk.main_iteration

    def gtk.main_iteration(block=True)

block :

if True block if no events are pending

Returns :

True if the gtk.main_quit() function has been called for the innermost main loop.

The gtk.main_iteration() function runs a single iteration of the mainloop. If no events are waiting to be processed PyGTK will block until the next event is noticed if block is True. This function is identical to the gtk.main_iteration_do() function.

gtk.main_iteration_do

    def gtk.main_iteration_do(block=True)

block :

if True block if no events are pending

Returns :

True if the gtk.main_quit() function has been called for the innermost main loop.

The gtk.main_iteration_do() function runs a single iteration of the main loop. If block is True block until an event occurs. This function is identical to the gtk.main_iteration() function.

gtk.grab_get_current

    def gtk.grab_get_current()

Returns :

the gtk.Widget that has the grab currently or None if no grab is active

The gtk.grab_get_current() function returns the gtk.Widget that has the grab or None if no grab is active.

gtk.quit_add

    def gtk.quit_add(level, func, ...)

level :

the level at which termination func shall be called. You can pass 0 here to have func run at the termination of the current main loop.

func :

the function to call - it should return 0 to be removed from the list of quit handlers

... :

optional parameter(s) to be passed to func

Returns :

a handle for this quit handler (you need this for the gtk.quit_remove() function).

The gtk.quit_add() function registers a function specified by func to be called when the specified main loop level is exited. func should return 0 to be removed from the list of quit handlers. This function returns a handler ID that is used when removing the handler with the gtk.quit_remove() function.

gtk.quit_remove

    def gtk.quit_remove(quit_handler_id)

quit_handler_id :

the ID of a quit handler

The gtk.quit_remove() function removes the quit handler specified by quit_handler_id from the list of quit handlers.

gtk.get_current_event

    def gtk.get_current_event()

Returns :

a copy of the current event or None

Note

This function is available in PyGTK 2.6 and above.

The gtk.get_current_event() function returns a copy of the event currently being processed by GTK+. For example, if you get a "clicked" signal from gtk.Button, the current event will be the GdkEventButton that triggered the "clicked" signal. If there is no current event, the function returns None.

gtk.get_current_event_state

    def gtk.get_current_event_state()

Returns :

the state of the current event if any or None if there is no current event or state

Note

This function is available in PyGTK 2.6 and above.

The gtk.get_current_event_state() function returns the state of the current event or None if there is no current event or state.

gtk.get_current_event_time

    def gtk.get_current_event_time()

Returns :

the timestamp of the current event or 0L

The gtk.get_current_event_time() function returns the timestamp from the current event or 0L if there is no current event.

gtk.init_check

    def gtk.init_check()

Returns :

True if GTK has been successfully initialized

The gtk.init_check() function tries to initialize GTK and returns True if successful.

gtk.remove_log_handlers

    def gtk.remove_log_handlers()

Note

This function is available in PyGTK 2.10 and above.

The gtk.remove_log_handlers() function removes the default PyGTK log handlers,

gtk.add_log_handlers

    def gtk.add_log_handlers()

Note

This function is available in PyGTK 2.10 and above.

The gtk.add_log_handlers() function installs the default PyGTK log handlers,

Prev Up Next
gtk.WindowGroup Home Stock Items
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkbuilder.html0000644000000000000000000006677611272037113023777 0ustar rootrootgtk.Builder
gtk.Builder
Prev The gtk Class Reference Next

gtk.Builder

gtk.Builder — Build an interface from an XML UI definition.

Synopsis

class gtk.Builder(gobject.GObject):
    gtk.Builder()
    def add_from_file(filename)
    def add_from_string(buffer)
    def connect_signals(object, user_data=None)
    def get_object(name)
    def get_objects()
    def get_translation_domain()
    def get_type_from_name(type_name)
    def set_translation_domain(domain)

Ancestry

+-- gobject.GObject
  +-- gtk.Builder

gtk.Builder Properties

"translation-domain"Read/WriteThe translation domain used when translating property values that have been marked as translatable in interface descriptions. If the translation domain is None, GtkBuilder uses gettext(), otherwise dgettext(). Default value: None

Description

A gtk.Builder is an auxiliary object that reads textual descriptions of a user interface and instantiates the described objects. To pass a description to a gtk.Builder, call add_from_file or add_from_string. These functions can be called multiple times; the builder merges the content of all descriptions.

A gtk.Builder holds a reference to all objects that it has constructed and drops these references when it is finalized. This finalization can cause the destruction of non-widget objects or widgets which are not contained in a toplevel window. For toplevel windows constructed by a builder, it is the responsibility of the user to call gtk.Widget.destroy to get rid of them and all the widgets they contain.

The functions get_object and get_objects can be used to access the widgets in the interface by the names assigned to them inside the UI description. Toplevel windows returned by these functions will stay around until the user explicitly destroys them with gtk_widget_destroy(). Other widgets will either be part of a larger hierarchy constructed by the builder (in which case you should not have to worry about their lifecycle), or without a parent, in which case they have to be added to some container to make use of them.

The function connect_signals and variants thereof can be used to connect handlers to the named signals in the description.

gtk.Builder UI definition

gtk.Builder parses textual descriptions of user interfaces which are specified in an XML format which can be roughly described by the DTD below. We refer to these descriptions as GtkBuilder UI definitions or just UI definitions if the context is clear. Do not confuse GtkBuilder UI Definitions with GtkUIManager UI Definitions, which are more limited in scope. 


<!ELEMENT interface object* >
<!ELEMENT object    (property|signal|child|ANY)* >
<!ELEMENT property  PCDATA >
<!ELEMENT signal    EMPTY >
<!ELEMENT child     (object|ANY*) >

<!ATTLIST interface  domain         	    #IMPLIED >
<!ATTLIST object     id             	    #REQUIRED
                     class          	    #IMPLIED
                     type-func      	    #IMPLIED
                     constructor    	    #IMPLIED >
<!ATTLIST property   name           	    #REQUIRED
                     translatable   	    #IMPLIED 
                     comments               #IMPLIED
                     context                #IMPLIED >
<!ATTLIST signal     name           	    #REQUIRED
                     handler        	    #REQUIRED
                     after          	    #IMPLIED
                     swapped        	    #IMPLIED
                     object         	    #IMPLIED
                     last_modification_time #IMPLIED >
<!ATTLIST child      type           	    #IMPLIED
                     internal-child 	    #IMPLIED >

The toplevel element is <interface>. It optionally takes a "domain" attribute, which will make the builder look for translated strings using dgettext() in the domain specified. This can also be done by calling set_translation_domain on the builder. Objects are described by <object> elements, which can contain <property> elements to set properties, <signal> elements which connect signals to handlers, and <child> elements, which describe child objects (most often widgets inside a container, but also e.g. actions in an action group, or columns in a tree model). A <child> element contains an <object> element which describes the child object.

Typically, the specific kind of object represented by an <object> element is specified by the "class" attribute. If the type has not been loaded yet, GTK+ tries to find the _get_type() from the class name by applying heuristics. This works in most cases, but if necessary, it is possible to specify the name of the _get_type() explictly with the "type-func" attribute. As a special case, GtkBuilder allows to use an object that has been constructed by a GtkUIManager in another part of the UI definition by specifying the id of the GtkUIManager in the "constructor" attribute and the name of the object in the "id" attribute.

Objects must be given a name with the "id" attribute, which allows the application to retrieve them from the builder with gtk_builder_get_object(). An id is also necessary to use the object as property value in other parts of the UI definition.

Setting properties of objects is pretty straightforward with the <property>element: the "name" attribute specifies the name of the property, and the content of the element specifies the value. If the "translatable" attribute is set to a true value, GTK+ uses gettext() (or dgettext() if the builder has a translation domain set) to find a translation for the value. This happens before the value is parsed, so it can be used for properties of any type, but it is probably most useful for string properties. It is also possible to specify a context to disambiguate short strings, and comments which may help the translators.

GtkBuilder can parse textual representations for the most common property types: characters, strings, integers, floating-point numbers, booleans (strings like "TRUE", "t", "yes", "y", "1" are interpreted as True, strings like "FALSE, "f", "no", "n", "0" are interpreted as False), enumerations (can be specified by their name, nick or integer value), flags (can be specified by their name, nick, integer value, optionally combined with "|", e.g. "gtk.VISIBLE|gtk.REALIZED") and colors (in a format understood by gdk_color_parse()). Objects can be referred to by their name. Pixbufs can be specified as a filename of an image file to load. In general, GtkBuilder allows forward references to objects — an object doesn't have to constructed before it can be referred to. The exception to this rule is that an object has to be constructed before it can be used as the value of a construct-only property.

Signal handlers are set up with the <signal> element. The "name" attribute specifies the name of the signal, and the "handler" attribute specifies the function to connect to the signal. By default, GTK+ tries to find the handler using g_module_symbol(), but this can be changed by passing a custom GtkBuilderConnectFunc to gtk_builder_connect_signals_full(). The remaining attributes, "after", "swapped" and "object", have the same meaning as the corresponding parameters of the g_signal_connect_object() or g_signal_connect_data() functions. A "last_modification_time" attribute is also allowed, but it does not have a meaning to the builder.

Sometimes it is necessary to refer to widgets which have implicitly been constructed by GTK+ as part of a composite widget, to set properties on them or to add further children (e.g. the vbox of a GtkDialog). This can be achieved by setting the "internal-child" propery of the <child> element to a true value. Note that GtkBuilder still requires an <object> element for the internal child, even if it has already been constructed.

A number of widgets have different places where a child can be added (e.g. tabs vs. page content in notebooks). This can be reflected in a UI definition by specifying the "type" attribute on a <child> The possible values for the "type" attribute are described in the sections describing the widget-specific portions of UI definitions.

A gtk.Builder UI definition example


<interface>
  <object class="GtkDialog" id="dialog1">
    <child internal-child="vbox">
      <object class="GtkVBox" id="vbox1">
        <property name="border-width">10</property>
        <child internal-child="action_area">
          <object class="GtkHButtonBox" id="hbuttonbox1">
            <property name="border-width">20</property>
            <child>
              <object class="GtkButton" id="ok_button">
                <property name="label">gtk-ok</property>
                <property name="use-stock">TRUE</property>
                <signal name="clicked" handler="ok_button_clicked"/>
              </object>
            </child>
          </object>
        </child>
      </object>
    </child>
  </object>
</interface>

Beyond this general structure, several object classes define their own XML DTD fragments for filling in the ANY placeholders in the DTD above. Note that a custom element in a <child> element gets parsed by the custom tag handler of the parent object, while a custom element in an <object> element gets parsed by the custom tag handler of the object.

Constructor

    gtk.Builder()

Returns :

a new builder object.

Creates a new builder object.

Methods

gtk.Builder.add_from_file

    def add_from_file(filename)

filename :

The name of the file to parse.

Returns :

A positive value on success, 0 if an error occurred.

Note

This method is available in PyGTK 2.12 and above.

The add_from_file() method parses a file containing a GtkBuilder UI definition and merges it with the current contents of builder.

gtk.Builder.add_from_string

    def add_from_string(buffer)

buffer :

The string to parse.

Returns :

A positive value on success, 0 if an error occurred.

Note

This method is available in PyGTK 2.12 and above.

The add_from_string() method parses a string containing a GtkBuilder UI definition and merges it with the current contents of builder.

gtk.Builder.connect_signals

    def connect_signals(object, user_data)

object :

A mapping or an instance.

user_data :

User data for every signal handler.

Note

This method is available in PyGTK 2.12 and above.

The connect_signals() method uses Python's introspective features to look at the keys (if object is a mapping) or attributes (if object is an instance) and tries to match them with the signal handler names given in the interface description. The callbacks referenced by each matched key or attribute are connected to their matching signals.

For each of handlers that cannot be found, a RuntimeWarning is issued. Also, if there is at least one such missing handler, connect_signals will return a list of their names, else return value is None.

Note

RuntimeWarning and return value for missing handlers was added in PyGTK 2.14.

gtk.Builder.get_object

    def get_object(name)

name :

Name of object to get.

Returns :

The object named name or None if it could not be found in the object tree.

Note

This method is available in PyGTK 2.12 and above.

The get_object() method gets the object named name.

gtk.Builder.get_objects

    def get_objects()

Returns :

A list containing all the objects constructed by the GtkBuilder instance

Note

This method is available in PyGTK 2.12 and above.

The get_objects() method gets all objects that have been constructed by builder.

gtk.Builder.get_translation_domain

    def get_translation_domain()

Returns :

The translation domain.

Note

This method is available in PyGTK 2.12 and above.

The get_translation_domain() gets the translation domain of builder.

gtk.Builder.get_type_from_name

    def get_type_from_name(type_name)

type_name :

The name to lookup.

Returns :

The GType found for type_name or G_TYPE_INVALID if no type was found

Note

This method is available in PyGTK 2.12 and above.

The get_type_from_name() method looks up a type by name, using the virtual function that GtkBuilder has for that purpose.

gtk.Builder.set_translation_domain

    def set_translation_domain(domain)

domain :

The translation domain or None.

Note

This method is available in PyGTK 2.12 and above.

The set_translation_domain() method sets the translation domain of builder. See GtkBuilder:translation-domain property.

Prev Up Next
gtk.Button Home gtk.Buildable
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkbuttonbox.html0000644000000000000000000003764511272037113024366 0ustar rootrootgtk.ButtonBox
gtk.ButtonBox
Prev The gtk Class Reference Next

gtk.ButtonBox

gtk.ButtonBox — the base class for widgets that contain multiple buttons

Synopsis

class gtk.ButtonBox(gtk.Box):
    def get_layout()
    def set_layout(layout_style)
    def get_child_secondary(child)
    def set_child_secondary(child, is_secondary)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Box
          +-- gtk.ButtonBox

Implemented Interfaces

gtk.ButtonBox implements gtk.Buildable

gtk.ButtonBox Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Box Properties

"layout-style"Read/Writethe style used to layout the buttons in the box. The layout styles are: gtk.BUTTONBOX_SPREAD, gtk.BUTTONBOX_EDGE, gtk.BUTTONBOX_START and gtk.BUTTONBOX_END.

gtk.ButtonBox Style Properties

gtk.Widget Style Properties

"child-internal-pad-x"ReadThe amount of padding that increases a child's size on the top and bottom
"child-internal-pad-y"ReadThe amount of padding that increases a child's size on the top and bottom
"child-min-height"ReadThe minimum height of buttons inside the box.
"child-min-width"ReadThe minimum width of buttons inside the box.

gtk.ButtonBox Child Properties

gtk.Box Child Properties

"secondary"Read/WriteIf True, the child appears in a secondary group of children, suitable for, e.g., help buttons.

gtk.ButtonBox Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

A button box is used to provide a consistent layout of buttons throughout an application. The gtk.ButtonBox is subclassed by the gtk.HButtonBox and gtk.VButtonBox classes to provide horizontal and vertical button layouts respectively. The same effect could be achieved by using a gtk.Box but less conveniently.

A buttonbox provides one default layout and a default spacing value that are persistent across all widgets. The layout/spacing can then be altered by the programmer, or if desired, by the user to alter the 'feel' of a program to a small degree.

The gtk.Box.get_spacing() method and the gtk.Box.set_spacing() methods retrieve and change the default number of pixels between buttons. The get_layout() and set_layout() methods retrieve and alter the style used to spread the buttons in a button box across the container. The layout styles are: gtk.BUTTONBOX_SPREAD, gtk.BUTTONBOX_EDGE, gtk.BUTTONBOX_START and gtk.BUTTONBOX_END.

Methods

gtk.ButtonBox.get_layout

    def get_layout()

Returns :

the layout style used by the buttonbox

The get_layout() method returns the current value of the "layout-style" property. The possible values are: gtk.BUTTONBOX_SPREAD, gtk.BUTTONBOX_EDGE, gtk.BUTTONBOX_START and gtk.BUTTONBOX_END.

gtk.ButtonBox.set_layout

    def set_layout(layout_style)

layout_style :

the new layout style

The set_layout() method sets the "layout-style" property to the value in layout_style. The possible values are: gtk.BUTTONBOX_SPREAD, gtk.BUTTONBOX_EDGE, gtk.BUTTONBOX_START and gtk.BUTTONBOX_END.

gtk.ButtonBox.get_child_secondary

    def get_child_secondary(child)

child :

a child button of the buttonbox

Returns :

if True, the child appears in a secondary group of the button box.

Note

This method is available in PyGTK 2.4 and above.

The get_child_secondary() method returns True if child should appear in a secondary group of children. See the set_child_secondary() method for more information.

gtk.ButtonBox.set_child_secondary

    def set_child_secondary(child, is_secondary)

child :

a child button of the buttonbox

is_secondary :

if True, the child appears in a secondary group of the button box.

The set_child_secondary() method sets whether child should appear in a secondary group of children. The typical use of a secondary child is the help button in a dialog that is displayed away from the main group of buttons e.g. right aligned.

The secondary group appears after the other children if the style is gtk.BUTTONBOX_START, gtk.BUTTONBOX_SPREAD or gtk.BUTTONBOX_EDGE, and before the the other children if the style is gtk.BUTTONBOX_END. For horizontal button boxes, the definition of before/after depends on direction of the widget (see gtk.Widget.set_direction()). If the style is gtk.BUTTONBOX_START or gtk.BUTTONBOX_END, then the secondary children are aligned at the other end of the button box from the main children. For the other styles, they appear immediately next to the main children.

Prev Up Next
gtk.Buildable Home gtk.Calendar
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkapplaunchcontext.html0000644000000000000000000002671611272037113025677 0ustar rootrootgtk.gdk.AppLaunchContext
gtk.gdk.AppLaunchContext
Prev The gtk.gdk Class Reference Next

gtk.gdk.AppLaunchContext

gtk.gdk.AppLaunchContext — Startup notification for applications.

Synopsis

class gtk.gdk.AppLaunchContext(gio.AppLaunchContext):
    def set_desktop(desktop)
    def set_display(display)
    def set_icon(icon)
    def set_icon_name(icon_name)
    def set_screen(screen)
    def set_timestamp(timestamp)

Ancestry

+-- gio.AppLaunchContext
  +-- gtk.gdk.AppLaunchContext

Description

The gtk.gdk.AppLaunchContext is an implementation of gio.AppLaunchContext that handles launching an application in a graphical context. It provides startup notification and allows to launch applications on a specific screen or workspace.

Methods

gtk.gdk.AppLaunchContext.set_display

    def set_display()

display :

a gtk.gdk.Display.

Note

This method is available in PyGTK 2.14 and above.

The set_display() method sets the display on which applications will be launched when using this context. See also set_screen.

gtk.gdk.AppLaunchContext.set_desktop

    def set_desktop()

desktop :

the number of a workspace, or -1

Note

This method is available in PyGTK 2.14 and above.

The set_desktop() method sets the workspace on which applications will be launched when using this context when running under a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints.

When the workspace is not specified or desktop is set to -1, it is up to the window manager to pick one, typically it will be the current workspace.

gtk.gdk.AppLaunchContext.set_icon

    def set_icon()

icon :

a gio.Icon, or None.

Note

This method is available in PyGTK 2.14 and above.

The set_icon() method sets the icon for applications that are launched with this context. See also set_icon_name.

gtk.gdk.AppLaunchContext.set_icon_name

    def set_icon_name()

icon_name :

an icon name, or None.

Note

This method is available in PyGTK 2.14 and above.

The set_icon_name() method sets the icon for applications that are launched with this context. The icon_name will be interpreted in the same way as the Icon field in desktop files. See also set_icon.

If both icon and icon_name are set, the icon_name takes priority. If neither icon or icon_name is set, the icon is taken from either the file that is passed to launched application or from the gio.AppInfo for the launched application itself.

gtk.gdk.AppLaunchContext.set_timestamp

    def set_timestamp()

timestamp :

a timestamp

Note

This method is available in PyGTK 2.14 and above.

The set_timestamp() method sets the timestamp of context. The timestamp should ideally be taken from the event that triggered the launch.

Window managers can use this information to avoid moving the focus to the newly launched application when the user is busy typing in another window. This is also known as 'focus stealing prevention'.

Prev Up Next
The gtk.gdk Class Reference Home gtk.gdk.Atom
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangofontmap.html0000644000000000000000000002544011272037113024313 0ustar rootrootpango.FontMap
pango.FontMap
Prev The pango Class Reference Next

pango.FontMap

pango.FontMap — an object that represents the set of fonts available for a particular rendering system.

Synopsis

class pango.FontMap(gobject.GObject):
    def load_font(context, desc)
    def load_fontset(context, desc, language)
    def list_families()
    def get_shape_engine_type()

Ancestry

+-- gobject.GObject
  +-- pango.FontMap

Description

A pango.FontMap object represents the set of fonts available for a particular rendering system. There appears to be no way to retrieve a pango.FontMap object in PyGTK.

Methods

pango.FontMap.load_font

    def load_font(context, desc)

context :

the pango.Context the font will be used with

desc :

a pango.FontDescription describing the font to load

Returns :

the loaded font , or None if no font matched.

The load_font() method loads the pango.Font in the fontmap that is the closest match for the pango.FontDescription specified by desc in the pango.Context specified by context.

pango.FontMap.load_fontset

    def load_fontset(context, desc, language)

context :

the pango.Context the font will be used with

desc :

a pango.FontDescription describing the font to load

language :

a pango.Language the fonts will be used for

Returns :

a pango.FontSet, or None if no font matched.

The load_fontset() method loads a set of pango.Font objects in the fontmap that can be used to render a font matching the pango.FontDescription specified by desc for the pango.Language specified by language in the pango.Context specified by context.

pango.FontMap.list_families

    def list_families()

Returns :

a list of pango.FontFamily objects.

The list_families() method returns a list of all pango.FontFamily objects for the fontmap.

pango.FontMap.get_shape_engine_type

    def get_shape_engine_type()

Returns :

 the ID string for the shape engines for the font map.

Note

This method is available in PyGTK 2.4 and above.

The get_shape_engine_type() method returns the render ID for the shape engines for the font map

Prev Up Next
pango.FontFamily Home pango.FontMetrics
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkdocument.html0000644000000000000000000000675511272037113024150 0ustar rootrootatk.Document
atk.Document
Prev The atk Class Reference Next

atk.Document

atk.Document — the ATK interface which allows access to a DOM associated with on object.

Synopsis

class atk.Document(gobject.GInterface):
    def get_document_type()

Description

The atk.Document interface should be supported by any object that has an associated document object model (DOM). This interface provides the standard mechanism allowing an assistive technology access to the DOM.

Methods

atk.Document.get_document_type

    def get_document_type()

Returns :

a string indicating the document type

Gets a string indicating the document type.

Prev Up Next
atk.Component Home atk.EditableText
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-atkrelation.html0000644000000000000000000003156611272037113024145 0ustar rootrootatk.Relation
atk.Relation
Prev The atk Class Reference Next

atk.Relation

atk.Relation — an object used to describe a relation between a object and one or more other objects.

Synopsis

class atk.Relation(gobject.GObject):
    atk.Relation(targets, relationship)
    def get_relation_type()
    def get_target()
Functions

    def atk.relation_type_register(name)
    def atk.relation_type_get_name(relationship)
    def atk.relation_type_for_name(name)

Ancestry

+-- gobject.GObject
  +-- atk.Relation

atk.Relation Properties

"relation-type"Read-WriteThe type of the relation - one of the Atk Relation Type Constants. Default value: atk.RELATION_NULL.
"target"Read-WriteAn array of the targets for the relation. Default value: None.

atk.Relation Signal Prototypes

gobject.GObject Signal Prototypes

Description

An atk.Relation describes a relation between an object and one or more other objects. The actual relations that an object has with other objects are defined as an atk.RelationSet, which contains a set of atk.Relation objects.

Constructor

atk.Relation

    atk.Relation(targets, relationship)

targets :

a sequence of atk.Object objects

relationship :

one of the Atk Relation Type Constants with which to create the new atk.Relation

Returns :

a new atk.Relation

Create a new relation for the specified relationship type and the specified sequence of targets.

Methods

atk.Relation.get_relation_type

    def get_relation_type()

Returns :

the relation type - one of the Atk Relation Type Constants.

Gets the relationship type.

atk.Relation.get_target

    def get_target()

Returns :

the target list of relation

Gets the target list of atk.Object objects.

Functions

atk.relation_type_register

    def atk.relation_type_register(name)

name :

a name string

Returns :

a new one of the Atk Relation Type Constants that is associated with name

Associate name with a new one of the Atk Relation Type Constants.

atk.relation_type_get_name

    def atk.relation_type_get_name(type)

type :

one of the Atk Relation Type Constants.

Returns :

the string associated with relationship.

Gets the description string describing the relation type specified by type.

atk.relation_type_for_name

    def atk.relation_type_for_name(name)

name :

a string which is the (non-localized) name of an ATK relation type.

Returns :

the matching type of the Atk Relation Type Constants corresponding to the specified name, or atk.RELATION_NULL if no matching relation type is found.

Get the relation type corresponding to the specified name.

Prev Up Next
atk.Registry Home atk.RelationSet
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkmenutoolbutton.html0000644000000000000000000005365311272037113025435 0ustar rootrootgtk.MenuToolButton
gtk.MenuToolButton
Prev The gtk Class Reference Next

gtk.MenuToolButton

gtk.MenuToolButton — A gtk.ToolItem containing a button with an additional dropdown menu (new in PyGTK 2.6)

Synopsis

class gtk.MenuToolButton(gtk.ToolButton):
    gtk.MenuToolButton(stock_id)
    gtk.MenuToolButton(icon_widget, label)
    def set_menu(menu)
    def get_menu()
    def set_arrow_tooltip(tooltips, tip_text, tip_private=None)
    def set_arrow_tooltip_markup(markup)
    def set_arrow_tooltip_text(text)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.ToolItem
            +-- gtk.ToolButton
              +-- gtk.MenuToolButton

Implemented Interfaces

gtk.MenuToolButton implements gtk.Buildable

gtk.MenuToolButton Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.ToolItem Properties

gtk.ToolButton Properties

"menu"Read-WriteThe dropdown gtk.Menu.

gtk.MenuToolButton Style Properties

gtk.Widget Style Properties

gtk.ToolButton Style Properties

gtk.MenuToolButton Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.ToolItem Signal Prototypes

gtk.ToolButton Signal Prototypes

"show-menu"

 def callback(menutoolbutton, user_param1, ...)

Description

Note

This widget is available in PyGTK 2.6 and above.

A gtk.MenuToolButton is a gtk.ToolItem that contains a button and a small additional button with an arrow. When clicked, the arrow button pops up a dropdown menu.

Constructor

gtk.MenuToolButton

    gtk.MenuToolButton(stock_id)

stock_id :

Returns :

a new gtk.MenuToolButton

Note

This constructor is available in PyGTK 2.6 and above.

Creates a new gtk.MenuToolButton using from the stock item specified by stock_id. The new gtk.MenuToolButton will contain the icon and label associated with stock_id.

gtk.MenuToolButton

    gtk.MenuToolButton(icon_widget, label)

icon_widget :

a widget that will be used as icon widget, or None

label :

a string that will be used as label, or None

Returns :

a new gtk.MenuToolButton

Note

This constructor is available in PyGTK 2.6 and above.

Creates a new gtk.MenuToolButton using the icon specified by icon_widget and the label specified by label.

Methods

gtk.MenuToolButton.set_menu

    def set_menu(menu)

menu :

a gtk.Menu

Note

This method is available in PyGTK 2.6 and above.

The set_menu() method sets the "menu" property to the gtk.Menu specified by menu.

gtk.MenuToolButton.get_menu

    def get_menu()

Returns :

the associated gtk.Menu

Note

This method is available in PyGTK 2.6 and above.

The get_menu() method returns the value of the "menu" property that contains the associated gtk.Menu.

gtk.MenuToolButton.set_arrow_tooltip

    def set_arrow_tooltip(tooltips, tip_text, tip_private=None)

tooltips :

A gtk.Tooltips object.

tip_text :

The text to use as the tooltip or None

tip_private :

Opitonal private tooltip text or None. Defaults to None.

Warning

This method is deprecated in PyGTK 2.12 and above.

The set_arrow_tooltip() method sets the tooltip data specified by tip_text for the arrow button using the gtk.Tooltips object specified by tooltips.

gtk.MenuToolButton.set_arrow_tooltip_markup

    def set_arrow_tooltip_markup(markup)

markup :

Markup text to be used as tooltip text for button's arrow button.

Note

This method is available in PyGTK 2.12 and above.

The set_arrow_tooltip_markup() method sets the tooltip markup to be used as tooltip for the arrow button which pops up the menu. See gtk.ToolItem.set_tooltip() for setting a tooltip on the whole gtk.MenuToolButton.

gtk.MenuToolButton.set_arrow_tooltip_text

    def set_arrow_tooltip_text(text)

text :

Text to be used as tooltip text for button's arrow button.

Note

This method is available in PyGTK 2.12 and above.

The set_arrow_tooltip_markup() method sets the tooltip text to be used as tooltip for the arrow button which pops up the menu. See gtk.ToolItem.set_tooltip() for setting a tooltip on the whole gtk.MenuToolButton.

Signals

The "show-menu" gtk.MenuToolButton Signal

    def callback(menutoolbutton, user_param1, ...)

menutoolbutton :

the menutoolbutton that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.6 and above.

The "show-menu" signal is emitted before the dropdown menu is displayed.

Prev Up Next
gtk.MenuShell Home gtk.MessageDialog
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkcolor.html0000644000000000000000000003124011272037113023421 0ustar rootrootgtk.gdk.Color
gtk.gdk.Color
Prev The gtk.gdk Class Reference Next

gtk.gdk.Color

gtk.gdk.Color — an object holding color information

Synopsis

class gtk.gdk.Color(gobject.GBoxed):
    gtk.gdk.Color(red=0, green=0, blue=0, pixel=0)
    def to_string()
Functions

    def gtk.gdk.color_parse(spec)

Attributes

"pixel"Read-WriteThe pixel value of the color
"red"Read-WriteThe value of the red component of the color
"green"Read-WriteThe value of the green component of the color
"blue"Read-WriteThe value of the blue component of the color

Description

A gtk.gdk.Color contains the values of a color that may or may not be allocated. The red, green and blue attributes are specified by an unsigned integer in the range 0-65535. The pixel value is an index into the colormap that has allocated the gtk.gdk.Color. Typically a color is allocated by using the gdk.Colormap.alloc_color() method. Unallocated colors can be used to specify the color attributes of gtk.Style objects since these colors will be allocated when an attempt is made to use the gtk.Style object.

Starting with PyGTK 2.14 gtk.gdk.Color objects are properly comparable. By Python rules, colors (being mutable) are now unhashable. If you need to use them as dictionary keys, use string representation instead. You can convert string representation to gtk.gdk.Color objects using the constructor.

Also beginning with PyGTK 2.14 gtk.gdk.Color objects have custom support for str and repr Python functions. For any color it holds that: 

  color == eval(repr(color))

Constructor

    gtk.gdk.Color(red=0, green=0, blue=0, pixel=0)
    gtk.gdk.Color(spec)

red :

The red color component in the range 0-65535

green :

The green color component in the range 0-65535

blue :

The blue color component in the range 0-65535

pixel :

The index of the color when allocated in its colormap

spec :

String containing color specification

Returns :

a new gtk.gdk.Color object

Note

Second form of the constructor is available in PyGTK 2.14 and above.

Creates a new gtk.gdk.Color object with the color component values specified by red, green and blue (all default to 0) and using the pixel value specified by pixel. The value of pixel will be overwritten when the color is allocated.

Second form of the constructor is analogous to gtk.gdk.color_parse.

Methods

gtk.gdk.Color.to_string

    def to_string()

Returns :

a string

Note

This method is available in PyGTK 2.12 and above.

The to_string() method returns a textual specification of color in the hexadecimal form #rrrrggggbbbb, where r, g and b are hex digits representing the red, green and blue components respectively.

Note

Starting with PyGTK 2.14 you can also use str(color) code. However, that can return a shorter (3, 6 or 12 hexadecimal digits) string if shorter version means the same for the constructor.

Functions

gtk.gdk.color_parse

    def gtk.gdk.color_parse(spec)

spec :

a string containing a color specification

Returns :

a gtk.gdk.Color object

The gtk.gdk.color_parse() method returns the gtk.gdk.Color specified by spec. The format of spec is a string containing the specification of the color either as a name (e.g. "navajowhite") as specified in the X11 rgb.txt file or as a hexadecimal string (e.g. "#FF0078"). The hexadecimal string must start with '#' and must contain 3 sets of hexadecimal digits of the same length (i.e. 1, 2 ,3 or 4 digits). For example the following specify the same color value: "#F0A", "#FF00AA", "#FFF000AAA" and "#FFFF0000AAAA". The gtk.gdk.Color is not allocated.

This function raise the ValueError (TypeError prior to PyGTK 2.4) exception if unable to parse the color specification

Prev Up Next
gtk.gdk.CairoContext Home gtk.gdk.Colormap
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/pangocairo-constants.html0000644000000000000000000000415211272037113024650 0ustar rootrootpangocairo Constants
pangocairo Constants
Prev The pangocairo Class Reference Next

pangocairo Constants

pangocairo Constants — the built-in constants of the pangocairo module

Synopsis

Description

Prev Up Next
pangocairo Functions Home The gtkunixprint Class Reference
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/atk-class-reference.html0000644000000000000000000001712711272037113024340 0ustar rootrootThe atk Class Reference
The atk Class Reference
Prev   Next

The atk Class Reference

Table of Contents

atk.Action — the ATK interface provided by UI components that the user can activate/interact with,
atk.Component — the ATK interface provided by UI components that occupy a physical area on the screen.
atk.Document — the ATK interface which allows access to a DOM associated with on object.
atk.EditableText — the ATK interface implemented by components containing user-editable text content.
atk.GObjectAccessible — this object class is derived from AtkObject and can be used as a basis implementing accessible objects.
atk.Hyperlink — An ATK object which encapsulates a link or set of links in a hypertext document.
atk.Hypertext — the ATK interface which provides standard mechanism for manipulating hyperlinks.
atk.Image — the ATK Interface implemented by components that expose image or pixmap content on-screen.
atk.Implementor
atk.NoOpObject — an atk.Object which purports to implement all ATK interfaces.
atk.NoOpObjectFactory — the atk.ObjectFactory which creates an atk.NoOpObject.
atk.Object — the base object class for the Accessibility Toolkit API.
atk.ObjectFactory — the base object class for a factory used to create accessible objects for objects of a specific GType.
atk.Rectangle — an object holding data about a rectangle
atk.Registry — an object used to store the GType of the factories used to create an accessible object for an object of a particular GType.
atk.Relation — an object used to describe a relation between a object and one or more other objects.
atk.RelationSet — a set of atk.Relation objects, normally the set of atk.Relation objects that an atk.Object has.
atk.Selection — the ATK interface implemented by container objects whose atk.Object children can be selected.
atk.StateSet — an atk.StateSet determines a component's state set.
atk.StreamableContent — the ATK interface which provides access to streamable content.
atk.Table — the ATK interface implemented for UI components which contain tabular or row/column information.
atk.Text — the ATK interface implemented by components with text content.
atk.Value — the ATK interface implemented by valuators and components which display or select a value from a bounded range of values.
atk Constants — the built-in constants of the atk module
Prev   Next
PyGTK Class Hierarchy Home atk.Action
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangorenderer.html0000644000000000000000000007515411272037113024464 0ustar rootrootpango.Renderer
pango.Renderer
Prev The pango Class Reference Next

pango.Renderer

pango.Renderer — a base class for pango rendering (new in PyGTK 2.8)

Synopsis

class pango.Renderer(gobject.GObject):
    def draw_layout(layout, x, y)
    def draw_layout_line(line, x, y)
    def draw_glyphs(font, glyphs, x, y)
    def draw_rectangle(part, x, y, width, height)
    def draw_error_underline(x, y, width, height)
    def draw_trapezoid(part, y1_, x11, x21, y2, x12, x22)
    def activate()
    def deactivate()
    def part_changed(part)
    def set_color(part, color)
    def get_color(part)

Ancestry

+-- gobject.GObject
  +-- pango.Renderer

Description

pango.Renderer is a base class that contains the necessary logic for rendering a pango.Layout or pango.LayoutLine. By subclassing pango.Renderer and overriding operations such as draw_glyphs() and draw_rectangle(), renderers for particular font backends and destinations can be created.

Methods

pango.Renderer.draw_layout

    def draw_layout(layout, x, y)

layout :

a pango.Layout

x :

the x position of left edge of baseline, in user space coordinates in Pango units.

y :

the y position of left edge of baseline, in user space coordinates in Pango units.

Note

This method is available in PyGTK 2.8 and above.

The draw_layout() method draws the pango.Layout s[ecified by layout at the position specified by x and y.

pango.Renderer.draw_layout_line

    def draw_layout_line(line, x, y)

line :

a pango.LayoutLine

x :

the x position of left edge of baseline, in user space coordinates in Pango units.

y :

the y position of left edge of baseline, in user space coordinates in Pango units.

Note

This method is available in PyGTK 2.8 and above.

The draw_layout_line() method draws the pango.LayoutLine specified by line at the position specified by x and y.

pango.Renderer.draw_glyphs

    def draw_glyphs(font, glyphs, x, y)

font :

a pango.Font

glyphs :

a pango.GlyphString

x :

the x position of left edge of baseline, in user space coordinates in Pango units.

y :

the y position of left edge of baseline, in user space coordinates in Pango units.

Note

This method is available in PyGTK 2.8 and above.

The draw_glyphs() method draws the pango.GlyphString specified by glyphs using the pango.Font specified by font at the position specified by x and y.

pango.Renderer.draw_rectangle

    def draw_rectangle(part, x, y, width, height)

part :

the part where the rectangle is to be rendered

x :

the x position at which to draw rectangle, in user space coordinates in Pango units

y :

the y position at which to draw rectangle, in user space coordinates in Pango units

width :

the width of rectangle in Pango units in user space coordinates

height :

the height of rectangle in Pango units in user space coordinates

Note

This method is available in PyGTK 2.8 and above.

The draw_rectangle() method draws an axis-aligned rectangle with the size specified by width and height at the position specified by x and y, all in user space coordinates. The rectangle will be drawn in the rendering part (see the Pango Render Part Constants) specified by part.

pango.Renderer.draw_error_underline

    def draw_error_underline(x, y, width, height)

x :

the X coordinate of the underline, in Pango units in the user coordinate system

y :

the Y coordinate of the underline, in Pango units in the user coordinate system

width :

the width of the underline, in Pango units in the user coordinate system

height :

the height of the underline, in Pango units in the user coordinate system

Note

This method is available in PyGTK 2.8 and above.

The draw_error_underline() method draws a squiggly line that approximately covers the rectangle specified by x, y, width and height in the style of an underline used to indicate a spelling error. (The width of the underline is rounded to an integer number of up/down segments and the resulting rectangle is centered in the original rectangle).

pango.Renderer.draw_trapezoid

    def draw_trapezoid(part, y1_, x11, x21, y2, x12, x22)

part :

where the trapezoid is to be rendered

y1_ :

the Y coordinate of the top of the trapezoid

x11 :

the X coordinate of the left end of the top of the trapezoid

x21 :

the X coordinate of the right end of the top of the trapezoid

y2 :

the Y coordinate of the bottom of the trapezoid

x12 :

the X coordinate of the left end of the bottom of the trapezoid

x22 :

the X coordinate of the left end of the bottom of the trapezoid

Note

This method is available in PyGTK 2.8 and above.

The draw_trapezoid() method draws a trapezoid with the parallel sides aligned with the X axis using the coordinates specified by y1_, x11, x21, y2, x12, x22. The coordinates are in device space. The trapezoid is rendered in the part specified by part which must be one of the Pango Render Part Constants.

pango.Renderer.activate

    def activate()

Note

This method is available in PyGTK 2.8 and above.

The activate() method does initial setup before performing the rendering operations on renderer. The deactivate() method should be called when drawing is complete. Calls to the draw_layout() method automatically activate the layout before drawing on it. Calls to the activate() and deactivate() methods can be nested and the renderer will only be initialized and deinitialized once.

pango.Renderer.deactivate

    def deactivate()

Note

This method is available in PyGTK 2.8 and above.

The deactivate() method cleans up after rendering operations are completed. See the activate() method for more information.

pango.Renderer.part_changed

    def part_changed(part)

part :

the part that has its rendering changed.

Note

This method is available in PyGTK 2.8 and above.

The part_changed() method informs Pango that the way that the renderering is done for the part specified by part has changed in a way that would prevent multiple pieces being joined together into one drawing call. part must be one of the Pango Render Part Constants. For instance, if a subclass of pango.Renderer was to add a stipple option for drawing underlines, it needs to call:

renderer.part_changed(pango.RENDER_PART_UNDERLINE)

when the stipple changes or underlines with different stipples might be joined together. Pango automatically calls this for changes to colors. (See the set_color() method for more information).

pango.Renderer.set_color

    def set_color(part, color)

part :

the part to change the color of

color :

a pango.Color

Note

This method is available in PyGTK 2.8 and above.

The set_color() method sets the pango.Color specified by color as the color for the part specified by part. part must be one of the Pango Render Part Constants.

pango.Renderer.get_color

    def get_color(part)

part :

a part

Returns :,  :

a pango.Color or None

Note

This method is available in PyGTK 2.8 and above.

The get_color() method returns the current rendering pango.Color for the part specified by part. part must be one of the Pango Render Part Constants. If None is returned, the color has not been set and should be inherited from the environment.

Prev Up Next
pango.LayoutLine Home pango.TabArray
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkscale.html0000644000000000000000000005065511272037113023425 0ustar rootrootgtk.Scale
gtk.Scale
Prev The gtk Class Reference Next

gtk.Scale

gtk.Scale — a base class for the scale widgets.

Synopsis

class gtk.Scale(gtk.Range):
    def set_digits(digits)
    def get_digits()
    def set_draw_value(draw_value)
    def get_draw_value()
    def set_value_pos(pos)
    def get_value_pos()
    def get_layout()
    def get_layout_offsets()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Range
        +-- gtk.Scale

Implemented Interfaces

gtk.Scale implements gtk.Buildable

gtk.Scale Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Range Properties

"digits"Read-WriteThe number of decimal places that are displayed in the value
"draw-value"Read-WriteIf True the current value is displayed as a string next to the slider
"value-pos"Read-WriteThe position in which the current value is displayed: gtk.POS_LEFT, gtk.POS_RIGHT, gtk.POS_TOP or gtk.POS_BOTTOM

gtk.Scale Style Properties

gtk.Widget Style Properties

gtk.Range Style Properties

"slider-length"ReadThe length of scale's slider
"value-spacing"ReadThe space between value text and the slider or trough area

gtk.Scale Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Range Signal Prototypes

"format-value"

 def callback(scale, user_param1, ...)

Description

The gtk.Scale widget is an abstract base class, used only for deriving the subclasses gtk.HScale and gtk.VScale. A gtk.Scale is a slider control used to select a numeric value. Since gtk.Scale is a subclass of gtk.Range, see the gtk.Range methods for additional methods. To set the value of a scale, you would normally use set_value(). To detect changes to the value, you would normally use the "value_changed" signal.

Methods

gtk.Scale.set_digits

    def set_digits(digits)

digits :

the number of decimal places to display

The set_digits() method sets the "digits" property to the value specified by digits. The value of digits specifies the number of decimal places that are displayed in the value. The value of the adjustment is also rounded off to this number of digits if "draw-value" is True, so the retrieved value matches the value the user sees. If the "draw-value" property has been set to False by using the set_draw_value() method, the adjustment value will not be rounded at all.

gtk.Scale.get_digits

    def get_digits()

Returns :

the number of decimal places that are displayed.

The get_digits() method returns the value of the "digits" property that indicates the number of decimal places that are displayed in the value.

gtk.Scale.set_draw_value

    def set_draw_value(draw_value)

draw_value :

If True draw the current value next to the slider

The set_draw_value() method sets the "draw-value" property to the value specified by draw_value. If draw_value is True the current value is displayed next to the slider.

gtk.Scale.get_draw_value

    def get_draw_value()

Returns :

True if the current value is to be drawn next to the slider

The get_draw_value() method returns the value of the "draw-value" property. If "draw-value" is True the current scale value is drawn next to the slider.

gtk.Scale.set_value_pos

    def set_value_pos(pos)

pos :

the position where the current value is displayed.

The set_value_pos() method sets the value of the "value-pos" property to the value specified by pos. The value of pos must be one of: gtk.POS_LEFT, gtk.POS_RIGHT, gtk.POS_TOP or gtk.POS_BOTTOM.

gtk.Scale.get_value_pos

    def get_value_pos()

Returns :

the position where the current value is displayed.

The get_value_pos() method returns the value of the "value-pos" property. See the set_value_pos() method.

gtk.Scale.get_layout

    def get_layout()

Returns :

the pango.Layout for this scale or None if the draw_value property is False.

Note

This method is available in PyGTK 2.4 and above.

The get_layout() method returns the pango.Layout used to display the scale.

gtk.Scale.get_layout_offsets

    def get_layout_offsets()

Returns :

a 2-tuple containing the coordinates where the scale will draw the pango.Layout representing the text in the scale

Note

This method is available in PyGTK 2.4 and above.

The get_layout_offsets() method returns a 2-tuple containing the coordinates where the scale will draw the pango.Layout representing the text in the scale. Remember when using the pango.Layout function you need to convert to and from pixels using the pango.PIXELS() function or pango.SCALE. If the "draw-value" property is False, the return values are undefined.

Signals

The "format-value" gtk.Scale Signal

    def callback(scale, value, user_param1, ...)

scale :

the scale that received the signal

value :

the value to be formatted

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Returns :

a string representing value for display

The "format-value" signal is emitted when the scale is being redrawn with a value displayed. The "format-value" signal handler should return a formatted string containing value.

Prev Up Next
gtk.Ruler Home gtk.ScaleButton
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkcurve.html0000644000000000000000000004534511272037113023462 0ustar rootrootgtk.Curve
gtk.Curve
Prev The gtk Class Reference Next

gtk.Curve

gtk.Curve — allows direct editing of a curve.

Synopsis

class gtk.Curve(gtk.DrawingArea):
    gtk.Curve()
    def reset()
    def set_gamma(gamma)
    def set_range(min_x, max_x, min_y, max_y)
    def get_vector(size=-1)
    def set_vector(vector)
    def set_curve_type(type)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.DrawingArea
        +-- gtk.Curve

Implemented Interfaces

gtk.Curve implements gtk.Buildable

gtk.Curve Properties

gtk.Object Properties

gtk.Widget Properties

"curve-type"Read/WriteThe curve type. One of linear (gtk.CURVE_TYPE_LINEAR), spline interpolated (gtk.CURVE_TYPE_SPLINE), or free-form (gtk.CURVE_TYPE_FREE).
"max-x"Read/WriteThe maximum possible value for X
"max-y"Read/WriteThe maximum possible value for Y
"min-x"Read/WriteThe minimum possible value for X
"min-y"Read/WriteThe minimum possible value for Y

gtk.Curve Style Properties

gtk.Widget Style Properties

gtk.Curve Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

"curve-type-changed"

 def callback(curve, widget, user_param1, ...)

Description

Note

This widget is considered too specialized or little-used for PyGTK, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, it will eventually move out of the PyGTK distribution.

The gtk.Curve widget allows the user to edit a curve covering a range of values. It is typically used to fine-tune color balances in graphics applications like the Gimp. The gtk.Curve widget has 3 modes of operation - spline, linear and free. In spline mode the user places points on the curve which are automatically connected together into a smooth curve. In linear mode the user places points on the curve which are connected by straight lines. In free mode the user can draw the points of the curve freely, and they are not connected at all.

Constructor

    gtk.Curve()

Returns :

a new gtk.Curve object

Creates a new gtk.Curve object

Methods

gtk.Curve.reset

    def reset()

The reset() method resets the curve to a straight line from the minimum x and y values to the maximum x and y values (i.e. from the bottom-left to the top-right corners). The curve type is not changed.

gtk.Curve.set_gamma

    def set_gamma(gamma)

gamma :

the gamma value

The set_gamma() method recomputes the entire curve using the value in gamma. A gamma value of 1 results in a straight line. Values greater than 1 result in a curve above the straight line. Values less than 1 result in a curve below the straight line. The curve type is changed to gtk.CURVE_TYPE_FREE.

gtk.Curve.set_range

    def set_range(min_x, max_x, min_y, max_y)

min_x :

the new minimum x value

max_x :

the maximum x value.

min_y :

the new minimum y value

max_y :

the maximum y value.

The set_range() method sets the "min-x", "min-y", "max-x" and "max-y" properties from min_x, min_y, max_x, and max_y. The curve is also reset with a call to reset().

gtk.Curve.get_vector

    def set_vector(size=-1)

size :

the number of points to return or -1 to return all the points in the curve.

Returns :

a tuple containing the points

The get_vector() method returns a tuple of points representing the curve. The number of points to return is specified by size; if size is -1 all the points in the curve are returned.

gtk.Curve.set_vector

    def get_vector(vector)

vector :

a list or tuple containing the points of the curve

The set_vector() method sets the curve using the points in vector. The curve type is set to gtk.CURVE_TYPE_FREE.

gtk.Curve.set_curve_type

    def set_curve_type(type)

type :

the new curve type: gtk.CURVE_TYPE_LINEAR, gtk.CURVE_TYPE_SPLINE or gtk.CURVE_TYPE_FREE

The set_curve_type() method sets the "curve-type" property with the value of type. The curve type must be one of gtk.CURVE_TYPE_LINEAR, gtk.CURVE_TYPE_SPLINE or gtk.CURVE_TYPE_FREE. The curve will remain unchanged except when changing from a free curve to a linear or spline curve, in which case the curve will be changed as little as possible.

Signals

The "curve-type-changed" gtk.Curve Signal

    def callback(curve, user_param1, ...)

curve :

the curve that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "curve-type-changed" signal is emitted when the curve type has been changed. The curve type can be changed explicitly with a call to set_curve_type(). It is also changed as a side-effect of calling reset() or set_gamma()

Prev Up Next
gtk.Container Home gtk.Dialog
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkmessagedialog.html0000644000000000000000000005741611272037113025144 0ustar rootrootgtk.MessageDialog
gtk.MessageDialog
Prev The gtk Class Reference Next

gtk.MessageDialog

gtk.MessageDialog — a convenient message window

Synopsis

class gtk.MessageDialog(gtk.Dialog):
    gtk.MessageDialog(parent=None, flags=0, type=gtk.MESSAGE_INFO, buttons=gtk.BUTTONS_NONE, message_format=None)
    def set_markup(str)
    def format_secondary_text(message_format)
    def format_secondary_markup(message_format)
    def set_image(image)
    def get_image()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Window
            +-- gtk.Dialog
              +-- gtk.MessageDialog

Implemented Interfaces

gtk.MessageDialog implements gtk.Buildable

gtk.MessageDialog Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Window Properties

gtk.Dialog Properties

"buttons"Write-ConstructThe buttons shown in the message dialog. One of the GTK Buttons Type Constants: gtk.BUTTONS_NONE, gtk.BUTTONS_OK, gtk.BUTTONS_CLOSE, gtk.BUTTONS_CANCEL, gtk.BUTTONS_YES_NO, gtk.BUTTONS_OK_CANCEL. Default value: gtk.BUTTONS_NONE
"image"Read-WriteThe image for this dialog. Available in GTK+ 2.10.
"message-type"Read-Write-ConstructThe type of message. One of the GTK Message Type Constants: gtk.MESSAGE_INFO, gtk.MESSAGE_WARNING, gtk.MESSAGE_QUESTION or gtk.MESSAGE_ERROR. Default value: gtk.MESSAGE_INFO
"secondary-text"Read-WriteThe secondary text of the message dialog. Default value: None. Available in GTK+ 2.10.
"secondary-use-markup"Read-WriteIf True the secondary text of the dialog includes Pango markup. See the pango.parse_markup() function. Default value: False. Available in GTK+ 2.10.
"text"Read-WriteThe primary text of the message dialog. If the dialog has a secondary text, this will appear as the title. Default value: None. Available in GTK+ 2.10.
"use-markup"Read-WriteIf True the primary text of the dialog includes Pango markup. See the pango.parse_markup() function. Default value: False. Available in GTK+ 2.10.

gtk.MessageDialog Style Properties

gtk.Widget Style Properties

gtk.Dialog Style Properties

"message-border"Read-WriteThe width of border around the label and image in the message dialog. Allowed values: >= 0. Default value: 12.
"use-separator"ReadIf True draw a separator line between the message label and the buttons in the dialog. This property is available in GTK+ 2.4 and above.

Attributes

"image"ReadThe stock ID image
"label"ReadThe label widget that contains the message text.

gtk.MessageDialog Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.Window Signal Prototypes

gtk.Dialog Signal Prototypes

Description

The gtk.MessageDialog presents a dialog with an image representing the type of message (Error, Question, etc.) alongside some message text. It's simply a convenience widget; you could construct the equivalent of gtk.MessageDialog from gtk.Dialog without too much effort, but gtk.MessageDialog saves time.

The gtk.MessageDialog types are listed in the GTK Message Type Constants.

A selection of predefined button sets is available for use in a message dialog. See the GTK Buttons Type Constants.

See the gtk.Dialog reference page for additional methods to be used with the gtk.MessageDialog.

Constructor

    gtk.MessageDialog(parent=None, flags=0, type=gtk.MESSAGE_INFO, buttons=gtk.BUTTONS_NONE, message_format=None)

parent :

the transient parent, or None if none

flags :

the dialog flags - a combination of: gtk.DIALOG_MODAL, gtk.DIALOG_DESTROY_WITH_PARENT or 0 for no flags

type :

the type of message: gtk.MESSAGE_INFO, gtk.MESSAGE_WARNING, gtk.MESSAGE_QUESTION or gtk.MESSAGE_ERROR.

buttons :

the predefined set of buttons to use: gtk.BUTTONS_NONE, gtk.BUTTONS_OK, gtk.BUTTONS_CLOSE, gtk.BUTTONS_CANCEL, gtk.BUTTONS_YES_NO, gtk.BUTTONS_OK_CANCEL

message_format :

a string containing the message text or None

Returns :

a new gtk.MessageDialog widget

Creates a new gtk.MessageDialog, which is a simple dialog with an icon indicating the dialog type (error, warning, etc.) specified by type and some text (message_format) the user may want to see. parent if specified indicates the transient parent of the dialog. The flags allow the specification special dialog characteristics: make the dialog modal (gtk.DIALOG_MODAL) and destroy the dialog when the parent is destroyed (gtk.DIALOG_DESTROY_WITH_PARENT). When the user clicks a button a "response" signal is emitted with response IDs. buttons specifies the set of predefined buttons to use: gtk.BUTTONS_NONE, gtk.BUTTONS_OK, gtk.BUTTONS_CLOSE, gtk.BUTTONS_CANCEL, gtk.BUTTONS_YES_NO, gtk.BUTTONS_OK_CANCEL. See gtk.Dialog for more details.

Methods

gtk.MessageDialog.set_markup

    def set_markup(str)

str :

a markup string (see the Pango markup language reference)

Note

This method is available in PyGTK 2.4 and above.

The set_markup() method sets the text of the message dialog to the contents of str. If str contains text marked up with Pango markup (see The Pango Markup Language), it will be displayed with those attributes. Note the '<', '>' and '&' characters must be replaced with '&lt;', '&gt;' and '&amp;' respectively to be displayed literally.

gtk.MessageDialog.format_secondary_text

    def format_secondary_text(message_format)

message_format :

The text to be displayed as the secondary text or None.

Note

This method is available in PyGTK 2.6 and above.

The format_secondary_text() method sets the secondary text of the message dialog to the text specified by message_format. Note that setting a secondary text makes the primary text bold, unless you have provided explicit markup.

gtk.MessageDialog.format_secondary_markup

    def format_secondary_markup(message_format)

message_format :

A string containing the pango markup to use as secondary text.

Note

This method is available in PyGTK 2.6 and above.

The format_secondary_markup() method sets the secondary text to the markup text specified by message_format. Note that setting a secondary text makes the primary text become bold, unless you have provided explicit markup.

gtk.MessageDialog.set_image

    def set_image(image)

image :

the image widget

Note

This method is available in PyGTK 2.10 and above.

The set_image() method sets the dialog's image to the gtk.Widget specified by image.

gtk.MessageDialog.get_image

    def get_image()

Returns :

the dialog's image.

Note

This method is available in PyGTK 2.14 and above.

The get_image() method gets the dialog's image.

Prev Up Next
gtk.MenuToolButton Home gtk.Misc
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkhscrollbar.html0000644000000000000000000001721711272037113024466 0ustar rootrootgtk.HScrollbar
gtk.HScrollbar
Prev The gtk Class Reference Next

gtk.HScrollbar

gtk.HScrollbar — a horizontal scrollbar widget

Synopsis

class gtk.HScrollbar(gtk.Scrollbar):
    gtk.HScrollbar(adjustment=None)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Range
        +-- gtk.Scrollbar
          +-- gtk.HScrollbar

Implemented Interfaces

gtk.HScrollbar implements gtk.Buildable

gtk.HScrollbar Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Range Properties

gtk.HScrollbar Style Properties

gtk.Widget Style Properties

gtk.Range Style Properties

gtk.Scrollbar Style Properties

gtk.HScrollbar Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Range Signal Prototypes

Description

The gtk.HScrollbar widget is subclassed from gtk.Scrollbar to provide a horizontal scrollbar. See gtk.Scrollbar for details on the methods available for managing scrollbars. A gtk.Adjustment may be specified with the scrollbar at creation (or is created automatically if none is specified) to handle the adjustment of the scrollbar. See gtk.Adjustment for details.

Constructor

    gtk.HScrollbar(adjustment=None)

adjustment :

a gtk.Adjustment or None to automatically create an adjustment

Returns :

a new hscrollbar widget

Creates a new gtk.HScrollbar with an associated gtk.Adjustment specified by adjustment. If adjustment is None or missing a new gtk.Adjustment will be created and associated with the scrollbar.

Prev Up Next
gtk.HScale Home gtk.HSeparator
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkrecentchooserdialog.html0000644000000000000000000003275311272037113026360 0ustar rootrootgtk.RecentChooserDialog
gtk.RecentChooserDialog
Prev The gtk Class Reference Next

gtk.RecentChooserDialog

gtk.RecentChooserDialog — Displays recently used files in a dialog (new in PyGTK 2.10)

Synopsis

class gtk.RecentChooserDialog(gtk.Dialog, gtk.RecentChooser):
    gtk.RecentChooserDialog(title=None, parent=None, manager=None, buttons=None)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Window
            +-- gtk.Dialog
              +-- gtk.RecentChooserDialog

Implemented Interfaces

gtk.RecentChooserDialog implements gtk.Buildable gtk.RecentChooser

gtk.RecentChooserDialog Properties

gtk.RecentChooser Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Window Properties

gtk.Dialog Properties

gtk.RecentChooserDialog Style Properties

gtk.Widget Style Properties

gtk.Dialog Style Properties

gtk.RecentChooserDialog Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.Window Signal Prototypes

gtk.Dialog Signal Prototypes

gtk.RecentChooser Signal Prototypes

Description

gtk.RecentChooserDialog is a dialog box suitable for displaying the recently used documents. This widgets works by putting a gtk.RecentChooserWidget inside a gtk.Dialog. It exposes the gtk.RecentChooser interface, so you can use all the gtk.RecentChooser methods on the recent chooser dialog as well as those for gtk.Dialog.

Note that gtk.RecentChooserDialog does not have any methods of its own. Instead, you should use the methods that work on a gtk.RecentChooser.

Example 4. Typical usage

In the simplest of cases, you can use the following code to use a gtk.RecentChooserDialog to select a recently used file:

  dialog = gtk.RecentChooserDialog("Recent Documents", parent_window, None,
			           (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
				    gtk.STOCK_OPEN, gtk.RESPONSE_ACCEPT))
					
  if dialog.run() == gtk.RESPONSE_ACCEPT:
    info = dialog.get_current_item ()
    open_file(info.get_uri())
  dialog.destroy()

Recently used files are supported since GTK+ 2.10.

Constructor

gtk.RecentChooserDialog

    gtk.RecentChooserDialog(title=None, parent=None, manager=None, buttons=None)

title :

Title of the dialog, or None

parent :

Transient parent of the dialog, or None,

manager :

a gtk.RecentManager, or None,

buttons :

a sequence of text-response pairs

Returns :

a new gtk.RecentChooserDialog

Note

This constructor is available in PyGTK 2.10 and above.

Creates a new gtk.RecentChooserDialog with the title text specified by title (or None for the default title; see gtk.Window.set_title()) and transient parent window specified by parent (or None for none; see gtk.Window.set_transient_for()). manager specifies a gtk.RecentManager object (or None). buttons is a sequence of button text/response ID pairs should be listed, or None (the default value) if no buttons are needed. The button text can be either a stock ID such as gtk.STOCK_OK, or some arbitrary text. A response ID can be any positive number, or one of the pre-defined GTK Response Type Constants. This constructor is analogous to gtk.Dialog.

Prev Up Next
gtk.RecentAction Home gtk.RecentChooserMenu
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkmenu.html0000644000000000000000000014136011272037113023274 0ustar rootrootgtk.Menu
gtk.Menu
Prev The gtk Class Reference Next

gtk.Menu

gtk.Menu — a drop down menu widget.

Synopsis

class gtk.Menu(gtk.MenuShell):
    gtk.Menu()
    def popup(parent_menu_shell, parent_menu_item, func, button, activate_time, data=None)
    def reposition()
    def popdown()
    def get_active()
    def set_active(index)
    def set_accel_group(accel_group)
    def get_accel_group()
    def set_accel_path(accel_path)
    def get_accel_path()
    def attach_to_widget(attach_widget, detach_func)
    def detach()
    def get_attach_widget()
    def set_tearoff_state(torn_off)
    def get_tearoff_state()
    def set_title(title)
    def get_title()
    def reorder_child(child, position)
    def set_screen(screen)
    def attach(child, left_attach, right_attach, top_attach, bottom_attach)
    def set_monitor(monitor_num)
    def get_monitor()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.MenuShell
          +-- gtk.Menu

Implemented Interfaces

gtk.Menu implements gtk.Buildable

gtk.Menu Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.MenuShell Properties

"accel-group"Read/WriteThe accel group holding accelerators for the menu. Available in GTK+ 2.14.
"accel-path"Read/WriteAn accel path used to conveniently construct accel paths of child items. Default value: None. Available in GTK+ 2.14.
"active"Read/WriteThe index of the currently selected menu item, or -1 if no menu item is selected. Allowed values: >= -1. Default value: -1. Available in GTK+ 2.14.
"attach-widget"Read/WriteThe widget the menu is attached to. Setting this property attaches the menu without a GtkMenuDetachFunc. If you need to use a detacher, use gtk.Menu.attach_to_widget() directly. Available in GTK+ 2.14.
"monitor"Read/WriteThe monitor the menu will be popped up on. Allowed values: >= -1. Default value: -1. Available in GTK+ 2.14.
"tearoff-state"Read-WriteIf True the menu is torn-off. Default value: False. Available in GTK+ 2.6 and above.
"tearoff-title"Read-WriteA title that may be displayed by the window manager when this menu is torn-off. Default value: "".

gtk.Menu Style Properties

gtk.Widget Style Properties

Note

These properties are available in GTK+ 2.4 and above.

"horizontal-offset"ReadWhen the menu is a submenu, position it this number of pixels offset horizontally. Default value: -2.
"horizontal-padding"ReadExtra space at the left and right edges of the menu
"vertical-offset"ReadWhen the menu is a submenu, position it this number of pixels offset vertically. Default value: 0.
"vertical-padding"ReadExtra space at the top and bottom of the menu. Allowed values: >= 0. Default value: 1.

gtk.Menu Child Properties

Note

These properties are available in GTK+ 2.4 and above.

"bottom-attach"Read-WriteThe row number to attach the bottom of the child to. Allowed values: >= -1. Default value: -1.
"left-attach"Read-WriteThe column number to attach the left side of the child to. Allowed values: >= -1. Default value: -1.
"right-attach"Read-WriteThe column number to attach the right side of the child to. Allowed values: >= -1. Default value: -1.
"top-attach"Read-WriteThe row number to attach the top of the child to. Allowed values: >= -1. Default value: -1.

gtk.Menu Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.MenuShell Signal Prototypes

"move-scroll"

 def callback(menu, type, user_param1, ...)

Description

A gtk.Menu is a gtk.MenuShell that implements a drop down menu consisting of a list of gtk.MenuItem objects which can be navigated and activated by the user to perform application functions. A gtk.Menu is most commonly dropped down by activating a gtk.MenuItem in a gtk.MenuBar or popped up by activating a gtk.MenuItem in another gtk.Menu. A gtk.Menu can also be popped up by activating a gtk.OptionMenu. Other composite widgets such as the gtk.Notebook can pop up a gtk.Menu as well. Applications can display a gtk.Menu as a popup menu by calling the popup() method.

Constructor

    gtk.Menu()

Returns :

a gtk.Menu widget

Creates a new gtk.Menu widget.

Methods

gtk.Menu.popup

    def popup(parent_menu_shell, parent_menu_item, func, button, activate_time, data=None)

parent_menu_shell :

the menu shell containing the triggering menu item or None.

parent_menu_item :

the menu item whose activation triggered the popup or None.

func :

a user supplied function used to position the menu or None.

button :

the mouse button which was pressed to initiate the event.

activate_time :

the time at which the activation event occurred.

data :

optional data to be passed to func

The popup() method displays a menu and makes it available for selection. Applications can use this function to display context-sensitive menus, and will typically supply None for the parent_menu_shell, parent_menu_item and func parameters. The default menu positioning function will position the menu at the current pointer position. The button and activate_time values should be the mouse button that was pressed to trigger the menu popup and the time the button was pressed. These values can usually be retrieved from the "button_press_event".

The signature of func is:

  def func(menu, user_data):

where user_data is data if not None. func should return a 3-tuple containing the x and y coordinates of the position to draw the menu and a boolean that, if True, indicates that the menu should be pushed in to be completely inside the screen instead of just clamped to the size of the screen.

Note

Prior to PyGTK 2.10 this method did not accept the data parameter and the signature of func was:

  def func(menu, user_data):

gtk.Menu.reposition

    def reposition()

The reposition() method repositions the menu on the screen according to the internal position function.

gtk.Menu.popdown

    def popdown()

The popdown() method removes the menu from the screen.

gtk.Menu.get_active

    def get_active()

Returns :

the gtk.MenuItem that was last selected in the menu. If a selection has not yet been made, the first menu item is selected.

The get_active() method returns the selected menu item from the menu. This is used by the gtk.OptionMenu.

gtk.Menu.set_active

    def set_active(index)

index :

the index of the menu item to select. Index values start from 0.

The set_active() method selects the menu item within the menu at the location specified by index. This is used by the gtk.OptionMenu and is not useful for applications.

gtk.Menu.set_accel_group

    def set_accel_group(accel_group)

accel_group :

a gtk.AccelGroup

The set_accel_group() method associates the gtk.AccelGroup specified by accel_group with the menu. The accelerator group should also be added to all windows using this menu by calling the gtk.Window.add_accel_group() method.

gtk.Menu.get_accel_group

    def get_accel_group()

Returns :

the gtk.AccelGroup associated with the menu.

The get_accel_group() method returns the gtk.AccelGroup that holds the global accelerators for the menu.

gtk.Menu.set_accel_path

    def set_accel_path(accel_path)

accel_path :

a valid accelerator path

The set_accel_path() method sets an accelerator path (specified by accel_path) for this menu to be used to construct accelerator paths for its menu items. This is a convenience method used to avoid calling the gtk.MenuItem.set_accel_path() method on each menu item that should support runtime user changeable accelerators. Instead, by just calling set_accel_path() on their parent, each menu item of this menu, that contains a label describing its purpose, automatically gets an accel path assigned. For example, calling:

  menu.set_accel_path("<main>/File")

for a menu containing menu items "New" and "Exit", will assign its items the accel paths: "<main>/File/New" and "<main>/File/Exit". Assigning accel paths to menu items enables the user to change their accelerators at runtime.

gtk.Menu.get_accel_path

    def get_accel_path()

Returns :

the accelerator path set on the menu.

Note

This method is available in PyGTK 2.14 and above.

The get_accel_path() method returns the accelerator path set on the menu.

gtk.Menu.attach_to_widget

    def attach_to_widget(attach_widget, detach_func)

attach_widget :

the widget that the menu will be attached to.

detach_func :

the user supplied callback function that will be called when the menu calls the detach() method.

The attach_to_widget() method attaches the menu to the widget specified by attach_widget and provides a callback function specified by detach_func that will be invoked when the menu calls the detach() method during its destruction. Attaching a menu to a widget associates the menu with a widget similar to setting a parent. This is mainly used for associating popup menus with a widget and a submenu with a menuitem.

The signature of detach is:

def detach_cb(menu, widget):

where menu is the menu being detached and widget is the attach_widget.

Note

For historical reasons, arguments for detach callback are swapped compared to GTK+ C API.

gtk.Menu.detach

    def detach()

The detach() method detaches the menu from the widget to which it had been attached. See attach_to_widget().

gtk.Menu.get_attach_widget

    def get_attach_widget()

Returns :

the widget that the menu is attached to.

The get_attach_widget() method returns the gtk.Widget that the menu is attached to.

gtk.Menu.set_tearoff_state

    def set_tearoff_state(torn_off)

torn_off :

If True, the menu is displayed as a tearoff menu.

The set_tearoff_state() method sets the tearoff state of the menu to the value of torn_off. If torn_off is True the menu is displayed as a tearoff menu; if torn_off is False the menu is displayed as a drop down menu which persists as long as the menu is active.

gtk.Menu.get_tearoff_state

    def get_tearoff_state()

Returns :

True if the menu is currently torn off.

The get_tearoff_state() method returns whether the menu is torn off. See set_tearoff_state().

gtk.Menu.set_title

    def set_title(title)

title :

a string containing the title for the menu.

The set_title() method sets the title text (from the value of title) to be used for the menu when it is shown as a tearoff menu.

gtk.Menu.get_title

    def get_title()

Returns :

the title of the menu, or None if the menu has no title set on it.

The get_title() method returns the title of the menu or None of no title is set. See set_title().

gtk.Menu.reorder_child

    def reorder_child(child, position)

child :

the gtk.MenuItem to move.

position :

the new position to place child. Positions are numbered starting from 0

The reorder_child() method moves the menuitem specified by child to a new position within the menu specified by position.

gtk.Menu.set_screen

    def set_screen(screen)

screen :

a gtk.gdk.Screen, or None if the screen should be determined by the widget the menu is attached to.

Note

This method is available in PyGTK 2.2 and above.

The set_screen() method sets the gtk.gdk.Screen specified by screen on which the menu will be displayed. If screen is None the screen is determined by the widget that the menu is attached to.

gtk.Menu.attach

    def attach(child, left_attach, right_attach, top_attach, bottom_attach)

child :

a gtk.MenuItem.

left_attach :

The column number to attach the left side of the item to.

right_attach :

The column number to attach the right side of the item to.

top_attach :

The row number to attach the top of the item to.

bottom_attach :

The row number to attach the bottom of the item to.

Note

This method is available in PyGTK 2.4 and above.

The attach() method adds a new gtk.MenuItem specified by child to a (table) menu. The number of 'cells' that an item will occupy is specified by left_attach, right_attach, top_attach and bottom_attach. These each represent the leftmost, rightmost, uppermost and lower column and row numbers of the table. (Columns and rows are indexed from zero).

Note that this function is not related to the detach() method.

gtk.Menu.set_monitor

    def set_monitor(monitor_num)

monitor_num :

the number of the monitor on which the menu should be popped up

Note

This method is available in PyGTK 2.4 and above.

The set_monitor() method informs GTK+ on which monitor a menu should be popped up. See the gtk.gdk.Screen.get_monitor_geometry() method for more information.

This method should be called from a menu positioning function if the menu should not appear on the same monitor as the pointer. This information can't be reliably inferred from the coordinates returned by a menu positioning function, since, for very long menus, these coordinates may extend beyond the monitor boundaries or even the screen boundaries.

gtk.Menu.get_monitor

    def get_monitor()

Returns :

the number of the monitor on which the menu should be popped up or -1, if no monitor has been set

Note

This method is available in PyGTK 2.14 and above.

The get_monitor() method returns the number of the monitor on which to show the menu.

Signals

The "move_scroll" gtk.Menu Signal

    def callback(menu, type, user_param1, ...)

menu :

the menu that received the signal

type :

the type of scroll that is requested

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.2 and above.

The "move_scroll" signal is emitted when the user attempts to scroll the menu. type should be one of the GTK Scroll Step Constants.

Prev Up Next
gtk.ListStore Home gtk.MenuBar
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangoattribute.html0000644000000000000000000021641311272037113024654 0ustar rootrootpango.Attribute
pango.Attribute
Prev The pango Class Reference Next

pango.Attribute

pango.Attribute — an attribute that applies to a section of text

Synopsis

class pango.Attribute:
    def copy()
Functions

    def pango.attr_type_register(name)
    def pango.AttrLanguage(language, start_index=0, end_index=1)
    def pango.AttrFamily(family, start_index=0, end_index=1)
    def pango.AttrForeground(red, green, blue, start_index=0, end_index=1)
    def pango.AttrBackground(red, green, blue, start_index=0, end_index=1)
    def pango.AttrSize(size, start_index=0, end_index=1)
    def pango.AttrStyle(style, start_index=0, end_index=1)
    def pango.AttrWeight(weight, start_index=0, end_index=1)
    def pango.AttrVariant(variant, start_index=0, end_index=1)
    def pango.AttrStretch(stretch, start_index=0, end_index=1)
    def pango.AttrFontDesc(desc, start_index=0, end_index=1)
    def pango.AttrUnderline(underline, start_index=0, end_index=1)
    def pango.AttrStrikethrough(strikethrough, start_index=0, end_index=1)
    def pango.AttrRise(rise, start_index=0, end_index=1)
    def pango.AttrShape(ink_rect, logical_rect, start_index=0, end_index=1)
    def pango.AttrScale(scale, start_index=0, end_index=1)
    def pango.AttrFallback(fallback, start_index=0, end_index=1)
    def pango.AttrSizeAbsolute(size, start_index=0, end_index=1)
    def pango.AttrUnderlineColor(red, green, blue, start_index=0, end_index=1)
    def pango.AttrStrikethroughColor(red, green, blue, start_index=0, end_index=1)
    def pango.AttrLetterSpacing(letter_spacing, start_index=0, end_index=1)

Attributes

All pango.Attribute objects support the following three attributes.

"end_index"Read-WriteThe index of the end of the application of the attribute in the associated text.
"start_index"Read-WriteThe index of the start of the application of the attribute in the associated text.
"type"ReadThe attribute type.

In addition each pango.Attribute type supports one or more additional attributes that are specific to the type:

"value"Read   ATTR_LANGUAGEThe pango.Language.
"value"ReadATTR_FAMILYThe string containing the font family name list (e.g. "normal,sans,serif,monospace")
"value"ReadATTR_STYLEThe font slant style. See the pango.AttrStyle() function for more details.
"value"ReadATTR_WEIGHTThe font weight. See the pango.AttrWeight() function for more detail.
"value"ReadATTR_VARIANTThe font variant. See the pango.AttrVariant() function for more detail.
"value"ReadATTR_STRETCHThe font stretch. See the pango.AttrStretch() function for more details.
"value"ReadATTR_SIZEThe font size in thousandths of a point.
"desc"ReadATTR_FONT_DESCThe pango.FontDescription object.
"color"ReadATTR_FOREGROUNDThe foreground pango.Color object.
"color"ReadATTR_BACKGROUNDThe background pango.Color object.
"value"ReadATTR_UNDERLINEThe underline style. See the pango.AttrUnderline() function for more details.
"value"ReadATTR_STRIKETHROUGHTrue if the text is struck through.
"value"ReadATTR_RISEThe displacement of the text from the baseline.
"ink_rect"ReadATTR_SHAPEThe 4-tuple specifying the ink rectangle. See the pango.AttrShape() function for more details.
"logical_rect"ReadATTR_SHAPEThe 4-tuple specifying the logical rectangle. See the pango.AttrShape() function for more details.
"value"ReadATTR_SCALEThe font size scale factor as a float.
"value"ReadATTR_FALLBACKTrue if font fallback is enabled.
"value"ReadATTR_LETTER_SPACINGThe extra space between graphemes.
"color"ReadATTR_UNDERLINE_COLORThe pango.Color object used for the color of the underline.
"color"ReadATTR_STRIKETHROUGH_COLORThe pango.Color object used for the color of the strikethrough.
"value"ReadATTR_ABSOLUTE_SIZEThe font size in device units.

Description

The pango.Attribute object contains an attribute that applies to a section of text. The predefined attribute types are:

pango.ATTR_LANGUAGE

Specifies a pango.Language.

pango.ATTR_FAMILY

Specifies a font family name list as a string.

pango.ATTR_STYLE

Specifies a font slant style. See the pango.AttrStyle() function for more details.

pango.ATTR_WEIGHT

Specifies a font weight. See the pango.AttrWeight() function for more detail.

pango.ATTR_VARIANT

Specifies a font variant (normal or small caps). See the pango.AttrVariant() function for more detail.

pango.ATTR_STRETCH

Specifies a font stretch. See the pango.AttrStretch() function for more details.

pango.ATTR_SIZE

Specifies a font size in thousandths of a point.

pango.ATTR_FONT_DESC

Specifies a pango.FontDescription.

pango.ATTR_FOREGROUND

Specifies a foreground pango.Color.

pango.ATTR_BACKGROUND

Specifies a background pango.Color.

pango.ATTR_UNDERLINE

Specifies an underline style. See the pango.AttrUnderline() function for more details.

pango.ATTR_STRIKETHROUGH

If True the text is struck through.

pango.ATTR_RISE

Specifies the displacement of the text from the baseline.

pango.ATTR_SHAPE

Specifies a shape. See the pango.AttrShape() function for more details.

pango.ATTR_SCALE

Specifies a font size scale factor.

pango.ATTR_FALLBACK

if True, fallback to other fonts is enabled.

pango.ATTR_LETTER_SPACING

Specifies the extra space between graphemes.

pango.ATTR_UNDERLINE_COLOR

Specifies the color of the underline.

pango.ATTR_STRIKETHROUGH_COLOR

Specifies the color of the strikethrough.

pango.ATTR_ABSOLUTE_SIZE

Specifies the font size in device units.

Additional attribute types can be registered with the pango.attr_type_register() function.

Methods

pango.Attribute.copy

    def copy()

Returns :

a new pango.Attribute object

The copy() method returns a new pango.Attribute object that is a copy of this attribute.

Functions

pango.attr_type_register

    def pango.attr_type_register(name)

name :

a name for the type. (Currently not used.)

Returns :

the new attribute type ID integer.

The attr_type_register() function returns a new attribute type ID integer value.

pango.AttrLanguage

    def pango.AttrLanguage(language, start_index=0, end_index=1)

language :

a pango.Language object.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object.

The AttrLanguage() function creates a new pango.Attribute object of the type pango.ATTR_LANGUAGE with the pango.Language specified by language and the text range specified by start_index and end_index.

pango.AttrFamily

    def pango.AttrFamily(family, start_index=0, end_index=1)

family :

the string containing a font family name list.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object.

The AttrFamily() function creates a new pango.Attribute object of the type pango.ATTR_FAMILY with the font family name list specified by the string family and the text range specified by start_index and end_index.

pango.AttrForeground

    def pango.AttrForeground(red, green, blue, start_index=0, end_index=1)

red :

the red component of the color in the range 0 to 65535.

green :

the green component of the color in the range 0 to 65535.

blue :

the blue component of the color in the range 0 to 65535.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object.

The AttrForeground() function creates a new pango.Attribute of the type pango.ATTR_FOREGROUND with the RGB color specified by red, green and blue and the text range specified by start_index and end_index.

pango.AttrBackground

    def pango.AttrBackground(red, green, blue, start_index=0, end_index=1)

red :

the red component of the color in the range 0 to 65535.

green :

the green component of the color in the range 0 to 65535.

blue :

the blue component of the color in the range 0 to 65535.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object.

The AttrBackground() function creates a new pangoAttribute of the type pango.ATTR_BACKGROUND with the RGB color specified by red, green and blue and the text range specified by start_index and end_index.

pango.AttrSize

    def pango.AttrSize(size, start_index=0, end_index=1)

size :

the font size in thousandths of a point.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrSize() function creates a new pango.Attribute object of the type pango.ATTR_SIZE with the font size specified by size and the text range specified by start_index and end_index.

pango.AttrStyle

    def pango.AttrStyle(style, start_index=0, end_index=1)

style :

the font slant style.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrStyle() function creates a new pango.Attribute object of the type pango.ATTR_STYLE with the font slant style specified by style and the text range specified by start_index and end_index. The value of style must be one of:

pango.STYLE_NORMAL

The font is upright.

pango.STYLE_OBLIQUE

The font is slanted in a roman style.

pango.STYLE_ITALIC

The font is slanted in an italic style.

pango.AttrWeight

    def pango.AttrWeight(weight, start_index=0, end_index=1)

weight :

the font weight.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrWeight() function creates a new pango.Attribute object of the type pango.ATTR_WEIGHT with the font weight specified by weight and the text range specified by start_index and end_index. The value of style must be one of:

pango.WEIGHT_ULTRALIGHT

The ultralight weight (= 200).

pango.WEIGHT_LIGHT

The light weight (=300).

pango.WEIGHT_NORMAL

The default weight (= 400).

pango.WEIGHT_BOLD

The bold weight (= 700).

pango.WEIGHT_ULTRABOLD

The ultrabold weight (= 800).

pango.WEIGHT_HEAVY

The heavy weight (= 900).

pango.AttrVariant

    def pango.AttrVariant(variant, start_index=0, end_index=1)

variant :

the font variant.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrVariant() function creates a new pango.Attribute object of the type pango.ATTR_VARIANT with the font variant specified by variant and the text range specified by start_index and end_index. The value of variant must be one of:

pango.VARIANT_NORMAL

A normal font.

pango.VARIANT_SMALL_CAPS

A font with the lower case characters replaced by smaller variants of the capital characters.

pango.AttrStretch

    def pango.AttrStretch(stretch, start_index=0, end_index=1)

stretch :

the font stretch style.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrStretch() function creates a new pango.Attribute object of the type pango.ATTR_STRETCH with the font stretch style specified by stretch and the text range specified by start_index and end_index. The value of stretch must be one of:

pango.STRETCH_ULTRA_CONDENSED

The most narrow width

pango.STRETCH_EXTRA_CONDENSED

pango.STRETCH_CONDENSED

pango.STRETCH_SEMI_CONDENSED

pango.STRETCH_NORMAL

The normal width.

pango.STRETCH_SEMI_EXPANDED

pango.STRETCH_EXPANDED

pango.STRETCH_EXTRA_EXPANDED

pango.STRETCH_ULTRA_EXPANDED

The most expanded width

pango.AttrFontDesc

    def pango.AttrFontDesc(desc, start_index=0, end_index=1)

desc :

a pango.FontDescription object.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrFontDesc() function creates a new pango.Attribute object of the type pango.ATTR_FONT_DESC with the pango.FontDescription specified by desc and the text range specified by start_index and end_index.

pango.AttrUnderline

    def pango.AttrUnderline(underline, start_index=0, end_index=1)

underline :

the underline style.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrUnderline() function creates a new pango.Attribute object of the type pango.ATTR_UNDERLINE with the underline style specified by underline and the text range specified by start_index and end_index. The value of underline must be one of:

pango.UNDERLINE_NONE

No underline should be drawn.

pango.UNDERLINE_SINGLE

A single underline should be drawn.

pango.UNDERLINE_DOUBLE

A double underline should be drawn.

pango.UNDERLINE_LOW

A single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining single characters, such as for keyboard accelerators. pango.UNDERLINE_SINGLE should be used for extended portions of text.

pango.AttrStrikethrough

    def pango.AttrStrikethrough(strikethrough, start_index=0, end_index=1)

strikethrough :

if True the text should be struck through.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrStrikethrough() function creates a new pango.Attribute object of the type pango.ATTR_STRIKETHROUGH with the value specified by strikethrough and the text range specified by start_index and end_index. If strikethough is True the text should be struck through.

pango.AttrRise

    def pango.AttrRise(rise, start_index=0, end_index=1)

rise :

the displacement of the text from the baseline.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrRise() function creates a new pango.Attribute object of the type pango.ATTR_RISE with the text displacement from the baseline specified by rise and the text range specified by start_index and end_index.

pango.AttrShape

    def pango.AttrShape(ink_rect, logical_rect, start_index=0, end_index=1)

ink_rect :

the ink rectangle of the shape.

logical_rect :

the logical rectangle of the shape.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrShape() function creates a new pango.Attribute object of the type pango.ATTR_SHAPE with the shape rectangles specified by ink_rect and logical_rect and the text range specified by start_index and end_index. A shape is used to impose a particular ink and logical rect on the result of shaping a particular glyph. This might be used, for instance, for embedding a picture or a widget inside a pango.Layout.

pango.AttrScale

    def pango.AttrScale(scale, start_index=0, end_index=1)

scale :

the font size scale factor as a float.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

The AttrScale() function creates a new pango.Attribute object of the type pango.ATTR_SCALE with the font size scale factor specified by scale and the text range specified by start_index and end_index. The value of scale can also be one of the following pre-defined values:

pango.SCALE_XX_SMALL

0.5787037037037 - the scale factor for three shrinking steps (1 / (1.2 * 1.2 * 1.2)).

pango.SCALE_X_SMALL

0.6444444444444 - the scale factor for two shrinking steps (1 / (1.2 * 1.2)).

pango.SCALE_SMALL

0.8333333333333 - the scale factor for one shrinking step (1 / 1.2).

pango.SCALE_MEDIUM

1.0 - The scale factor for normal size.

pango.SCALE_LARGE

1.2 - the scale factor for one magnification step.

pango.SCALE_X_LARGE

1.4399999999999 - the scale factor for two magnification steps (1.2 * 1.2).

pango.SCALE_XX_LARGE

1.728 - the scale factor for three magnification steps (1.2 * 1.2 * 1.2).

pango.AttrFallback

    def pango.AttrFallback(fallback, start_index=0, end_index=1)

fallback :

if True, we should fall back on other fonts for characters the active font is missing.

start_index :

the index of the start of the attribute application in the text.

end_index :

the index of the end of the attribute application in the text.

Returns :

a new pango.Attribute object

Note

This function is available in PyGTK 2.4 and above.

The AttrFallback() function creates a new pango.Attribute object of the type pango.ATTR_FALLBACK. If fallback is True other fonts on the system can be used to provide characters missing from the current font. Otherwise, only characters from the closest matching font can be used.

Prev Up Next
The pango Class Reference Home pango.AttrIterator
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkrecentmanager.html0000644000000000000000000010016411272037113025140 0ustar rootrootgtk.RecentManager
gtk.RecentManager
Prev The gtk Class Reference Next

gtk.RecentManager

gtk.RecentManager — manages recently used files (new in PyGTK 2.10)

Synopsis

class gtk.RecentManager(gobject.GObject):
    gtk.RecentManager()
    def set_screen(screen)
    def add_item(uri)
    def add_full(uri, recent_data)
    def remove_item(uri)
    def lookup_item(uri)
    def has_item(uri)
    def move_item(uri, new_uri)
    def set_limit(limit)
    def get_limit()
    def get_items()
    def purge_items()
Functions

    def gtk.recent_manager_get_default()
    def gtk.recent_manager_get_for_screen(screen)

Ancestry

+-- gobject.GObject
  +-- gtk.RecentManager

gtk.RecentManager Properties

"filename"Read-Write-Construct OnlyThe full path to the file to be used to store and read the recently used resources list This property is available in GTK+ 2.10 and above.
"limit"Read-WriteThe maximum number of items to be returned by the gtk.RecentManager.get_items() function. This property is available in GTK+ 2.10 and above.
"size"ReadThe size of the recently used resources list. This property is available in GTK+ 2.10 and above.

gtk.RecentManager Signal Prototypes

gobject.GObject Signal Prototypes

"changed

 def callback(recent_manager, user_param1, ...)

Description

gtk.RecentManager provides a facility for adding, removing and looking up recently used files. Each recently used file is identified by its URI, and has meta-data associated to it, like the names and command lines of the applications that have registered it, the number of time each application has registered the same file, the mime type of the file and whether the file should be displayed only by the applications that have registered it.

The gtk.RecentManager acts like a database of all the recently used files. You can create new gtk.RecentManager objects, but it is more efficient to use the standard recent manager for the gtk.gdk.Screen so that information about the recently used files is shared with other people using them. In case the default screen is being used, adding a new recently used file is as simple as:

  manager = gtk.recent_manager_get_default()
  manager.add_item(file_uri)

While looking up a recently used file is as simple as:

  manager = gtk.recent_manager_get_default()
  try:
    info = manager.lookup_item(file_uri)
  except gobject.GError:
    print "Could not find the file: ", file_uri

Recently used files are supported since GTK+ 2.10.

Constructor

gtk.RecentManager

    gtk.RecentManager()

Returns :

A newly created gtk.RecentManager object.

Note

This constructor is available in PyGTK 2.10 and above.

Creates a new recent manager object. Recent manager objects are used to handle the list of recently used resources. A gtk.RecentManager object monitors the recently used resources list, and emits the "changed" signal each time something inside the list changes.

gtk.RecentManager objects are expansive: be sure to create them only when needed. You should use the gtk.recent_manager_get_for_screen() or the gtk.recent_manager_get_default() functions instead.

Methods

gtk.RecentManager.set_screen

    def set_screen(screen)

screen :

a gtk.gdk.Screen

Note

This method is available in PyGTK 2.10 and above.

Sets the screen for a recent manager; the screen is used to track the user's currently configured recently used documents storage.

gtk.RecentManager.add_item

    def add_item(uri)

uri :

a valid URI

Returns :

True if the new item was successfully added to the recently used resources list

Note

This method is available in PyGTK 2.10 and above.

Adds a new resource, pointed by uri, into the recently used resources list.

This method automatically retrieves some of the needed metadata and sets other metadata to common default values.

See the gtk.RecentManager.add_full() method if you want to explicitly define the metadata for the resource pointed by uri.

gtk.RecentManager.add_full

    def add_full(uri, recent_data)

uri :

a valid URI

recent_data :

a dict containing metadata of the resource

Returns :

True if the new item was successfully added to the recently used resources list.

Note

This method is available in PyGTK 2.10 and above.

Adds a new resource, pointed by uri, into the recently used resources list, using the metadata specified inside the dict passed in recent_data.

The passed URI will be used to identify this resource inside the list.

In order to register the new recently used resource, metadata about the resource must be passed as well as the URI. The metadata is stored in a dict, which must contain the MIME type of the resource pointed by the URI ("mime_type"), the name of the application that is registering the item ("app_name"), and a command line to be used when launching the item ("app_exec").

Optionally, the recent_data dict might contain a UTF-8 string to be used when viewing the item instead of the last component of the URI ("display_name"), a short description of the item ("description"), whether the item should be considered private - that is, should be displayed only by the applications that have registered it("is_private") or a list of the groups that the item belongs to ("groups").

gtk.RecentManager.remove_item

    def remove_item(uri)

uri :

the URI of the item you wish to remove

Returns :

True if the item pointed by uri has been successfully removed by the recently used resources list.

Note

This method is available in PyGTK 2.10 and above.

Removes a resource pointed by uri from the recently used resources list handled by a recent manager. Raises the gobject.GError when an error occurs.

gtk.RecentManager.lookup_item

    def lookup_item(uri)

uri :

a URI

Returns :

a gtk.RecentInfo object containing information about the resource pointed by uri, or None if the URI was not registered in the recently used resources list.

Searches for a URI inside the recently used resources list, and returns a gtk.RecentInfo object containing information about the resource like its MIME type, or its display name. Raises the gobject.GError when an error occurs.

gtk.RecentManager.has_item

    def has_item(uri)

uri :

a URI

Returns :

True if the resource was found.

Note

This method is available in PyGTK 2.10 and above.

Checks whether there is a recently used resource registered with uri.

gtk.RecentManager.move_item

    def move_item(uri, new_uri)

uri :

the URI of a recently used resource

new_uri :

the new URI of the recently used resource, or None to remove the item pointed by uri in the list

Returns :

True on success.

Note

This method is available in PyGTK 2.10 and above.

Changes the location of a recently used resource from uri to new_uri.

Please note that this function will not affect the resource pointed by the URIs, but only the URI used in the recently used resources list. Raises the gobject.GError when an error occurs.

gtk.RecentManager.set_limit

    def set_limit(limit)

limit :

the maximum number of items to return, or -1.

Note

This method is available in PyGTK 2.10 and above.

Sets the maximum number of item that the gtk.RecentManager.get_items() function should return. If limit is set to -1, then return all the items.

gtk.RecentManager.get_limit

    def get_limit()

Returns :

the number of items to return, or -1 for every item.

Note

This method is available in PyGTK 2.10 and above.

Returns the maximum number of items that the gtk.RecentManager.get_items() method should return.

gtk.RecentManager.get_items

    def get_items()

Returns :

a list of gtk.RecentInfo objects.

Note

This method is available in PyGTK 2.10 and above.

Returns the list of recently used resources as gtk.RecentInfo objects.

gtk.RecentManager.purge_items

    def purge_items()

Returns :

the number of items that have been removed from the recently used resources list.

Note

This method is available in PyGTK 2.10 and above.

Purges every item from the recently used resources list. Raises the gobject.GError when an error occurs.

Functions

gtk.recent_manager_get_default

    def gtk.recent_manager_get_default()

Returns :

A unique gtk.RecentManager associated with the default screen. This recent manager is associated to the screen and can be used as long as the screen is open.

Note

This function is available in PyGTK 2.10 and above.

Gets the recent manager for the default screen. See the gtk.recent_manager_get_for_screen() function.

gtk.recent_manager_get_for_screen

    def gtk.recent_manager_get_for_screen(screen)

screen :

a gtk.gdk.Screen

Returns :

A unique gtk.RecentManager associated with the given screen. This recent manager is associated to the with the screen and can be used as long as the screen is open.

Note

This function is available in PyGTK 2.10 and above.

Gets the recent manager object associated with screen; if this function has not previously been called for the given screen, a new recent manager object will be created and associated with the screen. Recent manager objects are fairly expensive to create, so using this function is usually a better choice than calling the gtk.RecentManager() constructor and setting the screen yourself; by using this function a single recent manager object will be shared between users.

Signals

The "changed" gtk.RecentManager Signal

    def callback(recent_manager, user_param1, ...)

recent_manager :

the recent manager

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

Emitted when the current recently used resources manager changes its contents.

Prev Up Next
gtk.RecentInfo Home gtk.Requisition
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktreeviewcolumn.html0000644000000000000000000025424311272037113025405 0ustar rootrootgtk.TreeViewColumn
gtk.TreeViewColumn
Prev The gtk Class Reference Next

gtk.TreeViewColumn

gtk.TreeViewColumn — a visible column in a gtk.TreeView widget

Synopsis

class gtk.TreeViewColumn(gtk.Object):
    gtk.TreeViewColumn(title=None, cell_renderer=None, ...)
    def pack_start(cell, expand=True)
    def pack_end(cell, expand=True)
    def clear()
    def get_cell_renderers()
    def add_attribute(cell_renderer, attribute, column)
    def set_attributes(cell_renderer, ...)
    def set_cell_data_func(cell_renderer, func, func_data=None)
    def clear_attributes(cell_renderer)
    def set_spacing(spacing)
    def get_spacing()
    def set_visible(visible)
    def get_visible()
    def set_resizable(resizable)
    def get_resizable()
    def set_sizing(type)
    def get_sizing()
    def get_width()
    def get_fixed_width()
    def set_fixed_width(fixed_width)
    def set_min_width(min_width)
    def get_min_width()
    def set_max_width(max_width)
    def get_max_width()
    def clicked()
    def set_title(title)
    def get_title()
    def set_expand(expand)
    def get_expand()
    def set_clickable(active)
    def get_clickable()
    def set_widget(widget)
    def get_widget()
    def set_alignment(xalign)
    def get_alignment()
    def set_reorderable(reorderable)
    def get_reorderable()
    def set_sort_column_id(sort_column_id)
    def get_sort_column_id()
    def set_sort_indicator(setting)
    def get_sort_indicator()
    def set_sort_order(order)
    def get_sort_order()
    def cell_set_cell_data(tree_model, iter, is_expander, is_expanded)
    def cell_get_size(cell_area=(0,0,0,0))
    def cell_is_visible()
    def focus_cell(cell)
    def cell_get_position(cell_renderer)
    def queue_resize()
    def get_tree_view()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.TreeViewColumn

Implemented Interfaces

gtk.TreeViewColumn implements gtk.Buildable

gtk.TreeViewColumn Properties

gtk.Object Properties

"alignment"Read-WriteThe alignment of the column header text or widget
"clickable"Read-WriteIf True, the header can be clicked
"expand"Read-WriteIf True, the column can expand to take extra available space. Available in GTK+ 2.4 and above
"fixed-width"Read-WriteThe current fixed width of the column
"max-width"Read-WriteThe maximum allowed width of the column
"min-width"Read-WriteThe minimum allowed width of the column
"reorderable"Read-WriteIf True, the column can be reordered around the headers
"resizable"Read-WriteIf True, the user can resize the column
"sizing"Read-WriteThe resize mode of the column: gtk.TREE_VIEW_COLUMN_GROW_ONLY, gtk.TREE_VIEW_COLUMN_AUTOSIZE or gtk.TREE_VIEW_COLUMN_FIXED
"sort-indicator"Read-WriteIf True, how a sort indicator
"sort-order"Read-WriteThe sort direction the sort indicator should indicate: gtk.SORT_ASCENDING or gtk.SORT_DESCENDING
"spacing"Read-WriteSpace which is inserted between cells
"title"Read-WriteThe title to appear in the column header
"visible"Read-WriteIf True, display the column
"widget"Read-WriteThe widget to put in the column header button instead of the column title
"width"ReadThe current width of the column

gtk.TreeViewColumn Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

"clicked"

 def callback(treeviewcolumn, user_param1, ...)

Description

The gtk.TreeViewColumn object is a visible column in a gtk.TreeView widget. A gtk.TreeViewColumn manages the display of the header and the cells using a gtk.CellRenderer.

In PyGTK 2.4 gtk.TreeViewColumn implementes the gtk.CellLayout interface.

Constructor

    gtk.TreeViewColumn(title=None, cell_renderer=None, ...)

title :

the header title string

cell_renderer :

a gtk.CellRenderer

... :

zero or more attribute=column pairs

Returns :

A newly created gtk.TreeViewColumn.

Creates a new gtk.TreeViewColumn with the header string specified by title and using the gtk.CellRenderer specified by cell_renderer. Zero or more attribute=column pairs may be added to specify from which tree model column to retrieve the attribute value. For example:

  column = gtk.TreeViewColumn('Column Title', cell_renderer, text=0, foreground=1)

will retrieve the 'text' attribute values for the cell renderer from column 0 in the treemodel and the 'foreground' attribute values from column 1. See the add_attribute() method for more detail.

Methods

gtk.TreeViewColumn.pack_start

    def pack_start(cell, expand=True)

cell :

a gtk.CellRenderer.

expand :

if True cell is to be given the extra space allocated to the cell box.

The pack_start() method packs the gtk.CellRenderer specified by cell into the beginning column. If expand is True, then the cell is allocated a share of all available space that the column is allocated. Note expand defaults to True in PyGTK 2.4.

gtk.TreeViewColumn.pack_end

    def pack_end(cell, expand=True)

cell :

a gtk.CellRenderer.

expand :

if True cell is to be given the extra space allocated to the cell box.

The pack_end() method packs the gtk.CellRenderer specified by cell into the column. If expand is True, then the cell is allocated a share of all available space that the column is allocated. Note expand defaults to True in PyGTK 2.4.

gtk.TreeViewColumn.clear

    def clear()

The clear() method unsets all the mappings on all renderers on the column.

gtk.TreeViewColumn.get_cell_renderers

    def get_cell_renderers()

Returns :

a list of gtk.CellRenderer objects

The get_cell_renderers() method returns a list containing all the cell renderers in the column, in no particular order.

gtk.TreeViewColumn.add_attribute

    def add_attribute(cell_renderer, attribute, column)

cell_renderer :

the gtk.CellRenderer to set attributes on

attribute :

an attribute on the renderer

column :

the column position on the model to get the attribute from.

The add_attribute() method adds an attribute mapping to the list in the tree column. The column is the column of the tree model to get a value from, and the attribute is the parameter on cell_renderer to be set from the value. So for example if column 2 of the model contains strings, you could have the "text" attribute of a gtk.CellRendererText get its values from column 2.

gtk.TreeViewColumn.set_attributes

    def set_attributes(cell_renderer, ...)

cell_renderer :

the gtk.CellRenderer we're setting the attributes of

... :

zero or more attribute=column pairs

The set_attributes() method sets the attribute locations of the gtk.CellRenderer specified by cell_renderer using the attribute=column pairs (e.g. text=0, foreground=1). See the add_attribute() method for more detail. All existing cell attributes are removed, and replaced with the new attributes.

gtk.TreeViewColumn.set_cell_data_func

    def set_cell_data_func(cell_renderer, func, func_data=None)

cell_renderer :

a gtk.CellRenderer

func :

the function or method to use.

func_data :

the user data to pass when calling func.

The set_cell_data_func() method sets the data function (or method) to use for the column gtk.CellRenderer specified by cell_renderer. This function (or method) is used instead of the standard attribute mappings for setting the column values, and should set the attributes of the cell renderer as appropriate. func may be None to remove the current data function. The signature of func is:

    def celldatafunction(column, cell, model, iter, user_data)

    def celldatamethod(self, column, cell, model, iter, user_data)

where column is the gtk.TreeViewColumn in the treeview, cell is the gtk.CellRenderer for column, model is the gtk.TreeModel for the treeview and iter is the gtk.TreeIter pointing at the row.

gtk.TreeViewColumn.clear_attributes

    def clear_attributes(cell_renderer)

cell_renderer :

a gtk.CellRenderer to clear the attribute mapping on.

The clear_attributes() method clears all existing attributes previously set with the set_attributes() method.

gtk.TreeViewColumn.set_spacing

    def set_spacing(spacing)

spacing :

the distance between cell renderers in pixels.

The set_spacing() method sets the spacing field of the treeview column, which is the number of pixels to place between cell renderers packed into it.

gtk.TreeViewColumn.get_spacing

    def get_spacing()

Returns :

the spacing of the treeview column.

The get_spacing() method returns the spacing of the treeview column.

gtk.TreeViewColumn.set_visible

    def set_visible(visible)

visible :

if True the treeview column is visible.

The set_visible() method sets the "visible" property to the value of visible. If visible is True the treeview column is visible

gtk.TreeViewColumn.get_visible

    def get_visible()

Returns :

True if the column is visible

The get_visible() method returns the value of the "visible" property. If "visible" is True the treeview column is visible.

gtk.TreeViewColumn.set_resizable

    def set_resizable(resizable)

resizable :

if True, the column can be resized

The set_resizable() method sets the "resizable" property to the value of resizable. If resizable is True the user can explicitly resize the column by grabbing the outer edge of the column button. If resizable is True and the sizing mode of the column is gtk.TREE_VIEW_COLUMN_AUTOSIZE, the sizing mode is changed to gtk.TREE_VIEW_COLUMN_GROW_ONLY.

gtk.TreeViewColumn.get_resizable

    def get_resizable()

Returns :

True, if the treeview column can be resized.

The get_resizable() method returns the value of the "resizable" property. If "resizable" is True, the treeview column can be resized by the user.

gtk.TreeViewColumn.set_sizing

    def set_sizing(type)

type :

The treeview column sizing: gtk.TREE_VIEW_COLUMN_GROW_ONLY, gtk.TREE_VIEW_COLUMN_AUTOSIZE or gtk.TREE_VIEW_COLUMN_FIXED.

The set_sizing() method sets the "sizing" property to the value of type. The value of type must be one of the GTK TreeViewColumn Sizing Constants.

gtk.TreeViewColumn.get_sizing

    def get_sizing()

Returns :

the treeview column sizing type.

The get_sizing() method returns the value of the "sizing" property that contains the current type of the treeview column sizing mode. See the set_sizing() method for more detail.

gtk.TreeViewColumn.get_width

    def get_width()

Returns :

the current width of the treeview column.

The get_width() method returns the value of the "width" property that contains the current size of the treeview column in pixels.

gtk.TreeViewColumn.get_fixed_width

    def get_fixed_width()

Returns :

the fixed width of the treeview column

The get_fixed_width() method returns the value of the "fixed-width" property that contains the fixed width of the treeview column i.e. the width of the treeview column only if the sizing type is gtk.TREE_VIEW_COLUMN_FIXED.

gtk.TreeViewColumn.set_fixed_width

    def set_fixed_width(fixed_width)

fixed_width :

the size to set the treeview column to. Must be greater than 0.

The set_fixed_width() method sets the "fixed-width" property to the value of fixed_width. The value of fixed_width is the size of the column in pixels. This is meaningful only if the sizing type is gtk.TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to the min and max width for the column. Please note that the min and max width of the column doesn't actually affect the "fixed_width" property of the widget, just the actual size when displayed.

gtk.TreeViewColumn.set_min_width

    def set_min_width(min_width)

min_width :

the minimum width of the treeview column in pixels, or -1.

The set_min_width() method sets the "min-width" property to the value of min_width. The value of min_width is the minimum width of the treeview column. If min_width is -1, then the minimum width is unset.

gtk.TreeViewColumn.get_min_width

    def get_min_width()

Returns :

the minimum width of the treeview column.

The get_min_width() method returns the value of the "min-width" property that contains the minimum width in pixels of the treeview column, or -1 if no minimum width is set.

gtk.TreeViewColumn.set_max_width

    def set_max_width(max_width)

max_width :

the maximum width of the column in pixels, or -1.

The set_max_width() method sets the "max-width" property to the value of max_width. The value of max_width becomes the maximum width of the treeview column. If max_width is -1, then the maximum width is unset. Note, the column can actually be wider than max width if it's the last column in a view. In this case, the column expands to fill any extra space.

gtk.TreeViewColumn.get_max_width

    def get_max_width()

Returns :

the maximum width of the treeview column.

The get_max_width() method returns the value of the "max-width" property that contains the maximum width in pixels of the treeview column, or -1 if no maximum width is set.

gtk.TreeViewColumn.clicked

    def clicked()

The clicked() method emits the "clicked" signal on the treeview column. The treeview column must be clickable.

gtk.TreeViewColumn.set_title

    def set_title(title)

title :

the title string of the treeview column.

The set_title() method sets the "title" property to the value of title. The "title" property contains the string that is used to set the treeview column title. If a custom widget has been set (see the set_widget() method), this value is ignored.

gtk.TreeViewColumn.get_title

    def get_title()

Returns :

the title of the column.

The get_title() method returns the value of the "title" property that contains the treeview column title.

gtk.TreeViewColumn.set_expand

    def set_expand(expand)

expand :

if True the column expands to take extra space if available.

Note

This method is available in PyGTK 2.4 and above.

The set_expand() method sets the "expand" property to the value of expand. If expand is True the column expands to take available extra space. This space is shared equally among all columns that have their "expand" property set to True. If no column has this option set, then the last column gets all extra space. By default, every column is created with this False.

gtk.TreeViewColumn.get_expand

    def get_expand()

Returns :

True, if the column expands

Note

This method is available in PyGTK 2.4 and above.

The get_expand() method returns the value of the "expand" property. If "expand is True if the column expands to take any available space.

gtk.TreeViewColumn.set_clickable

    def set_clickable(active)

active :

if True the treeview column header can be clicked

The set_clickable() method sets the "clickable" property to the value of active. If active is True the header can take keyboard focus, and be clicked.

gtk.TreeViewColumn.get_clickable

    def get_clickable()

Returns :

True if the user can click the column header.

The get_clickable() method returns the value of the "clickable" property. If "clickable" is True the user can click on the header for the treeview column.

gtk.TreeViewColumn.set_widget

    def set_widget(widget)

widget :

a child gtk.Widget.

The set_widget() method sets the widget in the header to be widget.

gtk.TreeViewColumn.get_widget

    def get_widget()

Returns :

the gtk.Widget in the column header, or None

The get_widget() method returns the gtk.Widget in the button on the column header. If a custom widget has not been set using the set_widget() method None is returned.

gtk.TreeViewColumn.set_alignment

    def set_alignment(xalign)

xalign :

the horizontal alignment, in the range 0.0 to 1.0 inclusive.

The set_alignment() method sets the "alignment" property to the value of xalign. xalign specifies the alignment of the title or custom widget inside the column header. The alignment value specifies the fraction of free space to the left of the widget.

gtk.TreeViewColumn.get_alignment

    def get_alignment()

Returns :

the current alignment of the treeview column.

The get_alignment() method returns the value of the "alignment" property that contains the current horizontal alignment of the treeview column. See the set_alignment() method for more detail.

gtk.TreeViewColumn.set_reorderable

    def set_reorderable(reorderable)

reorderable :

if True, the column can be reordered.

The set_reorderable() method sets the "reorderable" property to the value of reorderable. If reorderable is True, the column can be reordered by the end user dragging the header.

gtk.TreeViewColumn.get_reorderable

    def get_reorderable()

Returns :

True if the treeview column can be reordered by the user.

The get_reorderable() method returns the value of the "reorderable" property. If "reorderable" is True the treeview column can be reordered by the user.

gtk.TreeViewColumn.set_sort_column_id

    def set_sort_column_id(sort_column_id)

sort_column_id :

the logical column ID of the model to sort on or -1.

The set_sort_column_id() method is a convenience method that sets the column's sort column ID to the value specified by sort_column_id (an integer value). The treeview model sorts on the sort_column_id when this treeview column is selected for sorting. This method also makes the treeview column header clickable. If sort_column_id is -1 sorting using the treeview column is disabled.

This method sets up a number of callbacks that manage the sorting of the tree model when the column header is clicked. These callbacks provide toggling of the sort order, enabling the sort indicator and so on.

gtk.TreeViewColumn.get_sort_column_id

    def get_sort_column_id()

Returns :

the current column ID for this column, or -1 if this column can't be used for sorting.

The get_sort_column_id() method returns the logical column ID that the model sorts on when this column is selected for sorting. See the set_sort_column_id() method.

gtk.TreeViewColumn.set_sort_indicator

    def set_sort_indicator(setting)

setting :

if True display an indicator that the column is sorted

The set_sort_indicator() method sets the "sort-indicator" property to the value of setting. If setting is True an arrow is displayed in the header button when the column is sorted. Call the set_sort_order() to change the direction of the arrow.

Note

If the set_sort_column_id() convenience method has been called the visibility of the sort indicator will be managed automatically. See the set_sort_order() method for more information.

gtk.TreeViewColumn.get_sort_indicator

    def get_sort_indicator()

Returns :

True if the sort indicator arrow is displayed

The get_sort_indicator() method returns the value of the "sort-indicator" property. If "sort-indicator" is True an arrow is displayed in the header button when the column is sorted.

gtk.TreeViewColumn.set_sort_order

    def set_sort_order(order)

order :

the sort order that the sort indicator should indicate

The set_sort_order() method set the "sort-order" property to the value of order. The value of order must be either: gtk.SORT_ASCENDING or gtk.SORT_DESCENDING. This method changes the appearance of the sort indicator.

Note

This method does not actually sort the model. Use the set_sort_column_id() method if you want automatic sorting support. This method is primarily for custom sorting behavior, and should be used in conjunction with the set_sort_column_id() method to do that. For custom models, the mechanism will vary.

The sort indicator changes direction to indicate normal sort or reverse sort. Of course, you must have the sort indicator enabled to see anything when calling this method; see the set_sort_indicator() method.

gtk.TreeViewColumn.get_sort_order

    def get_sort_order()

Returns :

the sort order the sort indicator is indicating

The get_sort_order() method returns the value of the "sort-order" property that indicates in which direction the treeview column is sorted. See the set_sort_order() method for more detail.

gtk.TreeViewColumn.cell_set_cell_data

    def cell_set_cell_data(tree_model, iter, is_expander, is_expanded)

tree_model :

the gtk.TreeModel to get the cell renderer's attributes from.

iter :

the gtk.TreeIter to get the cell renderer's attributes from.

is_expander :

if True, the row has children

is_expanded :

if True, the row has visible children

The cell_set_cell_data() method sets the cell renderer attributes based on the specified tree_model and iter. That is, for every attribute mapping in the treeview column, it will get a value from the set column in the iter, and use that value to set the attribute on the cell renderer. If is_expander is True the tree model row has children that may or may not be displayed. If is_expanded is True the tree model row has children that are displayed.

gtk.TreeViewColumn.cell_get_size

    def cell_get_size(cell_area=(0,0,0,0))

cell_area :

an optional 4-tuple or 4-list or gtk.gdk.Rectangle specifying the area allocated for a cell in the column

Returns :

a tuple containing five values: a gtk.gdk.Rectangle holding the area a cell in the column will be allocated; the x offset of the cell; the y offset of the cell; the cell width; and, the cell height

The cell_get_size() method returns a tuple containing:

  • a gtk.gdk.Rectangle holding the area a cell in the treeview column will be allocated.
  • the x offset of the cell relative to cell_area.
  • the y offset of the cell relative to cell_area.
  • the width of the cell.
  • the height of the cell.

This method is used primarily by the gtk.TreeView.

gtk.TreeViewColumn.cell_is_visible

    def cell_is_visible()

Returns :

True, if any of the cells packed into the treeview column are currently visible

The cell_is_visible() method returns True if any of the cells packed into the treeview column are visible. For this to be meaningful, you must first initialize the cells with the cell_set_cell_data() method.

gtk.TreeViewColumn.focus_cell

    def focus_cell(cell)

cell :

a gtk.CellRenderer

Note

This method is available in PyGTK 2.2 and above.

The focus_cell() method sets the current keyboard focus to be at cell, if the column contains 2 or more editable and activatable cells.

gtk.TreeViewColumn.cell_get_position

    def cell_get_position(cell_renderer)

cell_renderer :

a gtk.CellRenderer

Returns :

a 2-tuple containing the horizontal position and size of a cell or None

Note

This method is available in PyGTK 2.4 and above.

The cell_get_position() method returns the horizontal position and size of the cell specified by cell_renderer. If the cell is not found in the column, None is returned.

gtk.TreeViewColumn.queue_resize

    def queue_resize()

Note

This method is available in PyGTK 2.8 and above.

The queue_resize() method flags the column, and the cell renderers added to this column, to have their sizes renegotiated.

gtk.TreeViewColumn.get_tree_view

    def get_tree_view()

Returns :

The tree view wherein column has been inserted if any, Noneotherwise.

Note

This method is available in PyGTK 2.12 and above.

The get_tree_view() method returns the gtk.TreeView wherein tree_column has been inserted. If column is currently not inserted in any tree view, None is returned.

Signals

The "clicked" gtk.TreeViewColumn Signal

    def callback(treeviewcolumn, user_param1, ...)

treeviewcolumn :

the treeviewcolumn that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "clicked" signal is emitted when the user clicks on the treeviewcolumn header button.

Prev Up Next
gtk.TreeView Home gtk.UIManager
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkseparatormenuitem.html0000644000000000000000000001541411272037113026074 0ustar rootrootgtk.SeparatorMenuItem
gtk.SeparatorMenuItem
Prev The gtk Class Reference Next

gtk.SeparatorMenuItem

gtk.SeparatorMenuItem — a separator used in menus.

Synopsis

class gtk.SeparatorMenuItem(gtk.MenuItem):
    gtk.SeparatorMenuItem()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Item
            +-- gtk.MenuItem
              +-- gtk.SeparatorMenuItem

Implemented Interfaces

gtk.SeparatorMenuItem implements gtk.Buildable

gtk.SeparatorMenuItem Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.SeparatorMenuItem Style Properties

gtk.Widget Style Properties

gtk.MenuItem Style Properties

gtk.SeparatorMenuItem Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.Item Signal Prototypes

gtk.MenuItem Signal Prototypes

Description

The gtk.SeparatorMenuItem is a separator used to group items within a menu. It displays a horizontal line with a shadow to make it appear sunken into the interface.

Constructor

    gtk.SeparatorMenuItem()

Returns :

a new gtk.SeparatorMenuItem widget

Creates a new gtk.SeparatorMenuItem widget.

Prev Up Next
gtk.Separator Home gtk.SeparatorToolItem
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangofont.html0000644000000000000000000004005611272037113023615 0ustar rootrootpango.Font
pango.Font
Prev The pango Class Reference Next

pango.Font

pango.Font — a rendering-system independent font representation.

Synopsis

class pango.Font(gobject.GObject):
    def describe()
    def get_metrics(language)
    def get_glyph_extents(glyph)
    def get_font_map()
Functions

    def pango.PIXELS(size)
    def pango.ASCENT(rect)
    def pango.DESCENT(rect)
    def pango.RBEARING(rect)
    def pango.LBEARING(rect)

Ancestry

+-- gobject.GObject
  +-- pango.Font

Description

A pango.Font object represents a font in a rendering-system independent way. A pango.Font is returned from the pango.Context.load_font(), pango.FontSet.get_font() and pango.FontMap.load_font()) methods.

Methods

pango.Font.describe

    def describe()

Returns :

a pango.FontDescription object.

The describe() method returns a description of the font in a pango.FontDescription object.

pango.Font.get_metrics

    def get_metrics(language)

language :

a pango.Language that determines the script to get the metrics for, or None to get the metrics for the entire font.

Returns :

a pango.FontMetrics object.

The get_metrics() method returns a pango.FontMetrics object containing the metric information for a font using the pango.Language specified by language to limit the metrics to the script(s) used by language. If the value of language is None, the font metrics for the entire font is returned.

pango.Font.get_glyph_extents

    def get_glyph_extents(glyph)

glyph :

the glyph index

Returns :

a 2-tuple containing two 4-tuples representing the ink and logical rectangles used to store the extents of glyph as drawn.

The get_glyph_extents() method returns a 2-tuple containing two 4-tuples representing the values of the logical and ink extent rectangles of the specified glyph within a font. The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing coordinates extending to the right and down. The pango.ASCENT(), pango.DESCENT(), pango.LBEARING(), and pango.RBEARING functions can be used to convert from the extents rectangle to more traditional font metrics. The units of the rectangles are in 1/pango.SCALE of a device unit.

pango.Font.get_font_map

    def get_font_map()

Returns :

the pango.FontMap for the font

Note

This method is available in PyGTK 2.10 and above.

Gets the font map for which the font was created.

Functions

pango.PIXELS

    def pango.PIXELS(size)

size :

the integer value to convert to pango pixels

Returns :

the pixel value

The pango.PIXELS() function converts and returns the integer value specified by size to pango pixels.

pango.ASCENT

    def pango.ASCENT(rect)

rect :

a 4-tuple representing an extent rectangle's (x, y, width, height) value

Returns :

the ascent value of rect

The pango.ASCENT() function returns the ascent value of the extent rectangle specified by rect.

pango.DESCENT

    def pango.DESCENT(rect)

rect :

a 4-tuple representing an extent rectangle's (x, y, width, height) value

Returns :

the descent value of rect

The pango.DESCENT() function returns the descent value of the extent rectangle specified by rect.

pango.RBEARING

    def pango.RBEARING(rect)

rect :

a 4-tuple representing an extent rectangle's (x, y, width, height) value

Returns :

the right bearing value of rect

The pango.RBEARING() function returns the right bearing value of the extent rectangle specified by rect.

pango.LBEARING

    def pango.LBEARING(rect)

rect :

a 4-tuple representing an extent rectangle's (x, y, width, height) value

Returns :

the left bearing value of rect

The pango.LBEARING() function returns the left bearing value of the extent rectangle specified by rect.

Prev Up Next
pango.Context Home pango.FontDescription
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkbox.html0000644000000000000000000010273411272037113023122 0ustar rootrootgtk.Box
gtk.Box
Prev The gtk Class Reference Next

gtk.Box

gtk.Box — an abstract base class for box containers

Synopsis

class gtk.Box(gtk.Container):
    def pack_start(child, expand=True, fill=True, padding=0)
    def pack_end(child, expand=True, fill=True, padding=0)
    def pack_start_defaults(widget)
    def pack_end_defaults(widget)
    def set_homogeneous(homogeneous)
    def get_homogeneous()
    def set_spacing(spacing)
    def get_spacing()
    def reorder_child(child, position)
    def query_child_packing(child)
    def set_child_packing(child, expand, fill, padding, pack_type)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Box

Implemented Interfaces

gtk.Box implements gtk.Buildable

gtk.Box Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"spacing"Read/WriteThe amount of space between children.
"homogeneous"Read/WriteIf True the children should all be the same size.

gtk.Box Style Properties

gtk.Widget Style Properties

gtk.Box Child Properties

"expand"Read/WriteIf True the child should receive extra space when the parent grows
"fill"Read/WriteIf True extra space given to the child should be allocated to the child; if False extra space given to the child should be used as padding
"padding"Read/WriteThe amount of extra space to put between the child and its neighbors, in pixels
"pack-type"Read/WriteIndicates whether the child is packed with reference to the start (gtk.PACK_START) or end (gtk.PACK_END) of the parent
"position"Read/WriteThe index of the child in the parent

gtk.Box Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

The gtk.Box class is an abstract base class defining a widget that encapsulates functionality for a particular kind of container, one that organizes a variable number of widgets into a rectangular area. gtk.Box currently has two families of derived classes: gtk.HBox and gtk.VBox being one, and gtk.HButtonBox and gtk.VButtonBox -- the other.

The rectangular area of a gtk.Box is organized into either a single row or a single column of child widgets depending upon whether the box is of type gtk.HBox or gtk.VBox, respectively. Thus, all children of a gtk.Box are allocated one dimension in common, which is the height of a row, or the width of a column.

gtk.Box uses a notion of packing. Packing refers to adding widgets with reference to a particular position in a gtk.Container. For a gtk.Box, there are two reference positions: the start and the end of the box. For a gtk.VBox, the start is defined as the top of the box and the end is defined as the bottom. For a gtk.HBox the start is defined as the left side and the end is defined as the right side.

Repeated calls to pack_start() pack widgets into a gtk.Box from start to end. The pack_end() method adds widgets from end to start. You may intersperse these calls and add widgets from both ends of the same gtk.Box.

Because gtk.Box is a gtk.Container, you may also use add() to insert widgets into the box, and they will be packed as if with the pack_start() method. Use remove() to remove widgets from the gtk.Box.

The set_homogeneous() method specifies whether or not all children of the gtk.Box are forced to get the same amount of space.

The set_spacing() method determines how much space will be minimally placed between all children in the gtk.Box.

The reorder_child() method moves a gtk.Box child to a different place in the box.

The set_child_packing() method resets the expand, fill, and padding attributes of any gtk.Box child. Use the query_child_packing() to query these properties.

Methods

gtk.Box.pack_start

    def pack_start(child, expand=True, fill=True, padding=0)

child :

the widget to be added to the box

expand :

True if child is to be given extra space allocated to box. The extra space will be divided evenly between all children of box that use this option.

fill :

True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension.

padding :

extra space in pixels to put between child and its neighbors, over and above the global amount specified by spacing in gtk.Box. If child is a widget at one of the reference ends of box, then padding pixels are also put between child and the reference edge of box.

The pack_start() method adds child to the box, packed with reference to the start of box. The child is packed after any other child packed with reference to the start of box.

gtk.Box.pack_end

    def pack_end(child, expand=True, fill=True, padding=0)

child :

the widget to be added to the box

expand :

True if child is to be given extra space allocated to box. The extra space will be divided evenly between all children of box that use this option.

fill :

True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension.

padding :

extra space in pixels to put between child and its neighbors, over and above the global amount specified by spacing in gtk.Box. If child is a widget at one of the reference ends of box, then padding pixels are also put between child and the reference edge of box.

The pack_end() method adds child to the box, packed with reference to the end of the box. The child is packed after (away from end of) any other child packed with reference to the end of the box.

gtk.Box.pack_start_defaults

    def pack_start_defaults(widget)

widget :

the widget to be added to the box

Warning

This method is deprecated in PyGTK 2.4 and above.

The pack_start_defaults() method adds widget to the box, packed with reference to the start of the box. The widget is packed after any other child widget packed with reference to the start of box. The parameters for packing the child widget: expand, fill, and padding are given their default values, True, True, and 0, respectively.

gtk.Box.pack_end_defaults

    def pack_end_defaults(widget)

widget :

the widget to be added to the box

Warning

This method is deprecated in PyGTK 2.4 and above.

The pack_end_defaults() method adds widget to the box, packed with reference to the end of the box. The widget is packed after (away from the end of) any other child widget packed with reference to the end of the box. The parameters for packing the child widget: expand, fill, and padding are given their default values, True, True, and 0, respectively.

gtk.Box.set_homogeneous

    def set_homogeneous(homogeneous)

homogeneous :

If True the box is homogeneous i.e. all children are allocated the same space otherwise the allocations vary for each child.

The set_homogeneous() method sets the homogeneous (all children are allocated the same space) property of the box.

gtk.Box.get_homogeneous

    def get_homogeneous()

Returns :

True if the box is homogeneous.

The get_homogeneous() method returns whether the box is homogeneous (all children are allocated the same space). See gtk.Box.set_homogeneous().

gtk.Box.set_spacing

    def set_spacing(spacing)

spacing :

the number of pixels to put between children.

The set_spacing() method sets the number of pixels to place between children of the box.

gtk.Box.get_spacing

    def get_spacing()

Returns :

the spacing in pixels between children

The get_spacing() method returns the number of pixels used as padding between children as set by the set_spacing().

gtk.Box.reorder_child

    def reorder_child(child, position)

child :

the child widget to move

position :

the new position for child in the children list of the box starting from 0. If negative, indicates the end of the list.

Moves child to a new position in the list of the box children. The list contains both widgets packed gtk.PACK_START as well as widgets packed gtk.PACK_END, in the order that these widgets were added to box.

A widget's position in the box children list determines where the widget is packed into box. A child widget at some position in the list will be packed just after all other widgets of the same packing type that appear earlier in the list.

gtk.Box.query_child_packing

    def query_child_packing(child)

child :

the child widget to be queried for its packing information

expand :

the child's expand value

fill :

the child's fill value

padding :

the child's padding value

pack_type :

the child's pack_type value

The query_child_packing() method returns a tuple containing information about how child is packed into the box. The tuple members are: (expand, fill, padding, pack_type) where: expand and fill are 0 or 1 (corresponding to False or True); padding is the number of pixels of padding; and pack_type is gtk.PACK_START or gtk.PACK_END.

gtk.Box.set_child_packing

    def set_child_packing(child, expand, fill, padding, pack_type)

child :

the child widget to be queried for its packing information

expand :

the child's new expand value

fill :

the child's new fill value

padding :

the child's new padding value

pack_type :

the child's new pack_type value

The set_child_packing() method sets the way child is packed into the box.

Prev Up Next
gtk.Border Home gtk.Button
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkscreen.html0000644000000000000000000014752211272037113023575 0ustar rootrootgtk.gdk.Screen
gtk.gdk.Screen
Prev The gtk.gdk Class Reference Next

gtk.gdk.Screen

gtk.gdk.Screen — an object representing a physical screen

Synopsis

class gtk.gdk.Screen(gobject.GObject):
    def get_default_colormap()
    def set_default_colormap(colormap)
    def get_system_colormap()
    def get_system_visual()
    def get_rgb_colormap()
    def get_rgb_visual()
    def get_root_window()
    def get_display()
    def get_number()
    def get_width()
    def get_height()
    def get_width_mm()
    def get_height_mm()
    def list_visuals()
    def get_toplevel_windows()
    def make_display_name()
    def get_n_monitors()
    def get_monitor_geometry(monitor_num)
    def get_monitor_at_point(x, y)
    def get_monitor_at_window(window)
    def broadcast_client_message(event)
    def get_setting(name)
    def get_rgba_colormap()
    def get_rgba_visual()
    def get_monitor_height_mm(monitor_num)
    def get_monitor_width_mm(monitor_num)
    def get_monitor_plug_name(monitor_num)
Functions

    def gtk.gdk.screen_width()
    def gtk.gdk.screen_height()
    def gtk.gdk.screen_width_mm()
    def gtk.gdk.screen_height_mm()
    def gtk.gdk.screen_get_default()

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.Screen

Signal Prototypes

"size-changed"

 def callback(screen, user_param1, ...)

"monitors-changed"

 def callback(screen, user_param1, ...)

Description

Note

This object is available in PyGTK 2.2 and above.

gtk.gdk.Screen objects are the PyGTK representation of a physical screen. It is used throughout PyGTK to specify which screen the top level windows are to be displayed on. It is also used to query the screen specification and default settings such as the default colormap (the get_default_colormap() method), the screen width (the get_width() method), etc.

Note

a screen may consist of multiple monitors that are merged to form a large screen area.

Methods

gtk.gdk.Screen.get_default_colormap

    def get_default_colormap()

Returns :

the default gtk.gdk.Colormap.

Note

This method is available in PyGTK 2.2 and above.

The get_default_colormap() method returns the default gtk.gdk.Colormap for the screen.

gtk.gdk.Screen.set_default_colormap

    def set_default_colormap(colormap)

colormap :

a gtk.gdk.Colormap

Note

This method is available in PyGTK 2.2 and above.

The set_default_colormap() method sets the gtk.gdk.Colormap specified by colormap as the default colormap for the screen.

gtk.gdk.Screen.get_system_colormap

    def get_system_colormap()

Returns :

the default colormap for the screen. Since: 2.2

Note

This method is available in PyGTK 2.2 and above.

The get_system_colormap() method returns the system's default colormap for the screen

gtk.gdk.Screen.get_system_visual

    def get_system_visual()

Returns :

the system gtk.gdk.Visual

Note

This method is available in PyGTK 2.2 and above.

The get_system_visual() method returns the system's default gtk.gdk.Visual for the screen. This is the visual for the root window of the display.

gtk.gdk.Screen.get_rgb_colormap

    def get_rgb_colormap()

Returns :

a gtk.gdk.Colormap

Note

This method is available in PyGTK 2.2 and above.

The get_rgb_colormap() method returns the preferred colormap for rendering image data on the screen. Not a very useful function; historically, GDK could only render RGB image data to one colormap and visual, but in the current version it can render to any colormap and visual. So there's no need to call this function.

gtk.gdk.Screen.get_rgb_visual

    def get_rgb_visual()

Returns :

a gtk.gdk.Visual

Note

This method is available in PyGTK 2.2 and above.

The get_rgb_visual() method returns a "preferred visual" chosen for rendering RGB image data on the screen.

gtk.gdk.Screen.get_root_window

    def get_root_window()

Returns :

the root gtk.gdk.Window

Note

This method is available in PyGTK 2.2 and above.

The get_root_window() method returns the root gtk.gdk.Window of the screen.

gtk.gdk.Screen.get_display

    def get_display()

Returns :

the display that the screen belongs to

Note

This method is available in PyGTK 2.2 and above.

The get_display() method returns the gtk.gdk.Display that the screen belongs to.

gtk.gdk.Screen.get_number

    def get_number()

Returns :

the index

Note

This method is available in PyGTK 2.2 and above.

The get_number() method returns the index of the screen among the screens in its display. (See the get_display() method)

gtk.gdk.Screen.get_width

    def get_width()

Returns :

the width of the screen in pixels.

Note

This method is available in PyGTK 2.2 and above.

The get_width() method returns the width of the screen in pixels

gtk.gdk.Screen.get_height

    def get_height()

Returns :

the height of the screen in pixels.

Note

This method is available in PyGTK 2.2 and above.

The get_height() method returns the height of the screen in pixels

gtk.gdk.Screen.get_width_mm

    def get_width_mm()

Returns :

the width of the screen in millimeters.

Note

This method is available in PyGTK 2.2 and above.

The get_width_mm() method returns the width of the screen in millimeters. Note that on some X servers this value will not be correct.

gtk.gdk.Screen.get_height_mm

    def get_height_mm()

Returns :

the height of the screen in pixels. Since: 2.2

Note

This method is available in PyGTK 2.2 and above.

The get_height_mm() method returns the height of the screen in millimeters. Note that on some X servers this value will not be correct.

gtk.gdk.Screen.list_visuals

    def list_visuals()

Returns :

a list of gtk.gdk.Visual

Note

This method is available in PyGTK 2.2 and above.

The list_visuals() method returns a list of the available visuals for the screen. A gtk.gdk.Visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format.

gtk.gdk.Screen.get_toplevel_windows

    def get_toplevel_windows()

Returns :

a list of the toplevel gtk.gdk.Window objects

Note

This method is available in PyGTK 2.2 and above.

The get_toplevel_windows() method returns a list of all toplevel gtk.gdk.Window objects known to PyGTK on the screen. A toplevel window is a child of the root window (see the gtk.gdk.get_default_root_window() function).

gtk.gdk.Screen.make_display_name

    def make_display_name()

Returns :

a generated nae

Note

This method is available in PyGTK 2.2 and above.

The make_display_name() method determines the name to pass to gtk.gdk.Display() to get a gtk.gdk.Display with this screen as the default screen.

gtk.gdk.Screen.get_n_monitors

    def get_n_monitors()

Returns :

the number of monitors that the screen consists of.

Note

This method is available in PyGTK 2.2 and above.

The get_n_monitors() method returns the number of monitors that the screen consists of.

gtk.gdk.Screen.get_monitor_geometry

    def get_monitor_geometry(monitor_num)

monitor_num :

the monitor number.

Returns :

a gtk.gdk.Rectangle containing the monitor geometry

Note

This method is available in PyGTK 2.2 and above.

The get_monitor_geometry() method returns a gtk.gdk.Rectangle representing the size and position of the individual monitor within the the entire screen area.

Note that the size of the entire screen area can be retrieved via the get_width() and get_height(). methods.

gtk.gdk.Screen.get_monitor_at_point

    def get_monitor_at_point(x, y)

x :

an x coordinate in the virtual screen.

y :

a y coordinate in the virtual screen.

Returns :

the number of the monitor that the point (x,y) lies in, or a monitor close to (x,y) if the point is not in any monitor.

Note

This method is available in PyGTK 2.2 and above.

The get_monitor_at_point() method returns the number of the monitor in which the point (x,y) is located or the closest monitor if not in a monitor.

gtk.gdk.Screen.get_monitor_at_window

    def get_monitor_at_window(window)

window :

a gtk.gdk.Window

Returns :

the number of the monitor that most of window is located. Since: 2.2

Note

This method is available in PyGTK 2.2 and above.

The get_monitor_at_window() method returns the number of the monitor that most of the gtk.gdk.Window specified by window is in. If window does not intersect any monitors, the closest monitor to the main bounding rectangle of window is returned.

gtk.gdk.Screen.broadcast_client_message

    def broadcast_client_message(event)

event :

the gtk.gdk.Event.

Note

This method is available in PyGTK 2.2 and above.

The broadcast_client_message() method sends a message to all top level windows. On X11, sends an X ClientMessage event to all toplevel windows on the screen.

Toplevel windows are determined by checking for the WM_STATE property, as described in the Inter-Client Communication Conventions Manual (ICCCM). If no windows are found with the WM_STATE property set, the message is sent to all children of the root window.

On Windows, broadcasts a message registered with the name GDK_WIN32_CLIENT_MESSAGE to all top-level windows. The amount of data is limited to one long, i.e. four bytes.

gtk.gdk.Screen.get_setting

    def get_setting(name)

name :

the name of the setting

Returns :

the value of setting

Note

This method is available in PyGTK 2.2 and above.

The get_setting() method returns the value of the desktop-wide setting (specified by setting) such as double-click time for the screen.

gtk.gdk.Screen.get_rgba_colormap

    def get_rgba_colormap()

Returns :

a gtk.gdk.Colormap for use with windows with an alpha channel or None if the capability is not available.

Note

This method is available in PyGTK 2.10 and above.

The get_rgba_colormap() method returns a colormap to use for creating windows or pixmaps with an alpha channel. The windowing system on which PyGTK is running may not support this capability, in which case None will be returned. Even if a non-None value is returned, it's possible that the window's alpha channel won't be honored when displaying the window on the screen: in particular, for X an appropriate windowing manager and compositing manager must be running to provide appropriate display.

gtk.gdk.Screen.get_rgba_visual

    def get_rgba_visual()

Returns :

a gtk.gdk.Visual to use for windows with an alpha channel or None if the capability is not available.

Note

This method is available in PyGTK 2.10 and above.

The get_rgba_visual() method returns a visual to use for creating windows or pixmaps with an alpha channel. See the get_rgba_colormap() method for caveats.

gtk.gdk.Screen.get_monitor_height_mm

    def get_monitor_height_mm(monitor_num)

monitor_num :

Number of the monitor.

Returns :

The height of the monitor, or -1 if not available.

Note

This method is available in PyGTK 2.14 and above.

The get_monitor_height_mm() method gets the height in millimeters of the specified monitor.

gtk.gdk.Screen.get_monitor_width_mm

    def get_monitor_width_mm(monitor_num)

monitor_num :

Number of the monitor.

Returns :

The width of the monitor, or -1 if not available.

Note

This method is available in PyGTK 2.14 and above.

The get_monitor_width_mm() method gets the width in millimeters of the specified monitor.

gtk.gdk.Screen.get_monitor_plug_name

    def get_monitor_plug_name(monitor_num)

monitor_num :

Number of the monitor.

Returns :

A newly-allocated string containing the name of the monitor, or None if the name cannot be determined.

Note

This method is available in PyGTK 2.14 and above.

The get_monitor_plug_name() method returns the output name of the specified monitor. Usually something like VGA, DVI, or TV, not the actual product name of the display device.

Functions

gtk.gdk.screen_width

    def gtk.gdk.screen_width()

Returns :

 the width of the default screen in pixels.

The gtk.gdk.screen_width() function returns the width of the default screen in pixels.

gtk.gdk.screen_height

    def gtk.gdk.screen_height()

Returns :

 the height of the default screen in pixels.

The gtk.gdk.screen_height() function returns the height of the default screen in pixels.

gtk.gdk.screen_width_mm

    def gtk.gdk.screen_width_mm()

Returns :

 the width of the default screen in millimeters, though it is not always correct.

The gtk.gdk.screen_width_mm() function returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct.

gtk.gdk.screen_height_mm

    def gtk.gdk.screen_height_mm()

Returns :

 the height of the default screen in millimeters, though it is not always correct.

The gtk.gdk.screen_height_mm() function returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct.

gtk.gdk.screen_get_default

    def gtk.gdk.screen_get_default()

Returns :

a gtk.gdk.Screen, or None if there is no default display.

Note

This function is available in PyGTK 2.2 and above.

The gtk.gdk.screen_get_default() function returns the default gtk.gdk.Screen for the default gtk.gdk.Display. (See the gtk.gdk.display_get_default() function).

Signals

The "size-changed" gtk.gdk.Screen Signal

    def callback(screen, user_param1, ...)

screen :

the screen that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "size-changed" signal is emitted when the pixel width or height of a screen changes.

The "monitor-changed" gtk.gdk.Screen Signal

    def callback(screen, user_param1, ...)

screen :

the screen that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "monitor-changed" signal is emitted when the number, size or position of the monitors attached to the screen change.

Only for X for now. Future implementations for Win32 and OS X may be a possibility.

Prev Up Next
gtk.gdk.Region Home gtk.gdk.Visual
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangofontset.html0000644000000000000000000002112311272037113024323 0ustar rootrootpango.Fontset
pango.Fontset
Prev The pango Class Reference Next

pango.Fontset

pango.Fontset — an object containing a set of pango.Font objects.

Synopsis

class pango.Fontset(gobject.GObject):
    def get_font(wc)
    def get_metrics()
    def foreach(func, data=None)

Ancestry

+-- gobject.GObject
  +-- pango.Fontset

Description

A pango.Fontset object holds a set of pango.Font objects. A pango.FontSet object is returned from the following methods:

Methods

pango.Fontset.get_font

    def get_font(wc)

wc :

a unicode character

Returns :

a pango.Font.

The get_font() method returns the pango.Font in the fontset that contains the best glyph for the unicode character specified by wc.

pango.Fontset.get_metrics

    def get_metrics()

Returns :

a pango.FontMetrics object.

The get_metrics() method returns a pango.FontMetrics object that contains the overall metric information for the fonts in the fontset.

pango.Fontset.foreach

    def foreach(func, data=None)

func :

a callback function

data :

user data to pass to func

Note

This method is available in PyGTK 2.4 and above.

The foreach() method invokes the function specified by func on each pango.Font of the font set passing it the optional user data specified by data. The signature of func is:

  def func(fontset, font, user_data)

where fontset is the pango.Fontset containing the pango.Font font and user_data is data

Prev Up Next
pango.FontMetrics Home pango.FontsetSimple
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkstatusbar.html0000644000000000000000000005522011272037113024337 0ustar rootrootgtk.Statusbar
gtk.Statusbar
Prev The gtk Class Reference Next

gtk.Statusbar

gtk.Statusbar — report messages of minor importance to the user.

Synopsis

class gtk.Statusbar(gtk.HBox):
    gtk.Statusbar()
    def get_context_id(context_description)
    def push(context_id, text)
    def pop(context_id)
    def remove(context_id, message_id)
    def set_has_resize_grip(setting)
    def get_has_resize_grip()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Box
          +-- gtk.HBox
            +-- gtk.Statusbar

Implemented Interfaces

gtk.Statusbar implements gtk.Buildable

gtk.Statusbar Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.Box Properties

"has-resize-grip"Read-WriteIf True, the statusbar has a grip for resizing the toplevel window. Available in GTK+ 2.4 and above.

gtk.Statusbar Style Properties

gtk.Widget Style Properties

"shadow-type"ReadThe style of bevel around the statusbar text

gtk.Statusbar Child Properties

gtk.Box Child Properties

gtk.Statusbar Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

"text-popped"

 def callback(statusbar, context_id, text, user_param1, ...)

"text-pushed"

 def callback(statusbar, context_id, text, user_param1, ...)

Description

A gtk.Statusbar is usually placed along the bottom of an application's main gtk.Window. It may provide a regular commentary of the application's status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example). It may also have a resize grip (a triangular area in the lower right corner) which can be clicked on to resize the window containing the statusbar. Status bars in PyGTK maintain a stack of messages. The message at the top of the each bar's stack is the one that will currently be displayed.

Any messages added to a statusbar's stack must specify a context_id that is used to uniquely identify the source of a message. The context_id can be generated by the get_context_id() method, and associated with a context message. An existing context_id can be retrieved using the context message using the get_context_id() method. Note that messages are stored in a stack, and when choosing which message to display, the stack structure is adhered to, regardless of the context identifier of a message.

Constructor

    gtk.Statusbar()

Returns :

a new gtk.Statusbar widget

Creates a new gtk.Statusbar widget.

Methods

gtk.Statusbar.get_context_id

    def get_context_id(context_description)

context_description :

a string identifying the context for the message

Returns :

an integer context identifier

The get_context_id() method returns a new or existing context identifier, given a description of the actual context specified by context_description. In effect, get_context_id() both registers and retrieves a context identifier.

gtk.Statusbar.push

    def push(context_id, text)

context_id :

a context identifier

text :

the message text

Returns :

an integer message identifier

The push() method pushes a new message specified by text with the specified context_id onto a statusbar's stack and returns a message id that that can be used with the remove() method.

gtk.Statusbar.pop

    def pop(context_id)

context_id :

a context identifier

The pop() method removes the top message with the specified context_id from the statusbar's stack.

gtk.Statusbar.remove

    def remove(context_id, message_id)

context_id :

the context identifier

message_id :

the message identifier

The remove() method removes the message with the specified message_id and context_id from the statusbar's message stack.

gtk.Statusbar.set_has_resize_grip

    def set_has_resize_grip(setting)

setting :

if True a resize grip is displayed

The set_has_resize_grip() method sets the internal "has_resize_grip" property to the value specified by setting. If setting is True a resize grip is displayed on the statusbar

gtk.Statusbar.get_has_resize_grip

    def get_has_resize_grip()

Returns :

True if a resize grip is displayed

The get_has_resize_grip() method returns the value of the internal "has_resize_grip" property that determines if a resize grip is displayed on the statusbar.

Signals

The "text-popped" gtk.Statusbar Signal

    def callback(statusbar, context_id, text, user_param1, ...)

statusbar :

the statusbar that received the signal

context_id :

the context identifier of the top message

text :

the string containing the top message text

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "text-popped" signal is emitted when a message is removed from the statusbar message stack. Note the text and context_id are for the top message on the statusbar stack not the message that was actually removed.

The "text-pushed" gtk.Statusbar Signal

    def callback(statusbar, context_id, text, user_param1, ...)

statusbar :

the statusbar that received the signal

context_id :

the context identifier of the message added

text :

the string containing the message text

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "text-pushed" signal is emitted when a message is added to the statusbar message stack.

Prev Up Next
gtk.SpinButton Home gtk.StatusIcon
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gdkimage.html0000644000000000000000000003200111272037113023361 0ustar rootrootgtk.gdk.Image
gtk.gdk.Image
Prev The gtk.gdk Class Reference Next

gtk.gdk.Image

gtk.gdk.Image — an area for bit-mapped graphics stored on the X Windows client.

Synopsis

class gtk.gdk.Image(gobject.GObject):
    gtk.gdk.Image(type, visual, width, height)
    def put_pixel(x, y, pixel)
    def get_pixel(x, y)
    def set_colormap(colormap)
    def get_colormap()

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.Image

Description

The gtk.gdk.Image type represents an area for drawing graphics. It has now been superseded to a large extent by the much more flexible RGB methods (see gtk.gdk.Drawable).

Constructor

    gtk.gdk.Image(type, visual, width, height)

type :

a gtk.gdk.Image type

visual :

a gtk.gdk.Visual

width :

the width in pixels of the image

height :

the height in pixels of the image

Returns :

a new gtk.gdk.Image object

Creates a new gtk.gdk.Image object of the specified type, width and height and using the gtk.gdk.Visual specified by visual. The value of type must be one of:

gtk.gdk.IMAGE_NORMAL

The original X image type, which is quite slow since the image has to be transferred from the client to the server to display it.

gtk.gdk.IMAGE_SHARED

A faster image type, which uses shared memory to transfer the image data between client and server. However this will only be available if client and server are on the same machine and the shared memory extension is supported by the server.

gtk.gdk.IMAGE_FASTEST

Specifies that gtk.gdk.IMAGE_SHARED should be tried first, and if that fails then gtk.gdk.IMAGE_NORMAL will be used.

Usually using gtk.gdk.IMAGE_FASTEST is the best choice.

Methods

gtk.gdk.Image.put_pixel

    def put_pixel(x, y, pixel)

x :

the x coordinate of the pixel to set.

y :

the y coordinate of the pixel to set.

pixel :

the pixel value to set.

The put_pixel() method sets the value of the pixel in the image at the location specified by x and y to the value specified by pixel.

gtk.gdk.Image.get_pixel

    def get_pixel(x, y)

x :

the x coordinate of the pixel to get.

y :

the y coordinate of the pixel to get.

Returns :

the pixel value at the image location

The get_pixel() method returns the value of the pixel at the image location specified by x and y.

gtk.gdk.Image.set_colormap

    def set_colormap(colormap)

colormap :

a gtk.gdk.Colormap

The set_colormap() method sets the colormap for the image to the specified colormap. Normally there's no need to use this method since images are created with the correct colormap if you get the image from a drawable. If you create the image from scratch, use the colormap of the drawable you intend to render the image to.

gtk.gdk.Image.get_colormap

    def get_colormap()

Returns :

the colormap for the image

The get_colormap() method returns the colormap for a given image, if it exists. An image will have a colormap if the drawable from which it was created has a colormap, or if a colormap was set explicitly with the set_colormap() method.

Prev Up Next
gtk.gdk.GC Home gtk.gdk.Keymap
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangoattriterator.html0000644000000000000000000003121311272037113025366 0ustar rootrootpango.AttrIterator
pango.AttrIterator
Prev The pango Class Reference Next

pango.AttrIterator

pango.AttrIterator — an object pointing to a location in a pango.AttrList.

Synopsis

class pango.AttrIterator:
    def copy()
    def range()
    def next()
    def get(type)
    def get_font()
    def get_attrs()

Description

The pango.AttrIterator object contains a pointer into a pango.AttrList. A pango.AttrIterator object is created using the pango.AttrList.get_iterator() method and then can be advanced through the attribute changes in the text using the next() method. The pango.AttrIterator object can access information about the current attributes applied at the iterator location (using the get() method) and the range of text that the current attribute change applies to (using the range() method).

The pango.AttrIterator object is only valid as long as the associated pango.AttrList is not changed.

Methods

pango.AttrIterator.copy

    def copy()

Returns :

a new pango.AttrIterator object

The copy() method returns a new pango.AttrIterator object that is a copy of this attribute iterator.

pango.AttrIterator.range

    def range()

Returns :

a 2-tuple containing the start and end index of the current attribute in the text.

The range() method returns a 2-tuple containing the start and end index of the application of the current attribute change in the text.

pango.AttrIterator.next

    def next()

Returns :

False if the iterator is at the end of the pango.AttrList.

The next() method advances the iterator to the next attribute change in its pango.AttrList. The next method returns False if the iterator is at the end of the pango.AttrList; otherwise, True.

pango.AttrIterator.get

    def get(type)

type :

the pango.Attribute type to find.

Returns :

the pango.Attribute matching type or None.

The get() method returns the pango.Attribute at the iterator location that matches the specified type. When multiple attributes of the same type overlap, the attribute whose range starts closest to the current location is returned. If no attribute matches, None is returned.

pango.AttrIterator.get_font

    def get_font()

Returns :

a 3-tuple containing a pango.FontDescription, a pango.Language and a list of non-font pango.Attribute objects at the current iterator location.

The get_font() method returns a 3-tuple containing a pango.FontDescription holding the current font attributes, a pango.Language object (if a language is set) or None and a list of non-font pango.Attribute objects in effect at the current iterator location.

pango.AttrIterator.get_attrs

    def get_attrs()

Returns :

a tuple containing the pango.Attribute objects in effect at the current iterator location.

Note

This method is available in PyGTK 2.4 and above.

The get_attrs() method returns a tuple containing the pango.Attribute objects in effect at the current iterator location.

Prev Up Next
pango.Attribute Home pango.AttrList
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangolayoutline.html0000644000000000000000000002726711272037113025045 0ustar rootrootpango.LayoutLine
pango.LayoutLine
Prev The pango Class Reference Next

pango.LayoutLine

pango.LayoutLine — a line in a pango.Layout (new in PyGTK 2.8)

Synopsis

class pango.LayoutLine(gobject.GBoxed):
    def get_extents()
    def get_pixel_extents()
    def index_to_x(index, trailing)
    def x_to_index(x_pos)

Ancestry

+-- gobject.GBoxed
  +-- pango.LayoutLine

Attributes

"is_paragraph_start"ReadTrue if this is the first line of the paragraph
"length"Readthe length of the line in bytes
"resolved_dir"Readthe resolved direction of line
"runs"Reada list containing the runs of the line in visual order.
"start_index"Readthe start of the line as byte index into the layout.

Description

A pango.LayoutLine object represents one of the lines resulting from laying out a paragraph via pango.Layout. pango.LayoutLine objects are obtained by calling the pango.Layout.get_line() method or the pango.LayoutIter.get_line() method. pango.LayoutLine objects are only valid until the text, attributes, or settings of the parent pango.Layout are modified.

Methods

pango.LayoutLine.get_extents

    def get_extents()

Returns :

a 2-tuple containing 4-tuples representing the rectangles for the logical and ink extents in Pango units.

Note

This method is available in PyGTK 2.8 and above.

The get_extents() method returns the logical and ink extents rectangles of the layout line in a 2-tuple containing two 4-tuples which represent the rectangles. See the documentation for the pango.Font.get_glyph_extents() method for details about the interpretation of the rectangles. The return extents are in Pango units (1 device unit = pango.SCALE pango units).

pango.LayoutLine.get_pixel_extents

    def get_pixel_extents()

Returns :

a 2-tuple containing 4-tuples representing the rectangles for the logical and ink extents in device units.

Note

This method is available in PyGTK 2.8 and above.

The get_pixel_extents() method returns the logical and ink extents rectangles of the layout line in a 2-tuple containing two 4-tuples which represent the rectangles. See the documentation for the pango.Font.get_glyph_extents() method for details about the interpretation of the rectangles. The return extents are in device units (1 device unit = pango.SCALE pango units).

pango.LayoutLine.index_to_x

    def index_to_x(index, trailing)

index :

the byte offset of a grapheme within the layout

trailing :

an integer indicating the edge of the grapheme to retrieve the position of. If 0, the trailing edge of the grapheme, if > 0, the leading edge of the grapheme.

Returns :

the X position in Pango units

Note

This method is available in PyGTK 2.8 and above.

The index_to_x() method returns the X position (in Pango units) of the grapheme at the byte offset specified by index and edge specified by trailing.

pango.LayoutLine.x_to_index

    def x_to_index(x_pos)

x_pos :

the x offset (in Pango units) from the left edge of the line.

Returns :

a 3-tuple containing a boolean indicating if the x_pos is inside the line, the byte offset of the grapheme and the location in the grapheme.

Note

This method is available in PyGTK 2.8 and above.

The x_to_index() method returns a 3-tuple containing a boolean that is True if x_pos is inside the line, the location inside the grapheme - either zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme.

Prev Up Next
pango.LayoutIter Home pango.Renderer
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkaccessible.html0000644000000000000000000001010011272037113024410 0ustar rootrootgtk.Accessible
gtk.Accessible
Prev The gtk Class Reference Next

gtk.Accessible

gtk.Accessible — accessibility support for widgets.

Synopsis

class gtk.Accessible(atk.Object):
    def connect_widget_destroyed()

Ancestry

+-- gobject.GObject
  +-- atk.Object
    +-- gtk.Accessible

gtk.Accessible Properties

atk.Object Properties

gtk.Accessible Signal Prototypes

gobject.GObject Signal Prototypes

atk.Object Signal Prototypes

Description

The gtk.Accessible class is an abstract base class.

Methods

gtk.Accessible.connect_widget_destroyed

    def connect_widget_destroyed()

This method specifies the callback function to be called when the widget corresponding to a gtk.Accessible is destroyed.

Prev Up Next
gtk.AccelMap Home gtk.Action
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkpapersize.html0000644000000000000000000007724711272037113024346 0ustar rootrootgtk.PaperSize
gtk.PaperSize
Prev The gtk Class Reference Next

gtk.PaperSize

gtk.PaperSize — an object providing support for named paper sizes (new in PyGTK 2.10)

Synopsis

class gtk.PaperSize(gobject.GBoxed):
    gtk.PaperSize(name=None)
    def copy()
    def is_equal(size2)
    def get_name()
    def get_display_name()
    def get_ppd_name()
    def get_width(unit)
    def get_height(unit)
    def is_custom()
    def set_size(width, height, unit)
    def get_default_top_margin(unit)
    def get_default_bottom_margin(unit)
    def get_default_left_margin(unit)
    def get_default_right_margin(unit)
Functions

    def gtk.paper_size_new_from_ppd(ppd_name, ppd_display_name, width, height)
    def gtk.paper_size_new_cutom(name, display_name, width, height, unit)
    def gtk.paper_size_get_default()

Description

Note

This class is available in PyGTK 2.10 and above.

A gtk.PaperSize handles paper sizes. It uses the standard called "PWG 5101.1-2002 PWG: Standard for Media Standardized Names" to name the paper sizes (and to get the data for the page sizes). The common standard paper sizes are named by the GTK Papaer Name Constants. In addition to standard paper sizes, gtk.PaperSize allows to construct custom paper sizes with arbitrary dimensions.

The gtk.PaperSize object stores not only the dimensions (width and height) of a paper size and its name, it also provides default print margins.

Constructor

gtk.PaperSize

    gtk.PaperSize(name=None)

name :

a paper size name, or None

Returns :

a new gtk.PaperSize.

Note

This constructor is available in PyGTK 2.10 and above.

Creates a new gtk.PaperSize object by parsing a PWG 5101.1-2002 PWG paper name.

If name is None, the default paper size is returned, see paper_size_get_default().

Methods

gtk.PaperSize.copy

    def copy()

Returns :

a copy of other

Note

This method is available in PyGTK 2.10 and above.

The copy() method copies an existing gtk.PaperSize.

gtk.PaperSize.is_equal

    def is_equal(size2)

size2 :

another gtk.PaperSize object

Returns :

True, if this paper size and size2 represent the same paper size

Note

This method is available in PyGTK 2.10 and above.

The is_equal() method returns the result of comparing this paper size to the gtk.PaperSize specified by size2.

gtk.PaperSize.get_name

    def get_name()

Returns :

the name of the paper size

Note

This method is available in PyGTK 2.10 and above.

The get_name() method returns the name of the paper size.

gtk.PaperSize.get_display_name

    def get_display_name()

Returns :

the human-readable name of the paper size.

Note

This method is available in PyGTK 2.10 and above.

The get_display_name() method returns the human-readable name of the paper size.

gtk.PaperSize.get_ppd_name

    def get_ppd_name()

Returns :

the PPD name of the paper size or None

Note

This method is available in PyGTK 2.10 and above.

The get_ppd_name() method returns the PPD name of the paper size, which may be None.

gtk.PaperSize.get_width

    def get_width(unit)

unit :

the unit for the return value - one of the GTK Unit Constants.

Returns :

the paper width

Note

This method is available in PyGTK 2.10 and above.

The get_width() method returns the paper width of the paper size, in units of unit.

gtk.PaperSize.get_height

    def get_height(unit)

unit :

the unit for the return value - one of the GTK Unit Constants.

Returns :

the paper height

Note

This method is available in PyGTK 2.10 and above.

The get_height() method returns the paper height of the paper size, in units of unit.

gtk.PaperSize.is_custom

    def is_custom()

Returns :

True if the paper size is a custom paper size.

The is_custom() method returns True if paper size is not a standard paper size.

gtk.PaperSize.set_size

    def set_size(width, height, unit)

width :

the new width in units of unit

height :

the new height in units of unit

unit :

the unit for width and height - one of the GTK Unit Constants.

Note

This method is available in PyGTK 2.10 and above.

The set_size() method changes the dimensions of the paper size to width x height in the units specified by unit.

gtk.PaperSize.get_default_top_margin

    def get_default_top_margin(unit)

unit :

the unit for the return value - one of the GTK Unit Constants.

Returns :

the default top margin

Note

This method is available in PyGTK 2.10 and above.

The get_default_top_margin() method returns the default top margin for the gtk.PaperSize.

gtk.PaperSize.get_default_bottom_margin

    def get_default_bottom_margin(unit)

unit :

the unit for the return value - one of the GTK Unit Constants.

Returns :

the default bottom margin

Note

This method is available in PyGTK 2.10 and above.

The get_default_bottom_margin() method gets the default bottom margin for the paper size.

gtk.PaperSize.get_default_left_margin

    def get_default_left_margin(unit)

unit :

the unit for the return value - one of the GTK Unit Constants.

Returns :

the default left margin

Note

This method is available in PyGTK 2.10 and above.

The get_default_left_margin() method gets the default left margin for the paper size.

gtk.PaperSize.get_default_right_margin

    def get_default_right_margin(unit)

unit :

the unit for the return value - one of the GTK Unit Constants.

Returns :

the default right margin

Note

This method is available in PyGTK 2.10 and above.

The get_default_right_margin() method gets the default right margin for the paper size.

Functions

gtk.paper_size_new_from_ppd

    def gtk.paper_size_new_from_ppd(ppd_name, ppd_display_name, width, height)

>ppd_name :

a PPD paper name

ppd_display_name :

the corresponding human-readable name

width :

the paper width, in points

height :

the paper height in points

Returns :

a new gtk.PaperSize

Note

This function is available in PyGTK 2.10 and above.

The paper_size new__from_ppd() function creates a new gtk.PaperSize object by using PPD information. If ppd_name is not a recognized PPD paper name, ppd_display_name, width and height are used to construct a custom gtk.PaperSize object.

gtk.paper_size_new_custom

    def gtk.paper_size_new_custom(name, display_name, width, height, unit)

>name :

the paper name

display_name :

the corresponding human-readable name

width :

the paper width, in units of unit

height :

the paper height in units of unit

unit :

the units - one of the GTK Unit Constants.

Returns :

a new gtk.PaperSize

Note

This function is available in PyGTK 2.10 and above.

The paper_size_new_custom() function creates a new gtk.PaperSize object with the given parameters.

gtk.paper_size_get_default

    def gtk.paper_size_get_default()

Returns :

the name of the default paper size.

Note

This function is available in PyGTK 2.10 and above.

The paper_size_get_default() function returns the name of the default paper size, which depends on the current locale.

Prev Up Next
gtk.Paned Home gtk.Plug
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktextbuffer.html0000644000000000000000000060436411272037113024516 0ustar rootrootgtk.TextBuffer
gtk.TextBuffer
Prev The gtk Class Reference Next

gtk.TextBuffer

gtk.TextBuffer — stores attributed text for display in a gtk.TextView

Synopsis

class gtk.TextBuffer(gobject.GObject):
    gtk.TextBuffer(table=None)
    def get_line_count()
    def get_char_count()
    def get_tag_table()
    def set_text(text)
    def insert(iter, text)
    def insert_at_cursor(text)
    def insert_interactive(iter, text, default_editable)
    def insert_interactive_at_cursor(text, default_editable)
    def insert_range(iter, start, end)
    def insert_range_interactive(iter, start, end, default_editable)
    def insert_with_tags(iter, text, ...)
    def insert_with_tags_by_name(iter, text, ...)
    def delete(start, end)
    def delete_interactive(start_iter, end_iter, default_editable)
    def get_text(start, end, include_hidden_chars=True)
    def get_slice(start, end, include_hidden_chars=True)
    def insert_pixbuf(iter, pixbuf)
    def insert_child_anchor(iter, anchor)
    def create_child_anchor(iter)
    def create_mark(mark_name, where, left_gravity=False)
    def move_mark(mark, where)
    def delete_mark(mark)
    def get_mark(name)
    def move_mark_by_name(name, where)
    def delete_mark_by_name(name)
    def get_insert()
    def get_selection_bound()
    def place_cursor(where)
    def select_range(ins, bound)
    def apply_tag(tag, start, end)
    def remove_tag(tag, start, end)
    def apply_tag_by_name(name, start, end)
    def remove_tag_by_name(name, start, end)
    def remove_all_tags(start, end)
    def create_tag(tag_name=None, ...)
    def get_iter_at_line_offset(line_number, char_offset)
    def get_iter_at_line_index(line_number, byte_index)
    def get_iter_at_offset(char_offset)
    def get_iter_at_line(line_number)
    def get_start_iter()
    def get_end_iter()
    def get_bounds()
    def get_iter_at_mark(mark)
    def get_iter_at_child_anchor(anchor)
    def get_modified()
    def set_modified(setting)
    def add_selection_clipboard(clipboard)
    def remove_selection_clipboard(clipboard)
    def cut_clipboard(clipboard, default_editable)
    def copy_clipboard(clipboard)
    def paste_clipboard(clipboard, override_location, default_editable)
    def get_selection_bounds()
    def delete_selection(interactive, default_editable)
    def begin_user_action()
    def end_user_action()
    def backspace(iter, interactive, default_editable)
    def get_has_selection()
    def get_copy_target_list()
    def get_paste_target_list()
    def register_serialize_format(mime_type, function, user_data)
    def register_serialize_tagset(tagset_name=NULL)
    def register_deserialize_format(mime_type, function, user_data)
    def register_deserialize_tagset(tagset_name=NULL)
    def unregister_serialize_format(format)
    def unregister_deserialize_format(format)
    def deserialize_set_can_create_tags(format, can_create_tags)
    def deserialize_get_can_create_tags(format)
    def get_serialize_formats()
    def get_deserialize_formats()
    def serialize(content_buffer, format, start, end)
    def deserialize(content_buffer, format, iter, data)
    def add_mark(mark, where)

Ancestry

+-- gobject.GObject
  +-- gtk.TextBuffer

gtk.TextBuffer Properties

"copy-target-list"ReadThe list of targets this buffer supports for clipboard copying and as DND source. This property is available in GTK+ 2.10 and above.
"cursor-position"ReadThe position of the insert mark (as offset from the beginning of the buffer). It is useful for getting notified when the cursor moves. Allowed values: >= 0. Default value: 0. This property is available in GTK+ 2.10 and above.
"has-selection"ReadIf True the buffer has some text currently selected. Default value: False. This property is available in GTK+ 2.10 and above.
"paste-target-list"ReadThe list of targets this buffer supports for clipboard pasting and as DND destination. This property is available in GTK+ 2.10 and above.
"tag-table"Read-Write-Construct OnlyThe gtk.TextTagTable associated with the textbuffer. Available in GTK+ 2.2 and above.
"text"Read-WriteThe text content of the buffer. Without child widgets and images, see the gtk.TextBuffer.get_text() method for more information. Default value: "". This property is available in GTK+ 2.8 and above.

Attributes

"tag_table"ReadThe gtk.TextTagTable associated with the textbuffer.

gtk.TextBuffer Signal Prototypes

gobject.GObject Signal Prototypes

"apply-tag"

 def callback(textbuffer, texttag, start, end, user_param1, ...)

"begin-user-action"

 def callback(textbuffer, user_param1, ...)

"changed"

 def callback(textbuffer, user_param1, ...)

"delete-range"

 def callback(textbuffer, start, end, user_param1, ...)

"end-user-action"

 def callback(textbuffer, user_param1, ...)

"insert-child-anchor"

 def callback(textbuffer, iter, anchor, user_param1, ...)

"insert-pixbuf"

 def callback(textbuffer, iter, pixbuf, user_param1, ...)

"insert-text"

 def callback(textbuffer, iter, text, length, user_param1, ...)

"mark-deleted"

 def callback(textbuffer, textmark, user_param1, ...)

"mark-set"

 def callback(textbuffer, iter, textmark, user_param1, ...)

"modified-changed"

 def callback(textbuffer, user_param1, ...)

"remove-tag"

 def callback(textbuffer, texttag, start, end, user_param1, ...)

Description

A gtk.TextBuffer is the core component of the PyGTK text editing system. A gtk.TextBuffer contains the text, pixbufs and child widget anchors that are displayed in one or more gtk.TextView widgets. A gtk.TextBuffer has an associated gtk.TextTagTable that contains the gtk.TextTag objects that can be used to set attributes on the text in the textbuffer.

A gtk.TextBuffer can be automatically created when creating a gtk.TextView or it can be created with the gtk.TextBuffer() constructor and associated with a gtk.TextView using the set_buffer() method or the gtk.TextView() constructor.

Constructor

    gtk.TextBuffer(table=None)

table :

a tag table, or None to create a new one

Returns :

a new text buffer object

Creates a new gtk.TextBuffer object.

Methods

gtk.TextBuffer.get_line_count

    def get_line_count()

Returns :

the number of lines in the buffer

The get_line_count() method returns the number of lines in the buffer. This value is cached, so the function is very fast.

gtk.TextBuffer.get_char_count

    def get_char_count()

Returns :

the number of characters in the buffer

The get_char_count() method returns the number of characters in the buffer; note that characters and bytes are not the same, you can't e.g. expect the contents of the buffer in string form to be this many bytes long. The character count is cached, so this function is very fast.

gtk.TextBuffer.get_tag_table

    def get_tag_table()

Returns :

the buffer's tag table

The get_tag_table() method returns the gtk.TextTagTable object associated with the textbuffer.

gtk.TextBuffer.set_text

    def set_text(text)

text :

UTF-8 text to insert

The set_text() method replaces the current contents of the textbuffer with the contents of text. text must be valid UTF-8.

gtk.TextBuffer.insert

    def insert(iter, text)

iter :

a gtk.TextIter specifying a position in the buffer

text :

UTF-8 format text to insert

The insert() method inserts the contents of text into the textbuffer at the position specified by iter. The "insert_text" signal is emitted and the text insertion actually occurs in the default handler for the signal. iter is invalidated when insertion occurs (because the buffer contents change), but the default signal handler revalidates it to point to the end of the inserted text.

gtk.TextBuffer.insert_at_cursor

    def insert_at_cursor(text)

text :

some text in UTF-8 format

The insert_at_cursor() method is a convenience method that calls the insert() method, using the current cursor position as the insertion point.

gtk.TextBuffer.insert_interactive

    def insert_interactive(iter, text, default_editable)

iter :

a gtk.TextIter specifying a position in buffer

text :

some UTF-8 text

default_editable :

default editability of buffer

Returns :

True if the text was actually inserted

The insert_interactive() method is similar to the insert() method, except the insertion of text at iter will not occur if iter is at a non-editable location in the buffer. A location is non-editable if a gtk.TextTag applied at that location has its "editable" attribute set to False or the gtk.TextView used by the user is set non-editable. Usually you want to prevent insertions at locations if the insertion results from a user action (is interactive).

default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of the gtk.TextView.get_editable() method is appropriate here.

gtk.TextBuffer.insert_interactive_at_cursor

    def insert_interactive_at_cursor(text, default_editable)

text :

text in UTF-8 format

default_editable :

default editability of buffer

Returns :

True if the text was actually inserted

The insert_interactive_at_cursor() method calls the insert_interactive() method to insert text at the cursor (insert) position. default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of the gtk.TextView.get_editable() method is appropriate here.

gtk.TextBuffer.insert_range

    def insert_range(iter, start, end)

iter :

a gtk.TextIter specifying a position in the textbuffer

start :

a gtk.TextIter specifying a position in a (possibly different) gtk.TextBuffer

end :

a gtk.TextIter specifying another position in the same buffer as start

The insert_range() method copies text, tags, and pixbufs (but not child anchors) between start and end (the order of start and end doesn't matter) form a gtk.TextBuffer and inserts the copy at iter. Used instead of simply getting/inserting text because it preserves images and tags. If start and end are in a different buffer from buffer, the two buffers must share the same tag table. This method is implemented via emissions of the "insert_text" and "apply_tag" signals.

gtk.TextBuffer.insert_range_interactive

    def insert_range_interactive(iter, start, end, default_editable)

iter :

a gtk.TextIter specifying a position in the textbuffer

start :

a gtk.TextIter specifying a position in a (possibly different) gtk.TextBuffer

end :

a gtk.TextIter specifying another position in the same buffer as start

default_editable :

default editability of the buffer

Returns :

True if an insertion was possible at iter

The insert_range_interactive() method is similar to the insert_range() method, except the insertion of text at iter will not occur if the insertion position is non-editable. A location is non-editable if a gtk.TextTag applied at that location has its "editable" attribute set to False or the gtk.TextView used by the user is set non-editable. The default_editable parameter indicates whether the text is editable at iter if no tags enclosing iter affect editability. Typically the result of the gtk.TextView.get_editable() method is appropriate here.

gtk.TextBuffer.insert_with_tags

    def insert_with_tags(iter, text, ...)

iter :

a gtk.TextIter specifying a position in buffer

text :

UTF-8 text

... :

one or more optional gtk.TextTag objects to apply to text

The insert_with_tags() method inserts the specified text into the textbuffer at the location specified by iter, applying any optional tags following the first two parameters to the newly-inserted text. This method is a convenience method that is equivalent to calling the insert() method, then the apply_tag() method on the inserted text.

gtk.TextBuffer.insert_with_tags_by_name

    def insert_with_tags_by_name(iter, text, ...)

iter :

a gtk.TextIter specifying a position in buffer

text :

UTF-8 text

... :

one or more optional gtk.TextTag names to apply to text

The insert_with_tags_by_name() method is similar to the insert_with_tags() method, but uses tag names instead of tag objects.

gtk.TextBuffer.delete

    def delete(start, end)

start :

a gtk.TextIter specifying a position in the textbuffer

end :

a gtk.TextIter specifying another position in the textbuffer

The delete() method deletes the text between start and end. The order of start and end is not actually relevant as the delete() method will reorder them. This method emits the "delete_range" signal, and the default handler of that signal deletes the text. Because the textbuffer is modified, all outstanding iterators become invalid after calling this function; however, start and end will be re-initialized to point to the location where text was deleted.

gtk.TextBuffer.delete_interactive

    def delete_interactive(start_iter, end_iter, default_editable)

start_iter :

a gtk.TextIter specifying the start of the text to delete

end_iter :

a gtk.TextIter specifying the end of the text to delete

default_editable :

whether the buffer is editable by default

Returns :

True if some text was actually deleted

The delete_interactive() method deletes all editable text in the given range. This method calls the delete() method for each editable sub-range of [start,end). start and end are revalidated to point to the location of the last deleted range, or left untouched if no text was deleted. A range of text is non-editable if a gtk.TextTag applied to that range has its "editable" attribute set to False or the gtk.TextView used by the user is set non-editable. The default_editable parameter indicates whether text is editable if no tags enclosing any part of text affect editability. Typically the result of the gtk.TextView.get_editable() method is appropriate here.

gtk.TextBuffer.get_text

    def get_text(start, end, include_hidden_chars=True)

start :

a gtk.TextIter specifying the start of a range

end :

a gtk.TextIter specifying the end of a range

include_hidden_chars :

if True include invisible text

Returns :

the text in the range

The get_text() method returns the text in the specified range [start,end). Undisplayed text (text marked with tags that set the invisibility attribute) are excluded if include_hidden_chars is False. get_text() does not return characters representing embedded images, so byte and character indexes into the returned string do not correspond to byte and character indexes into the buffer. Contrast this behavior with the get_slice() method.

gtk.TextBuffer.get_slice

    def get_slice(start, end, include_hidden_chars)

start :

a gtk.TextIter specifying the start of a range

end :

a gtk.TextIter specifying the end of a range

include_hidden_chars :

if True include invisible text

Returns :

the contents of the range including text and indicators for pixbufs and child anchors

The get_slice() method returns the text in the range [start,end). Undisplayed text (text marked with tags that set the invisibility attribute) is excluded if include_hidden_chars is False. The returned string includes a 0xFFFC character whenever the textbuffer contains embedded images or child anchors, so byte and character indexes into the returned string do correspond to byte and character indexes into the buffer. Contrast this behavior with the get_text() method. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer.

gtk.TextBuffer.insert_pixbuf

    def insert_pixbuf(iter, pixbuf)

iter :

a gtk.TextIter specifying the location to insert the pixbuf

pixbuf :

a gtk.gdk.Pixbuf

The insert_pixbuf() method inserts an image specified by pixbuf into the text buffer at the location specified by iter. The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode "object replacement character" 0xFFFC. Note that the "slice" variants for obtaining portions of the buffer as a string include this character for pixbufs, but the "text" variants do not. e.g. see the get_slice() and get_text() methods.

gtk.TextBuffer.insert_child_anchor

    def insert_child_anchor(iter, anchor)

iter :

a gtk.TextIter specifying the location to insert the anchor

anchor :

a gtk.TextChildAnchor

The insert_child_anchor() method inserts a child widget anchor specified by anchor into the textbuffer at the location specified by iter. The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode "object replacement character" 0xFFFC. Note that the "slice" variants for obtaining portions of the buffer as a string include this character for child anchors, but the "text" variants do not. e.g. see the get_slice() and get_text() methods. The create_child_anchor() is a more convenient alternative to this function.

gtk.TextBuffer.create_child_anchor

    def create_child_anchor(iter)

iter :

a gtk.TextIter specifying a location in the buffer

Returns :

the new child anchor

The create_child_anchor() method is a convenience function that creates a child anchor with the gtk.TextChildAnchor() constructor and inserts it into the textbuffer at the location specified by iter with the insert_child_anchor() method.

gtk.TextBuffer.create_mark

    def create_mark(mark_name, where, left_gravity)

mark_name :

the name for the new mark, or None

where :

a gtk.TextIter specifying the location to place the mark

left_gravity :

if True the mark has left gravity

Returns :

the new gtk.TextMark object

The create_mark() method creates a mark with the name specified by mark_name at the position specified by where and left gravity specified by left_gravity. If mark_name is None, the mark is anonymous; otherwise, the mark can be retrieved by name using the get_mark() method. If a mark has left gravity, and text is inserted at the mark's current location, the mark will be moved to the left of the newly-inserted text. If the mark has right gravity (left_gravity = False), the mark will end up on the right of newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right side of the text you're typing). Marks are owned by the buffer and go away when the buffer does. This method emits the "mark_set" signal as notification of the mark's initial placement.

gtk.TextBuffer.move_mark

    def move_mark(mark, where)

mark :

a gtk.TextMark

where :

a gtk.TextIter specifying a new location for mark

The move_mark() method moves the gtk.TextMark specified by mark to the new location specified by where.This method emits the "mark_set" signal as notification of the move.

gtk.TextBuffer.delete_mark

    def delete_mark(mark)

mark :

a gtk.TextMark in the textbuffer

The delete_mark() method deletes the gtk.TextMark specified by mark, so that it's no longer located anywhere in the textbuffer. Most operations on mark become invalid and there is no way to undelete a mark. The get_deleted() method will return True after this method has been called on a mark to indicate that a mark no longer belongs to a textbuffer. The "mark_deleted" signal will be emitted as notification after the mark is deleted.

gtk.TextBuffer.get_mark

    def get_mark(name)

name :

a mark name

Returns :

a gtk.TextMark, or None

The get_mark() method returns the mark named name in the textbuffer, or None if no such mark exists in the buffer.

gtk.TextBuffer.move_mark_by_name

    def move_mark_by_name(name, where)

name :

the name of a mark

where :

a gtk.TextIter specifying the new location for mark

The move_mark_by_name() method moves the mark named name (which must exist) to the textbuffer location specified by where. See the move_mark() method for details.

gtk.TextBuffer.delete_mark_by_name

    def delete_mark_by_name(name)

name :

the name of a mark in buffer

The delete_mark_by_name() method deletes the mark (which must exist) named name. See the delete_mark() for details.

gtk.TextBuffer.get_insert

    def get_insert()

Returns :

the insertion point mark

The get_insert() method returns the mark that represents the cursor (insertion point). Equivalent to calling the get_mark() method to get the mark named "insert", but very slightly more efficient, and involving less typing.

gtk.TextBuffer.get_selection_bound

    def get_selection_bound()

Returns :

the selection bound mark

The get_selection_bound() method returns the mark that represents the selection bound. Equivalent to calling the get_mark() method to get the mark named "selection_bound", but very slightly more efficient, and involving less typing. The currently-selected text in a textbuffer is the region between the "selection_bound" and "insert" marks. If "selection_bound" and "insert" are in the same place, then there is no current selection. The get_selection_bounds() method is a convenience method for handling the selection, if you just want to know whether there's a selection and what its bounds are.

gtk.TextBuffer.place_cursor

    def place_cursor(where)

where :

a gtk.TextIter specifying where to put the cursor

The place_cursor() method moves the "insert" and "selection_bound" marks simultaneously to the location specified by where. If you move them to the same place in two steps with the move_mark() method, you will temporarily select a region in between their old and new locations, which is inefficient. This method moves them as a unit, which can be optimized.

gtk.TextBuffer.select_range

    def select_range(ins, bound)

ins :

a gtk.TextIter specifying where to put the "insert" mark

bound :

a gtk.TextIter specifying where to put the "selection_bound" mark

Note

This method is available in PyGTK 2.4 and above.

The select_range() method moves the "insert" and "selection_bound" marks simultaneously to the locations specified by ins and bound respectively. If you move them to the same place in two steps with the move_mark() method, you will temporarily select a region in between their old and new locations, which is inefficient. This method moves them as a unit, which can be optimized.

gtk.TextBuffer.apply_tag

    def apply_tag(tag, start, end)

tag :

a gtk.TextTag

start :

a gtk.TextIter specifying the start of the range

end :

a gtk.TextIter specifying the end of the range

The apply_tag() method emits the "apply-tag" signal that causes the gtk.TextTag specified by tag to be applied to the range of text between start and end by the default signal handler. start and end do not have to be in order.

gtk.TextBuffer.remove_tag

    def remove_tag(tag, start, end)

tag :

a gtk.TextTag

start :

a gtk.TextIter specifying the start of the range

end :

a gtk.TextIter specifying the end of the range

The delete_tag() method emits the "remove_tag" signal that causes the default handler for the signal to remove all occurrences of the gtk.TextTag specified by tag from the text in the range between start and end. start and end don't have to be in order.

gtk.TextBuffer.apply_tag_by_name

    def apply_tag_by_name(name, start, end)

name :

the name of a gtk.TextTag

start :

a gtk.TextIter specifying the start of the range

end :

a gtk.TextIter specifying the end of the range

The apply_tag_by_name() method calls the gtk.TextTagTable.lookup() method on the textbuffer's tag table to find the gtk.TextTag with the specified name, then calls the apply_tag() method to apply that tag to the text in the range between start and end. start and end don't have to be in order.

gtk.TextBuffer.remove_tag_by_name

    def remove_tag_by_name(name, start, end)

name :

the name of a gtk.TextTag

start :

a gtk.TextIter specifying the start of the range

end :

a gtk.TextIter specifying the end of the range

The delete_tag_by_name() method calls the gtk.TextTagTable.lookup() method on the textbuffer's tag table to find the gtk.TextTag, then calls the remove_tag() method to remove that that tag from the text in the range between start and end. start and end don't have to be in order.

gtk.TextBuffer.remove_all_tags

    def remove_all_tags(start, end)

start :

a gtk.TextIter specifying the start of the range

end :

a gtk.TextIter specifying the end of the range

The remove_all_tags() method removes all tags in the text in the range between start and end. Be careful with this function; it could remove tags added in code unrelated to the code you're currently writing. That is, using this function is probably a bad idea if you have two or more unrelated code sections that add tags. start and end don't have to be in order.

gtk.TextBuffer.create_tag

    def create_tag(tag_name=None, ...)

tag_name :

the name of the new tag, or None if the tag is anonymous

... :

one or more property_name= value pairs

Returns :

a new tag

The create_tag() method creates a tag with the name specified by tag_name and adds it to the tag table for the textbuffer. If one or more property_name=value pairs are available they are used to set the properties of the tag. Note the property_name must be specified using underscores instead of dashes e.g. use pixels_above_lines=10 instead of pixels-above-lines=10. This method is equivalent to calling the gtk.TextTag() constructor and then adding the tag to the buffer's tag table with the gtk.TextTagTable.add() method. If tag_name is None, the tag is anonymous. If tag_name is non-None, a tag called tag_name must not already exist in the tag table for this buffer.

gtk.TextBuffer.get_iter_at_line_offset

    def get_iter_at_line_offset(line_number, char_offset)

line_number :

the line number counting from 0

char_offset :

the char offset from start of line

Returns :

a gtk.TextIter

The get_iter_at_line_offset() returns an iterator pointing to the position specified by char_offset within the line specified by line_number. The char_offset must exist, offsets off the end of the line are not allowed. Note specify characters, not bytes; UTF-8 may encode one character as multiple bytes.

gtk.TextBuffer.get_iter_at_line_index

    def get_iter_at_line_index(line_number, byte_index)

line_number :

the line number counting from 0

byte_index :

the byte index from start of line

Returns :

a gtk.TextIter

The get_iter_at_line_index() method returns an iterator pointing to the position specified by byte_index within the line specified by line_number. byte_index must be the start of a UTF-8 character, and must not be beyond the end of the line. Note specify bytes, not characters; UTF-8 may encode one character as multiple bytes.

gtk.TextBuffer.get_iter_at_offset

    def get_iter_at_offset(char_offset)

char_offset :

the char offset from start of buffer, counting from 0

Returns :

a gtk.TextIter

The get_iter_at_offset() method returns an iterator pointing to the location specified by char_offset characters from the start of the entire buffer.

gtk.TextBuffer.get_iter_at_line

    def get_iter_at_line(line_number)

line_number :

line number counting from 0

Returns :

a gtk.TextIter

The get_iter_at_line() method returns an iterator pointing to the start of the line specified by line_number.

gtk.TextBuffer.get_start_iter

    def get_start_iter()

Returns :

a gtk.TextIter

The get_start_iter() method returns an iterator pointing at the location of the first position in the text buffer. This is the same as using the get_iter_at_offset() with an argument of 0.

gtk.TextBuffer.get_end_iter

    def get_end_iter()

Returns :

a gtk.TextIter

The get_end_iter() method returns an iterator pointing at the "end iterator," one past the last valid character in the text buffer. If passed to the gtk.TextIter.get_char() method, the end iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer (call the get_start_iter() method to get character position 0) to the end iterator.

gtk.TextBuffer.get_bounds

    def get_bounds()

Returns :

a tuple containing gtk.TextIter objects that point at the first and last positions in the buffer

The get_bounds() method returns a tuple containing the first and last iterators in the buffer, i.e. the entire buffer lies within the range.

gtk.TextBuffer.get_iter_at_mark

    def get_iter_at_mark(mark)

mark :

a gtk.TextMark in the textbuffer

Returns :

a gtk.TextIter

The get_iter_at_mark() method returns an iterator that points at the current position of mark.

gtk.TextBuffer.get_iter_at_child_anchor

    def get_iter_at_child_anchor(iter, anchor)

anchor :

a child anchor that appears in the textbuffer

Returns :

a gtk.TextIter

The get_iter_at_child_anchor() method returns an iterator that points at the location of anchor within the textbuffer.

gtk.TextBuffer.get_modified

    def get_modified()

Returns :

True if the buffer has been modified

The get_modified() method returns True if the buffer has been modified since the last call to the set_modified() method set the modification flag to False. Used for example to enable a "save" function in a text editor.

gtk.TextBuffer.set_modified

    def set_modified(setting)

setting :

the modification flag setting

The set_modified() method sets the modification flag of the textbuffer to the value specified by setting. The modification flag is used to keep track of whether the buffer has been modified since the last time it was saved. Whenever the buffer is saved to disk, call this method with a setting of False. When the buffer is modified, it will automatically set the modification flag to True and emit a "modified_changed" signal.

gtk.TextBuffer.add_selection_clipboard

    def add_selection_clipboard(clipboard)

clipboard :

a gtk.Clipboard

Note

This method is available in PyGTK 2.2 and above.

The add_selection_clipboard() method adds the gtk.Clipboard specified by clipboard to the list of clipboards in which the selection contents of the buffer are available. In most cases, clipboard will be the gtk.gdk.SELECTION_PRIMARY clipboard

gtk.TextBuffer.remove_selection_clipboard

    def remove_selection_clipboard(clipboard)

clipboard :

a gtk.Clipboard added to the buffer by the add_selection_clipboard() method.

Note

This method is available in PyGTK 2.2 and above.

The remove_selection_clipboard() method removes the gtk.Clipboard added with the add_selection_clipboard() method.

gtk.TextBuffer.cut_clipboard

    def cut_clipboard(clipboard, default_editable)

clipboard :

the gtk.Clipboard object to cut to.

default_editable :

the default editability of the buffer

Note

This method is available in PyGTK 2.2 and above.

The cut_clipboard() method copies the currently-selected text to the gtk.Clipboard specified by clipboard, then deletes said text if it's editable as specified by default_editable. Typically the result of the gtk.TextView.get_editable() method is appropriate here.

gtk.TextBuffer.copy_clipboard

    def copy_clipboard(clipboard)

clipboard :

the gtk.Clipboard object to copy to.

Note

This method is available in PyGTK 2.2 and above.

The copy_clipboard() method copies the currently-selected text to the gtk.ClipBoard specified by clipboard.

gtk.TextBuffer.paste_clipboard

    def paste_clipboard(clipboard, override_location, default_editable)

clipboard :

the gtk.Clipboard to paste from

override_location :

the gtk.TextIter specifying the location to insert pasted text, or None for at the cursor

default_editable :

the default editability of the buffer

Note

This method is available in PyGTK 2.2 and above.

The paste_clipboard() method pastes the contents of the gtk.ClipBoard specified by clipboard at the insertion point, or at the location specified by override_location (if not None). (Note: pasting is asynchronous, that is, we'll ask for the paste data and return, and at some point later after the main loop runs, the paste data will be inserted.)

gtk.TextBuffer.get_selection_bounds

    def get_selection_bounds()

Returns :

a tuple containing gtk.TextIter objects pointing to the selection start and end or an empty tuple if there is no selection

The get_selection_bounds() method returns a tuple containing iterators that point at the start and end of the selection, if any. If there is no selection an empty tuple is returned.

gtk.TextBuffer.delete_selection

    def delete_selection(interactive, default_editable)

interactive :

if True the deletion is caused by user interaction

default_editable :

if True the buffer is editable by default

Returns :

True if there was a non-empty selection to delete

The delete_selection() method deletes the text in the range between the "insert" and "selection_bound" marks, i.e. the currently-selected text. If interactive is True, the editability of the selection will be considered (users can't delete uneditable text) and default_editable is used to determine the default editability of the textbuffer usually as a result of a call to the gtk.TextView.get_editable() method.

gtk.TextBuffer.begin_user_action

    def begin_user_action()

The begin_user_action() method is called to indicate that the textbuffer operations until a call to the end_user_action() method are part of a single user-visible operation. The operations between the begin_user_action() and end_user_action() methods can then be grouped when creating an undo stack. gtk.TextBuffer maintains a count of calls to the begin_user_action() method that have not been closed with a call to the end_user_action() method, and emits the "begin_user_action" and "end_user_action" signals only for the outermost pair of calls. This allows you to chain user actions.

The "interactive" textbuffer mutation methods, such as the insert_interactive() method, automatically call the begin and end user action methods around the textbuffer operations they perform, so there's no need to add extra calls if you user action consists solely of a single call to one of those methods.

gtk.TextBuffer.end_user_action

    def end_user_action()

The end_user_action() method should be paired with a call to the begin_user_action() method.

gtk.TextBuffer.backspace

    def backspace(iter, interactive, default_editable)

iter :

a gtk.TextIter

interactive :

if True the deletion is caused by user interaction

default_editable :

if True the buffer is editable by default

Returns :

True if the buffer was modified

Note

This method is available in PyGTK 2.6 and above.

The backspace() method performs the appropriate action as if the user hit the delete key with the cursor at the position specified by iter. In the normal case a single character will be deleted, but when combining accents are involved, more than one character can be deleted, and when precomposed character and accent combinations are involved, less than one character will be deleted.

Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, iter will be re-initialized to point to the location where text was deleted.

gtk.TextBuffer.get_has_selection

    def get_has_selection()

Returns :

True if there is text selected

Note

This method is available in PyGTK 2.10 and above.

Indicates whether the buffer has some text currently selected.

gtk.TextBuffer.get_copy_target_list

    def get_copy_target_list()

Returns :

a list of the targets each represented as a 3-tuple containing the target name, a combination of the GTK Target Flags Constants and an application assigned integer

Note

This method is available in PyGTK 2.10 and above.

This method returns the list of targets this text buffer can provide for copying and as DND source. The targets in the list are added with info values from the GTK TextBuffer Target Info Constants, using the gtk.target_list_add_rich_text_targets() and gtk.target_list_add_text_targets() functions.

gtk.TextBuffer.get_paste_target_list

    def get_paste_target_list()

Returns :

a list of the targets each represented as a 3-tuple containing the target name, a combination of the GTK Target Flags Constants and an application assigned integer

Note

This method is available in PyGTK 2.10 and above.

This method returns the list of targets this text buffer supports for pasting and as DND destination. The targets in the list are added with info values from the GTK TextBuffer Target Info Constants, using the gtk.target_list_add_rich_text_targets() and gtk.target_list_add_text_targets() functions.

gtk.TextBuffer.register_serialize_format

    def register_serialize_format(mime_type, function, user_data)

mime_type :

the format's mime-type

function :

the serialize function to register

user_data :

function's user_data

Returns :

the newly registered format's mime-type.

Note

This method is available in PyGTK 2.10 and above.

This method registers a rich text serialization function along with its mime_type with the passed buffer.

The signature of function is:

  def function(register_buf, content_buf, start, end, data):

where register_buf is the textbuffer that the format is registered with, content_buf is the textbuffer containing the text to be serialized, start and end are textiters bounding the text to be serialized and data is user_data. function should return the serialized data.

gtk.TextBuffer.register_serialize_tagset

    def register_serialize_tagset(tagset_name=NULL)

tagset_name :

an optional tagset name, or None

Returns :

the newly registered format's mime-type.

Note

This method is available in PyGTK 2.10 and above.

This method registers GTK+'s internal rich text serialization format with this textbuffer. The internal format does not comply to any standard rich text format and only works between gtk.TextBuffer instances. It is capable of serializing all of a text buffer's tags and embedded pixbufs.

This method is just a wrapper around gtk.TextBuffer.register_serialize_format(). The mime_type used for registering is "application/x-gtk-text-buffer-rich-text", or "application/x-gtk-text-buffer-rich-text;format=tagset_name" if a tagset_name was passed.

The tagset_name can be used to restrict the transfer of rich text to buffers with compatible sets of tags, in order to avoid unknown tags from being pasted. It is probably the common case to pass a non-None tagset here, since the None tagset requires the receiving buffer to deal with with pasting of arbitrary tags.

gtk.TextBuffer.register_deserialize_format

    def register_deserialize_format(mime_type, function, user_data)

mime_type :

the format's mime-type

function :

the deserialize function to register

user_data :

function's user_data

Returns :

the newly registered format's mime-type.

Note

This method is available in PyGTK 2.10 and above.

This method registers a rich text deserialization function along with its mime_type with the passed buffer.

The signature of function is:

  def function(register_buf, content_buf, iter, data, create_tags, udata):

where register_buf is the textbuffer that the format is registered with, content_buf is the textbuffer that data will be deserialized into, iter is a textiter indicating the start of the deserialized data in content_buf, create_tags is a boolean indicating if tags should be created during deserializtion and udata is user_data. function should return True if the data was successfully deserialized.

gtk.TextBuffer.register_deserialize_tagset

    def register_deserialize_tagset(tagset_name=NULL)

tagset_name :

an optional tagset name, or None

Returns :

the newly registered format's mime-type.

Note

This method is available in PyGTK 2.10 and above.

This method registers GTK+'s internal rich text serialization format with this buffer. See the gtk.TextBuffer.register_serialize_tagset() method for details.

gtk.TextBuffer.unregister_serialize_format

    def unregister_serialize_format(format)

format :

a target string representing a registered rich text format.

Note

This method is available in PyGTK 2.10 and above.

This method unregisters a rich text format that was previously registered using the gtk.TextBuffer.register_serialize_format() or gtk.TextBuffer.register_serialize_tagset() methods.

gtk.TextBuffer.unregister_deserialize_format

    def unregister_deserialize_format(format)

format :

a target string representing a registered rich text format.

Note

This method is available in PyGTK 2.10 and above.

This method unregisters a rich text format that was previously registered using the gtk.TextBuffer.register_deserialize_format() or gtk.TextBuffer.register_deserialize_tagset() methods.

gtk.TextBuffer.deserialize_set_can_create_tags

    def deserialize_set_can_create_tags(format, can_create_tags)

format :

a target string representing a registered rich text format

can_create_tags :

if True deserializing format may create tags

Note

This method is available in PyGTK 2.10 and above.

Use this method to allow a rich text deserialization function to create new tags in the receiving buffer. Note that using this method is almost always a bad idea, because the rich text functions you register should know how to map the rich text format they handle to your text buffers set of tags.

The ability of creating new (arbitrary!) tags in the receiving buffer is meant for special rich text formats like the internal one that is registered using gtk.TextBuffer.register_deserialize_tagset(), because that format is essentially a dump of the internal structure of the source buffer, including its tag names.

You should allow creation of tags only if you know what you are doing, e.g. if you defined a tagset name for your application suite's text buffers and you know that it's fine to receive new tags from these buffers, because you know that your application can handle the newly created tags.

gtk.TextBuffer.deserialize_get_can_create_tags

    def deserialize_get_can_create_tags(format)

format :

a target string representing a registered rich text format

Returns :

True if deserializing format may create tags

Note

This method is available in PyGTK 2.10 and above.

This method returns the value set with the gtk.TextBuffer.deserialize_set_can_create_tags() method.

gtk.TextBuffer.get_serialize_formats

    def get_serialize_formats()

Returns :

a list of target strings representing the registered formats.

Note

This method is available in PyGTK 2.10 and above.

This method returns a list of the rich text serialize formats registered using the gtk.TextBuffer.register_serialize_format() or gtk.TextBuffer.register_serialize_tagset() methods.

gtk.TextBuffer.get_deserialize_formats

    def get_deserialize_formats()

Returns :

a list of target strings representing the registered formats.

Note

This method is available in PyGTK 2.10 and above.

This method returns the rich text deserialize formats registered using the gtk.TextBuffer.register_deserialize_format() or gtk.TextBuffer.register_deserialize_tagset() methods.

gtk.TextBuffer.serialize

    def serialize(content_buffer, format, start, end)

content_buffer :

the gtk.TextBuffer to serialize

format :

the rich text format to use for serializing

start :

start of block of text to serialize

end :

end of block of test to serialize

Returns :

the serialized data, encoded as format

Note

This method is available in PyGTK 2.10 and above.

This method serializes the portion of text between start and end in the rich text format represented by format.

The formats to be used must be registered using the gtk.TextBuffer.register_serialize_format() or gtk.TextBuffer.register_serialize_tagset() methods beforehand.

gtk.TextBuffer.deserialize

    def deserialize(content_buffer, format, iter, data)

content_buffer :

the gtk.TextBuffer to deserialize into

format :

the rich text format to use for deserializing

iter :

insertion point for the deserialized text

data :

data to deserialize

Returns :

True on success, False otherwise.

Note

This method is available in PyGTK 2.10 and above.

This method deserializes rich text in format format and inserts it at iter in content_buffer.

The formats to be used must be registered using the gtk.TextBuffer.register_deserialize_format() or gtk.TextBuffer.register_deserialize_tagset() methods beforehand.

gtk.TextBuffer.add_mark

    def add_mark(mark, where)

mark :

the gtk.TextMark to add

where :

the location to place mark.

Note

This method is available in PyGTK 2.12 and above.

Adds the mark at position where. The mark must not be added to another buffer, and if its name is not None then there must not be another mark in the buffer with the same name.

Emits the "mark_set" signal as notification of the mark's initial placement.

Signals

The "apply-tag" gtk.TextBuffer Signal

    def callback(textbuffer, texttag, start, end, user_param1, ...)

textbuffer :

the textbuffer that received the signal

texttag :

the gtk.TextTag being applied

start :

a gtk.TextIter pointing to the start of the range of text

end :

a gtk.TextIter pointing to the end of the range of text

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "apply-tag" signal is emitted when texttag is applied to the text in textbuffer in the range specified by start and end.

The "begin-user-action" gtk.TextBuffer Signal

    def callback(textbuffer, user_param1, ...)

textbuffer :

the textbuffer that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "begin-user-action" signal is emitted on the first call to the begin_user_action() method.

The "changed" gtk.TextBuffer Signal

    def callback(textbuffer, user_param1, ...)

textbuffer :

the textbuffer that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "changed" signal is emitted when text is inserted in textbuffer.

The "delete-range" gtk.TextBuffer Signal

    def callback(textbuffer, start, end, user_param1, ...)

textbuffer :

the textbuffer that received the signal

start :

a gtk.TextIter pointing to the start of the range of text

end :

a gtk.TextIter pointing to the end of the range of text

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "delete-range" signal is emitted when the text in the range specified by start and end is to be deleted.

The "end-user-action" gtk.TextBuffer Signal

    def callback(textbuffer, user_param1, ...)

textbuffer :

the textbuffer that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "end-user-action" signal is emitted when the call to the end_user_action() method reduces the user action count to zero i.e. undoes the first call to the begin_user_action() method.

The "insert-child-anchor" gtk.TextBuffer Signal

    def callback(textbuffer, iter, anchor, user_param1, ...)

textbuffer :

the textbuffer that received the signal

iter :

a gtk.TextIter

anchor :

a gtk.TextChildAnchor

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "insert-child-anchor" signal is emitted when anchor is inserted into textbuffer at the location specified by iter.

The "insert-pixbuf" gtk.TextBuffer Signal

    def callback(textbuffer, iter, pixbuf, user_param1, ...)

textbuffer :

the textbuffer that received the signal

iter :

a gtk.TextIter

pixbuf :

a gtk.gdk.Pixbuf

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "insert-pixbuf" signal is emitted when pixbuf is inserted into textbuffer at the location specified by iter.

The "insert-text" gtk.TextBuffer Signal

    def callback(textbuffer, iter, text, length, user_param1, ...)

textbuffer :

the textbuffer that received the signal

iter :

a gtk.TextIter

text :

the text inserted in textbuffer

length :

the length of the text inserted in textbuffer

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "insert-text" signal is emitted when text of the size specified by length is inserted into textbuffer at the location specified by iter.

The "mark-deleted" gtk.TextBuffer Signal

    def callback(textbuffer, textmark, user_param1, ...)

textbuffer :

the textbuffer that received the signal

textmark :

the gtk.TextMark that is being deleted

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "mark-deleted" signal is emitted when textmark is being deleted from textbuffer.

The "mark-set" gtk.TextBuffer Signal

    def callback(textbuffer, iter, textmark, user_param1, ...)

textbuffer :

the textbuffer that received the signal

iter :

a gtk.TextIter pointing at the location where textmark will be set.

textmark :

the gtk.TextMark that is being set

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "mark-set" signal is emitted when textmark is being set at the location specified by iter in textbuffer.

The "modified-changed" gtk.TextBuffer Signal

    def callback(textbuffer, user_param1, ...)

textbuffer :

the textbuffer that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "modified-changed" signal is emitted when the modification flag is changed.

The "remove-tag" gtk.TextBuffer Signal

    def callback(textbuffer, texttag, start, end, user_param1, ...)

textbuffer :

the textbuffer that received the signal

texttag :

the gtk.TextTag being removed

start :

a gtk.TextIter pointing to the start of the range of text

end :

a gtk.TextIter pointing to the end of the range of text

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "remove-tag" signal is emitted when texttag is being removed from the textbuffer text in the range specified by start and end.

Prev Up Next
gtk.TextAttributes Home gtk.TextChildAnchor
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkliststore.html0000644000000000000000000012260111272037113024355 0ustar rootrootgtk.ListStore
gtk.ListStore
Prev The gtk Class Reference Next

gtk.ListStore

gtk.ListStore — a list model to use with a gtk.TreeView

Synopsis

class gtk.ListStore(gobject.GObject, gtk.TreeModel, gtk.TreeDragSource, gtk.TreeDragDest, gtk.TreeSortable):
    gtk.ListStore(column_type, ...)
    def set_column_types(type, ...)
    def set_value(iter, column, value)
    def set(iter, column_num, value, ...)
    def remove(iter)
    def insert(position, row=None)
    def insert_before(sibling, row=None)
    def insert_after(sibling, row=None)
    def prepend(row=None)
    def append(row=None)
    def clear()
    def iter_is_valid(iter)
    def reorder(new_order)
    def swap(a, b)
    def move_after(iter, position)
    def move_before(iter, position)

Ancestry

+-- gobject.GObject
  +-- gtk.ListStore

Implemented Interfaces

gtk.Bin implements gtk.Buildable gtk.TreeModel gtk.TreeDragSource gtk.TreeDragDest gtk.TreeSortable

gtk.ListStore Signal Prototypes

gobject.GObject Signal Prototypes

gtk.TreeModel Signal Prototypes

gtk.TreeSortable Signal Prototypes

Description

The gtk.ListStore object is a list model for use with a gtk.TreeView widget. It implements the gtk.TreeModel interface, the gtk.TreeSortable and the tree drag and drop interfaces.

The gtk.ListStore objects support the Python mapping and iterator protocols. See the gtk.TreeModel Description and the PyGTK tutorial for more information.

Constructor

    gtk.ListStore(column_type, ...)

column_type :

the column type of the first column

... :

optional types for succeeding columns

Returns :

a new gtk.ListStore

Creates a new list store as with one or more columns with the type specified by the arguments passed to the constructor. For example, gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING, gtk.gdk.Pixbuf); will create a new gtk.ListStore with three columns, of type int, string and gtk.gdk.Pixbuf respectively. The built-in GObject types are:

  • gobject.TYPE_BOOLEAN
  • gobject.TYPE_BOXED
  • gobject.TYPE_CHAR
  • gobject.TYPE_DOUBLE
  • gobject.TYPE_ENUM
  • gobject.TYPE_FLAGS
  • gobject.TYPE_FLOAT
  • gobject.TYPE_INT
  • gobject.TYPE_INT64
  • gobject.TYPE_INTERFACE
  • gobject.TYPE_INVALID
  • gobject.TYPE_LONG
  • gobject.TYPE_NONE
  • gobject.TYPE_OBJECT
  • gobject.TYPE_PARAM
  • gobject.TYPE_POINTER
  • gobject.TYPE_PYOBJECT
  • gobject.TYPE_STRING
  • gobject.TYPE_UCHAR
  • gobject.TYPE_UINT
  • gobject.TYPE_UINT64
  • gobject.TYPE_ULONG

The column types can be any GObject type including those that are PyGTK objects or application defined objects that are subclassed from the GObject class.

Methods

gtk.ListStore.set_column_types

    def set_column_types(type, ...)

type :

the type of the first column

... :

zero or more type specifications

Note

This method is available in PyGTK 2.2 and above.

The set_column_types() method sets the liststore columns to the types specified by type and any additional type parameters. This method is meant primarily for classes that inherit from gtk.ListStore, and should only be used when constructing a new gtk.ListStore. It will not function after a row has been added, or a method on the gtk.TreeModel interface is called.

gtk.ListStore.set_value

    def set_value(iter, column, value)

iter :

a valid gtk.TreeIter for the row being modified

column :

the column number to modify

value :

the new value for the cell

The set_value() method sets the data in the cell specified by iter and column. The type of value must be convertible to the type of the column.

gtk.ListStore.set

    def set(iter, column_num, value, ...)

iter :

 A valid gtk.TreeIter for the row being modified

column_num :

the number of the column to modify

value :

the new cell value

... :

additional optional sets of column number - value pairs

The set() method sets the value of one or more cells in the row referenced by iter. The argument list should contain integer column numbers, each followed by the value to be set (the value must be convertible to the type of the cell column). For example, to set column 0 with type gobject.TYPE_STRING to "Foo", you would write:

  liststore.set(iter, 0, "Foo")

gtk.ListStore.remove

    def remove(iter)

iter :

A valid gtk.TreeIter for the row

Returns :

True if iter is still valid.

The remove() method removes the row specified by iter from the list store and returns True if iter is still valid. After being removed, iter is set to be the next valid row, or is invalidated if it pointed to the last row.

Note

Prior to PyGTK 2.4 this method returned a new gtk.TreeIter that is a copy of iter.

gtk.ListStore.insert

    def insert(position, row=None)

position :

the integer position to insert the new row

row :

an optional list or tuple containing ordered column values to set on the row or None

Returns :

A gtk.TreeIter pointing at the new row

The insert() method creates a new row at the location specified by position. If position is larger than the number of rows on the list, then the new row will be appended to the list. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods.

gtk.ListStore.insert_before

    def insert_before(sibling, row=None)

sibling :

A valid gtk.TreeIter or None

row :

an optional list or tuple containing ordered column values to set on the row or None

Returns :

A gtk.TreeIter pointing at the new row

The insert_before() method inserts a new row before the row specified by the gtk.TreeIter sibling. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods.

In PyGTK 2.4, if sibling is None the row will be appended to the liststore.

gtk.ListStore.insert_after

    def insert_after(sibling, row=None)

sibling :

A valid gtk.TreeIter or None

row :

an optional list or tuple containing ordered column values to set on the row or None

Returns :

A gtk.TreeIter pointing at the new row

The insert_after() method inserts a new row after the row specified by the gtk.TreeIter sibling. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods.

In PyGTK 2.4, if sibling is None the row will be prepended to the liststore.

gtk.ListStore.prepend

    def prepend(row=None)

row :

an optional list or tuple containing ordered column values to set on the row or None

Returns :

A gtk.TreeIter pointing at the new row

The prepend() method prepends a new row to the liststore. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods.

gtk.ListStore.append

    def append(row=None)

row :

an optional list or tuple containing ordered column values to set on the row or None

Returns :

A gtk.TreeIter pointing at the new row

The append() method appends a new row to the liststore. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods.

gtk.ListStore.clear

    def clear()

The clear() method removes all rows from the liststore.

gtk.ListStore.iter_is_valid

    def iter_is_valid(iter)

iter :

A gtk.TreeIter.

Returns :

True if the iter is valid, False if the iter is invalid.

Note

This method is available in PyGTK 2.2 and above.

Warning

This method is slow. Only use it for debugging and/or testing purposes.

The iter_is_valid() method checks if the gtk.TreeIter specified by iter is a valid iter for this gtk.ListStore.

gtk.ListStore.reorder

    def reorder(new_order)

new_order :

a list of integers mapping the new position of each child to its old position before the re-ordering, i.e. new_order[newpos] = oldpos.

Note

This method is available in PyGTK 2.2 and above.

The reorder() method reorders the gtk.ListStore items to follow the order indicated by new_order. Note that this method only works with unsorted stores.

gtk.ListStore.swap

    def swap(a, b)

a :

A gtk.TreeIter.

b :

Another gtk.TreeIter.

Note

This method is available in PyGTK 2.2 and above.

The swap() method swaps the liststore rows specified by the gtk.TreeIters a and b. Note that this method only works with unsorted stores.

gtk.ListStore.move_after

    def move_after(iter, position)

iter :

A gtk.TreeIter.

position :

A gtk.TreeIter or None.

Note

This method is available in PyGTK 2.2 and above.

The move_after() method moves the liststore row referenced by iter to the position after the row referenced by position. Note that this method only works with unsorted stores. If position is None, the row referenced by iter will be moved to the start of the list.

gtk.ListStore.move_before

    def move_before(iter, position)

iter :

A gtk.TreeIter.

position :

A gtk.TreeIter, or None.

Note

This method is available in PyGTK 2.2 and above.

The move_before() method moves the liststore row referenced by iter to the position before the row referenced by position. Note that this method only works with unsorted stores. If position is None, the row referenced by iter will be moved to the end of the list.

Prev Up Next
gtk.LinkButton Home gtk.Menu
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktextview.html0000644000000000000000000046242211272037113024214 0ustar rootrootgtk.TextView
gtk.TextView
Prev The gtk Class Reference Next

gtk.TextView

gtk.TextView — a widget that displays the contents of a gtk.TextBuffer

Synopsis

class gtk.TextView(gtk.Container):
    gtk.TextView(buffer=None)
    def set_buffer(buffer)
    def get_buffer()
    def scroll_to_iter(iter, within_margin, use_align=False, xalign=0.5, yalign=0.5)
    def scroll_to_mark(mark, within_margin, use_align=False, xalign=0.5, yalign=0.5)
    def scroll_mark_onscreen(mark)
    def move_mark_onscreen(mark)
    def place_cursor_onscreen()
    def get_visible_rect()
    def set_cursor_visible(setting)
    def get_cursor_visible()
    def get_iter_location(iter)
    def get_iter_at_location(x, y)
    def get_line_yrange(iter)
    def get_line_at_y(target_iter)
    def buffer_to_window_coords(win, buffer_x, buffer_y)
    def window_to_buffer_coords(win, window_x, window_y)
    def get_window(win)
    def get_window_type(window)
    def set_border_window_size(type, size)
    def get_border_window_size(type)
    def forward_display_line(iter)
    def backward_display_line(iter)
    def forward_display_line_end(iter)
    def backward_display_line_start(iter)
    def starts_display_line(iter)
    def move_visually(iter, count)
    def add_child_at_anchor(child, anchor)
    def add_child_in_window(child, which_window, xpos, ypos)
    def move_child(child, xpos, ypos)
    def set_wrap_mode(wrap_mode)
    def get_wrap_mode()
    def set_editable(setting)
    def get_editable()
    def set_overwrite(overwrite)
    def get_overwrite()
    def set_accepts_tab(accepts_tab)
    def get_accepts_tab()
    def set_pixels_above_lines(pixels_above_lines)
    def get_pixels_above_lines()
    def set_pixels_below_lines(pixels_below_lines)
    def get_pixels_below_lines()
    def set_pixels_inside_wrap(pixels_inside_wrap)
    def get_pixels_inside_wrap()
    def set_justification(justification)
    def get_justification()
    def set_left_margin(left_margin)
    def get_left_margin()
    def set_right_margin(right_margin)
    def get_right_margin()
    def set_indent(indent)
    def get_indent()
    def set_tabs(tabs)
    def get_tabs()
    def get_default_attributes()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.TextView

Implemented Interfaces

gtk.TextView implements gtk.Buildable

gtk.TextView Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"accepts-tab"Read-WriteIf True, pressing Tab will result in a tab character being entered; otherwise the focus will be moved. Available in GTK+ 2.4 and above.
"buffer"Read-WriteThe buffer that is displayed. Available in GTK+ 2.4 and above.
"cursor-visible"Read-WriteIf True, the insertion cursor is shown
"editable"Read-WriteIf True, the text can be modified by the user by default
"indent"Read-WriteThe default amount to indent the paragraph, in pixels
"justification"Read-WriteThe default text justification: gtk.JUSTIFY_LEFT, gtk.JUSTIFY_RIGHT, gtk.JUSTIFY_CENTER or gtk.JUSTIFY_FILL
"left-margin"Read-WriteThe default width of the left margin in pixels
"overwrite"Read-WriteIf True, the entered text overwrites existing contents. Available in GTK+ 2.4 and above.
"pixels-above-lines"Read-WriteThe default number of pixels of blank space above paragraphs
"pixels-below-lines"Read-WriteThe default number of pixels of blank space below paragraphs
"pixels-inside-wrap"Read-WriteThe default number of pixels of blank space between wrapped lines in a paragraph
"right-margin"Read-WriteThe default width of the right margin in pixels
"tabs"Read-WriteThe default custom tabs
"wrap-mode"Read-WriteThe default wrap mode: gtk.WRAP_NONE, gtk.WRAP_CHAR or gtk.WRAP_WORD

gtk.TextView Style Properties

gtk.Widget Style Properties

"error-underline-color"Read-WriteThe gtk.gdk.Color with which to draw error-indication underlines. Available in GTK+ 2.4 and above.

gtk.TextView Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

"backspace

 def callback(textview, user_param1, ...)

"copy-clipboard"

 def callback(textview, user_param1, ...)

"cut-clipboard"

 def callback(textview, user_param1, ...)

"delete-from-cursor"

 def callback(textview, delete_type, count, user_param1, ...)

"insert-at-cursor"

 def callback(textview, string, user_param1, ...)

"move-cursor"

 def callback(textview, step_size, count, extend_selection, user_param1, ...)

"move-focus"

 def callback(textview, direction, user_param1, ...)

"move-viewport"

 def callback(textview, scrollstep, count, user_param1, ...)

"page-horizontally"

 def callback(textview, count, extend_selection, user_param1, ...)

"paste-clipboard"

 def callback(textview, user_param1, ...)

"populate-popup"

 def callback(textview, menu, user_param1, ...)

"select-all"

 def callback(textview, select, user_param1, ...)

"set-anchor"

 def callback(textview, user_param1, ...)

"set-scroll-adjustments"

 def callback(textview, hadjustment, vadjustment, user_param1, ...)

"toggle-overwrite"

 def callback(textview, user_param1, ...)

Description

A gtk.TextView widget provides the display for the contents of a gtk.TextBuffer object. A textview provides a set of attributes for the default display of text from a textbuffer. The attributes set by gtk.TextTag objects override the attributes set on a gtk.TextView widget. Since a gtk.TextBuffer can be associated with multiple gtk.TextView widgets each having a different set of default attributes, the display of the same text in different textview widgets can be quite different except for those attributes that are overridden by texttags.

A gtk.TextView widget has several gtk.gdk.Window widgets most of which are not displayed by default:

gtk.TEXT_WINDOW_WIDGET

The widget window

gtk.TEXT_WINDOW_TEXT

The window that holds the text

gtk.TEXT_WINDOW_LEFT

The left border window - not displayed by default

gtk.TEXT_WINDOW_RIGHT

The right border window - not displayed by default

gtk.TEXT_WINDOW_TOP

The top border window - not displayed by default

gtk.TEXT_WINDOW_BOTTOM

The bottom border window - not displayed by default

gtk.TEXT_WINDOW_PRIVATE

An internal inaccessible gtk.gdk.Window

The border windows are not created until they are given a size by using the set_border_window_size() method.

Depending on the wrap mode of the textview a textbuffer line may be displayed as more than one screen display line. The textview has methods to navigate through the display lines.

A gtk.TextChildAnchor in a gtk.TextBuffer provides a place for a PyGTK widget to be placed in a gtk.TextView. Each textview displaying the same textbuffer with a child anchor must have a different widget placed at that child anchor. In addition, a widget can be placed at a specific location in one of the above gtk.TextView windows using the add_child_in_window() method. The widget will be clipped to the window boundaries if it is larger than the window or located where it extends beyond the window boundaries.

A gtk.TextView has a default popup menu that includes the usual cut, copy and paste capabilities. In PyGTK 2.2 gtk.Clipboard objects are supported so your program can access the contents of the cut, copy and paste clipboard through the gdk.SELECTION_CLIPBOARD clipboard. Also the selected text in a gtk.TextView is available on the gdk.SELECTION_PRIMARY clipboard.

Constructor

    gtk.TextView(buffer=None)

buffer :

a gtk.TextBuffer or None

Returns :

a new gtk.TextView.

Creates a new gtk.TextView widget displaying the gtk.TextBuffer specified by buffer. If buffer is None, a new gtk.TextBuffer will be created. One textbuffer can be shared among many widgets.

Methods

gtk.TextView.set_buffer

    def set_buffer(buffer)

buffer :

a gtk.TextBuffer

The set_buffer() method sets the gtk.TextBuffer specified by buffer as the textbuffer being displayed by the textview.

gtk.TextView.get_buffer

    def get_buffer()

Returns :

a gtk.TextBuffer

The get_buffer() method returns the gtk.TextBuffer being displayed by this textview.

gtk.TextView.scroll_to_iter

    def scroll_to_iter(iter, within_margin, use_align=False, xalign=0.5, yalign=0.5)

iter :

a gtk.TextIter object

within_margin :

the margin as a [0.0,0.5) fraction of screen size

use_align :

if True use the alignment arguments; if False, just get iter on screen

xalign :

the horizontal alignment of iter within visible area.

yalign :

the vertical alignment of iter within visible area

Returns :

True if scrolling occurred

The scroll_to_iter() method scrolls the textview so that the gtk.TextIter location specified by iter is on the screen in the position indicated by xalign and yalign. If use_align is True the alignments specify the fraction of screen space to the left of or above the location of iter. If use_align is False, the text scrolls the minimal distance to get iter on screen, possibly not scrolling at all. The effective screen for purposes of this method is reduced by a margin of size specified by within_margin.

Note

This method uses the currently-computed height of the lines in the text buffer. The line heights are computed in an idle handler so this method may not have the desired effect if it's called before the height computations are complete. To avoid oddness, consider using the scroll_to_mark() method that saves a point to be scrolled to after line validation.

gtk.TextView.scroll_to_mark

    def scroll_to_mark(mark, within_margin, use_align=False, xalign=0.5, yalign=0.5)

mark :

a gtk.TextMark object

within_margin :

the margin as a [0.0,0.5) fraction of screen size

use_align :

if True use the alignment arguments; if False, just get mark on screen

xalign :

the horizontal alignment of mark within the visible area.

yalign :

the vertical alignment of mark within the visible area

The scroll_to_mark() method scrolls the textview so that the gtk.TextMark location specified by mark is on the screen in the position specified by xalign and yalign. If use_align is True the alignments specify the fraction of screen space to the left of or above the location of mark. If use_align is False, the text scrolls the minimal distance to get mark on screen, possibly not scrolling at all. The effective screen for purposes of this function is reduced by a margin of size specified by within_margin.

gtk.TextView.scroll_mark_onscreen

    def scroll_mark_onscreen(mark)

mark :

a gtk.TextMark in the textbuffer for textview

The scroll_mark_onscreen() method scrolls the textview the minimum distance to place the gtk.TextMark location specified by mark within the visible area of the widget.

gtk.TextView.move_mark_onscreen

    def move_mark_onscreen(mark)

mark :

a gtk.TextMark object

Returns :

True if mark moved (wasn't already on screen)

The move_mark_onscreen() moves the gtk.TextMark location specified by mark to a location within the currently-visible text area of the textview.

gtk.TextView.place_cursor_onscreen

    def place_cursor_onscreen()

Returns :

True if the cursor had to be moved.

The place_cursor_onscreen() method moves the cursor to a new location within the currently visible region of the buffer, if it isn't there already.

gtk.TextView.get_visible_rect

    def get_visible_rect()

Returns :

a gtk.gdk.Rectangle

The get_visible_rect() method returns a gtk.gdk.Rectangle containing the coordinates of the currently-visible region of the buffer. The rectangle is in buffer coordinates that can be converted to window coordinates with the buffer_to_window_coords() method.

gtk.TextView.set_cursor_visible

    def set_cursor_visible(setting)

setting :

if True show the insertion cursor

The set_cursor_visible() method sets the "cursor-visible" property to the value of setting. If setting is True the cursor is visible; if False, it is not. A buffer with no editable text probably shouldn't have a visible cursor, so you may want to turn the cursor off.

gtk.TextView.get_cursor_visible

    def get_cursor_visible()

Returns :

True if the insertion mark is visible

The get_cursor_visible() method returns the value of the "cursor-visible" property that determines if the insertion point is visible.

gtk.TextView.get_iter_location

    def get_iter_location(iter)

iter :

a gtk.TextIter

Returns :

a gtk.gdk.Rectangle containing the bounds of the character at iter

The get_iter_location() method returns a gtk.gdk.Rectangle that contains the character at the location specified by iter. The rectangle position is in buffer coordinates that can be converted to window coordinates with the buffer_to_window_coords() method.

gtk.TextView.get_iter_at_location

    def get_iter_at_location(x, y)

x :

x position, in buffer coordinates

y :

y position, in buffer coordinates

Returns :

a gtk.TextIter

The get_iter_at_location() method returns a gtk.TextIter that points at the location specified by the buffer coordinates x and y. Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. Window coordinates from an event, must be converted to buffer coordinates with the window_to_buffer_coords() method before using them with this method.

gtk.TextView.get_line_yrange

    def get_line_yrange(iter)

iter :

a gtk.TextIter

Returns :

a tuple containing a y coordinate and a height

The get_line_yrange() method locates the line containing the gtk.TextIter specified by iter and returns a tuple containing the y coordinate of the top of the line and the height of the line. The coordinate is a buffer coordinate that can be converted to window coordinates with the buffer_to_window_coords() method.

gtk.TextView.get_line_at_y

    def get_line_at_y(y)

y :

a y coordinate

Returns :

a tuple containing a gtk.TextIter pointing at the line start and the top coordinate of the line

The get_line_at_y() method returns a tuple containing:

  • a gtk.TextIter pointing at the start of the line with the vertical coordinate specified by y and,
  • the vertical coordinate of the top edge of the line.

y is in buffer coordinates that can be converted from window coordinates with the window_to_buffer_coords() method.

gtk.TextView.buffer_to_window_coords

    def buffer_to_window_coords(win, buffer_x, buffer_y)

win :

one of the textview windows except gtk.TEXT_WINDOW_PRIVATE

buffer_x :

buffer x coordinate

buffer_y :

buffer y coordinate

Returns :

a tuple containing the window x and y coordinates

The buffer_to_window_coords() method returns a tuple containing the x and y coordinates for the window specified by win that correspond to the textbuffer coordinates specified by buffer_x and buffer_y. See the above description for more details on textview window types.

Note

You can't convert coordinates for a non-existing window (see the set_border_window_size() method).

gtk.TextView.window_to_buffer_coords

    def window_to_buffer_coords(win, window_x, window_y)

win :

a textview window except gtk.TEXT_WINDOW_PRIVATE

window_x :

window x coordinate

window_y :

window y coordinate

Returns :

a tuple containing the textbuffer x and y coordinates

The window_to_buffer_coords() method returns a tuple containing the textbuffer x and y coordinates corresponding to the window_x and window_y coordinates in the window specified by win, See the above description for more details on textview window types.

Note

You can't convert coordinates for a non-existing window (see the set_border_window_size()) method.

gtk.TextView.get_window

    def get_window(win)

win :

a textview window type

Returns :

a gtk.gdk.Window, or None

The get_window() method returns the gtk.gdk.Window corresponding to an area of the textview specified by win:

gtk.TEXT_WINDOW_WIDGET

The widget window

gtk.TEXT_WINDOW_TEXT

The window that holds the text

gtk.TEXT_WINDOW_LEFT

The left border window - not displayed by default

gtk.TEXT_WINDOW_RIGHT

The right border window - not displayed by default

gtk.TEXT_WINDOW_TOP

The top border window - not displayed by default

gtk.TEXT_WINDOW_BOTTOM

The bottom border window - not displayed by default

gtk.TEXT_WINDOW_PRIVATE

An internal inaccessible gtk.gdk.Window

This method returns None if the window is nonexistent i.e. if its width or height is 0.

gtk.TextView.get_window_type

    def get_window_type(window)

window :

a window type

Returns :

the window type.

The get_window_type() method returns the type of the gtk.gdk.Window specified by window. This method is used to find out what window type an event corresponds to. If you connect to an event signal on the textview, this method can be called on event.window to see what window type it was. See the get_window() method for more details on window types.

gtk.TextView.set_border_window_size

    def set_border_window_size(type, size)

type :

a textview border window type

size :

the width or height of the window

The set_border_window_size() method sets the width of a gtk.TEXT_WINDOW_LEFT or gtk.TEXT_WINDOW_RIGHT window, or the height of a gtk.TEXT_WINDOW_TOP or gtk.TEXT_WINDOW_BOTTOM window. This method automatically destroys the corresponding window if the size is set to 0, and creates the window if the size is set to non-zero. This method can only be used for the "border windows", it doesn't work with the gtk.TEXT_WINDOW_WIDGET, gtk.TEXT_WINDOW_TEXT, or gtk.TEXT_WINDOW_PRIVATE windows.

gtk.TextView.get_border_window_size

    def get_border_window_size(type)

type :

a textview border window type

Returns :

the width or height of the textview border window

The get_border_window_size() method returns the width or height of the border window of the type specified by type. See the set_border_window_size() method for more details.

gtk.TextView.forward_display_line

    def forward_display_line(iter)

iter :

a gtk.TextIter

Returns :

True if iter was moved and is not on the end iterator

The forward_display_line() method moves the location of iter forward by one display line. A textview display line is different from a textbuffer line. Textbuffer lines are paragraphs and are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a textbuffer line. If wrapping is turned off, display lines and textbuffer lines will be the same. Display lines are divided differently for each textview, since they depend on the textview's width and the textview's default wrap mode. Paragraphs are the same in all views, since they depend on the contents of the gtk.TextBuffer. This method returns True if the location of iter moves to a dereferenceable position (i.e. not the end position).

gtk.TextView.backward_display_line

    def backward_display_line(iter)

iter :

a gtk.TextIter

Returns :

True if iter was moved

The backward_display_line() method moves the location of iter backward by one display line. A textview display line is different from a textbuffer line. Textview lines are paragraphs and are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a textbuffer line. If wrapping is turned off, display lines and textbuffer lines will be the same. Display lines are divided differently for each textview, since they depend on the textview's width and the textview's default wrap mode. Paragraphs are the same in all views, since they depend on the contents of the gtk.TextBuffer. This method returns True if the location of iter moves to a dereferenceable position (i.e. not the end position).

gtk.TextView.forward_display_line_end

    def forward_display_line_end(iter)

iter :

a gtk.TextIter

Returns :

True if iter was moved and is not on the end iterator

The forward_display_line_end() method moves the location of iter forward to the next display line end. A textview display line is different from a textbuffer line. Textbuffer lines are paragraphs and are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a textbuffer line. If wrapping is turned off, display lines and textbuffer lines will be the same. Display lines are divided differently for each textview, since they depend on the textview's width and the textview's default wrap mode. Paragraphs are the same in all views, since they depend on the contents of the gtk.TextBuffer. This method returns True if the location of iter moves to a dereferenceable position (i.e. not the end position).

gtk.TextView.backward_display_line_start

    def backward_display_line_start(iter)

iter :

a gtk.TextIter

Returns :

True if iter was moved

The backward_display_line_start() method moves the location of iter backward to the next display line start. A textview display line is different from a textbuffer line. Textbuffer lines are paragraphs and are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a textbuffer line. If wrapping is turned off, display lines and textbuffer lines will be the same. Display lines are divided differently for each textview, since they depend on the textview's width and the textview's default wrap mode. Paragraphs are the same in all views, since they depend on the contents of the gtk.TextBuffer. This method returns True if the location of iter moves to a dereferenceable position (i.e. not the end position).

gtk.TextView.starts_display_line

    def starts_display_line(iter)

iter :

a gtk.TextIter

Returns :

True if the location of iter is at the beginning of a display line

The starts_display_line() method returns True if the location of iter is at the start of a display line. See the forward_display_line() method for an explanation of display lines vs. textbuffer lines (paragraphs).

gtk.TextView.move_visually

    def move_visually(iter, count)

iter :

a gtk.TextIter

count :

the number of characters to move (may be negative)

Returns :

True if iter moved and is not on the end iterator

The move_visually() method moves the location of iter by count cursor positions. If count is negative the location moves against the normal text direction. Note a cursor position move may move over multiple characters when multiple characters combine to form one grapheme.

gtk.TextView.add_child_at_anchor

    def add_child_at_anchor(child, anchor)

child :

a gtk.Widget

anchor :

a gtk.TextChildAnchor in the textview's gtk.TextBuffer

The add_child_at_anchor() method adds the widget specified by child in the textview, at the gtk.TextChildAnchor specified by anchor.

gtk.TextView.add_child_in_window

    def add_child_in_window(child, which_window, xpos, ypos)

child :

a gtk.Widget

which_window :

the textview window child should appear in

xpos :

the X position of child in window coordinates

ypos :

the Y position of child in window coordinates

The add_child_in_window() method adds the widget specified by child at the fixed coordinates specified by xpos and ypos in one of the text widget's windows specified by which_window. The window must have nonzero size (see the set_border_window_size() method).

Note

The child coordinates are given relative to the gtk.gdk.Window specified by which_window, and these coordinates have no sane relationship to scrolling. When placing child in a gtk.TEXT_WINDOW_WIDGET window, scrolling is irrelevant, child floats above all scrollable areas. However, placing child in one of the scrollable windows (a border windows or the text window), you'll need to compute the correct position of child in textbuffer coordinates any time scrolling occurs or textbuffer changes occur, and then call the move_child() method to update the child's position. Unfortunately there's no good way to detect that scrolling has occurred, using the current API; a possible hack would be to update all child positions when the scroll adjustments change or the text buffer changes.

gtk.TextView.move_child

    def move_child(child, xpos, ypos)

child :

a child widget in the textview

xpos :

the new X position in window coordinates

ypos :

the new Y position in window coordinates

The move_child() method moves the position of child to the location (in its current window) specified by xpos and ypos.

gtk.TextView.set_wrap_mode

    def set_wrap_mode(wrap_mode)

wrap_mode :

a wrap mode value

The set_wrap_mode() method sets the "wrap-mode" property of the textview to the value specified by wrap_mode. The value of wrap_mode can be one of: gtk.WRAP_NONE, gtk.WRAP_CHAR, gtk.WRAP_WORD or gtk.WRAP_WORD_CHAR. The "wrap-mode" property defines the wrap mode for text that is not influenced by a gtk.TextTag that sets its "wrap_mode" attribute.

gtk.TextView.get_wrap_mode

    def get_wrap_mode()

Returns :

the line wrap setting

The get_wrap_mode() method returns the value of the "wrap-mode" property. The value of "wrap-mode" can be one of: gtk.WRAP_NONE, gtk.WRAP_CHAR or gtk.WRAP_WORD. The "wrap-mode" property defines the wrap mode for text that is not influenced by a gtk.TextTag that sets its "wrap_mode" attribute.

gtk.TextView.set_editable

    def set_editable(setting)

setting :

if True the text is editable by default

The set_editable() method sets the "editable" property to the value of setting. If setting is True the text in textview is editable by default. The "editable" property determines the editability of the gtk.TextView text that is not influenced by a gtk.TextTag that sets its "editable" attribute.

gtk.TextView.get_editable

    def get_editable()

Returns :

True if text is editable by default

The get_editable() method returns the value of the "editable" property. The "editable" property determines the editability of the gtk.TextView text that is not influenced by a gtk.TextTag that sets its "editable" attribute.

gtk.TextView.set_overwrite

    def set_overwrite(overwrite)

overwrite :

if True turn on overwrite mode; if False turn it off

Note

This method is available in PyGTK 2.4 and above.

The set_overwrite() method sets the "overwrite" property to the value of overwrite. If overwrite is True, inserted text overwrites the existing text.

gtk.TextView.get_overwrite

    def get_overwrite()

Returns :

True if the textview is in overwrite mode

Note

This method is available in PyGTK 2.4 and above.

The get_overwrite() method returns the value of the "overwrite" property. see the set_overwrite() method for more information.

gtk.TextView.set_accepts_tab

    def set_accepts_tab(accepts_tab)

accepts_tab :

if True pressing the Tab key should insert a tab character; if False, pressing the Tab key should move the keyboard focus.

Note

This method is available in PyGTK 2.4 and above.

The set_accepts_tab() method sets the "accepts_tab" property to the value of accepts_tab. If accepts_tab is True a tab character is inserted. If accepts_tab is False the keyboard focus is moved to the next widget in the focus chain.

gtk.TextView.get_accepts_tab

    def get_accepts_tab()

Returns :

True if pressing the Tab key inserts a tab character, False if pressing the Tab key moves the keyboard focus.

Note

This method is available in PyGTK 2.4 and above.

The get_accepts_tab() method returns the value of the "accepts_tab" property. See the set_accepts_tab() method for more information.

gtk.TextView.set_pixels_above_lines

    def set_pixels_above_lines(pixels_above_lines)

pixels_above_lines :

the number of pixels above paragraphs

The set_pixels_above_lines() method sets the "pixels-above-lines" property to the value of pixels_above_lines. The "pixels-above-lines" property determines the number of blank pixels to place above textbuffer lines (paragraphs) in the textview for text that is not influenced by a gtk.TextTag that sets its "pixels-above-lines" attribute.

gtk.TextView.get_pixels_above_lines

    def get_pixels_above_lines()

Returns :

the default number of pixels above paragraphs

The get_pixels_above_lines() method returns the value of the "pixels-above-lines" property. The "pixels-above-lines" property determines the number of pixels to put above textbuffer lines (paragraphs) in the textview for text that is not influenced by a gtk.TextTag that sets its "pixels-above-lines" attribute.

gtk.TextView.set_pixels_below_lines

    def set_pixels_below_lines(pixels_below_lines)

pixels_below_lines :

the default number of pixels below paragraphs

The set_pixels_below_lines() method sets the "pixels-below-lines" property to the value of pixels_below_lines. The "pixels-below-lines" property determines the number of blank pixels to place below textbuffer lines (paragraphs) in the textview for text that is not influenced by a gtk.TextTag that sets its "pixels-below-lines" attribute.

gtk.TextView.get_pixels_below_lines

    def get_pixels_below_lines()

Returns :

the default number of blank pixels below paragraphs

The get_pixels_below_lines() method returns the value of the "pixels-below-lines" property. The "pixels-below-lines" property determines the number of pixels to put below textbuffer lines (paragraphs) in the textview for text that is not influenced by a gtk.TextTag that sets its "pixels-below-lines" attribute.

gtk.TextView.set_pixels_inside_wrap

    def set_pixels_inside_wrap(pixels_inside_wrap)

pixels_inside_wrap :

the default number of pixels between wrapped lines

The set_pixels_inside_wrap() method sets the "pixels-inside_wrap" property to the value of pixels_inside_wrap. The "pixels-inside_wrap" property determines the number of blank pixels to place between wrapped textbuffer lines (inside paragraphs) for text that is not influenced by a gtk.TextTag that sets its "pixels-inside_wrap" attribute.

gtk.TextView.get_pixels_inside_wrap

    def get_pixels_inside_wrap()

Returns :

the default number of pixels of blank space between wrapped lines

The get_pixels_inside_wrap() method returns the value of the "pixels-inside-wrap" property. The "pixels-inside-wrap" property determines the number of pixels to put between wrapped textbuffer lines (inside paragraphs) for text that is not influenced by a gtk.TextTag that sets its "pixels-inside-wrap" attribute.

gtk.TextView.set_justification

    def set_justification(justification)

justification :

the text justification

The set_justification() method sets the "justification" property to the value of justification. The value of justification must be one of: gtk.JUSTIFY_LEFT, gtk.JUSTIFY_RIGHT, gtk.JUSTIFY_CENTER or gtk.JUSTIFY_FILL. The "justification" property determines the justification of text in the textview that is not influenced by a gtk.TextTag that set its "justification" attribute.

gtk.TextView.get_justification

    def get_justification()

Returns :

the default justification

The get_justification() method returns the value of the "justification" property. the default justification of paragraphs in text_view. The value of "justification" must be one of: gtk.JUSTIFY_LEFT, gtk.JUSTIFY_RIGHT, gtk.JUSTIFY_CENTER or gtk.JUSTIFY_FILL. The "justification" property determines the justification of text in the textview that is not influenced by a gtk.TextTag that set its "justification" attribute.

gtk.TextView.set_left_margin

    def set_left_margin(left_margin)

left_margin :

the default left margin in pixels

The set_left_margin() method sets the "left-margin" property to the value of left_margin. The "left-margin"property determines the number of pixels of space for the left margin of text that is not influenced by a gtk.TextTag that sets its "left_margin" attribute.

gtk.TextView.get_left_margin

    def get_left_margin()

Returns :

the default left margin in pixels

The get_left_margin() method returns the value of the "left_margin" property. The "left-margin"property determines the number of pixels of space for the left margin of text that is not influenced by a gtk.TextTag that sets its "left_margin" attribute.

gtk.TextView.set_right_margin

    def set_right_margin(right_margin)

right_margin :

the default right margin in pixels

The set_right_margin() method sets the "right-margin" property to the value of right_margin. The "right-margin"property determines the number of pixels of space for the right margin of text that is not influenced by a gtk.TextTag that sets its "right_margin" attribute.

gtk.TextView.get_right_margin

    def get_right_margin()

Returns :

the default right margin in pixels

The get_right_margin() method returns the value of the "right_margin" property. The "right-margin"property determines the number of pixels of space for the right margin of text that is not influenced by a gtk.TextTag that sets its "right_margin" attribute.

gtk.TextView.set_indent

    def set_indent(indent)

indent :

the default indentation in pixels

The set_indent() method sets the "indent" property to the value of indent. The "indent" property determines the indentation for textview paragraphs that are not influenced by a gtk.TextTag that sets its "indent" attribute. The indentation may be negative.

gtk.TextView.get_indent

    def get_indent()

Returns :

the default number of pixels of indentation

The get_indent() method returns the value of the "indent" property. The "indent" property determines the indentation for textview paragraphs that are not influenced by a gtk.TextTag that sets its "indent" attribute. The indentation may be negative.

gtk.TextView.set_tabs

    def set_tabs(tabs)

tabs :

the default tabs as a pango.TabArray

The set_tabs() method sets the "tabs" property to a copy of the value of tabs. The "tabs" property contains the custom tab stops for the textview paragraphs that are not influenced by a gtk.TextTag that sets its "tabs" attribute.

gtk.TextView.get_tabs

    def get_tabs()

Returns :

a copy of default tab array, or None if "standard" tabs are used

The get_tabs() method returns the value of the "tabs" property. The "tabs" property contains the custom tab stops for the textview paragraphs that are not influenced by a gtk.TextTag that sets its "tabs" attribute. The returned value will be None if "standard" (8-space) tabs are used.

gtk.TextView.get_default_attributes

    def get_default_attributes()

Returns :

a new gtk.TextAttributes

The get_default_attributes() method returns a copy of the default gtk.TextAttributes. These attributes are used for text unless the text is influenced by a gtk.TextTag. You'd typically pass the default attributes in to the gtk.TextIter.get_attributes() method to get the attributes in effect at a given text position.

Signals

The "backspace" gtk.TextView Signal

    def callback(textview, user_param1, ...)

textview :

the object which received the signal.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.10 and above.

The "backspace" signal is emitted when the Backspace key is pressed.

The "copy-clipboard" gtk.TextView Signal

    def callback(textview, user_param1, ...)

textview :

the textview that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "copy-clipboard" signal is emitted when a selection is copied to the clipboard from textview.

The "cut-clipboard" gtk.TextView Signal

    def callback(textview, user_param1, ...)

textview :

the textview that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "cut-clipboard" signal is emitted when a selection is cut from textview to the clipboard.

The "delete-from-cursor" gtk.TextView Signal

    def callback(textview, delete_type, count, user_param1, ...)

textview :

the textview that received the signal

delete_type :

the type of deletion

count :

the number of deletions to do

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "delete-from-cursor" signal is emitted when a deletion of the type specified by delete_type is initiated by user action (e.g. pressing the Delete or Backspace keys). The value of delete_type must be one of:

  • gtk.DELETE_CHARS
  • gtk.DELETE_WORD_ENDS
  • gtk.DELETE_WORDS
  • gtk.DELETE_DISPLAY_LINES
  • gtk.DELETE_DISPLAY_LINE_ENDS
  • gtk.DELETE_PARAGRAPH_ENDS
  • gtk.DELETE_PARAGRAPHS
  • gtk.DELETE_WHITESPACE

count specifies the number of times that deletion should be applied.

The "insert-at-cursor" gtk.TextView Signal

    def callback(textview, string, user_param1, ...)

textview :

the textview that received the signal

string :

the text to be inserted

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "insert-at-cursor" signal is emitted when string is being inserted in textview.

The "move-cursor" gtk.TextView Signal

    def callback(textview, step_size, count, extend_selection, user_param1, ...)

textview :

the textview that received the signal

step_size :

the step size to move

count :

the number of steps to move

extend_selection :

if True extend the selection

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "move-cursor" signal is emitted when the cursor is moved by count steps of step_size. If extend_selection is True the selection is extended by the cursor movement. The value of step_size must be one of:

gtk.MOVEMENT_LOGICAL_POSITIONS

move by graphemes

gtk.MOVEMENT_VISUAL_POSITIONS

move by graphemes

gtk.MOVEMENT_WORDS

move by words

gtk.MOVEMENT_DISPLAY_LINES

move by lines(wrapped lines)

gtk.MOVEMENT_DISPLAY_LINE_ENDS

move to line ends(wrapped lines)

gtk.MOVEMENT_PARAGRAPHS

move by paragraphs(newline-ended lines)

gtk.MOVEMENT_PARAGRAPH_ENDS

move to ends of a paragraph

gtk.MOVEMENT_PAGES

move by pages

gtk.MOVEMENT_BUFFER_ENDS

move to ends of the buffer

The "move-focus" gtk.TextView Signal

    def callback(textview, direction, user_param1, ...)

textview :

the textview that received the signal

direction :

the direction to move the focus

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "move-focus" signal is emitted when the focus moves from textview in the direction specified by direction that must be one of: gtk.DIR_TAB_FORWARD, gtk.DIR_TAB_BACKWARD, gtk.DIR_UP, gtk.DIR_DOWN, gtk.DIR_LEFT or gtk.DIR_RIGHT

The "move-viewport" gtk.TextView Signal

    def callback(textview, scrollstep, count, user_param1, ...)

textview :

the textview that received the signal

scrollstep :

the size of the scroll step: gtk.SCROLL_STEPS, gtk.SCROLL_PAGES, gtk.SCROLL_ENDS, gtk.SCROLL_HORIZONTAL_STEPS, gtk.SCROLL_HORIZONTAL_PAGES or gtk.SCROLL_HORIZONTAL_ENDS

count :

the number of scroll steps of size scrollstep to take

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.4 and above.

The "move-viewport" signal is emitted when the viewport is being moved usually as the result of user action in moving the cursor or using the scrollbars.

The "page-horizontally" gtk.TextView Signal

    def callback(textview, count, extend_selection, user_param1, ...)

textview :

the textview that received the signal

count :

the number of pages to move

extend_selection :

if True extend the selection

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "page-horizontally" signal is emitted when user initiates horizontal paging by pressing one of the key combinations:

Control+Page Up

Page horizontally with extend_selection set to False

Shift+Control+Page Up

Page horizontally with extend_selection set to True

The "paste-clipboard" gtk.TextView Signal

    def callback(textview, user_param1, ...)

textview :

the textview that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "paste-clipboard" signal is emitted when the contents of the clipboard are pasted into textview.

The "populate-popup" gtk.TextView Signal

    def callback(textview, menu, user_param1, ...)

textview :

the textview that received the signal

menu :

the menu to populate

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "populate-popup" signal is emitted when the popup menu (specified by menu) associated with textview needs to be populated.

The "select-all" gtk.TextView Signal

    def callback(textview, select, user_param1, ...)

textview :

the textview that received the signal

select :

if True select the buffer contents; otherwise deselect the buffer contents

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Note

This signal is available in GTK+ 2.2 and above.

The "select-all" signal is emitted when the user presses one of:

  • Control+a or Control+/ to select all text in a buffer
  • Control+\ to deselect all text in a buffer

The "set-anchor" gtk.TextView Signal

    def callback(textview, user_param1, ...)

textview :

the textview that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "set-anchor" signal is emitted when an application calls the GObject.emit()() method on textview with "set-anchor" as the signal.

The "set-scroll-adjustments" gtk.TextView Signal

    def callback(textview, hadjustment, vadjustment, user_param1, ...)

textview :

the textview that received the signal

hadjustment :

the horizontal adjustment

vadjustment :

the vertical adjustment

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "set-scroll-adjustments" signal is emitted when one or both adjustments (specified by hadjustment and vadjustment) are set on textview.

The "toggle-overwrite" gtk.TextView Signal

    def callback(textview, user_param1, ...)

textview :

the textview that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "toggle-overwrite" signal is emitted when the user presses the Insert key.

Prev Up Next
gtk.TextTagTable Home gtk.ToggleAction
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkscrolledwindow.html0000644000000000000000000013105011272037113025362 0ustar rootrootgtk.ScrolledWindow
gtk.ScrolledWindow
Prev The gtk Class Reference Next

gtk.ScrolledWindow

gtk.ScrolledWindow — adds scrollbars to its child widget.

Synopsis

class gtk.ScrolledWindow(gtk.Bin):
    gtk.ScrolledWindow(hadjustment=None, vadjustment=None)
    def set_hadjustment(hadjustment)
    def set_vadjustment(vadjustment)
    def get_hadjustment()
    def get_vadjustment()
    def get_hscrollbar()
    def get_vscrollbar()
    def set_policy(hscrollbar_policy, vscrollbar_policy)
    def get_policy(hscrollbar_policy, vscrollbar_policy)
    def set_placement(window_placement)
    def get_placement()
    def set_shadow_type(type)
    def get_shadow_type()
    def add_with_viewport(child)

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.ScrolledWindow

Implemented Interfaces

gtk.ScrolledWindow implements gtk.Buildable

gtk.ScrolledWindow Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"hadjustment"Read-Write-ConstructThe gtk.Adjustment for the horizontal position.
hscrollbar-policy""Read-WriteThe horizontal scrollbar display policy; one of: gtk.POLICY_ALWAYS, gtk.POLICY_AUTOMATIC or gtk.POLICY_NEVER.
"shadow-type"Read-WriteThe style of bevel around the contents; one of: gtk.SHADOW_NONE, gtk.SHADOW_IN, gtk.SHADOW_OUT, gtk.SHADOW_ETCHED_IN, gtk.SHADOW_ETCHED_OUT.
"vadjustment"Read-Write-ConstructThe gtk.Adjustment for the vertical position.
"vscrollbar-policy"Read-WriteThe vertical scrollbar display policy; one of: gtk.POLICY_ALWAYS, gtk.POLICY_AUTOMATIC or gtk.POLICY_NEVER.
"window-placement"Read-WriteWhere the contents are located with respect to the scrollbars; one of: gtk.CORNER_TOP_LEFT, gtk.CORNER_BOTTOM_LEFT, gtk.CORNER_TOP_RIGHT, gtk.CORNER_BOTTOM_RIGHT.
"window-placement-set"Read-WriteIf True "window-placement" should be used to determine the location of the contents with respect to the scrollbars.

gtk.ScrolledWindow Style Properties

gtk.Widget Style Properties

"scrollbar-spacing"ReadThe number of pixels between the scrollbars and the scrolled window. Available in GTK+ 2.2 and above.
"scrollbar-within-bevel"ReadWhether to place scrollbars within the scrolled window's bevel. Default value: False Available in GTK+ 2.12 and above.

gtk.ScrolledWindow Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

"move-focus-out"

 def callback(scrolledwindow, direction, user_param1, ...)

"scroll-child"

 def callback(scrolledwindow, scrolltype, horizontal, user_param1, ...)

Description

A gtk.ScrolledWindow is a subclass of gtk.Bin that adds scrollbars to a single child widget and optionally draws a beveled frame around the child widget. The scrolled window can work in two ways:

  • Some widgets have native scrolling support using "slots" to hold gtk.Adjustment objects. Widgets with native scroll support include gtk.TreeView, gtk.TextView, and gtk.Layout.
  • Widgets that lack native scrolling support use the gtk.Viewport widget that acts as an adapter class, implementing scrollability for child widgets that lack their own scrolling capabilities. Use gtk.Viewport to scroll child widgets such as gtk.Table, gtk.Box, and so on.

If a widget has native scrolling abilities, it can be added to the gtk.ScrolledWindow with the gtk.Container.add() method. If a widget does not, you must first add the widget to a gtk.Viewport, then add the gtk.Viewport to the scrolled window. The convenience method add_with_viewport() does exactly this, so you can ignore the presence of the viewport.

The position of the scrollbars is controlled by the scroll adjustments. The gtk.ScrolledWindow uses the attributes in an adjustment (see gtk.Adjustment) as follows:

  • the adjustment.lower attribute is the minimum value of the scroll region
  • the adjustment.upper attribute is the maximum value of the scroll region
  • the adjustment.value attribute represents the position of the scrollbar, which must be between adjustment.lower and adjustment.upper - adjustment.page_size
  • the adjustment.page_size attribute represents the size of the visible scrollable area
  • the adjustment.step_increment attribute is the distance to scroll when the small stepper arrows are clicked
  • the adjustment.page_increment attribute is the distance to scroll when the Page Up or Page Down keys are pressed

If a gtk.ScrolledWindow doesn't behave quite as you would like, or doesn't have exactly the right layout, it's very possible to set up your own scrolling with gtk.Scrollbar and for example a gtk.Table.

Constructor

    gtk.ScrolledWindow(hadjustment=None, vadjustment=None)

hadjustment :

the horizontal gtk.Adjustment or None

vadjustment :

a vertical gtk.Adjustment or None

Returns :

a new gtk.ScrolledWindow widget

Creates a new scrolled window with the horizontal and vertical gtk.Adjustment specified by hadjustment and vadjustment respectively. These will be shared with the scrollbars and the child widget to keep the bars in sync with the child. If hadjustment and vadjustment are None or not specified the scrolled window will create them for you.

Methods

gtk.ScrolledWindow.set_hadjustment

    def set_hadjustment(hadjustment)

hadjustment :

the horizontal gtk.Adjustment

The set_hadjustment() method sets the horizontal adjustment (and the "hadjustment" property) to the value of hadjustment. hadjustment must be a gtk.Adjustment.

gtk.ScrolledWindow.set_vadjustment

    def set_vadjustment(vadjustment)

vadjustment :

the vertical gtk.Adjustment

The set_vadjustment() method sets the vertical adjustment (and the "vadjustment" property) to the value of vadjustment. vadjustment must be a gtk.Adjustment.

gtk.ScrolledWindow.get_hadjustment

    def get_hadjustment()

Returns :

the horizontal gtk.Adjustment

The get_hadjustment() method returns the value of the "hadjustment" property which is a reference to the horizontal adjustment.

gtk.ScrolledWindow.get_vadjustment

    def get_vadjustment()

Returns :

the vertical gtk.Adjustment

The get_vadjustment() method returns the value of the "vadjustment" property which is a reference to the vertical adjustment.

gtk.ScrolledWindow.get_hscrollbar

    def get_hscrollbar()

Returns :

The horizontal scrollbar of the scrolled window or None if it does not exist.

Note

This method is available in PyGTK 2.8 and above.

The get_hscrollbar() method returns the gtk.HScrollbar for the scrolled window or None if there is no horizontal scrollbar.

gtk.ScrolledWindow.get_vscrollbar

    def get_vscrollbar()

Returns :

The vertical scrollbar of the scrolled window or None if it does not exist.

Note

This method is available in PyGTK 2.8 and above.

The get_vscrollbar() method returns the gtk.VScrollbar for the scrolled window or None if there is no vertical scrollbar.

gtk.ScrolledWindow.set_policy

    def set_policy(hscrollbar_policy, vscrollbar_policy)

hscrollbar_policy :

the policy for the horizontal scrollbar

vscrollbar_policy :

the policy for the vertical scrollbar

The set_policy() method sets the "hscrollbar_policy" and "vscrollbar_policy" properties to the value of hscrollbar_policy and vscrollbar_policy respectively. The policy determines when the scrollbar should be displayed. The policy value is one of:

gtk.POLICY_ALWAYS

the scrollbar is always present

gtk.POLICY_AUTOMATIC

the scrollbar is present only if needed i.e. the contents are larget than the window

gtk.POLICY_NEVER

the scrollbar is never present

gtk.ScrolledWindow.get_policy

    def get_policy()

Returns> :

a tuple containing the horizontal and vertical scrollbar policies

The get_policy() method returns a tuple containing the horizontal and vertical scrollbar policies. See the set_policy() method for more detail.

gtk.ScrolledWindow.set_placement

    def set_placement(window_placement)

window_placement :

the placement of the contents with respect to the scrollbars

The set_placement() method sets the "window-placement" property to the value specified by window_placement. The window placement determines the location of the child widget with respect to the scrollbars. window_placement must be one of:

gtk.CORNER_TOP_LEFT

Place the scrollbars on the right and bottom of the widget (default behavior).

gtk.CORNER_BOTTOM_LEFT

Place the scrollbars on the top and right of the widget.

gtk.CORNER_TOP_RIGHT

Place the scrollbars on the left and bottom of the widget.

gtk.CORNER_BOTTOM_RIGHT

Place the scrollbars on the top and left of the widget.

gtk.ScrolledWindow.get_placement

    def get_placement()

Returns :

the current placement value.

The get_placement() method returns the value of the "window-placement" property that determines the placement of the scrollbars with respect to the scrolled window. See the set_placement() method for more detail.

gtk.ScrolledWindow.set_shadow_type

    def set_shadow_type(type)

type :

the kind of bevel shadow to draw around the scrolled window contents

The set_shadow_type() method sets the value of the "shadow-type" property to the value of shadow_type. shadow_type determines the type of bevel shadow drawn around the contents of the scrolled window. The shadow type must be one of:

gtk.SHADOW_NONE

No outline.

gtk.SHADOW_IN

The outline is beveled inward.

gtk.SHADOW_OUT

The outline is beveled outward.

gtk.SHADOW_ETCHED_IN

The outline is an inward etched bevel.

gtk.SHADOW_ETCHED_OUT

The outline is an outward etched bevel.

gtk.ScrolledWindow.get_shadow_type

    def get_shadow_type()

Returns :

the current shadow type

The get_shadow_type() method returns the value of the "shadow-type" property that determines the shadow type of the scrolled window. See the set_shadow_type() method for more detail.

gtk.ScrolledWindow.add_with_viewport

    def add_with_viewport(child)

child :

the widget to be scrolled

The add_with_viewport() method is used to add a widget (specified by child) without native scrolling capabilities to the scrolled window. This is a convenience function that is equivalent to adding child to a gtk.Viewport, then adding the viewport to the scrolled window. If a child has native scrolling (e.g. gtk.TextView, gtk.TreeView, gtk.Layout), use gtk.Container.add() instead of this method.

The viewport scrolls the child by moving its gtk.gdk.Window, and takes the size of the child to be the size of its toplevel gtk.gdk.Window. This will be wrong for most widgets that support native scrolling. For example, if you add a widget such as gtk.TreeView with a viewport, the whole widget will scroll, including the column headings.

Signals

The "move-focus-out" gtk.ScrolledWindow Signal

    def callback(scrolledwindow, direction, user_param1, ...)

scrolledwindow :

the scrolledwindow that received the signal

direction :

the direction that the focus is moving either gtk.DIR_TAB_FORWARD or gtk.DIR_TAB_BACKWARD.

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "move-focus-out" signal is emitted when the user presses Control+Tab or Control+Shift+Tab to move the focus out of the scrolled window. The direction is either gtk.DIR_TAB_FORWARD or gtk.DIR_TAB_BACKWARD

The "scroll-child" gtk.ScrolledWindow Signal

    def callback(scrolledwindow, scrolltype, horizontal, user_param1, ...)

scrolledwindow :

the scrolledwindow that received the signal

scrolltype :

the scroll type; one of: gtk.SCROLL_STEP_BACKWARD, gtk.SCROLL_STEP_FORWARD, gtk.SCROLL_PAGE_BACKWARD, gtk.SCROLL_PAGE_FORWARD, gtk.SCROLL_PAGE_UP, gtk.SCROLL_PAGE_DOWN, gtk.SCROLL_START or gtk.SCROLL_END.

horizontal :

if True scroll in the horizontal direction

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "scroll-child" signal is emitted when the child widget is being scrolled by a keyboard action. The default key bindings with resulting scrolltype and horizontal arguments are:

Control+Left Arrow

gtk.SCROLL_STEP_BACKWARD - horizontal

Control+Right Arrow

gtk.SCROLL_STEP_FORWARD - horizontal

Control+Up Arrow

gtk.SCROLL_STEP_BACKWARD - vertical

Control+Down Arrow

gtk.SCROLL_STEP_FORWARD - vertical

Control+Page Up

gtk.SCROLL_PAGE_BACKWARD - horizontal

Control+Page Down

gtk.SCROLL_PAGE_FORWARD - horizontal

Page Up

gtk.SCROLL_PAGE_BACKWARD - vertical

Page Down

gtk.SCROLL_PAGE_FORWARD - vertical

Control+Home

gtk.SCROLL_START - horizontal

Control+End

gtk.SCROLL_END - horizontal

Home

gtk.SCROLL_START - vertical

End

gtk.SCROLL_END - vertical

Prev Up Next
gtk.Scrollbar Home gtk.SelectionData
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkeditable.html0000644000000000000000000006666711272037113024121 0ustar rootrootgtk.Editable
gtk.Editable
Prev The gtk Class Reference Next

gtk.Editable

gtk.Editable — an interface for text-editing widgets.

Synopsis

class gtk.Editable(gobject.GInterface):
    def select_region(start, end)
    def get_selection_bounds()
    def insert_text(text, position=0)
    def delete_text(start_pos, end_pos)
    def get_chars(start_pos, end_pos)
    def cut_clipboard()
    def copy_clipboard()
    def paste_clipboard()
    def delete_selection()
    def set_position(position)
    def get_position()
    def set_editable(is_editable)
    def get_editable()

gtk.Editable Signal Prototypes

"changed"

 def callback(editable, user_param1, ...)

"delete-text"

 def callback(editable, start, end, user_param1, ...)

"insert-text"

 def callback(editable, new_text, new_text_length, position, user_param1, ...)

Description

gtk.Editable is an interface for text editing widgets, such as gtk.Entry. The editable class contains methods for generically manipulating an editable widget, a large number of action signals used for key bindings, and several signals that an application can connect to to modify the behavior of a widget.

Methods

gtk.Editable.select_region

    def select_region(start, end)

start :

the new start position of the selection

end :

the new end position of the selection

The select_region() method selects a region of text from start up to, but not including end. If end is negative, then the selection will run from start to the end of the text.

gtk.Editable.get_selection_bounds

    def get_selection_bounds()

Returns :

a tuple containing the start and end positions of the selection or an empty tuple if there is no selection

The get_selection_bounds() method returns a tuple that contains the start and end positions of the selection if any or an empty tuple if there is no selection.

gtk.Editable.insert_text

    def insert_text(text, position=0)

text :

the text to be inserted

position :

the position where the text should be inserted

The insert_text() method inserts the string specified by text at the location specified by position.

gtk.Editable.delete_text

    def delete_text(start_pos, end_pos)

start_pos :

the start position of the text to delete

end_pos :

the end position of the text to delete

The delete_text() method deletes a sequence of characters starting from start_pos up to, but not including end_pos. If end_pos is negative, then the characters deleted will be those characters from start_pos to the end of the text.

gtk.Editable.get_chars

    def get_chars(start_pos, end_pos)

start_pos :

the start position

end_pos :

the end position

Returns :

a string containing the characters from start to end

The get_chars() method retrieves a string of characters starting from start_pos up to, but not including end_pos. If end_pos is negative, then all the characters from start_pos to the end of the text are retrieved.

gtk.Editable.cut_clipboard

    def cut_clipboard()

The cut_clipboard() method copies the characters in the current selection to the clipboard and then deletes them from the widget.

gtk.Editable.copy_clipboard

    def copy_clipboard()

The copy_clipboard() method copies the characters in the current selection to the clipboard

gtk.Editable.paste_clipboard

    def paste_clipboard()

The paste_clipboard() method copies the contents of the clipboard to the widget at the cursor position.

gtk.Editable.delete_selection

    def delete_selection()

The delete_selection() method deletes the characters in the selection and releases the selection ownership

gtk.Editable.set_position

    def set_position(position)

position :

the new cursor position

The set_position() method sets the cursor position to be just before the character at the location specified by position. If position is less than 0 or greater than the number of characters in the widget the cursor is positioned after the last character in the widget. Note position is in characters not bytes.

gtk.Editable.get_position

    def get_position()

Returns :

the cursor position

The get_position() method retrieves the cursor position as a character index starting from 0. If the cursor is after the last character the position will equal the number of characters in the widget. Note position is in characters not bytes.

gtk.Editable.set_editable

    def set_editable(is_editable)

is_editable :

if True the text can be edited

The set_editable() method sets the widget "editable" attribute of the widget to the value specified by is_editable. If is_editable is True the text can be edited; if False, the text cannot be edited.

gtk.Editable.get_editable

    def get_editable()

Returns :

True if the text is editable.

The get_editable() method retrieves the value of the widget "editable" attribute that specifies whether the text is editable. See set_editable().

Signals

The "changed" gtk.Editable Signal

    def callback(editable, user_param1, ...)

editable :

the editable that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "changed" signal is emitted when the contents of the widget have changed.

The "delete-text" gtk.Editable Signal

    def callback(editable, start, end, user_param1, ...)

editable :

the editable that received the signal

start :

the start position

end :

the end position

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "delete-text" signal is emitted when text is deleted from the widget by the user. The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with the gobject.stop_emission() method, it is possible to prevent it from being deleted. The start and end parameters are interpreted as for delete_text()

The "insert-text" gtk.Editable Signal

    def callback(editable, new_text, new_text_length, position, user_param1, ...)

editable :

the editable that received the signal

new_text :

the string that is being inserted

new_text_length :

the length of the new text

position :

a pointer to the location at which the new text will be inserted

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "insert-text" signal is emitted when text is inserted into the widget by the user. The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with the gobject.stop_emission() method, it is possible to prevent it from being inserted entirely. The position parameter is a gobject.GPointer object containing a pointer to the insertion position - there is no way to access the position value from PyGTK.

Prev Up Next
gtk.DrawingArea Home gtk.Entry
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtktoolbutton.html0000644000000000000000000010550211272037113024537 0ustar rootrootgtk.ToolButton
gtk.ToolButton
Prev The gtk Class Reference Next

gtk.ToolButton

gtk.ToolButton — a gtk.ToolItem subclass that displays buttons (new in PyGTK 2.4)

Synopsis

class gtk.ToolButton(gtk.ToolItem):
    gtk.ToolButton(icon_widget=None, label=None)
    gtk.ToolButton(stock_id)
    def set_label(label)
    def get_label()
    def set_use_underline(use_underline)
    def get_use_underline()
    def set_stock_id(stock_id)
    def get_stock_id()
    def set_icon_name(icon_name)
    def get_icon_name()
    def set_icon_widget(icon_widget)
    def get_icon_widget()
    def set_label_widget(label_widget)
    def get_label_widget()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.ToolItem
            +-- gtk.ToolButton

Implemented Interfaces

gtk.ToolButton implements gtk.Buildable

gtk.ToolButton Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

gtk.ToolItem Properties

"icon-name"Read-WriteThe themed icon name to display in the item. This property only has an effect if not overridden by "label", "icon-widget" or "stock-id" properties. Default value: None. Available in GTK+ 2.8 and above.
"icon-widget"Read-WriteThe icon widget to display in the item. Default value: None.
"label"Read-WriteThe text to show in the item. Default value: None.
"label-widget"Read-WriteThe widget to use as the item label instead of "label". Default value: None.
"stock-id"Read-WriteThe stock icon displayed on the item if "label" and "label-widget" are None. Default value: None.
"use-underline"Read-WriteIf True, an underline in the "label" property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu. Default value: False.

gtk.ToolButton Style Properties

gtk.Widget Style Properties

"icon-spacing"Read-WriteSpacing in pixels between the icon and label

gtk.ToolButton Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

gtk.ToolItem Signal Prototypes

Signal Prototypes

"clicked"

 def callback(toolbutton, user_param1, ...)

Description

Note

This widget is available in PyGTK 2.4 and above.

A gtk.ToolButton is a sub class of gtk.ToolItem that contains a button. Use the gtk.ToolButton() constructor to create a new gtk.ToolButton specifying a widget to use as the icon and a label for the text. Alternatively use the other gtk.ToolButton() constructor to create a gtk.ToolButton from a stock item.

The label of a gtk.ToolButton is determined by the properties "label_widget", "label", and "stock_id". If "label_widget" specifies a gtk.Widget, that widget is used as the label. If "label-widget" is None, then the string in "label" is used as the label. If both "label-widget" and "label" are None, the label is determined by the stock item specified by "stock-id". Finally, if "label-widget", "label" and "stock-id" are all None, the button does not have a label.

The icon of a gtk.ToolButton is determined by the properties "icon-widget" and "stock-id". If "icon-widget" specifies a gtk.Widget, that widget is used as the icon. If "icon-widget" is None, the icon is determined by the stock item specified by "stock-id". If both "icon-widget" and "stock-id" are None, the button does not have an icon.

Constructor

gtk.ToolButton

    gtk.ToolButton(icon_widget=None, label=None)

icon_widget :

a gtk.Widget that will be used as the icon widget, or None

label :

a string that will be used as the label, or None

Returns :

A new gtk.ToolButton

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.ToolButton optionally using the icon specified by icon_widget and the label text specified by label. If both icon_widget and label are None, the tool button will be empty.

gtk.ToolButton

    gtk.ToolButton(stock_id)

stock_id :

a string that specifies a stock item

Returns :

A new gtk.ToolButton

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new gtk.ToolButton using the stock item specified by stock_id to determine the icon and label text. It is an error if stock_id is not a name of a stock item.

Methods

gtk.ToolButton.set_label

    def set_label(label)

label :

a string that will be used as label, or None.

Note

This method is available in PyGTK 2.4 and above.

The set_label() method sets the "label" property to the value of label. If the "label_widget" property is None, label will be used as the label of the tool button.

gtk.ToolButton.get_label

    def get_label()

Returns :

The label, or None

Note

This method is available in PyGTK 2.4 and above.

The get_label() method returns the value of the "label" property that is used as the label of the tool button if the "label-widget" property is None.

gtk.ToolButton.set_use_underline

    def set_use_underline(use_underline)

use_underline :

if True, an underline in the label string specifies a mnemonic key for the overflow menu

Note

This method is available in PyGTK 2.4 and above.

The set_use_underline() method sets the "use-underline" property to the value of use_underline. If use_underline is True, an underline in the "label" property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu. For example, if the label property is "_Open" and use_underline is True, the label on the tool button will be "Open" and the item on the overflow menu will have an underlined 'O'. Labels shown on tool buttons never have mnemonics on them; this property only affects the menu item on the overflow menu.

gtk.ToolButton.get_use_underline

    def get_use_underline()

Returns :

True if underscores in the "label" property are used as mnemonics on menu items on the overflow menu.

Note

This method is available in PyGTK 2.4 and above.

The get_use_underline() method returns the value of the "use-underline" property. If "use-underline" is True, underscores in the label property are used as mnemonics on menu items on the overflow menu. See the set_use_underline() method for more information.

gtk.ToolButton.set_stock_id

    def set_stock_id(stock_id)

stock_id :

a name of a stock item, or None

Note

This method is available in PyGTK 2.4 and above.

The set_stock_id() method sets the "stock-id" property to the value of stock_id. The stock item specified by stock_id is used to determine the icon and label if not overridden by the "label" and "icon-widget" properties. See the gtk.ToolButton() constructor for more information.

gtk.ToolButton.get_stock_id

    def get_stock_id()

Returns :

the name of the stock item.

Note

This method is available in PyGTK 2.4 and above.

The get_stock_id() method returns the value of the "stock-id" property that contains the name of a stock item or None. See the gtk.ToolButton() constructor for more information.

gtk.ToolButton.set_icon_name

    def set_icon_name(icon_name)

icon_name :

a name of a themed icon, or None

Note

This method is available in PyGTK 2.8 and above.

The set_icon_name() method sets the "icon-name" property to the value of icon_name. The themed icon name specified by icon_name is used to determine the icon for the toolbutton if not overridden by the "label", "stock-id" and "icon-widget" properties. See the gtk.ToolButton() constructor for more information.

In PyGTK 2.10 and above, icon_name may be None to unset the icon name.

gtk.ToolButton.get_icon_name

    def get_icon_name()

Returns :

the name of the stock item.

Note

This method is available in PyGTK 2.8 and above.

The get_icon_name() method returns the value of the "icon_name" property that contains the name of a themed icon or None. See the gtk.ToolButton() constructor for more information.

gtk.ToolButton.set_icon_widget

    def set_icon_widget(icon_widget)

icon_widget :

the widget used as icon, or None

Note

This method is available in PyGTK 2.4 and above.

The set_icon_widget() method sets the "icon-widget" property to the value of icon_widget. If icon_widget specifies a gtk.Widget, it is used as the icon of the tool button. If icon_widget is None the icon is determined by the "stock_id" property. If the "stock_id" property is also None, the tool button will not have an icon.

gtk.ToolButton.get_icon_widget

    def get_icon_widget()

Returns :

The widget used as icon on button, or None.

Note

This method is available in PyGTK 2.4 and above.

The get_icon_widget() method returns the value of the "icon-widget" property that contains the gtk.Widget used as the icon on the tool button. See the set_icon_widget() method for more information.

gtk.ToolButton.set_label_widget

    def set_label_widget(label_widget)

label_widget :

the widget used as the label, or None

Note

This method is available in PyGTK 2.4 and above.

The set_label_widget() method sets the "label-widget" property to the gtk.Widget specified by label_widget that will be used as the label for the tool button. If label_widget is None the "label" property is used as label. If "label-widget" and "label" are both None, the label in the stock item determined by the "stock_id" property is used as the label. If "label-widget", "label" and "stock_id" are all None, the tool button will not have a label.

gtk.ToolButton.get_label_widget

    def get_label_widget()

Returns :

The widget used as label on button, or None.

Note

This method is available in PyGTK 2.4 and above.

The get_label_widget() method returns the value of the "label-widget" property that is used as the label on the tool button. See the gtk.ToolButton.set_label_widget() method for more information.

Signals

The "clicked" gtk.ToolButton Signal

    def callback(toolbutton, user_param1, ...)

toolbutton :

the toolbutton that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "clicked" signal is emitted when the tool button is clicked with the mouse or activated with the keyboard.

Prev Up Next
gtk.Toolbar Home gtk.ToolItem
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-pangolanguage.html0000644000000000000000000003175011272037113024433 0ustar rootrootpango.Language
pango.Language
Prev The pango Class Reference Next

pango.Language

pango.Language — an object that represents a language tag.

Synopsis

class pango.Language(gobject.GBoxed):
    pango.Language(language)
    def matches(range_list)
    def to_string()
Functions

    def pango.pango_language_from_string(language)
    def pango.pango_language_matches(language, range_list)

Description

A pango.Language object represents a language tag meeting the RFC-3066 standard. The pango.Language can be retrieved from a pango.Context by using the pango.Context.get_language() method or created using the pango.Language() constructor. Example RFC-3066 language tags include: "en-us", "fr", and "sgn-us-ma".

Constructor

    pango.Language(language>)

language :

a string representing a language tag

Returns :

a new pango.Language object

Note

This constructor is available in PyGTK 2.4 and above.

Creates a new pango.Language object from the RFC-3066 language tag specified by language. This constructor first canonicalizes the string in language by converting it to lowercase, mapping '_' to '-', and stripping all characters other than letters and '-'.

Methods

pango.Language.matches

    def matches(range_list)

>range_list :

a list of language ranges, separated by ';' characters.

Returns :

True if a match was found.

Note

This method is available in PyGTK 2.4 and above.

The matches() method returns True if the language matches one of the language ranges in the list specified by range_list.A language tag is considered to match a range in the list if

  • the range is '*'
  • the range is exactly the same as the tag, or
  • the range is a prefix of the tag, and the character after the matching portion of the tag is '-'

each range must either be '*', or a canonicalized RFC-3066 language range (see the pango.Language() constructor for more information).

pango.Language.matches

    def to_string()

Returns :

the string representation of the language tag

Note

This method is available in PyGTK 2.4 and above.

The to_string() method returns a string representation of the canonicalized language tag. See the pango.Language() constructor for more information.

Functions

pango.pango_language_from_string

    def pango.pango_language_from_string(language)

language :

a string representing a language tag

Returns :

a new pango.Language object

Note

This function is deprecated in PyGTK 2.4 and above. Use the pango.Language() constructor instead.

The pango.pango_language_from_string() function takes a RFC-3066 format language tag as a string (specified by language) and converts it to a pango.Language object. This function first canonicalizes the string by converting it to lowercase, mapping '_' to '-', and stripping all characters other than letters and '-'.

pango.pango_language_matches

    def pango.pango_language_matches()

language :

 a language tag (see the pango.pango_language_from_string() function), None is allowed and matches nothing but '*'

range_list :

 a list of language ranges, separated by ';' characters. each element must either be '*', or a RFC 3066 language range canonicalized as by the pango.pango_language_from_string() function.

Returns :

True if a match was found.

Note

This function is deprecated in PyGTK 2.4 and above. Use the matches() method instead.

The pango.pango_language_matches() function checks if a language tag matches one of the elements in a list of language ranges. A language tag is considered to match a range in the list if the range is '*', the range is exactly the tag, or the range is a prefix of the tag, and the character after the tag is '-'.

Prev Up Next
pango.GlyphString Home pango.Layout
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkprintjob.html0000644000000000000000000006014211272037113024155 0ustar rootrootgtkunixprint.PrintJob
gtkunixprint.PrintJob
Prev The gtkunixprint Class Reference Next

gtkunixprint.PrintJob

gtkunixprint.PrintJob — an object that represents a print job (new in PyGTK 2.10)

Synopsis

class gtkunixprint.PrintJob(gobject.GObject):
    gtkunixprint.PrintJob(title, printer, settings, page_setup)
    def get_settings()
    def get_printer()
    def get_title()
    def get_status()
    def set_source_file(filename)
    def get_surface()
    def set_track_print_status(track_status)
    def get_track_print_status()
    def send(callback, user_data=None)

Ancestry

+-- gobject.GObject
  +-- gtkunixprint.PrintJob

gtkunixprint.PrintJob Properties

"page-setup"Read-Write-Construct OnlyThe Page Setup. Available in GTK+ 2.10.
"printer"Read-Write-Construct OnlyThe Printer to print the job to. Available in GTK+ 2.10.
"settings"Read-Write-Construct OnlyThe Printer Settings. Available in GTK+ 2.10.
"title"Read-Write-Construct OnlyTitle of the print job. Default value: None. Available in GTK+ 2.10.
"track-print-status"Read-Writeif True the print job will continue to emit status-changed signals after the print data has been sent to the printer or print server. Available in GTK+ 2.10.

gtkunixprint.PrintJob Signal Prototypes

gobject.GObject Signal Prototypes

"status-changed"

 def callback(printjob, user_param1, ...)

Description

Note

This class is available in PyGTK 2.10 and above.

A gtkunixprint.PrintJob object represents a job that is sent to a printer. You only need to deal directly with print jobs if you use the non-portable gtkunixprint.PrintUnixDialog API.

Use the get_surface() method to obtain the cairo surface onto which the pages must be drawn. Use the send() method to send the finished job to the printer. If you don't use cairo gtkunixprint.PrintJob also supports printing of manually generated postscript, via the set_source_file() method.

Constructor

gtkunixprint.PrintJob

    gtkunixprint.PrintJob(title, printer, settings, page_setup)

title :

the job title

printer :

a gtkunixprint.Printer

settings :

a gtk.PrintSettings

page_setup :

a gtk.PageSetup

Returns :

a new gtkunixprint.PrintJob

Note

This constructor is available in PyGTK 2.10 and above.

Creates a new gtkunixprint.PrintJob.

Methods

gtkunixprint.PrintJob.get_settings

    def get_settings()

Returns :

the settings of the print job

Note

This method is available in PyGTK 2.10 and above.

The get_settings() method returns the gtk.PrintSettings of the print job.

gtkunixprint.PrintJob.get_printer

    def get_printer()

Returns :

the printer of the print job

Note

This method is available in PyGTK 2.10 and above.

The get_printer() method returns the gtkunixprint.Printer of the print job.

gtkunixprint.PrintJob.get_title

    def get_title()

Returns :

the title of the print job

Note

This method is available in PyGTK 2.10 and above.

The get_title() method returns the print job title.

gtkunixprint.PrintJob.get_status

    def get_status()

Returns :

the status of the print job

Note

This method is available in PyGTK 2.10 and above.

The get_status() method returns the status of the print job.

gtkunixprint.PrintJob.set_source_file

    def set_source_file(filename)

filename :

the file to be printed

Returns :

False if an error occurred

Note

This method is available in PyGTK 2.10 and above.

The set_source_file() method makes the gtkunixprint.PrintJob send the existing document specified by filename to the printing system. The file can be in any format understood by the platforms printing system (typically PostScript, but on many platforms PDF may work too).

gtkunixprint.PrintJob.get_surface

    def get_surface()

Returns :

the cairo surface of the print job

Note

This method is available in PyGTK 2.10 and above.

The get_surface() method returns a cairo surface onto which the pages of the print job should be rendered.

gtkunixprint.PrintJob.set_track_print_status

    def set_track_print_status(track_status)

track_status :

if True track the status of the print job after sending

Note

This method is available in PyGTK 2.10 and above.

The set_track_print_status() method enable or disables tracking of the print job status based on the value specified by track_status. If track_status is True, the print job will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer.

This method is often implemented using some form of polling, so tracking should not be enabled unless needed.

gtkunixprint.PrintJob.get_track_print_status

    def get_track_print_status()

Returns :

True if print job status will be reported after printing

Note

This method is available in PyGTK 2.10 and above.

The get_track_print_status() method returns wheter jobs will be tracked after printing. For details, see the set_track_print_status() method.

gtkunixprint.PrintJob.send

    def send(callback, user_data=None)

callback :

the function to call when the job completes

user_data :

user data that gets passed to callback

Returns :

False if an error occurred

Note

This method is available in PyGTK 2.10 and above.

The send() method sends the print job off to the printer and registers the function specified by callback ro be called when the job completes.

The signature of callback is:

def callback(print_job, data, errormsg):

where data is user_data and errormsg is a message indicating what problem has occurred or None if no error has occurred.

Signals

The "status-changed" Signal

    def callback(gtkprintjob, user_param1, ...)

gtkprintjob :

the gtkprintjob that received the signal

user_param1 :

the first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

The "status-changed" signal is emitted when the status of a job changes. The signal handler can use the get_status() method to obtain the new status.

Prev Up Next
gtkunixprint.Printer Home gtkunixprint.PrintUnixDialog
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/pygtk.devhelp0000644000000000000000000166603211272037112022350 0ustar rootroot ./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/class-gtkalignment.html0000644000000000000000000004610011272037113024302 0ustar rootrootgtk.Alignment
gtk.Alignment
Prev The gtk Class Reference Next

gtk.Alignment

gtk.Alignment — a widget that controls the alignment and size of its child

Synopsis

class gtk.Alignment(gtk.Bin):
    gtk.Alignment(xalign=0.0, yalign=0.0, xscale=0.0, yscale=0.0)
    def set(xalign, yalign, xscale, yscale)
    def set_padding(padding_top, padding_bottom, padding_left, padding_right)
    def get_padding()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Container
        +-- gtk.Bin
          +-- gtk.Alignment

Implemented Interfaces

gtk.Alignment implements gtk.Buildable

gtk.Alignment Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Container Properties

"bottom-padding"Read/WriteThe padding to insert at the bottom of the widget. GTK+ 2.4 and above.
"left-padding"Read/WriteThe padding to insert at the left of the widget. GTK+ 2.4 and above.
"right-padding"Read/WriteThe padding to insert at the right of the widget. GTK+ 2.4 and above.
"top-padding"Read/WriteThe padding to insert at the top of the widget. GTK+ 2.4 and above.
"xalign"Read/WriteThe fraction of horizontal free space to the left of the child. 0.0 means no free space to the left, 1.0 means all free space to the left.
"xscale"Read/WriteThe fraction of horizontal free space (beyond that needed by the child) that the child will absorb. 0.0 means the child will absorb none, 1.0 means the child will absorb all
"yalign"Read/WriteThe fraction of vertical free space above the child. 0.0 means no free space above, 1.0 means all free space above.
"yscale"Read/WriteThe fraction of vertical free space (beyond that needed by the child) that the child will absorb. 0.0 means the child will absorb none, 1.0 means the child will absorb all

gtk.Alignment Style Properties

gtk.Widget Style Properties

gtk.Alignment Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

gtk.Container Signal Prototypes

Description

The gtk.Alignment widget controls the alignment and size of its child widget. It has four properties: xscale, yscale, xalign, and yalign. The scale properties are used to specify how much of the free (extra) space allocated to the gtk.Alignment should be absorbed by the child widget. The values can range from 0.0 (meaning the child absorbs none) to 1.0 (meaning the child absorbs all of the free space). If the value is 0.5, the child widget absorbs half the free space. The align properties are used to place the child widget within the available area by specifying the fraction of free space that will be placed above or to the left of the child widget. The values range from 0.0 (no free space above or to the left of the child) to 1.0 (all free space above or to the left of the child). Of course, if the scale properties are both set to 1.0, the alignment properties have no effect.

An example may make this clearer. A gtk.Button widget (32 pixels wide by 32 pixels high) is placed inside a gtk.Alignment widget (256 pixels wide by 128 pixels high) which has xalign of 0.25, yalign of 0.25, xscale of 0.25 and yscale of 0.25. The horizontal free space is 256-32=224 pixels and the vertical free space is 128-32=96 pixels. The button will absorb 0.25x224=56 pixels horizontally and 0.25x96=24 pixels vertically since the xscale and yscale are 0.25 thus becoming 32+56=88 pixels wide by 32+24=56 pixels high. This will leave 256-88=168 pixels of horizontal free space and 128-56=72 pixels of vertical free space. Since the xalign value is 0.25 the horizontal free space will be allocated as 0.25x168=42 pixels to the left of the button and 0.72x168=126 pixels to the right. Likewise since the yalign is 0.25 the vertical free space is allocated as 0.25x72=18 pixels above the button and 0.75*72=54 pixels below.

Constructor

    gtk.Alignment(xalign=0.0, yalign=0.0, xscale=0.0, yscale=0.0)

xalign :

the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0

yalign :

the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0

xscale :

the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0

yscale :

the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0

Returns :

a new alignment object

Creates a new alignment widget with the specified properties. If the scale and alignment parameters are not specified they default to 0.0.

Methods

gtk.Alignment.set

    def set(xalign, yalign, xscale, yscale)

xalign :

the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0

yalign :

the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0

xscale :

the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0

yscale :

the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0

The set() method sets the properties of the alignment widget to the specified values.

gtk.Alignment.set_padding

    def set_padding(padding_top, padding_bottom, padding_left, padding_right)

padding_top :

 the padding at the top of the widget

padding_bottom :

 the padding at the bottom of the widget

padding_left :

 the padding at the left of the widget

padding_right :

 the padding at the right of the widget.

Note

This method is available in PyGTK 2.4 and above.

The set_padding() method sets the padding around the sides of the alignment widget to the values specified by padding_top, padding_bottom, padding_left and padding_right. The padding adds blank space to the sides of the widget. For instance, this can be used to indent the child widget toward the right by adding padding on the left.

gtk.Alignment.get_padding

    def get_padding()

Returns :

a 4-tuple containing the padding set on the top, bottom, left and right sides of the widget

Note

This method is available in PyGTK 2.4 and above.

The get_padding() method returns a 4-tuple containing the padding set on the sides of the widget.

Prev Up Next
gtk.Adjustment Home gtk.Arrow
./pygtk-2.14.1-i686/usr/share/gtk-doc/html/pygtk/atk-constants.html0000644000000000000000000012574411272037113023320 0ustar rootrootatk Constants
atk Constants
Prev The atk Class Reference Next

atk Constants

atk Constants — the built-in constants of the atk module

Synopsis

Atk Coord Type Constants
Atk Layer Constants
Atk Relation Type Constants
Atk Role Constants
Atk State Type Constants
Atk Text Attribute Constants
Atk Text Boundary Constants
Atk Text Clip Type Constants

Description

Atk Coord Type Constants

The Atk Coord Type constants specify how xy coordinates are to be interpreted. Used by methods such as atk.Component.get_position() and atk.Text.get_character_extents()

atk.XY_SCREEN

specifies xy coordinates relative to the screen

atk.XY_WINDOW

specifies xy coordinates relative to the widget's top-level window

Atk Layer Constants

The Atk Layer constants specify the layer of a component. These enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another.

atk.LAYER_INVALID

The object does not have a layer

atk.LAYER_BACKGROUND

This layer is reserved for the desktop background

atk.LAYER_CANVAS

This layer is used for Canvas components

atk.LAYER_WIDGET

This layer is normally used for components

atk.LAYER_MDI

This layer is used for layered components

atk.LAYER_POPUP

This layer is used for popup components, such as menus

atk.LAYER_OVERLAY

This layer is reserved for future use.

atk.LAYER_WINDOW

This layer is used for toplevel windows.

Atk Relation Type Constants

The Atk Relation Type constants specify the type of the relation.

atk.RELATION_NULL

 Not used, represents "no relationship" or an error condition.

atk.RELATION_CONTROLLED_BY

 Indicates an object controlled by one or more target objects.

atk.RELATION_CONTROLLER_FOR

 Indicates an object is an controller for one or more target objects.

atk.RELATION_LABEL_FOR

 Indicates an object is a label for one or more target objects.

atk.RELATION_LABELLED_BY

 Indicates an object is labelled by one or more target objects.

atk.RELATION_MEMBER_OF

 Indicates an object is a member of a group of one or more target objects.

atk.RELATION_NODE_CHILD_OF

 Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.

atk.RELATION_FLOWS_TO

 Indicates that the object has content that flows logically to another atk.Object in a sequential way, (for instance text-flow).

atk.RELATION_FLOWS_FROM

 Indicates that the object has content that flows logically from another atk.Object in a sequential way, (for instance text-flow).

atk.RELATION_SUBWINDOW_OF

 Indicates a subwindow attached to a component but otherwise has no connection in the UI hierarchy to that component.

atk.RELATION_EMBEDS

 Indicates that the object visually embeds another object's content, i.e. this object's content flows around another's content.

atk.RELATION_EMBEDDED_BY

 Inverse of atk.RELATION_EMBEDS, indicates that this object's content is visualy embedded in another object.

atk.RELATION_POPUP_FOR

Indicates that an object is a popup for another object.

atk.RELATION_PARENT_WINDOW_OF

 Indicates that an object is a parent window of another object.

atk.RELATION_LAST_DEFINED

 Not used, this value indicates the end of the enumeration.

Atk Role Constants

The Atk Role constants describes the role of an object. These are the built-in enumerated roles that UI components can have in ATK. Other roles may be added at runtime, so an AtkRole >= atk.ROLE_LAST_DEFINED is not necessarily an error.

atk.ROLE_INVALID

Invalid role

atk.ROLE_ACCEL_LABEL

A label which represents an accelerator

atk.ROLE_ALERT

An object which is an alert to the user

atk.ROLE_ANIMATION

An object which is an animated image

atk.ROLE_ARROW

An arrow in one of the four cardinal directions

atk.ROLE_CALENDAR

 An object that displays a calendar and allows the user to select a date

atk.ROLE_CANVAS

 An object that can be drawn into and is used to trap events

atk.ROLE_CHECK_BOX

 A choice that can be checked or unchecked and provides a separate indicator for the current state

atk.ROLE_CHECK_MENU_ITEM

A menu item with a check box

atk.ROLE_COLOR_CHOOSER

A specialized dialog that lets the user choose a color

atk.ROLE_COLUMN_HEADER

The header for a column of data

atk.ROLE_COMBO_BOX

A list of choices the user can select from

atk.ROLE_DATE_EDITOR

An object whose purpose is to allow a user to edit a date

atk.ROLE_DESKTOP_ICON

An inconifed internal frame within a DESKTOP_PANE

atk.ROLE_DESKTOP_FRAME

 A pane that supports internal frames and iconified versions of those internal frames

atk.ROLE_DIAL

An object whose purpose is to allow a user to set a value

atk.ROLE_DIALOG

A top level window with title bar and a border

atk.ROLE_DIRECTORY_PANE

 A pane that allows the user to navigate through and select the contents of a directory

atk.ROLE_DRAWING_AREA

 An object used for drawing custom user interface elements

atk.ROLE_FILE_CHOOSER

A specialized dialog that lets the user choose a file

atk.ROLE_FILLER

A object that fills up space in a user interface

atk.ROLE_FONT_CHOOSER

A specialized dialog that lets the user choose a font

atk.ROLE_FRAME

 A top level window with a title bar, border, menubar, etc.

atk.ROLE_GLASS_PANE

 A pane that is guaranteed to be painted on top of all panes beneath it

atk.ROLE_HTML_CONTAINER

 A document container for HTML, whose children represent the document content

atk.ROLE_ICON

 A small fixed size picture, typically used to decorate components

atk.ROLE_IMAGE

 An object whose primary purpose is to display an image

atk.ROLE_INTERNAL_FRAME

A frame-like object that is clipped by a desktop pane

atk.ROLE_LABEL

 An object used to present an icon or short string in an interface

atk.ROLE_LAYERED_PANE

 A specialized pane that allows its children to be drawn in layers, providing a form of stacking order

atk.ROLE_LIST

 An object that presents a list of objects to the user and allows the user to select one or more of them

atk.ROLE_LIST_ITEM

An object that represents an element of a list

atk.ROLE_MENU

 An object usually found inside a menu bar that contains a list of actions the user can choose from

atk.ROLE_MENU_BAR

 An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from

atk.ROLE_MENU_ITEM

 An object usually contained in a menu that presents an action the user can choose

atk.ROLE_OPTION_PANE

 A specialized pane whose primary use is inside a DIALOG

atk.ROLE_PAGE_TAB

 An object that is a child of a page tab list

atk.ROLE_PAGE_TAB_LIST

 An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object

atk.ROLE_PANEL

A generic container that is often used to group objects

atk.ROLE_PASSWORD_TEXT

 A text object uses for passwords, or other places where the text content is not shown visibly to the user

atk.ROLE_POPUP_MENU

 A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices

atk.ROLE_PROGRESS_BAR

 An object used to indicate how much of a task has been completed

atk.ROLE_PUSH_BUTTON

 An object the user can manipulate to tell the application to do something

atk.ROLE_RADIO_BUTTON

 A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked

atk.ROLE_RADIO_MENU_ITEM

 A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected

atk.ROLE_ROOT_PANE

 A specialized pane that has a glass pane and a layered pane as its children

atk.ROLE_ROW_HEADER

The header for a row of data

atk.ROLE_SCROLL_BAR

 An object usually used to allow a user to incrementally view a large amount of data.

atk.ROLE_SCROLL_PANE

 An object that allows a user to incrementally view a large amount of information

atk.ROLE_SEPARATOR

 An object usually contained in a menu to provide a visibl