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 <X11/Xlib.h>
00033 #ifdef HAVE_XFIXES
00034 #include <X11/extensions/Xfixes.h>
00035 #endif /* HAVE_XFIXES */
00036 
00037 #include <glib.h>
00038 
00039 #include <gdk/gdk.h>
00040 
00041 #include <bonobo/bonobo-object.h>
00042 #include <bonobo/bonobo-property-bag.h>
00043 
00044 #include <login-helper/login-helper.h>
00045 
00046 #define MAGNIFIER_TYPE         (magnifier_get_type ())
00047 #define MAGNIFIER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), MAGNIFIER_TYPE, Magnifier))
00048 #define MAGNIFIER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), MAGNIFIER_TYPE, MagnifierClass))
00049 #define IS_MAGNIFIER(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), MAGNIFIER_TYPE))
00050 #define IS_MAGNIFIER_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), MAGNIFIER_TYPE))
00051 
00052 #define MAGNIFIER_OAFIID "OAFIID:GNOME_Magnifier_Magnifier:0.9"
00053 
00054 typedef struct _MagnifierPrivate MagnifierPrivate;
00055 
00056 typedef struct {
00057         BonoboObject parent;
00058         BonoboPropertyBag *property_bag;
00059         GdkDisplay *source_display;
00060         GdkDisplay *target_display;
00061         gchar *source_display_name;
00062         gchar *target_display_name;
00063         int source_screen_num;
00064         int target_screen_num;
00065         GList *zoom_regions;
00066         gboolean source_initialized;
00067         gint crosswire_size;
00068         guint32 crosswire_color;
00069         gboolean crosswire_clip;
00070         gchar *cursor_set;
00071         gint cursor_size_x;
00072         gint cursor_size_y;
00073         guint32 cursor_color;
00074         float cursor_scale_factor;
00075         GNOME_Magnifier_RectBounds source_bounds;
00076         GNOME_Magnifier_RectBounds target_bounds;
00077         GNOME_Magnifier_Point cursor_hotspot;
00078         MagnifierPrivate *priv;
00079 } Magnifier;
00080 
00081 typedef struct {
00082         BonoboObjectClass parent_class;
00083         POA_GNOME_Magnifier_Magnifier__epv epv;
00084 } MagnifierClass;
00085 
00086 /*
00087  * When running the magnifier in timing test mode (--timing-pan-rate and/or
00088  * --timing-iterations), then the following output is displayed:
00089  *
00090  * Pan Rate           = 200
00091  * Frames Processed   = 1225
00092  * Width/Height/Depth = 640/1024/8
00093  * Zoom Factor (x/y)  = 3.000000/3.000000
00094  * Update Duration    = (avg. 0.010232) (max. 0.002685) (tot. 1.084589) seconds
00095  *   Update Pixels    = (avg. 3046) pixels/frame
00096  *   Update Rate      = (avg. 97.732909) (max. 372.439485) updates/second
00097  *   Net Update Rate  = (avg. 0.297724) (max. 0.457741) Mpex/second
00098  * Pan Latency        = (avg. 0.008229) (max. 0.562326) seconds
00099  * Tot Frame Duration = (avg. 0.008363) (max. 0.562485) (tot. 10.235981)seconds
00100  * Frame Rate         = (avg. 119.578189) (max. 4854.369141) frames/second
00101  * Scroll Delta (x)   = (avg. 0.000000) (tot. 0) lines
00102  * Scroll Delta (y)   = (avg. 5.019608) (tot. 6144) lines
00103  * Scroll Rate (x)    = (avg. 0.000000) lines/second
00104  * Scroll Rate (y)    = (avg. 600.235657) lines/second
00105  * Net Render Rate    = (avg. 8.685322) (max. 3181.359360) Mpex/second
00106  *
00107  * Pan Rate             - Displays the pan rate specified on the command line.
00108  *                        Only displayed if --timing-pan-rate is used.
00109  * Frames Processed     - Number of frames displayed
00110  * Width/Height/Depth   - The width/height/depth of magnifier display.
00111  * Zoom Factor (x/y)    - The zoom factor used.
00112  * Update Duration      - Average and total time spent updating new sections of
00113  *                        the screen.
00114  *   Update Pixels      - Number of pixels updated
00115  *   Update Rate        - Number of updates possible per second.
00116  *   Net Update Rate    - Number of Megapixels updated per second.
00117  * Pan Latency          - Time spent from the beginning of the setROI request
00118  *                        until GTK+ has finished processing the update (in
00119  *                        GDK's gdk_window_update_idle idle handler.
00120  * Total Frame Duration - Average and total time processing frames.
00121  * Frame Rate           - Number of frames per second.
00122  * Scroll Delta         - Average and total number of lines scrolled.
00123  * Scroll Rate          - Number of lines scrolled per second.  Note that this
00124  *                        value will be equal to the --timing-pan-rate value
00125  *                        times the y zoom factor.
00126  * Net Render Rate      - Number of Megapixels processed per second.
00127  *
00128  * When running with the --timing-output argument, similar information is
00129  * displayed for each frame plus timing information for the frame.  Update
00130  * information is not displayed for frames where updates do not occur.  Pan 
00131  * Rate, Frames Processed, and Width/Height/Depth is not displayed for each
00132  * frame, only when displaying summary information.
00133  */
00134 
00135 typedef struct timing {
00136         GTimer *process;
00137         GTimer *frame;
00138         GTimer *scale;
00139         GTimer *idle;
00140         gdouble scale_val;
00141         gdouble idle_val;
00142         gdouble frame_val;
00143         int   dx;
00144         int   dy;
00145         gdouble scale_total;
00146         gdouble idle_total;
00147         gdouble frame_total;
00148         int   dx_total;
00149         int   dy_total;
00150         long  update_pixels_total;
00151         long  num_scale_samples;
00152         long  num_idle_samples;
00153         long  num_frame_samples;
00154         long  num_line_samples;
00155         gdouble last_frame_val;
00156         int   last_dy;
00157 } TimingStruct;
00158 
00159 TimingStruct mag_timing;
00160 
00161 GdkDrawable *magnifier_get_cursor    (Magnifier *magnifier);
00162 GType        magnifier_get_type      (void);
00163 GdkWindow   *magnifier_get_root      (Magnifier *magnifier);
00164 Magnifier   *magnifier_new           (gboolean override_redirect);
00165 gboolean     magnifier_error_check   (void);
00166 void         magnifier_notify_damage (Magnifier *magnifier, XRectangle *rect);
00167 void         magnifier_set_cursor_from_pixbuf (Magnifier *magnifier,
00168                                                GdkPixbuf *cursor_pixbuf);
00169 void         magnifier_set_cursor_pixmap_by_name (Magnifier *magnifier,
00170                                                   const gchar *cursor_name, 
00171                                                   gboolean source_fallback);
00172 void         magnifier_transform_cursor (Magnifier *magnifier);
00173 #ifdef __cplusplus
00174 }
00175 #endif /* __cplusplus */
00176 
00177 #endif /* MAGNIFIER_H_ */

Generated on Fri Mar 9 14:08:10 2007 for gnome-mag by  doxygen 1.4.7