SK.gnome.sane
Interface SaneConstants

All Superinterfaces:

MorenaConstants

All Known Implementing Classes:

SaneConnection, SaneException, SaneOptionDescriptor

public interface SaneConstants
extends MorenaConstants

Usefull constants defined by SANE specification.

Field Summary

static int	SANE_ACTION_GET_VALUE Get current option value.
static int	SANE_ACTION_SET_AUTO Turn on automatic mode.
static int	SANE_ACTION_SET_VALUE Set option value.
static int	SANE_CAP_ADVANCED If set, this capability indicates that the option should be considered an ``advanced user option.'' A frontend typically displays such options in a less conspicuous way than regular options (e.g., a command line interface may list such options last or a graphical interface may make them available in a seperate ``advanced settings'' dialog).
static int	SANE_CAP_AUTOMATIC If set, this capability indicates that the backend (or the device) is capable to picking a reasonable option value automatically.
static int	SANE_CAP_EMULATED If set, this capability indicates that an option is not directly supported by the device and is instead emulated in the backend.
static int	SANE_CAP_HARD_SELECT The option value can be set by user-intervention (e.g., by flipping a switch).
static int	SANE_CAP_INACTIVE 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).
static int	SANE_CAP_SOFT_DETECT The option value can be detected by software.
static int	SANE_CAP_SOFT_SELECT The option value can be set by a call to sane_control_option().
static int	SANE_CONSTRAINT_NONE The value is unconstrained.
static int	SANE_CONSTRAINT_RANGE This constraint is applicable to integer and fixed-point valued options only.
static int	SANE_CONSTRAINT_STRING_LIST This constraint is applicable to string-valued options only.
static int	SANE_CONSTRAINT_WORD_LIST This constraint is applicable to integer and fixed-point valued options only.
static int	SANE_FRAME_BLUE Blue band of a red/green/blue image.
static int	SANE_FRAME_GRAY Band covering human visual range.
static int	SANE_FRAME_GREEN Green band of a red/green/blue image.
static int	SANE_FRAME_RED Red band of a red/green/blue image.
static int	SANE_FRAME_RGB Pixel-interleaved red/green/blue bands.
static int	SANE_NET_AUTHORIZE
static int	SANE_NET_CANCEL
static int	SANE_NET_CLOSE
static int	SANE_NET_CONTROL_OPTION
static int	SANE_NET_EXIT
static int	SANE_NET_GET_DEVICES
static int	SANE_NET_GET_OPTION_DESCRIPTORS
static int	SANE_NET_GET_PARAMETERS
static int	SANE_NET_INIT
static int	SANE_NET_OPEN
static int	SANE_NET_START
static int	SANE_STATUS_ACCESS_DENIED Return code - Access denied
static int	SANE_STATUS_CANCELLED Return code - Operation was cancelled
static int	SANE_STATUS_COVER_OPEN Return code - Scanner cover is open
static int	SANE_STATUS_DEVICE_BUSY Return code - Device is busy; try again later
static int	SANE_STATUS_EOF Return code - No more data available (end-of-file)
static int	SANE_STATUS_GOOD Return code - Operation completed succesfully
static int	SANE_STATUS_INVAL Return code - Data is invalid (includes no dev at open)
static int	SANE_STATUS_IO_ERROR Return code - Error during device I/O
static int	SANE_STATUS_JAMMED Return code - Document feeder jammed
static int	SANE_STATUS_NO_DOCS Return code - Document feeder out of documents
static int	SANE_STATUS_NO_MEM Return code - Out of memory
static int	SANE_STATUS_UNSUPPORTED Return code - Operation is not supported
static int	SANE_TYPE_BOOL Option value is of type SANE_Bool.
static int	SANE_TYPE_BUTTON An option of this type has no value.
static int	SANE_TYPE_FIXED Option value is of type SANE_Fixed.
static int	SANE_TYPE_GROUP An option of this type has no value.
static int	SANE_TYPE_INT Option value is of type SANE_Int.
static int	SANE_TYPE_STRING Option value is of type SANE_String.
static int	SANE_UNIT_BIT Value is in number of bits.
static int	SANE_UNIT_DPI Value is a resolution in dots/inch.
static int	SANE_UNIT_MICROSECOND Value is time in �-seconds.
static int	SANE_UNIT_MM Value is in millimeters.
static int	SANE_UNIT_NONE Value is unit-less (e.g., page count).
static int	SANE_UNIT_PERCENT Value is a percentage.
static int	SANE_UNIT_PIXEL Value is in number of pixels.
static int	SANE_VERSION
static java.lang.String[]	STATUS_CODE
static int	UNFIX_CONST

Fields inherited from interface SK.gnome.morena.MorenaConstants

MORENA_MESSAGES, VERSION

Field Detail

SANE_VERSION

static final int SANE_VERSION

See Also:

Constant Field Values

UNFIX_CONST

static final int UNFIX_CONST

See Also:

Constant Field Values

SANE_NET_INIT

static final int SANE_NET_INIT

See Also:

Constant Field Values

SANE_NET_GET_DEVICES

static final int SANE_NET_GET_DEVICES

See Also:

Constant Field Values

SANE_NET_OPEN

static final int SANE_NET_OPEN

See Also:

Constant Field Values

SANE_NET_CLOSE

static final int SANE_NET_CLOSE

See Also:

Constant Field Values

SANE_NET_GET_OPTION_DESCRIPTORS

static final int SANE_NET_GET_OPTION_DESCRIPTORS

See Also:

Constant Field Values

SANE_NET_CONTROL_OPTION

static final int SANE_NET_CONTROL_OPTION

See Also:

Constant Field Values

SANE_NET_GET_PARAMETERS

static final int SANE_NET_GET_PARAMETERS

See Also:

Constant Field Values

SANE_NET_START

static final int SANE_NET_START

See Also:

Constant Field Values

SANE_NET_CANCEL

static final int SANE_NET_CANCEL

See Also:

Constant Field Values

SANE_NET_AUTHORIZE

static final int SANE_NET_AUTHORIZE

See Also:

Constant Field Values

SANE_NET_EXIT

static final int SANE_NET_EXIT

See Also:

Constant Field Values

STATUS_CODE

static final java.lang.String[] STATUS_CODE

SANE_STATUS_GOOD

static final int SANE_STATUS_GOOD

Return code - Operation completed succesfully

See Also:

Constant Field Values

SANE_STATUS_UNSUPPORTED

static final int SANE_STATUS_UNSUPPORTED

Return code - Operation is not supported

See Also:

Constant Field Values

SANE_STATUS_CANCELLED

static final int SANE_STATUS_CANCELLED

Return code - Operation was cancelled

See Also:

Constant Field Values

SANE_STATUS_DEVICE_BUSY

static final int SANE_STATUS_DEVICE_BUSY

Return code - Device is busy; try again later

See Also:

Constant Field Values

SANE_STATUS_INVAL

static final int SANE_STATUS_INVAL

Return code - Data is invalid (includes no dev at open)

See Also:

Constant Field Values

SANE_STATUS_EOF

static final int SANE_STATUS_EOF

Return code - No more data available (end-of-file)

See Also:

Constant Field Values

SANE_STATUS_JAMMED

static final int SANE_STATUS_JAMMED

Return code - Document feeder jammed

See Also:

Constant Field Values

SANE_STATUS_NO_DOCS

static final int SANE_STATUS_NO_DOCS

Return code - Document feeder out of documents

See Also:

Constant Field Values

SANE_STATUS_COVER_OPEN

static final int SANE_STATUS_COVER_OPEN

Return code - Scanner cover is open

See Also:

Constant Field Values

SANE_STATUS_IO_ERROR

static final int SANE_STATUS_IO_ERROR

Return code - Error during device I/O

See Also:

Constant Field Values

SANE_STATUS_NO_MEM

static final int SANE_STATUS_NO_MEM

Return code - Out of memory

See Also:

Constant Field Values

SANE_STATUS_ACCESS_DENIED

static final int SANE_STATUS_ACCESS_DENIED

Return code - Access denied

See Also:

Constant Field Values

SANE_TYPE_BOOL

static final int SANE_TYPE_BOOL

Option value is of type SANE_Bool.

See Also:

Constant Field Values

SANE_TYPE_INT

static final int SANE_TYPE_INT

Option value is of type SANE_Int.

See Also:

Constant Field Values

SANE_TYPE_FIXED

static final int SANE_TYPE_FIXED

Option value is of type SANE_Fixed.

See Also:

Constant Field Values

SANE_TYPE_STRING

static final int SANE_TYPE_STRING

Option value is of type SANE_String.

See Also:

Constant Field Values

SANE_TYPE_BUTTON

static final int SANE_TYPE_BUTTON

An option of this type has no value. Instead, setting an option of this type has an option-specific side-effect. For example, a button-typed option could be used by a backend to provide a means to select default values or to the tell an automatic document feeder to advance to the next sheet of paper.

See Also:

Constant Field Values

SANE_TYPE_GROUP

static final int SANE_TYPE_GROUP

An option of this type has no value. This type is used to group logically related options. A group option is in effect up to the point where another group option is encountered (or up to the end of the option list, if there are no other group options). For group options, only members title and type are valid in the option descriptor.

See Also:

Constant Field Values

SANE_UNIT_NONE

static final int SANE_UNIT_NONE

Value is unit-less (e.g., page count).

See Also:

Constant Field Values

SANE_UNIT_PIXEL

static final int SANE_UNIT_PIXEL

Value is in number of pixels.

See Also:

Constant Field Values

SANE_UNIT_BIT

static final int SANE_UNIT_BIT

Value is in number of bits.

See Also:

Constant Field Values

SANE_UNIT_MM

static final int SANE_UNIT_MM

Value is in millimeters.

See Also:

Constant Field Values

SANE_UNIT_DPI

static final int SANE_UNIT_DPI

Value is a resolution in dots/inch.

See Also:

Constant Field Values

SANE_UNIT_PERCENT

static final int SANE_UNIT_PERCENT

Value is a percentage.

See Also:

Constant Field Values

SANE_UNIT_MICROSECOND

static final int SANE_UNIT_MICROSECOND

Value is time in �-seconds.

See Also:

Constant Field Values

SANE_CONSTRAINT_NONE

static final int SANE_CONSTRAINT_NONE

The value is unconstrained. The option can take any of the values possible for the option's type.

See Also:

Constant Field Values

SANE_CONSTRAINT_RANGE

static final int SANE_CONSTRAINT_RANGE

This constraint is applicable to integer and fixed-point valued options only. It constrains the option value to a possibly quantized range of numbers.

See Also:

Constant Field Values

SANE_CONSTRAINT_WORD_LIST

static final int SANE_CONSTRAINT_WORD_LIST

This constraint is applicable to integer and fixed-point valued options only. It constrains the option value to a list of numeric values.

See Also:

Constant Field Values

SANE_CONSTRAINT_STRING_LIST

static final int SANE_CONSTRAINT_STRING_LIST

This constraint is applicable to string-valued options only. It constrains the option value to a list of strings.

See Also:

Constant Field Values

SANE_FRAME_GRAY

static final int SANE_FRAME_GRAY

Band covering human visual range.

See Also:

Constant Field Values

SANE_FRAME_RGB

static final int SANE_FRAME_RGB

Pixel-interleaved red/green/blue bands.

See Also:

Constant Field Values

SANE_FRAME_RED

static final int SANE_FRAME_RED

Red band of a red/green/blue image.

See Also:

Constant Field Values

SANE_FRAME_GREEN

static final int SANE_FRAME_GREEN

Green band of a red/green/blue image.

See Also:

Constant Field Values

SANE_FRAME_BLUE

static final int SANE_FRAME_BLUE

Blue band of a red/green/blue image.

See Also:

Constant Field Values

SANE_ACTION_GET_VALUE

static final int SANE_ACTION_GET_VALUE

Get current option value.

See Also:

Constant Field Values

SANE_ACTION_SET_VALUE

static final int SANE_ACTION_SET_VALUE

Set option value. The option value passed through argument v may be modified by the backend if the value cannot be set exactly.

See Also:

Constant Field Values

SANE_ACTION_SET_AUTO

static final int SANE_ACTION_SET_AUTO

Turn on automatic mode. Backend or device will automatically select an appropriate value. This mode remains effective until overridden by an explicit set value request. The value of parameter v is completely ignored in this case and may be NULL.

See Also:

Constant Field Values

SANE_CAP_SOFT_SELECT

static final int SANE_CAP_SOFT_SELECT

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

See Also:

Constant Field Values

SANE_CAP_HARD_SELECT

static final int SANE_CAP_HARD_SELECT

The option value can be set by user-intervention (e.g., by flipping a switch). The user-interface should prompt the user to execute the appropriate action to set such an option. This capability is mutually exclusive with SANE_CAP_SOFT_SELECT (either one of them can be set, but not both simultaneously).

See Also:

Constant Field Values

SANE_CAP_SOFT_DETECT

static final int SANE_CAP_SOFT_DETECT

The option value can be detected by software. If SANE_CAP_SOFT_SELECT is set, this capability must be set. If SANE_CAP_HARD_SELECT is set, this capability may or may not be set. If this capability is set but neither SANE_CAP_SOFT_SELECT nor SANE_CAP_HARD_SELECT are, then there is no way to control the option. That is, the option provides read-out of the current value only.

See Also:

Constant Field Values

SANE_CAP_EMULATED

static final int SANE_CAP_EMULATED

If set, this capability indicates that an option is not directly supported by the device and is instead emulated in the backend. A sophisticated frontend may elect to use its own (presumably better) emulation in lieu of an emulated option.

See Also:

Constant Field Values

SANE_CAP_AUTOMATIC

static final int SANE_CAP_AUTOMATIC

If set, this capability indicates that the backend (or the device) is capable to picking a reasonable option value automatically. For such options, it is possible to select automatic operation by calling sane_control_option() with an action value of SANE_ACTION_SET_AUTO.

See Also:

Constant Field Values

SANE_CAP_INACTIVE

static final int SANE_CAP_INACTIVE

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).

See Also:

Constant Field Values

SANE_CAP_ADVANCED

static final int SANE_CAP_ADVANCED

If set, this capability indicates that the option should be considered an ``advanced user option.'' A frontend typically displays such options in a less conspicuous way than regular options (e.g., a command line interface may list such options last or a graphical interface may make them available in a seperate ``advanced settings'' dialog).

See Also:

Constant Field Values