gnome-mag: magnifier.h Source File

# magnifier.h

Go to the documentation of this file.

    00001 /*
    00002  * AT-SPI - Assistive Technology Service Provider Interface
    00003  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
    00004  *
    00005  * Copyright 2001 Sun Microsystems Inc.
    00006  *
    00007  * This library is free software; you can redistribute it and/or
    00008  * modify it under the terms of the GNU Library General Public
    00009  * License as published by the Free Software Foundation; either
    00010  * version 2 of the License, or (at your option) any later version.
    00011  *
    00012  * This library is distributed in the hope that it will be useful,
    00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00015  * Library General Public License for more details.
    00016  *
    00017  * You should have received a copy of the GNU Library General Public
    00018  * License along with this library; if not, write to the
    00019  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    00020  * Boston, MA 02111-1307, USA.
    00021  */
    00022
    00023 #ifndef MAGNIFIER_H_
    00024 #define MAGNIFIER_H_
    00025
    00026 #ifdef __cplusplus
    00027 extern "C" {
    00028 #endif /* __cplusplus */
    00029
    00030 #include "GNOME_Magnifier.h"
    00031
    00032 #include <glib.h>
    00033
    00034 #include <gdk/gdk.h>
    00035
    00036 #include <bonobo/bonobo-object.h>
    00037 #include <bonobo/bonobo-property-bag.h>
    00038
    00039 #include <login-helper/login-helper.h>
    00040
    00041 #define MAGNIFIER_TYPE         (magnifier_get_type ())
    00042 #define MAGNIFIER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), MAGNIFIER_TYPE, Magnifier))
    00043 #define MAGNIFIER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), MAGNIFIER_TYPE, MagnifierClass))
    00044 #define IS_MAGNIFIER(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), MAGNIFIER_TYPE))
    00045 #define IS_MAGNIFIER_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), MAGNIFIER_TYPE))
    00046
    00047 #define MAGNIFIER_OAFIID "OAFIID:GNOME_Magnifier_Magnifier:0.9"
    00048
    00049 typedef struct _MagnifierPrivate MagnifierPrivate;
    00050
    00051 typedef struct {
    00052         BonoboObject parent;
    00053         BonoboPropertyBag *property_bag;
    00054         GdkDisplay *source_display;
    00055         GdkDisplay *target_display;
    00056         gchar *source_display_name;
    00057         gchar *target_display_name;
    00058         int source_screen_num;
    00059         int target_screen_num;
    00060         GList *zoom_regions;
    00061         gboolean source_initialized;
    00062         gint crosswire_size;
    00063         gint crosswire_length;
    00064         guint32 crosswire_color;
    00065         gboolean crosswire_clip;
    00066         gchar *cursor_set;
    00067         gint cursor_size_x;
    00068         gint cursor_size_y;
    00069         guint32 cursor_color;
    00070         float cursor_scale_factor;
    00071         GNOME_Magnifier_RectBounds source_bounds;
    00072         GNOME_Magnifier_RectBounds target_bounds;
    00073         GNOME_Magnifier_Point cursor_hotspot;
    00074         MagnifierPrivate *priv;
    00075 } Magnifier;
    00076
    00077 typedef struct {
    00078         BonoboObjectClass parent_class;
    00079         POA_GNOME_Magnifier_Magnifier__epv epv;
    00080 } MagnifierClass;
    00081
    00082 /*
    00083  * When running the magnifier in timing test mode (--timing-pan-rate and/or
    00084  * --timing-iterations), then the following output is displayed:
    00085  *
    00086  * Pan Rate           = 200
    00087  * Frames Processed   = 1225
    00088  * Width/Height/Depth = 640/1024/8
    00089  * Zoom Factor (x/y)  = 3.000000/3.000000
    00090  * Update Duration    = (avg. 0.010232) (max. 0.002685) (tot. 1.084589) seconds
    00091  *   Update Pixels    = (avg. 3046) pixels/frame
    00092  *   Update Rate      = (avg. 97.732909) (max. 372.439485) updates/second
    00093  *   Net Update Rate  = (avg. 0.297724) (max. 0.457741) Mpex/second
    00094  * Pan Latency        = (avg. 0.008229) (max. 0.562326) seconds
    00095  * Tot Frame Duration = (avg. 0.008363) (max. 0.562485) (tot. 10.235981)seconds
    00096  * Frame Rate         = (avg. 119.578189) (max. 4854.369141) frames/second
    00097  * Scroll Delta (x)   = (avg. 0.000000) (tot. 0) lines
    00098  * Scroll Delta (y)   = (avg. 5.019608) (tot. 6144) lines
    00099  * Scroll Rate (x)    = (avg. 0.000000) lines/second
    00100  * Scroll Rate (y)    = (avg. 600.235657) lines/second
    00101  * Net Render Rate    = (avg. 8.685322) (max. 3181.359360) Mpex/second
    00102  *
    00103  * Pan Rate             - Displays the pan rate specified on the command line.
    00104  *                        Only displayed if --timing-pan-rate is used.
    00105  * Frames Processed     - Number of frames displayed
    00106  * Width/Height/Depth   - The width/height/depth of magnifier display.
    00107  * Zoom Factor (x/y)    - The zoom factor used.
    00108  * Update Duration      - Average and total time spent updating new sections of
    00109  *                        the screen.
    00110  *   Update Pixels      - Number of pixels updated
    00111  *   Update Rate        - Number of updates possible per second.
    00112  *   Net Update Rate    - Number of Megapixels updated per second.
    00113  * Pan Latency          - Time spent from the beginning of the setROI request
    00114  *                        until GTK+ has finished processing the update (in
    00115  *                        GDK's gdk_window_update_idle idle handler.
    00116  * Total Frame Duration - Average and total time processing frames.
    00117  * Frame Rate           - Number of frames per second.
    00118  * Scroll Delta         - Average and total number of lines scrolled.
    00119  * Scroll Rate          - Number of lines scrolled per second.  Note that this
    00120  *                        value will be equal to the --timing-pan-rate value
    00121  *                        times the y zoom factor.
    00122  * Net Render Rate      - Number of Megapixels processed per second.
    00123  *
    00124  * When running with the --timing-output argument, similar information is
    00125  * displayed for each frame plus timing information for the frame.  Update
    00126  * information is not displayed for frames where updates do not occur.  Pan
    00127  * Rate, Frames Processed, and Width/Height/Depth is not displayed for each
    00128  * frame, only when displaying summary information.
    00129  */
    00130
    00131 typedef struct timing {
    00132         GTimer *process;
    00133         GTimer *frame;
    00134         GTimer *scale;
    00135         GTimer *idle;
    00136         gdouble scale_val;
    00137         gdouble idle_val;
    00138         gdouble frame_val;
    00139         int   dx;
    00140         int   dy;
    00141         gdouble scale_total;
    00142         gdouble idle_total;
    00143         gdouble frame_total;
    00144         int   dx_total;
    00145         int   dy_total;
    00146         long  update_pixels_total;
    00147         long  num_scale_samples;
    00148         long  num_idle_samples;
    00149         long  num_frame_samples;
    00150         long  num_line_samples;
    00151         gdouble last_frame_val;
    00152         int   last_dy;
    00153 } TimingStruct;
    00154
    00155 TimingStruct mag_timing;
    00156
    00157 GdkDrawable *magnifier_get_cursor    (Magnifier *magnifier);
    00158 GType        magnifier_get_type      (void);
    00159 GdkWindow   *magnifier_get_root      (Magnifier *magnifier);
    00160 Magnifier   *magnifier_new           (gboolean override_redirect);
    00161 void         magnifier_notify_damage (Magnifier *magnifier,
    00162                                       GdkRectangle *rect);
    00163 void         magnifier_set_cursor_from_pixbuf (Magnifier *magnifier,
    00164                                                GdkPixbuf *pointer_pixbuf);
    00165 void         magnifier_set_cursor_pixmap_by_name (Magnifier *magnifier,
    00166                                                   const gchar *cursor_name,
    00167                                                   gboolean source_fallback);
    00168 void         magnifier_transform_cursor (Magnifier *magnifier);
    00169 void         magnifier_zoom_regions_update_pointer (Magnifier *magnifier);
    00170 gboolean     magnifier_full_screen_capable (Magnifier *magnifier);
    00171 #ifdef __cplusplus
    00172 }
    00173 #endif /* __cplusplus */
    00174
    00175 #endif /* MAGNIFIER_H_ */