From a3570c360e8884f2bbf60b89e4d9531321ae01ad Mon Sep 17 00:00:00 2001 From: tpearson Date: Thu, 21 Jul 2011 04:30:08 +0000 Subject: Initial import of kbookreader git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/kbookreader@1242482 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/en/Makefile.am | 2 + doc/en/index.docbook | 555 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 557 insertions(+) create mode 100644 doc/en/Makefile.am create mode 100644 doc/en/index.docbook (limited to 'doc/en') diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..dd0f909 --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_DOCS = bookreader +KDE_LANG = en diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..b69e70d --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,555 @@ + +BookReader 0.1"> + + + + + + + +]> + + + + + + + + + + + + + + +The &bookreader; Handbook + + + + + +Alexandr Nemish + +
atlanter@gmail.com
+ + + + + + + +1999 +2005 +Alexandr Nemish + + + +&FDLNotice; + + + +2001-10-18 +0.1 + + + + + +&bookreader; is an application specially designed to do nothing you would +ever want. + + + + + + +KDE +BookReader +nothing +nothing else + + + + + + + +Introduction + + + + +&bookreader; is a program that lets you do absolutely nothing. Please report +any problems or feature requests to the &kde; mailing lists. + + + + +Using &bookreader; + + + + + + + + +Here's a screenshot of &bookreader; + + + + + + + + + Screenshot + + + + + + + +More &bookreader; features + +It slices! It dices! and it comes with a free toaster! + +The Squiggle Tool + + + + + + + + Squiggle + + is used to draw squiggly lines all over +the &bookreader; main window. It's not a bug, it's a feature! + + + + + + +Command Reference + + + + +The main &bookreader; window + + +The File Menu + + + + + +&Ctrl;N + +File +New + +Creates a new document + + + + +&Ctrl;S + +File +Save + +Saves the document + + + + +&Ctrl;Q + +File +Quit + +Quits &bookreader; + + + + + + + +The <guimenu>Help</guimenu> Menu + + + + + + +&help.menu.documentation; + + + + + + + +Developer's Guide to &bookreader; + + + + +Programming &bookreader; plugins is a joy to behold. Just read through the next +66 pages of API's to learn how! + + + + + + +XtUnmanageChildren +Xt - Geometry Management + + +XtUnmanageChildren + +remove a list of children from a parent widget's managed +list. +widgetsremoving +XtUnmanageChildren + + + + + +4 March 1996 + + +void XtUnmanageChildren(children, num_children) + WidgetList children; + Cardinal num_children; + + + +Inputs + + +children + + +Specifies an array of child widgets. Each child must be of +class RectObj or any subclass thereof. + + + + +num_children + + +Specifies the number of elements in children. + + + + + + + +Description + +XtUnmanageChildren() unmaps the specified widgets +and removes them from their parent's geometry management. +The widgets will disappear from the screen, and (depending +on its parent) may no longer have screen space allocated for +them. + +Each of the widgets in the children array must have +the same parent. + +See the “Algorithm” section below for full details of the +widget unmanagement procedure. + + + + +Usage +Unmanaging widgets is the usual method for temporarily +making them invisible. They can be re-managed with +XtManageChildren(). + +You can unmap a widget, but leave it under geometry +management by calling XtUnmapWidget(). You can +destroy a widget's window without destroying the widget by +calling XtUnrealizeWidget(). You can destroy a +widget completely with XtDestroyWidget(). + +If you are only going to unmanage a single widget, it is +more convenient to call XtUnmanageChild(). It is +often more convenient to call XtUnmanageChild() +several times than it is to declare and initialize an array +of widgets to pass to XtUnmanageChildren(). Calling +XtUnmanageChildren() is more efficient, however, +because it only calls the parent's change_managed() +method once. + + + + +Algorithm + +XtUnmanageChildren() performs the following: + + + +- + + +Ignores the child if it already is unmanaged or is being +destroyed. + + + + +- + + +Otherwise, if the child is realized, it makes it nonvisible +by unmapping it. + + + + + + + + + +Structures +The WidgetList type is simply an array of widgets: + +typedef Widget *WidgetList; + + + + + + + +Questions and Answers + + + +&reporting.bugs; +&updating.documentation; + + + + +My Mouse doesn't work. How do I quit &bookreader;? + + +You silly goose! Check out the Commands +Section for the answer. + + + + +Why can't I twiddle my documents? + + +You can only twiddle your documents if you have the foobar.lib +installed. + + + + + + + + + +Credits and License + + +&bookreader; + + +Program copyright 2005 Alexandr Nemish atlanter@gmail.com + + +Contributors: + +Konqui the KDE Dragon konqui@kde.org + +Tux the Linux Penguin tux@linux.org + + + + + +Documentation copyright 2005 Alexandr Nemish atlanter@gmail.com + + + + +&underFDL; + + + +&underGPL; +&underBSDLicense; +&underArtisticLicense; +&underX11License; + + + + +Installation + + +How to obtain &bookreader; + + + +&install.intro.documentation; + + + + +Requirements + + + + +In order to successfully use &bookreader;, you need &kde; 1.1. Foobar.lib is +required in order to support the advanced &bookreader; features. &bookreader; uses +about 5 megs of memory to run, but this may vary depending on your +platform and configuration. + + + +All required libraries as well as &bookreader; itself can be found +on The &bookreader; home page. + + + + +You can find a list of changes at http://apps.kde.org/bookreader. + + + + +Compilation and Installation + + + + + +&install.compile.documentation; + + + + +Configuration + +Don't forget to tell your system to start the dtd +dicer-toaster daemon first, or &bookreader; won't work ! + + + + + +&documentation.index; + + + + -- cgit v1.2.1