From dba834a513e2cf72c5ba9305de3f3fed41215895 Mon Sep 17 00:00:00 2001 From: Eugene Wang Date: Thu, 15 Nov 2018 21:14:28 -0500 Subject: [PATCH] Added some xml docs to SupportedSize and DeviceEvent values. --- src/NTwain/Data/TwainValues.cs | 310 ++++++++++++++++++++++++++++----- 1 file changed, 264 insertions(+), 46 deletions(-) diff --git a/src/NTwain/Data/TwainValues.cs b/src/NTwain/Data/TwainValues.cs index c757511..11eef2c 100644 --- a/src/NTwain/Data/TwainValues.cs +++ b/src/NTwain/Data/TwainValues.cs @@ -423,19 +423,70 @@ namespace NTwain.Data /// public enum DeviceEvent : uint // using uint to support custom event values { + /// + /// The automatic capture settings on the device have been changed. + /// CheckAutomaticCapture = 0, + /// + /// Status of the battery has changed. Sources will report BatteryMinutes or BatteryPercentage + /// depending on which capabilities say they support. + /// CheckBattery = 1, + /// + /// The device has been powered off. If an Application receives this device event, it should call + /// CAP_DEVICEONLINE to verify the state of the Source, and then proceed as seems appropriate. + /// CheckDeviceOnline = 2, + /// + /// The flash setting on the device has been changed. + /// CheckFlash = 3, + /// + /// The power supply has changed, for example this event would be generated if AC was + /// removed from a device, putting it on battery. Scanners may also provide this event to notify + /// that a power on reset has taken place, indicating that the device has been power cycled. + /// CheckPowerSupply = 4, + /// + /// The resolution on the device has changed. + /// CheckResolution = 5, + /// + /// A device has been added to the Source. See DG_CONTROL / DAT_FILESYSTEM / MSG_CHANGEDIRECTORY + /// and DG_CONTROL / DAT_FILESYSTEM / MSG_GETINFO to get more information about the new device. + /// DeviceAdded = 6, + /// + /// A device has become unavailable. This is different from TWDC_DEVICEREMOVED, since the + /// device is assumed to be connected. + /// DeviceOffline = 7, + /// + /// A device is ready to capture another image. Applications should be careful when negotiating + /// this event, especially in situations where images are gathered quickly, as with automatic + /// capture. + /// DeviceReady = 8, + /// + /// A device has been removed from the Source. This is different from TWDE_DEVICEOFFLINE. + /// As soon as this event is received an Application should re-negotiate its current device, since + /// that may have been the one that was removed. Sources must default to the TWFY_CAMERA + /// device if the current device is removed. + /// DeviceRemoved = 9, ImageCaptured = 10, ImageDeleted = 11, + /// + /// Report double feeds to the Application. Because of the asynchronous nature of device events + /// there may still be images waiting to be transferred, applications need to decide if they want to + /// recover these images or discard them. + /// PaperDoubleFeed = 12, + /// + /// Report paper jams to the Application. Because of the asynchronous nature of device events + /// there may still be images waiting to be transferred, applications need to decide if they want to + /// recover these images or discard them. + /// PaperJam = 13, LampFailure = 14, PowerSave = 15, @@ -1069,59 +1120,226 @@ namespace NTwain.Data /// public enum SupportedSize : ushort { + /// + /// Images will match the maximum scanning dimensions of + /// the device. This setting is only applicable to devices that + /// have fixed measurable dimensions, such as most + /// scanners. + /// None = 0, - A4 = 1, - JisB5 = 2, + /// + /// 8.5" x 11.0" (216mm x 280mm) + /// USLetter = 3, + /// + /// 8.5" x 14.0" (216mm x 356mm) + /// USLegal = 4, - A5 = 5, - IsoB4 = 6, - IsoB6 = 7, + /// + /// 11.0" x 17.0" (280mm x 432mm) + /// USLedger = 9, + /// + /// 7.25" x 10.5" (184mm x 267mm) + /// USExecutive = 10, - A3 = 11, - IsoB3 = 12, - A6 = 13, - C4 = 14, - C5 = 15, - C6 = 16, - FourA0 = 17, - TwoA0 = 18, - A0 = 19, - A1 = 20, - A2 = 21, - A7 = 22, - A8 = 23, - A9 = 24, - A10 = 25, - IsoB0 = 26, - IsoB1 = 27, - IsoB2 = 28, - IsoB5 = 29, - IsoB7 = 30, - IsoB8 = 31, - IsoB9 = 31, - IsoB10 = 33, - JisB0 = 34, - JisB1 = 35, - JisB2 = 36, - JisB3 = 37, - JisB4 = 38, - JisB6 = 39, - JisB7 = 40, - JisB8 = 41, - JisB9 = 42, - JisB10 = 43, - C0 = 44, - C1 = 45, - C2 = 46, - C3 = 47, - C7 = 48, - C8 = 49, - C9 = 50, - C10 = 51, + /// + /// 5.5" x 8.5" (140mm x 216mm) + /// USStatement = 52, + /// + /// 90mm x 55mm + /// BusinessCard = 53, + /// + /// 1682mm x 2378mm + /// + FourA0 = 17, + /// + /// 1189mm x 1682mm + /// + TwoA0 = 18, + /// + /// 841mm x 1189mm + /// + A0 = 19, + /// + /// 594mm x 841mm + /// + A1 = 20, + /// + /// 420mm x 594mm + /// + A2 = 21, + /// + /// 297mm x 420mm + /// + A3 = 11, + /// + /// 210mm x 297mm + /// + A4 = 1, + /// + /// 148mm x 210mm + /// + A5 = 5, + /// + /// 105mm x 148mm + /// + A6 = 13, + /// + /// 74mm x 105mm + /// + A7 = 22, + /// + /// 52mm x 74mm + /// + A8 = 23, + /// + /// 37mm x 52mm + /// + A9 = 24, + /// + /// 26mm x 37mm + /// + A10 = 25, + /// + /// 1000mm x1414mm + /// + IsoB0 = 26, + /// + /// 707mm x1000mm + /// + IsoB1 = 27, + /// + /// 500mm x 707mm + /// + IsoB2 = 28, + /// + /// 353mm x 500mm + /// + IsoB3 = 12, + /// + /// 250mm x 353mm + /// + IsoB4 = 6, + /// + /// 176mm x 250mm + /// + IsoB5 = 29, + /// + /// 125mm x 176mm + /// + IsoB6 = 7, + /// + /// 88mm x 125mm + /// + IsoB7 = 30, + /// + /// 62mm x 88mm + /// + IsoB8 = 31, + /// + /// 44mm x 62mm + /// + IsoB9 = 31, + /// + /// 31mm x 44mm + /// + IsoB10 = 33, + /// + /// 1030mm x1456mm + /// + JisB0 = 34, + /// + /// 728mm x1030mm + /// + JisB1 = 35, + /// + /// 515mm x 728mm + /// + JisB2 = 36, + /// + /// 364mm x 515mm + /// + JisB3 = 37, + /// + /// 257mm x 364mm + /// + JisB4 = 38, + /// + /// 182mm x 257mm + /// + JisB5 = 2, + /// + /// 128mm x 182mm + /// + JisB6 = 39, + /// + /// 91mm x 128mm + /// + JisB7 = 40, + /// + /// 64mm x 91mm + /// + JisB8 = 41, + /// + /// 45mm x 64mm + /// + JisB9 = 42, + /// + /// 32mm x 45mm + /// + JisB10 = 43, + /// + /// 917mm x1297mm + /// + C0 = 44, + /// + /// 648mm x 917mm + /// + C1 = 45, + /// + /// 458mm x 648mm + /// + C2 = 46, + /// + /// 324mm x 458mm + /// + C3 = 47, + /// + /// 229mm x 324mm + /// + C4 = 14, + /// + /// 162mm x 229mm + /// + C5 = 15, + /// + /// 114mm x 162mm + /// + C6 = 16, + /// + /// 81mm x 114mm + /// + C7 = 48, + /// + /// 57mm x 81mm + /// + C8 = 49, + /// + /// 40mm x 57mm + /// + C9 = 50, + /// + /// 28mm x 40mm + /// + C10 = 51, + /// + /// Added to simplify negotiating for the entire acquisition area of a + /// device, since TWSS_NONE was overloaded to mean both "a custom frame" and "the + /// maximum image size." + /// MaxSize = 54 }