A B C D E F G I L M N O P R S T U V

A

actionPerformed(SaneEvent) - Method in interface com.tuneology.sane.SaneAction

Called by SanePanel when a parameter or option changes.

addOptionChangeListener(SaneAction) - Method in class com.tuneology.sane.SanePanel

Register a callback for when an OptionDescriptor changes.

addParameterChangeListener(SaneAction) - Method in class com.tuneology.sane.SanePanel

Register a callback for when a SaneParameter changes.

B

BooleanOption - class com.tuneology.sane.BooleanOption.

This option is an array of boolean values.

ButtonOption - class com.tuneology.sane.ButtonOption.

This option has no value.

bytes_per_line - Variable in class com.tuneology.sane.SaneParameters

Specifies the number of bytes that comprise one scan line.

C

cancel() - Method in class com.tuneology.sane.SaneScanner

This function is used to immediately or as quickly as possible cancel the currently pending operation of the device.

CAP_ADVANCED - Static variable in class com.tuneology.sane.Sane

If set, this capability indicates that the option should be considered an advanced user option.

CAP_ALWAYS_SETTABLE - Static variable in class com.tuneology.sane.Sane

CAP_AUTOMATIC - Static variable in class com.tuneology.sane.Sane

If set, this capability indicates that the backend (or the device) is capable to picking a reasonable option value automatically.

CAP_EMULATED - Static variable in class com.tuneology.sane.Sane

If set, this capability indicates that an option is not directly supported by the device and is instead emulated in the backend.

CAP_HARD_SELECT - Static variable in class com.tuneology.sane.Sane

The option value can be set by user-intervention (e.g., by flipping a switch).

CAP_INACTIVE - Static variable in class com.tuneology.sane.Sane

If set, this capability indicates that the option is not currently active (e.g., because it's meaningful only if another option is set to some other value).

CAP_SOFT_DETECT - Static variable in class com.tuneology.sane.Sane

The option value can be detected by software.

CAP_SOFT_SELECT - Static variable in class com.tuneology.sane.Sane

The option value can be set by a call to setValues().

close() - Method in class com.tuneology.sane.SaneScanner

This function terminates the association between the scanner object and the device it represents.

com.tuneology.sane - package com.tuneology.sane

D

depth - Variable in class com.tuneology.sane.SaneParameters

Specifies the number of bits per sample.

E

eventType - Variable in class com.tuneology.sane.SaneEvent

The type of event, either PARAMETERS_CHANGED or OPTIONS_CHANGED.

exit() - Static method in class com.tuneology.sane.Sane

This function must be called to terminate use of a backend.

F

FixedOption - class com.tuneology.sane.FixedOption.

This option is an array of fixed-point (16 bits integer, 16 bits fractional) values.

format - Variable in class com.tuneology.sane.SaneParameters

Specifies the format of the next frame to be returned.

FRAME_BLUE - Static variable in class com.tuneology.sane.Sane

Blue band of a red/green/blue image.

FRAME_GRAY - Static variable in class com.tuneology.sane.Sane

Band covering human visual range.

FRAME_GREEN - Static variable in class com.tuneology.sane.Sane

Green band of a red/green/blue image.

FRAME_RED - Static variable in class com.tuneology.sane.Sane

Red band of a red/green/blue image.

FRAME_RGB - Static variable in class com.tuneology.sane.Sane

Pixel-interleaved red/green/blue bands.

G

get_option_descriptors() - Method in class com.tuneology.sane.SaneScanner

This function is used to access option descriptors.

get_parameters() - Method in class com.tuneology.sane.SaneScanner

This function is used to obtain the current scan parameters.

getCap() - Method in class com.tuneology.sane.OptionDescriptor

Describes what capabilities the option posseses.

getCredentials(String) - Method in interface com.tuneology.sane.SaneAuthorization

Supply the credentials required to access the device.

getDescription() - Method in class com.tuneology.sane.OptionDescriptor

A (potentially very) long string that can be used as a help text to describe the option.

getDevices(boolean) - Static method in class com.tuneology.sane.Sane

This function can be used to query the list of devices that are available.

getElements() - Method in class com.tuneology.sane.OptionDescriptor

Returns an array of constraint elements for the option.

getMax() - Method in class com.tuneology.sane.SaneRange

maximum (element) value

getMin() - Method in class com.tuneology.sane.SaneRange

minimum (element) value

getName() - Method in class com.tuneology.sane.OptionDescriptor

String that uniquely identifies the option.

getQuant() - Method in class com.tuneology.sane.SaneRange

If non-zero, specifies the quantization value (increment).

getRange() - Method in class com.tuneology.sane.OptionDescriptor

If not null, indicates a range of values for the option.

getSize() - Method in class com.tuneology.sane.OptionDescriptor

Returns the number of elements in the option.

getTitle() - Method in class com.tuneology.sane.OptionDescriptor

A single-line string that can be used by the frontend as a title string.

getUnit() - Method in class com.tuneology.sane.OptionDescriptor

Specifies the type of the option value.

getValue() - Method in class com.tuneology.sane.StringOption

Returns option values.

getValues() - Method in class com.tuneology.sane.BooleanOption

Returns option values.

getValues() - Method in class com.tuneology.sane.IntegerOption

Returns option values.

getValues() - Method in class com.tuneology.sane.FixedOption

getVersionCode() - Static method in class com.tuneology.sane.Sane

Returns the version code of the backend.

GroupOption - class com.tuneology.sane.GroupOption.

I

INFO_INEXACT - Static variable in class com.tuneology.sane.Sane

This value is returned when setting an option value resulted in a value being selected that does not exactly match the requested value.

INFO_RELOAD_OPTIONS - Static variable in class com.tuneology.sane.Sane

The setting of an option may affect the value or availability of one or more other options.

INFO_RELOAD_PARAMS - Static variable in class com.tuneology.sane.Sane

The setting of an option may affect the parameter values (see sane_get_parameters()).

init() - Static method in class com.tuneology.sane.Sane

This function must be called before any other SANE function can be called.

IntegerOption - class com.tuneology.sane.IntegerOption.

This option is an array of integers.

L

last_frame - Variable in class com.tuneology.sane.SaneParameters

Set to true if and only if the frame that is currently being acquired (or the frame that will be acquired next if there is no current frame) is the last frame of a multi frame image (e.g., the current frame is the blue component of a red, green, blue image).

lines - Variable in class com.tuneology.sane.SaneParameters

Specifies how many scan lines the frame is comprised of.

M

model - Variable in class com.tuneology.sane.SaneDevice

Information on the model of the scanner.

N

name - Variable in class com.tuneology.sane.SaneDevice

The unique name of the scanner, to be passed in a call to open().

O

open(String) - Static method in class com.tuneology.sane.Sane

This function is used to establish a connection to a particular device.

OptionDescriptor - class com.tuneology.sane.OptionDescriptor.

Option descriptors are at the same time the most intricate and powerful type in the SANE standard.

OPTIONS_CHANGED - Static variable in class com.tuneology.sane.SaneEvent

P

PARAMETERS_CHANGED - Static variable in class com.tuneology.sane.SaneEvent

password - Variable in class com.tuneology.sane.SaneCredentials

pixels_per_line - Variable in class com.tuneology.sane.SaneParameters

Specifies the number of pixels that comprise one scan line.

pressButton() - Method in class com.tuneology.sane.ButtonOption

R

read(Object, int, int) - Method in class com.tuneology.sane.SaneScanner

This function is used to read image data from the device.

removeOptionChangeListener(SaneAction) - Method in class com.tuneology.sane.SanePanel

Remove a callback.

removeParameterChangeListener(SaneAction) - Method in class com.tuneology.sane.SanePanel

Remove a callback.

S

Sane - class com.tuneology.sane.Sane.

SANE is an application programming interface (API) that provides standardized access to any raster image scanner hardware.

SaneAction - interface com.tuneology.sane.SaneAction.

Callback class for when a parameter or option changes.

SaneAuthorization - interface com.tuneology.sane.SaneAuthorization.

A callback for obtaining authentication info for a particular scanner.

SaneCredentials - class com.tuneology.sane.SaneCredentials.

This is returned by SaneAuthorization when prompted for user credentials.

SaneCredentials() - Constructor for class com.tuneology.sane.SaneCredentials

SaneDevice - class com.tuneology.sane.SaneDevice.

Represents a SANE device.

SaneEvent - class com.tuneology.sane.SaneEvent.

Represents a Sane event triggered by the user's changing of a parameter.

SaneException - exception com.tuneology.sane.SaneException.

Thrown by SANE API functions when an error condition occurs.

SaneException(int) - Constructor for class com.tuneology.sane.SaneException

SaneException(String) - Constructor for class com.tuneology.sane.SaneException

SanePanel - class com.tuneology.sane.SanePanel.

A control panel for a SANE scanner.

SanePanel(SaneScanner, boolean) - Constructor for class com.tuneology.sane.SanePanel

SaneParameters - class com.tuneology.sane.SaneParameters.

The current scan parameters.

SaneRange - class com.tuneology.sane.SaneRange.

This constraint is applicable to integer and fixed-point valued options only.

SaneScanner - class com.tuneology.sane.SaneScanner.

Represents a connection to a hardware scanner device.

set_io_mode(boolean) - Method in class com.tuneology.sane.SaneScanner

This function is used to set the I/O mode of the scanner.

setAuthorizer(SaneAuthorization) - Static method in class com.tuneology.sane.Sane

The authorization function may be called by a backend in response to any of the following calls: open, setValue(s), getValue(s), setAutomatic, SaneScanner.start.

setAutomatic() - Method in class com.tuneology.sane.OptionDescriptor

Turn on automatic mode.

setValue(String) - Method in class com.tuneology.sane.StringOption

Set option values.

setValues(boolean[]) - Method in class com.tuneology.sane.BooleanOption

Set option values.

setValues(int[]) - Method in class com.tuneology.sane.IntegerOption

Set option values.

setValues(int[]) - Method in class com.tuneology.sane.FixedOption

start() - Method in class com.tuneology.sane.SaneScanner

This function initiates aquisition of an image from the scanner.

startScan() - Method in class com.tuneology.sane.SanePanel

Call this function to start scanning.

status - Variable in class com.tuneology.sane.SaneException

STATUS_ACCESS_DENIED - Static variable in class com.tuneology.sane.Sane

Access to resource has been denied.

STATUS_CANCELLED - Static variable in class com.tuneology.sane.Sane

Operation was cancelled.

STATUS_COVER_OPEN - Static variable in class com.tuneology.sane.Sane

Scanner cover is open.

STATUS_DEVICE_BUSY - Static variable in class com.tuneology.sane.Sane

Device is busy---retry later.

STATUS_EOF - Static variable in class com.tuneology.sane.Sane

No more data available (end-of-file).

STATUS_GOOD - Static variable in class com.tuneology.sane.Sane

Operation completed succesfully.

STATUS_INVAL - Static variable in class com.tuneology.sane.Sane

Data or argument is invalid.

STATUS_IO_ERROR - Static variable in class com.tuneology.sane.Sane

Error during device I/O.

STATUS_JAMMED - Static variable in class com.tuneology.sane.Sane

Document feeder jammed.

STATUS_NO_DOCS - Static variable in class com.tuneology.sane.Sane

Document feeder out of documents.

STATUS_NO_MEM - Static variable in class com.tuneology.sane.Sane

Out of memory.

STATUS_UNSUPPORTED - Static variable in class com.tuneology.sane.Sane

Operation is not supported.

stopScan() - Method in class com.tuneology.sane.SanePanel

Call this function to stop scanning.

StringOption - class com.tuneology.sane.StringOption.

This option is a String value.

strstatus(int) - Static method in class com.tuneology.sane.Sane

This function can be used to translate a SANE status code into a printable string.

T

type - Variable in class com.tuneology.sane.SaneDevice

Information on the type of the scanner.

TYPE_BOOL - Static variable in class com.tuneology.sane.Sane

Option value is of type boolean.

TYPE_BUTTON - Static variable in class com.tuneology.sane.Sane

An option of this type has no value.

TYPE_FIXED - Static variable in class com.tuneology.sane.Sane

Option value is of type int with 16 bits of integer value and 16 bits of fractional value.

TYPE_GROUP - Static variable in class com.tuneology.sane.Sane

An option of this type has no value.

TYPE_INT - Static variable in class com.tuneology.sane.Sane

Option value is of type int.

TYPE_STRING - Static variable in class com.tuneology.sane.Sane

Option value is of type String.

U

UNIT_BIT - Static variable in class com.tuneology.sane.Sane

UNIT_DPI - Static variable in class com.tuneology.sane.Sane

UNIT_MICROSECOND - Static variable in class com.tuneology.sane.Sane

UNIT_MM - Static variable in class com.tuneology.sane.Sane

UNIT_NONE - Static variable in class com.tuneology.sane.Sane

UNIT_PERCENT - Static variable in class com.tuneology.sane.Sane

UNIT_PIXEL - Static variable in class com.tuneology.sane.Sane

username - Variable in class com.tuneology.sane.SaneCredentials

V

vendor - Variable in class com.tuneology.sane.SaneDevice

Information on the vendor (manufacturer) of the scanner.

A B C D E F G I L M N O P R S T U V