From 00bb99ac80741fc50ef8a289719373032f2391eb Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdeaccessibility@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/kmag/Makefile.am | 4 + doc/kmag/index.docbook | 647 ++++++++++++++++++++++++++++++++++++++++++++ doc/kmag/man-kmag.1.docbook | 64 +++++ doc/kmag/screenshot.png | Bin 0 -> 192028 bytes 4 files changed, 715 insertions(+) create mode 100644 doc/kmag/Makefile.am create mode 100644 doc/kmag/index.docbook create mode 100644 doc/kmag/man-kmag.1.docbook create mode 100644 doc/kmag/screenshot.png (limited to 'doc/kmag') diff --git a/doc/kmag/Makefile.am b/doc/kmag/Makefile.am new file mode 100644 index 0000000..cc0e7e4 --- /dev/null +++ b/doc/kmag/Makefile.am @@ -0,0 +1,4 @@ +KDE_LANG = en +KDE_DOCS = AUTO +KDE_MANS = AUTO + diff --git a/doc/kmag/index.docbook b/doc/kmag/index.docbook new file mode 100644 index 0000000..0faf531 --- /dev/null +++ b/doc/kmag/index.docbook @@ -0,0 +1,647 @@ + +KMagnifier"> + + + + +]> + + + + + + + +The &kmag; Handbook + + + +Sarang +Lakare + +
sarang@users.sf.net
+ + + +Olaf +Schmidt + +
ojschmidt@kde.org
+ + + + + + + +2000 +2002 +Sarang Lakare + + + +2004 +2005 +Olaf Schmidt + + +&FDLNotice; + + + +2006-05-25 +1.0 + + + + + +&kmag; is a screen magnifier. You can use +&kmag; to magnify a part of the screen just as you would use a lens to magnify +a newspaper fine-print or a photograph. This application is useful for a +variety of people: from researchers to artists to web-designers to people with +low vision. This document will try to be a complete reference manual for using +&kmag;. + + + + + +KDE +kmag +K Magnifier + + + + + +Introduction + + +&kmag; is a screen magnifier for the K Desktop Environment (&kde;). It can be used +to magnify a part of the screen. This application can be useful to various people: +People with low vision can use this application to magnify a part of the screen which they +are unable to view clearly, +artists can use this application to zoom into the graphics they produce and verify it +at the pixel level, +image-processing researchers can use this application to zoom into images and study them closely. +Other than these, &kmag; can be used for various other purposes ⪚ is possible to use the +application for grabbing a portion of the screen and saving it to the disk (with an option of +zooming the screen captured). + + +&kmag; is a very powerful application with new features being added all the time. It is optimized +for use on low processing power machines. + + + + +Using &kmag; + + +Here's a screen shot of &kmag; + + + + + + Screen shot of &kmag; + + + + + +After running &kmag; you will get a window similar to the one show above. The main window of +&kmag; shows the magnified (or zoomed) contents. +We refer to this window as the zoom window. The zoomed image shown inside the zoom window is +captured from a part of the screen. The part of the screen which is magnified is referred to +as the selection window. + + +By default, &kmag; magnifies the region around the mouse cursor into the zoom window (think of it as a moving lens). +Alternatively, you can ask &kmag; to magnify an chosen area of the screen into the zoom window +(Selection Window Mode), or the area around the mouse cursur to one of the screen edges +(e.g. Left Screen Edge Mode). + + +If you would prefer not to see the mouse cursor in the zoomed image, select +Hide Mouse Cursor. Please note that &kmag; cannot yet find out the current cursor shape. +Thus, it shows the default &kde;/&Qt; cursor. + + + +Changing the part of the screen to be magnified + +When in Selection Window Mode, the selection window can be moved and resized. +You can also change the position and size of the selection window using the arrow keys on the keyboard, +or by clicking into the zoom window: + + + + +Arrow keys or &LMB; + +By keeping the left mouse button pressed and moving the +mouse, you can grab and drag the contents of the zoom window. +You can also use the arrow keys. + + + +&Shift;Arrow Keys or +&Shift;&LMB; or &MMB;. + +By additionally pressing &Shift; or using the &MMB;, +you can move the selection window. + + + + +&Ctrl;Arrow Keys or +&Ctrl;&LMB; + +By using this combination, you can resize the selection +window. Keep in mind that the top-left corner of the selection window +is kept constant and the bottom-right corner is movable. + + + + + + + +More &kmag; features + +&kmag; comes with lots of features. Its possible to print the zoomed +image directly to a printer, save the image to a file, copy the zoomed +image to the clipboard (which can be later used to paste in other applications), +rotate the magnification image and more. + + + + + + + +Menu Reference + + +The <guimenu>File</guimenu> Menu + + + + + + +&Ctrl; +N + +File +New Window + +Opens a new &kmag; window. + + + + + +&Ctrl; +S + +File +Save Snapshot As... + +Saves the zoomed view to an image file. + + + + + +&Ctrl; +P + +File +Print... + +Prints the current zoomed view. + + + + + +&Ctrl; +Q + +File +Quit + +Quits the application + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + + +&Ctrl; +C + +Edit +Copy + +Copy the current zoomed view to the clipboard which +you can paste in other applications. + + + + + +The <guimenu>View</guimenu> Menu + + + + + + + +F5 + +View +Start/Stop + +Start/Stop updating of the display. +Stopping the update will zero the processing power required (CPU +usage) + + + + +View +Zoom + +Select the zoom factor. + + + + + +&Ctrl; +- + +View +Zoom Out + +Click on this button to zoom-out on the selected region. + + + + + +&Ctrl; ++ + +View +Zoom In + +Click on this button to zoom-in on the selected region. + + + + + + +F6 + +View +Invert Colors + +Inverts colors on the view, &ie; black things will be shown white. + + + + +View +Rotation + +Select the rotation degree (No Rotation (0 Degrees), +Left (90 Degrees), Upside Down (180 Degrees), +Right (270 Degrees). + + + + +View +Refresh + +Select the refresh rate (Very Low, +Low, Medium, +High, Very High). +The higher the rate, the more computing power (CPU) +will be needed. + + + + + +The <guimenu>Settings</guimenu> Menu + + + + + + +&Ctrl; +M + +Settings +Show/Hide Menu + +Toggles the menubar on/off. + + + + +Settings +Show/Hide Main Toolbar + +Toggles the main toolbar on/off. + + + + +Settings +Show/Hide View Toolbar + +Toggles the view toolbar on/off. + + + + +Settings +Show/Hide Settings Toolbar + +Toggles the settings toolbar on/off. + + + + + + +F1 + +Settings +Follow Mouse Mode + +In this mode the area around the mouse cursor is shown in a normal window. + + + + + + +F2 + +Settings +Selection Window Mode + +In this mode a selection window is opened. The selected area is shown in a normal window. + + + + +Settings +Top Screen Edge Mode + +In this mode the area around the mouse is magnified to the top screen edge. + + + + +Settings +Left Screen Edge Mode + +In this mode the area around the mouse is magnified to the left screen edge. + + + + +Settings +Right Screen Edge Mode + +In this mode the area around the mouse is magnified to the right screen edge. + + + + +Settings +Bottom Screen Edge Mode + +In this mode the area around the mouse is magnified to the bottom screen edge. + + + + + + +F4 + +Settings +Show/Hide Mouse Cursor + +Show or hide the mouse cursor in the magnified image. + + + + +Settings +Configure Shortcuts... + +Opens a window that lets you configure the keyboard +shortcuts for many menu commands. + + + + +Settings +Configure Toolbars... + +Opens a window that lets you choose which icons are visible +in the toolbar. + + + + + +The <guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + + +Command Reference + +&kmag; automatically uses all your default shortcuts for saving +file, opening new window, printing, starting/stopping refresh (reload +button in &konqueror;), zoom-in, zoom-out &etc; + + +Default Keyboard Shortcuts + + + +&Ctrl;S +This will save the contents of the zoom window to a +file. + + + +F1 +Switch to "Follow Mouse Mode". + + + +F2 +Switch to "Selection Window Mode". + + + +F4 +Show or hide the mouse cursor in the magnified image. + + + +F5 +This will start the refresh of the zoom window if it is +stopped, or stops the refresh of the zoom window if the refresh is +currently on. + + + +F6 +Invert Colors + + + +&Ctrl;N +This will open a new &kmag; window. + + +&Ctrl;P +This will open the print dialog for printing the contents +of the zoom window. + + +&Ctrl;C +This will copy the zoom window contents to the +clipboard. + + + +&Ctrl;M +Show/Hide the menubar. + + + +&Ctrl;- +Zoom out + + +&Ctrl;+ +Zoom in + + +&Ctrl;Q +Quits the application. + + + + +
+ + + + + + + + +Credits and License + + +&kmag; + + +Program copyright 2001-2003 Sarang Lakare sarang@users.sf.net and 2003-2005 Olaf Schmidt ojschmidt@kde.org. + + +Contributors: + +Michael Forster forster@fmi.uni-passau.de (original author) + + + + + +Documentation copyright 2002 Sarang Lakare sarang@users.sf.net and +2004-2005 Olaf Schmidt ojschmidt@kde.org + + + +&underFDL; +&underGPL; + + + + +Installation + + +How to obtain &kmag; + +&install.intro.documentation; + + + + +Compilation and Installation + +&install.compile.documentation; + + + + + +&documentation.index; + + diff --git a/doc/kmag/man-kmag.1.docbook b/doc/kmag/man-kmag.1.docbook new file mode 100644 index 0000000..540b139 --- /dev/null +++ b/doc/kmag/man-kmag.1.docbook @@ -0,0 +1,64 @@ + + +]> + + + +&kde; User's Manual +&Lauri.Watts; &Lauri.Watts.mail; +June 12, 2005 +K Desktop Environment + + + +kmag +1 + + + +kmag +Screen magnifier + + + + +kmag +&kde; Generic Options +&Qt; Generic Options + + + + +Description +kmag, also known as &kmagnifier; is a screen +magnifier. You can use &kmagnifier; to magnify a part of the screen just as +you would use a lens to magnify a newspaper fine-print or a photograph. This +application is useful for a variety of people: from researchers to artists +to web-designers to people with low vision. + + + +See Also + +More detailed user documentation is available from help:/kmag +(either enter this &URL; into &konqueror;, or run +khelpcenter +help:/kmag). + +There is also further information available at the &kde; accessibility project home page. + + + +Authors +&kmagnifier; was written by +OlafSchmidt +ojschmidt@kde.org and +SarangLakare +sarang@users.sf.net and +MichaelForster +forster@fmi.uni-passau.de + + + diff --git a/doc/kmag/screenshot.png b/doc/kmag/screenshot.png new file mode 100644 index 0000000..7d90441 Binary files /dev/null and b/doc/kmag/screenshot.png differ -- cgit v1.2.1