Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Graphics
libksane
Commits
ace3ae92
Commit
ace3ae92
authored
Jul 04, 2021
by
Alexander Stippich
Browse files
further cleanup and extended documentation
parent
5e8ba42b
Changes
1
Hide whitespace changes
Inline
Side-by-side
src/ksanecore.h
View file @
ace3ae92
...
@@ -20,7 +20,9 @@
...
@@ -20,7 +20,9 @@
#include
<QList>
#include
<QList>
#include
<QImage>
#include
<QImage>
/** This namespace collects all methods and classes in LibKSane. */
/**
* This namespace collects all methods and classes in LibKSane.
*/
namespace
KSaneIface
namespace
KSaneIface
{
{
...
@@ -36,14 +38,19 @@ class KSANE_EXPORT KSaneCore : public QObject
...
@@ -36,14 +38,19 @@ class KSANE_EXPORT KSaneCore : public QObject
friend
class
KSaneCorePrivate
;
friend
class
KSaneCorePrivate
;
public:
public:
/** @note There might come more enumerations in the future. */
/**
* Enum defining the message level of the returned scan status string.
* @note There might come more enumerations in the future.
*/
enum
KSaneScanStatus
{
enum
KSaneScanStatus
{
NoError
,
// The scanning
w
as finished successfully
NoError
,
// The scanning
h
as finished successfully
ErrorGeneral
,
// The error string should contain an error message.
ErrorGeneral
,
// The error string should contain an error message.
Information
// There is some information to the user.
Information
// There is some information to the user.
};
};
/** Enum determining whether the scanner opened correctly. */
/**
* Enum determining whether the scanner opened correctly.
*/
enum
KSaneOpenStatus
{
enum
KSaneOpenStatus
{
OpeningSucceeded
,
// scanner opened successfully
OpeningSucceeded
,
// scanner opened successfully
OpeningDenied
,
// access was denied,
OpeningDenied
,
// access was denied,
...
@@ -83,6 +90,9 @@ public:
...
@@ -83,6 +90,9 @@ public:
WhiteLevelOption
,
WhiteLevelOption
,
};
};
/*
* Struct describing scanner devices.
*/
struct
DeviceInfo
{
struct
DeviceInfo
{
QString
name
;
/* unique device name */
QString
name
;
/* unique device name */
QString
vendor
;
/* device vendor string */
QString
vendor
;
/* device vendor string */
...
@@ -96,7 +106,9 @@ public:
...
@@ -96,7 +106,9 @@ public:
*/
*/
KSaneCore
(
QObject
*
parent
=
nullptr
);
KSaneCore
(
QObject
*
parent
=
nullptr
);
/** Standard destructor */
/**
* Standard destructor.
*/
~
KSaneCore
();
~
KSaneCore
();
/**
/**
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment