EpadInkLib::_DEpadInk

_DEpadInk Interface Reference

List of all members.

Public Member Functions

void AboutBox ()
SHORT GetNumDevices (void)
SHORT OpenConnection (SHORT nNumDevice)
void CloseConnection (void)
SHORT connClearScreen (void)
SHORT connRefreshScreen (SHORT layer)
SHORT connStartDraw (void)
SHORT connStopDraw (SHORT fSyncToDevice)
SHORT connTextOut (SHORT Layer, SHORT xStart, SHORT yStart, BSTR lpString, SHORT nStrlen)
SHORT connSetFont (BSTR LogFontStr, SHORT FontStrLen)
SHORT connLoadBitmapToDevice (SHORT layer, BSTR lpFileName, SHORT nFileNameLen, SHORT nStretch, SHORT xPos, SHORT yPos)
SHORT connGetWhiteThreshold (void)
SHORT connGetBlackThreshold (void)
SHORT connSetWhiteThreshold (SHORT WhiteVal)
SHORT connSetBlackThreshold (SHORT BlackVal)
SHORT connDrawLine (SHORT Layer, SHORT nColor, SHORT xStart, SHORT yStart, SHORT xEnd, SHORT yEnd)
BSTR connGetSerialNumber (void)
LONG connGetDataRangeMinX (void)
LONG connGetDataRangeMinY (void)
LONG connGetDataRangeMinZ (void)
LONG connGetDataRangeMaxX (void)
LONG connGetDataRangeMaxY (void)
LONG connGetDataRangeMaxZ (void)
DOUBLE connGetPhysicalX (void)
DOUBLE connGetPhysicalY (void)
LONG connMapToLcdX (LONG lValue)
LONG connMapToLcdY (LONG lValue)
SHORT connSetInkRegion (SHORT upperLeft_x, SHORT upperLeft_y, SHORT lowerRight_x, SHORT lowerRight_y)
BSTR connGetDebugParam (BSTR pKey)
SHORT connSetDebugParam (BSTR pKey, BSTR pValue)
SHORT connSetUseSlowMethod (SHORT nUseSlowMethod)
SHORT connSetInkColor (SHORT InkColor)
SHORT connSetInkOptions (SHORT inkTrailsOpt, SHORT seconds)
SHORT connSetBgImg (SHORT bgImgOpt, BSTR bgImgPath)
SHORT connSetBacklight (SHORT BkLight, SHORT BkOnSeconds, SHORT BkIntensity)
BSTR connGetFriendlyName (BSTR GUIDstr)
SHORT connSetFriendlyName (BSTR sGUID, BSTR sNewName)
SHORT connSaveDefaults (void)
SHORT connResetDeviceDefaults (void)
SHORT connGetInkRegion_ULX (void)
SHORT connGetInkRegion_ULY (void)
SHORT connGetInkRegion_LRX (void)
SHORT connGetInkRegion_LRY (void)
SHORT connGetUseSlowMethod (void)
SHORT connGetInkColor (void)
SHORT connGetInkingBacklight (void)
SHORT connGetInkingSecond (void)
SHORT connGetBgImgOptions (void)
BSTR connGetBgImgPath (void)
SHORT connGetBacklightOption (void)
SHORT connGetBacklightSecond (void)
SHORT connGetBacklightIntensity (void)
SHORT connClearInk (void)
LONG connGetMapInkingRegionOnly (void)
LONG connSetMapInkingRegionOnly (SHORT sMapInkingRegionOnly)
LONG ConnSetLayer (SHORT layer, SHORT intensity)
LONG connGetDC (void)
LONG connReleaseDC (LONG dc, LONG fSyncToDevice)
SHORT connDrawScreen (SHORT nLayer, SHORT xOrig, SHORT yOrig, BSTR sFileName)

Member Function Documentation

void AboutBox (  ) 

Displays aboutBox dialog

SHORT GetNumDevices ( void   ) 

Returns:
The number of attached ePad-ink devices. Note that the index number is zero-based, thus if a single unit is reported its index will be 0:
              SHORT sNumDevices = pInk->GetNumDevices();
              if ( sNumDevices > 0 ) {
                 ...
                 SHORT sResult = pInk->OpenConnection(0);
                 ...
              } // endif
See also:
gIIEPad::GetNumDevices

SHORT OpenConnection ( SHORT  nNumDevice  ) 

Opens a connection to the indicated device, if it exists.

Parameters:
nNumDevice the zero-based device number to open
Returns:
  • 1 - successfully connected
  • 0 - connection failed
See also:
GetNumDevices

gIIEPad::OpenConnection

void CloseConnection ( void   ) 

Closes the active device connection, if one exists.

See also:
gIIEPad::OpenConnection

SHORT connClearScreen ( void   ) 

Clears all layers of the active device's display via the graphics library. Requires previous execution of connStartDraw.

Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

SHORT connRefreshScreen ( SHORT  layer  ) 

Refreshes the active device's display from the cached image in PC memory. Requires previous execution of connStartDraw.

Parameters:
layer the layer(s) on the device's display to refresh
Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

SHORT connStartDraw ( void   ) 

Creates a graphics context for the active device. Requires that the device be opened previously with OpenConnection.

Returns:
  • 1 - success
  • 0 - failure
See also:
OpenConnection

SHORT connStopDraw ( SHORT  fSyncToDevice  ) 

Destroys the active graphics context for the active device.

Parameters:
fSyncToDevice reserved for future use
Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

SHORT connTextOut ( SHORT  Layer,
SHORT  xStart,
SHORT  yStart,
BSTR  lpString,
SHORT  nStrlen 
)

Draws text on the LCD at the given location using the last font set by connSetFont. Requires previous execution of connStartDraw.

Parameters:
Layer the layer on the device's display on which to draw the text
xStart position for left edge of text rectangle, measured from left edge of device's display
yStart position for top edge of text rectangle, measured from top edge of device's display
lpString text to be displayed
nStrlen length of lpString
Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

connSetFont

SHORT connSetFont ( BSTR  LogFontStr,
SHORT  FontStrLen 
)

Sets the current font for drawing methods. Requires previous execution of connStartDraw.

Parameters:
LogFontStr font name
FontStrLen length of LogFontStr
Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

connTextOut

SHORT connLoadBitmapToDevice ( SHORT  layer,
BSTR  lpFileName,
SHORT  nFileNameLen,
SHORT  nStretch,
SHORT  xPos,
SHORT  yPos 
)

Loads a bitmap to the device's display via the graphics library. Requires previous execution of connStartDraw.

Parameters:
layer the layer on the device's display on which to load the bitmap
lpFileName the fully qualified path of the graphic file to load
nFileNameLen length of lpFileName
nStretch determines whether the image should be stretched or not
  • 1 - stretch the image to fit the device's display
  • 0 - don't stretch the image
xPos position for left edge of image, measured from left edge of device's display
yPos position for top edge of image, measured from top edge of device's display
Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

SHORT connGetWhiteThreshold ( void   ) 

Requires previous execution of connStartDraw.

Returns:
the current white threshold for the graphics library
See also:
connStartDraw

ePadInk_GetWhiteThreshold

SHORT connGetBlackThreshold ( void   ) 

Requires previous execution of connStartDraw.

Returns:
the current black threshold for the graphics library
See also:
connStartDraw

ePadInk_GetBlackThreshold

SHORT connSetWhiteThreshold ( SHORT  WhiteVal  ) 

Sets the white threshold for the graphics library. Requires previous execution of connStartDraw.

Parameters:
WhiteVal the desired white threshold
Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

ePadInk_SetWhiteThreshold

SHORT connSetBlackThreshold ( SHORT  BlackVal  ) 

Sets the black threshold for the graphics library. Requires previous execution of connStartDraw.

Parameters:
BlackVal the desired black threshold
Returns:
  • 1 - success
  • 0 - failure
See also:
connStartDraw

ePadInk_SetBlackThreshold

SHORT connDrawLine ( SHORT  Layer,
SHORT  nColor,
SHORT  xStart,
SHORT  yStart,
SHORT  xEnd,
SHORT  yEnd 
)

Draws a line on the device's display, bypassing the graphics library. Use of this is not recommended if a graphics context is active as the PC-side cache will not be aware of the device's changed LCD graphics state.
Use with extreme caution.

Parameters:
Layer the layer on the device's display on which to draw the line
nColor the color of the line to draw
  • 1 - black
  • 0 - white
xStart position for the line's starting point, measured from left edge of device's display
yStart position for the line's starting point, measured from top edge of device's display
xEnd position for the line's ending point, measured from left edge of device's display
yEnd position for the line's ending point, measured from top edge of device's display
Returns:
  • 1 - success
  • 0 - failure
See also:
IWedge::ConnDrawLine

BSTR connGetSerialNumber ( void   ) 

Returns:
the serial number of the active device
See also:
openConnection

gIIEPad::ConnGetSerialNumber

LONG connGetDataRangeMinX ( void   ) 

Returns:
the minimum value of the active device's x-axis
See also:
openConnection

gIIEPad::ConnGetRanges

LONG connGetDataRangeMinY ( void   ) 

Returns:
the minimum value of the active device's y-axis
See also:
openConnection

gIIEPad::ConnGetRanges

LONG connGetDataRangeMinZ ( void   ) 

Returns:
the minimum value of the active device's z-axis (pressure)
See also:
openConnection

gIIEPad::ConnGetRanges

LONG connGetDataRangeMaxX ( void   ) 

Returns:
the maximum value of the active device's x-axis
See also:
gIIEPad::ConnGetRanges

openConnection

LONG connGetDataRangeMaxY ( void   ) 

Returns:
the maximum value of the active device's x-axis
See also:
openConnection

gIIEPad::ConnGetRanges

LONG connGetDataRangeMaxZ ( void   ) 

Returns:
the maximum value of the active device's z-axis (pressure)
See also:
openConnection

gIIEPad::ConnGetRanges

DOUBLE connGetPhysicalX ( void   ) 

Returns:
the width of the active device, in inches
See also:
openConnection

gIIEPad::ConnGetPhysicalExtents

DOUBLE connGetPhysicalY ( void   ) 

Returns:
the height of the active device, in inches
See also:
openConnection

gIIEPad::ConnGetPhysicalExtents

LONG connMapToLcdX ( LONG  lValue  ) 

Maps raw touchscreen data to pixel position on the active device's display.

Parameters:
lValue x-coordinate (horizontal position) of raw touchscreen data
Returns:
x-coordinate of corresponding device display pixel position
See also:
IWedge::ConnMapToLCD

LONG connMapToLcdY ( LONG  lValue  ) 

Maps raw touchscreen data to pixel position on the active device's display.

Parameters:
lValue y-coordinate (vertical position) of raw touchscreen data
Returns:
y-coordinate of corresponding device display pixel position
See also:
IWedge::ConnMapToLCD

SHORT connSetInkRegion ( SHORT  upperLeft_x,
SHORT  upperLeft_y,
SHORT  lowerRight_x,
SHORT  lowerRight_y 
)

Sets the inking region on the active device's display. This will limit the area where inking will occur on the device to the rectangle defined by the X and Y coordinates given.

Parameters:
upperLeft_x position for the inking region's left edge, measured from left edge of device's display
upperLeft_y position for the inking region's top edge, measured from left edge of device's display
lowerRight_x position for the inking region's right edge, measured from left edge of device's display
lowerRight_y position for the inking region's bottom edge, measured from left edge of device's display
Returns:
  • 1 - success
  • 0 - failure
See also:
IWedge::ConnSetOptions

BSTR connGetDebugParam ( BSTR  pKey  ) 

Gets the value of the specified debug parameter.

Parameters:
pKey the name of the debug parameter to check
Returns:
the debug parameter value
See also:
gIEDebugGUI::GetDebugParam

SHORT connSetDebugParam ( BSTR  pKey,
BSTR  pValue 
)

Sets the value of the specified debug parameter.

Parameters:
pKey the name of the debug parameter to set
pValue the value to set for the debug parameter
Returns:
  • 1 - success
  • 0 - failure
See also:
gIEDebugGUI::SetDebugParam

SHORT connSetUseSlowMethod ( SHORT  nUseSlowMethod  ) 

Causes images to be transferred to the device pixel-by-pixel rather than in blocks. Useful when high definition color images are used.
WARNING: This method causes transfer times to become very long. It is recommended that images be converted to monochrome before being transferred to the device for optimal performance.

Parameters:
nUseSlowMethod 
  • 0 - do not use slow method
  • 1 - use slow method
See also:
ePadInk_SetUseSlowMethod

SHORT connSetInkColor ( SHORT  InkColor  ) 

Sets the color for ink trails.

Parameters:
InkColor the color to be used for ink trails
  • 1 - black
  • 0 - white
Returns:
  • 1 - success
  • 0 - failure
See also:
IWedge::ConnSetOptions

SHORT connSetInkOptions ( SHORT  inkTrailsOpt,
SHORT  seconds 
)

Sets the ink trails behavior on the active device's display.

Parameters:
inkTrailsOpt the desired ink trails behavior
  • 0 - do not show ink trails
  • 1 - show ink trails until cleared via another method
  • 2 - show ink trails while pen data is being received and for 'n' seconds after pen lift
seconds number of seconds to show ink trails for (ignored unless inkTrailsOpt = 2)
Returns:
  • 1 - success
  • 0 - failure
See also:
IWedge::ConnSetOptions

SHORT connSetBgImg ( SHORT  bgImgOpt,
BSTR  bgImgPath 
)

Sets the background image to use on the active device's display.

Parameters:
bgImgOpt the desired background setting
  • 0 - no background (leave blank)
  • 1 - default background
  • 2 - user defined background
bgImgPath the fully qualified path of the graphic file to load (ignored unless bgImgOpt = 2)
Returns:
  • 1 - success
  • 0 - failure

SHORT connSetBacklight ( SHORT  BkLight,
SHORT  BkOnSeconds,
SHORT  BkIntensity 
)

Sets the backlight behavior on the active device's display.

Parameters:
BkLight the desired backlight behavior
  • 0 - backlight is always off
  • 1 - backlight is always on
  • 2 - backlight is on while pen data is being received and for 'n' seconds after pen lift
BkOnSeconds number of seconds to show backlight for (ignored unless BkLight = 2)
BkIntensity 
  • 0 - dim
  • 1 - bright
Returns:
  • 1 - success
  • 0 - failure
See also:
IWedge::ConnSetOptions

BSTR connGetFriendlyName ( BSTR  GUIDstr  ) 

Gets the friendly name of the device.

Parameters:
GUIDstr the serial number of the device
Returns:
the friendly name of the device
See also:
gIIEPad::GetFriendlyName

SHORT connSetFriendlyName ( BSTR  sGUID,
BSTR  sNewName 
)

Gets the friendly name of the device.

Parameters:
sGUID the serial number of the device
sNewName the friendly name to set
Returns:
  • 1 - success
  • 0 - failure
See also:
gIIEPad::SetFriendlyName

SHORT connSaveDefaults ( void   ) 

Save the current device settings as the defaults.

Returns:
  • 1 - success
  • 0 - failure
See also:
IWedge::SaveDefaults

SHORT connResetDeviceDefaults ( void   ) 

Resets the default settings to the factory defaults.

Returns:
  • 1 - success
  • 0 - failure
See also:
IWedge::ConnResetDefaults

SHORT connGetInkRegion_ULX ( void   ) 

Returns:
the position of the inking region's left edge, measured from left edge of device's display

SHORT connGetInkRegion_ULY ( void   ) 

Returns:
the position of the inking region's top edge, measured from left edge of device's display

SHORT connGetInkRegion_LRX ( void   ) 

Returns:
the position of the inking region's right edge, measured from left edge of device's display

SHORT connGetInkRegion_LRY ( void   ) 

Returns:
the position of position for the inking region's bottom edge, measured from left edge of device's display

SHORT connGetUseSlowMethod ( void   ) 

Returns:
the current value for slow method use
  • 0 - do not use slow method
  • 1 - use slow method
See also:
ePadInk_SetUseSlowMethod

SHORT connGetInkColor ( void   ) 

Returns:
the current ink trails color
  • 1 - black
  • 0 - white
See also:
IWedge::ConnSetOptions

SHORT connGetInkingBacklight ( void   ) 

Returns:
the current inking option
  • 0 - ink trails are not shown
  • 1 - ink trails are shown until cleared via another method
  • 2 - ink trails are shown while pen data is being received and for 'n' seconds after pen lift
See also:
IWedge::ConnSetOptions

SHORT connGetInkingSecond ( void   ) 

Returns:
the number of seconds set for the ink trails timer
See also:
IWedge::ConnSetOptions

SHORT connGetBgImgOptions ( void   ) 

Returns:
the current background image option
  • 0 - no background (blank)
  • 1 - default background
  • 2 - user defined background

BSTR connGetBgImgPath ( void   ) 

Returns:
the fully qualified path of the user-defined background image (NULL if no user-defined image is present)

SHORT connGetBacklightOption ( void   ) 

Returns:
the current backlight option
  • 0 - backlight is always off
  • 1 - backlight is always on
  • 2 - backlight is on while pen data is being received and for 'n' seconds after pen lift

SHORT connGetBacklightSecond ( void   ) 

Returns:
the number of seconds set for the backlight timer

SHORT connGetBacklightIntensity ( void   ) 

Returns:
the backlight intensity setting
  • 0 - dim
  • 1 - bright

SHORT connClearInk ( void   ) 

Clears the default inking layer on the active device's display. Note that this does not require a call to 'connStartDraw' first. Clearing the inking layer has no effect on the other 2 graphics layers.

Returns:
  • 1 - success
  • 0 - failure

LONG connGetMapInkingRegionOnly ( void   ) 

Returns:
the current value for the map inking region only setting
  • 0 - all pen data will be returned from the device
  • 1 - only pen data within the inking region will be returned from the device

LONG connSetMapInkingRegionOnly ( SHORT  sMapInkingRegionOnly  ) 

Sets the map inking region only behavior.
The inking region determines where ink trails will show up on the device. When sMapInkingRegionOnly is set to 1, the pen data is restricted to the same rectangle defined by the ink region. When sMapInkingRegionOnly is set to 0, all pen data is returned to the host application - even though the ink trails do not appear on the device's display.

Parameters:
sMapInkingRegionOnly the
  • 0 - all pen data will be returned from the device
  • 1 - only pen data within the inking region will be returned from the device

LONG ConnSetLayer ( SHORT  layer,
SHORT  intensity 
)

Sets the display intensity of the specified layer on the active device's display.

Parameters:
layer the layer number to modify
intensity the desired intensity for display of the layer
  • 0 - off (do not display)
  • 1 - on (display at full intensity)
  • 2 - flash (continuously toggle between on and off)
  • 3 - half (display at half intensity)
Returns:
  • 1 - success
  • 0 - failure

LONG connGetDC ( void   ) 

Returns:
a handle to the display device context

LONG connReleaseDC ( LONG  dc,
LONG  fSyncToDevice 
)

Releases the specified display device context.

Parameters:
dc the display device context to release
fSyncToDevice write the content of the display device context to the device before closing
  • 0 - no
  • 1 - yes
Returns:
  • 1 - success
  • 0 - failure

SHORT connDrawScreen ( SHORT  nLayer,
SHORT  xOrig,
SHORT  yOrig,
BSTR  sFileName 
)

Converts a bitmap file to monochrome color depth and displays it on the active device's display using the specified position and layer. Note: The bitmap must have the same height and width as the device's display.

Parameters:
nLayer the layer on the device's display on which to draw the bitmap
xOrig position for left edge of bitmap, measured from left edge of device's display
yOrig position for top edge of bitmap, measured from top edge of device's display
sFileName the fully qualified path of the bitmap file to load
Returns:
  • 1 - success
  • 0 - failure

Generated on Mon Dec 17 17:19:33 2007 for ePadAPIs by  doxygen 1.5.4