You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdegraphics/libkscan/devselector.h

106 lines
3.3 KiB

/* This file is part of the KDE Project
Copyright (C) 2000 Klaas Freitag <freitag@suse.de>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef DEVSELECTOR_H
#define DEVSELECTOR_H
#include <kdialogbase.h>
class TQButtonGroup;
class TQStrList;
class TQStringList;
class TQCheckBox;
/**
*@author Klaas Freitag
*/
/* Configuration-file definitions */
#define GROUP_STARTUP "Scan Settings"
#define STARTUP_SCANDEV "ScanDevice"
#define STARTUP_SKIP_ASK "SkipStartupAsk"
#define STARTUP_ONLY_LOCAL "QueryLocalOnly"
/**
* A utitlity class that lets the user select a scan device.
*
* This class provides functions to get the scan device to use for an
* application with scan support.
*
* Its main purpose is to display a selection dialog, but it also reads
* and writes config entries to store the users selection and handles
* a field 'do not ask me again'.
*
*/
class DeviceSelector: public KDialogBase
{
Q_OBJECT
public:
/**
* constructs the dialog class
* @param TQWidget *parent - the parent
* @param TQStrList backends - a list of device names retrieved from the scan device
* @param TQStrList scannerNames - a list of corresponding human readable sanner names.
*/
DeviceSelector( TQWidget *parent, TQStrList&, const TQStringList& );
~DeviceSelector();
/**
* returns the device the user selected.
* @return a CString containing the technical name of the selected device (taken from
* the backends-list from the constructor)
*/
TQCString getSelectedDevice( void ) const;
/**
* returns the users selection if the dialog should be skipped in future.
* @return true for should be skipped.
*/
bool getShouldSkip( void ) const;
/**
* retrieval to get the device from the config file. The function reads the applications
* config file, cares for the 'do not ask me again'-settings and checks if the scandevice
* specified in the config file is present at the current configuration.
* If this function returns null, the DeviceSelector should be opened for a user selection.
* @return a string containing the device to open or null if no device is specified or the
* one specified is not valid.
*/
TQCString getDeviceFromConfig( void ) const;
public slots:
void setScanSources( const TQStrList&, const TQStringList& );
private:
TQButtonGroup *selectBox;
mutable TQStrList devices;
TQCheckBox *cbSkipDialog;
bool configDevValid;
class DeviceSelectorPrivate;
DeviceSelectorPrivate *d;
};
#endif