michael@1: ## michael@1: ## OSSP asgui - Accounting system graphical user interface michael@12: ## Copyright (c) 2002-2009 The OSSP Project (http://www.ossp.org/) michael@12: ## Copyright (c) 2002-2009 Ralf S. Engelschall michael@12: ## Copyright (c) 2002-2009 Michael Schloh von Bennewitz michael@12: ## Copyright (c) 2002-2009 Cable & Wireless Telecommunications Services GmbH michael@1: ## michael@1: ## This file is part of OSSP asgui, an accounting system graphical user michael@3: ## interface which can be found at http://asgui.europalab.com/. michael@1: ## michael@1: ## Permission to use, copy, modify, and distribute this software for michael@1: ## any purpose with or without fee is hereby granted, provided that michael@1: ## the above copyright notice and this permission notice appear in all michael@1: ## copies. michael@1: ## michael@1: ## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED michael@1: ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF michael@1: ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. michael@1: ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR michael@1: ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, michael@1: ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT michael@1: ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF michael@1: ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND michael@1: ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, michael@1: ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT michael@1: ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF michael@1: ## SUCH DAMAGE. michael@1: ## michael@1: ## as-gui.pod: Plain old documentation file michael@1: ## michael@1: michael@1: =pod michael@1: michael@1: =head1 NAME michael@1: michael@1: B - accounting system graphical client michael@1: michael@1: =head1 VERSION michael@1: michael@1: as-gui ASGUI_VERSION_STR michael@1: michael@1: =head1 SYNOPSIS michael@1: michael@1: B michael@1: [I] michael@1: [I] michael@1: [file] michael@1: michael@1: =head1 DESCRIPTION michael@1: michael@1: The B application tracks the time a person spends on a number of michael@1: predefined tasks. This is the graphical client to the B michael@1: server (B). Although the two can interact through means of interprocess michael@1: communication mechanisms, B is a generic stand-alone tool which can be michael@1: used with no B server. michael@1: michael@1: When logging to a local file, B takes input and waits until receiving michael@1: a save request from the user. Then, the time sheet will save its data entries michael@1: to the associated file name (as shown in the title bar). michael@1: michael@1: Logging to a remote B server follows a similar input scheme, but at least michael@1: one B server must be specified in the preferences. A simple 'syncronize michael@1: with server' operation does the rest. michael@1: michael@1: =head1 X11 OPTIONS michael@1: michael@1: The following I are passed directly to the X11 subsystem, and michael@1: allow for the typical customization of a X11 application. michael@1: michael@1: =over 4 michael@1: michael@1: =item B<-display display> michael@1: michael@1: Sets the X display (host:server.screen). The default value is $DISPLAY. michael@1: michael@1: =item B<-geometry geometry> michael@1: michael@1: Sets the client geometry (width x height + xoffset + yoffset) of the main widget. michael@1: michael@1: =item B<-fn font>, B<-font font> michael@1: michael@1: Defines the application font. The font should be specified using a X logical michael@1: font description. michael@1: michael@1: =item B<-bg color>, B<-background color> michael@1: michael@1: Sets the default background color and an application palette (light and dark michael@1: shades are calculated). michael@1: michael@1: =item B<-fg color>, B<-foreground color> michael@1: michael@1: Sets the default foreground color. michael@1: michael@1: =item B<-btn color>, B<-button color> michael@1: michael@1: Sets the default button color. michael@1: michael@1: =item B<-name name> michael@1: michael@1: Sets the application name. michael@1: michael@1: =item B<-title title> michael@1: michael@1: Sets the application title (caption). michael@1: michael@1: =item B<-visual TrueColor> michael@1: michael@1: Forces the application to use a TrueColor visual on an 8-bit display. michael@1: michael@1: =item B<-ncols count> michael@1: michael@1: Limits the number of colors allocated in the color cube on an 8-bit display, michael@1: if the application is using the QApplication::ManyColor color specification. michael@1: If count is 216 then a 6x6x6 color cube is used (i.e. 6 levels of red, 6 of michael@1: green, and 6 of blue). For other values, a cube approximately proportional to michael@1: a 2x3x1 cube is used. michael@1: michael@1: =item B<-cmap> michael@1: michael@1: Causes the application to install a private color map on an 8-bit display. michael@1: michael@1: =back michael@1: michael@1: =head1 Qt OPTIONS michael@1: michael@1: The following I are used when rendering the graphics of the Qt michael@1: widget library. They are not compatible with other X11 or Win32 applications, michael@1: unless they were first linked with the Qt widget library. michael@1: michael@1: =over 4 michael@1: michael@1: =item B<-session session> michael@1: michael@1: Restores the application from an earlier session. michael@1: michael@1: =item B<-widgetcount> michael@1: michael@1: Prints debug message at the end about number of widgets left undestroyed and michael@1: maximum number of widgets existed at the same time. michael@1: michael@1: =back michael@1: michael@1: =head1 ENVIRONMENT michael@1: michael@1: C The user name to use when accounting. michael@1: michael@1: C The full path of the user's home directory. michael@1: michael@1: =head1 RETURN VALUES michael@1: michael@1: C<0> The application exited sucessfully. michael@1: michael@1: C0 or E0> At least one error ocurred. michael@1: michael@1: =head1 EXAMPLES michael@1: michael@1: Try out some of these examples to customize B from the command michael@1: line. Remember that options can be mixed. michael@1: michael@1: Initially editing the document 'figo.as': michael@1: michael@1: =over 4 michael@1: michael@1: $ as-gui figo.as michael@1: michael@1: =back michael@1: michael@1: Showing lovely blue shades in most widgets: michael@1: michael@1: =over 4 michael@1: michael@1: $ as-gui -bg lightblue -fg darkblue michael@1: michael@1: =back michael@1: michael@1: Starting with a title bar that reads 'Yours here': michael@1: michael@1: =over 4 michael@1: michael@1: $ as-gui -title 'Yours here' michael@1: michael@1: =back michael@1: michael@1: Displaying graphics output on the host borchert: michael@1: michael@1: =over 4 michael@1: michael@1: $ as-gui -display borchert:0.0 michael@1: michael@1: =back michael@1: michael@1: A slim window slightly left of the top right corner: michael@1: michael@1: =over 4 michael@1: michael@1: $ as-gui -geometry 761x347-120+0 michael@1: michael@1: =back michael@1: michael@1: =head1 FILES michael@1: michael@1: =over 4 michael@1: michael@1: =item ~/.as-gui michael@1: michael@1: User preferences file. michael@1: michael@1: =item as-gui.html michael@1: michael@1: Help reference. michael@1: michael@1: =back michael@1: michael@1: =head1 BUGS michael@1: michael@1: Sometimes a click on a widget (like a toolbar button) is seemingly ignored. michael@1: michael@1: Consistent row shading is not always maintained. This means that the sharp michael@1: colour difference between one row and the next may not correctly follow the michael@1: chosen sort order. Press 'refresh' to work around this problem. michael@1: michael@1: The row highlight may be wrong after resorting the entire time sheet. Press michael@1: the arrow keys a few times to find the currently selected row if this happens. michael@1: michael@1: Double clicking on column separators should automatically expand or shrink michael@1: the corresponding column to the exact size needed. Broken. michael@1: michael@1: Local reports only take datewise sorting into account. Attention! This is not michael@1: a bug, and local reports are almost always only useful when sorted by date. michael@1: michael@1: =head1 SEE ALSO michael@1: michael@1: as-gui.conf(5), michael@1: as-events(5), michael@1: as-accounts(5) michael@1: michael@1: =head1 AUTHOR michael@1: michael@1: Michael Schloh von Bennewitz michael@1: (michael@schloh.com) michael@1: michael@1: =cut