EpadInkLib::_DEpadInk Interface Reference

import "EpadInk.idl";

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 backlight, SHORT seconds)
SHORT connSetBgImg (SHORT bgImgOpt, BSTR bgImgPath)
SHORT connSetBacklight (SHORT BkLight, SHORT BkOnSeconds, SHORT BkIntensify)
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)


Detailed Description

Definition at line 36 of file EpadInk.idl.


Member Function Documentation

void EpadInkLib::_DEpadInk::AboutBox  ) 
 

Displays aboutBox dialog

void EpadInkLib::_DEpadInk::CloseConnection void   ) 
 

Closes the active connection to a device, if it exists.

See also:
gIIEPad::OpenConnection

SHORT EpadInkLib::_DEpadInk::connClearInk void   ) 
 

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

SHORT EpadInkLib::_DEpadInk::connClearScreen void   ) 
 

Clears all layers of the LCD display via the graphics library. Requires previous execution of connStartDraw.

SHORT EpadInkLib::_DEpadInk::connDrawLine SHORT  Layer,
SHORT  nColor,
SHORT  xStart,
SHORT  yStart,
SHORT  xEnd,
SHORT  yEnd
 

Draws a line on the LCD 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.

See also:
IWedge::ConnDrawLine

SHORT EpadInkLib::_DEpadInk::connDrawScreen SHORT  nLayer,
SHORT  xOrig,
SHORT  yOrig,
BSTR  sFileName
 

Given a bitmap file with same width and height as ePad device, connDrawScreen converts it to monochrome format and retrieves bitmap bits then displays on the ePad's (xOrig, yOrig) position at nLayer.

SHORT EpadInkLib::_DEpadInk::connGetBacklightIntensity void   ) 
 

SHORT EpadInkLib::_DEpadInk::connGetBacklightOption void   ) 
 

SHORT EpadInkLib::_DEpadInk::connGetBacklightSecond void   ) 
 

SHORT EpadInkLib::_DEpadInk::connGetBgImgOptions void   ) 
 

BSTR EpadInkLib::_DEpadInk::connGetBgImgPath void   ) 
 

SHORT EpadInkLib::_DEpadInk::connGetBlackThreshold void   ) 
 

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

See also:
connStartDraw

ePadInk_GetBlackThreshold

LONG EpadInkLib::_DEpadInk::connGetDataRangeMaxX void   ) 
 

Returns max X value of current device

See also:
gIIEPad::ConnGetRanges

openConnection

LONG EpadInkLib::_DEpadInk::connGetDataRangeMaxY void   ) 
 

Returns max Y value of current device

See also:
openConnection

gIIEPad::ConnGetRanges

LONG EpadInkLib::_DEpadInk::connGetDataRangeMaxZ void   ) 
 

Returns max Z value of current device

See also:
openConnection

gIIEPad::ConnGetRanges

LONG EpadInkLib::_DEpadInk::connGetDataRangeMinX void   ) 
 

Returns min X value of current device

See also:
openConnection

gIIEPad::ConnGetRanges

LONG EpadInkLib::_DEpadInk::connGetDataRangeMinY void   ) 
 

Returns min Y value of current device

See also:
openConnection

gIIEPad::ConnGetRanges

LONG EpadInkLib::_DEpadInk::connGetDataRangeMinZ void   ) 
 

Returns min Z value of current device

See also:
openConnection

gIIEPad::ConnGetRanges

LONG EpadInkLib::_DEpadInk::connGetDC void   ) 
 

BSTR EpadInkLib::_DEpadInk::connGetDebugParam BSTR  pKey  ) 
 

See also:
gIEDebugGUI::GetDebugParam

BSTR EpadInkLib::_DEpadInk::connGetFriendlyName BSTR  GUIDstr  ) 
 

See also:
gIIEPad::GetFriendlyName

SHORT EpadInkLib::_DEpadInk::connGetInkColor void   ) 
 

See also:
IWedge::ConnSetOptions

SHORT EpadInkLib::_DEpadInk::connGetInkingBacklight void   ) 
 

See also:
IWedge::ConnSetOptions

SHORT EpadInkLib::_DEpadInk::connGetInkingSecond void   ) 
 

See also:
IWedge::ConnSetOptions

SHORT EpadInkLib::_DEpadInk::connGetInkRegion_LRX void   ) 
 

SHORT EpadInkLib::_DEpadInk::connGetInkRegion_LRY void   ) 
 

SHORT EpadInkLib::_DEpadInk::connGetInkRegion_ULX void   ) 
 

SHORT EpadInkLib::_DEpadInk::connGetInkRegion_ULY void   ) 
 

LONG EpadInkLib::_DEpadInk::connGetMapInkingRegionOnly void   ) 
 

DOUBLE EpadInkLib::_DEpadInk::connGetPhysicalX void   ) 
 

Returns physical extents in inches of current device.

See also:
openConnection

gIIEPad::ConnGetPhysicalExtents

DOUBLE EpadInkLib::_DEpadInk::connGetPhysicalY void   ) 
 

Returns physical extents in inches of current device.

See also:
openConnection

gIIEPad::ConnGetPhysicalExtents

BSTR EpadInkLib::_DEpadInk::connGetSerialNumber void   ) 
 

Returns the serial # of the current opened device

See also:
openConnection

gIIEPad::ConnGetSerialNumber

SHORT EpadInkLib::_DEpadInk::connGetUseSlowMethod void   ) 
 

See also:
ePadInk_SetUseSlowMethod

SHORT EpadInkLib::_DEpadInk::connGetWhiteThreshold void   ) 
 

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

See also:
connStartDraw

ePadInk_GetWhiteThreshold

SHORT EpadInkLib::_DEpadInk::connLoadBitmapToDevice SHORT  layer,
BSTR  lpFileName,
SHORT  nFileNameLen,
SHORT  nStretch,
SHORT  xPos,
SHORT  yPos
 

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

See also:
connStartDraw

LONG EpadInkLib::_DEpadInk::connMapToLcdX LONG  lValue  ) 
 

See also:
IWedge::ConnMapToLCD

LONG EpadInkLib::_DEpadInk::connMapToLcdY LONG  lValue  ) 
 

See also:
IWedge::ConnMapToLCD

SHORT EpadInkLib::_DEpadInk::connRefreshScreen SHORT  layer  ) 
 

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

LONG EpadInkLib::_DEpadInk::connReleaseDC LONG  dc,
LONG  fSyncToDevice
 

SHORT EpadInkLib::_DEpadInk::connResetDeviceDefaults void   ) 
 

See also:
IWedge::ConnResetDefaults

SHORT EpadInkLib::_DEpadInk::connSaveDefaults void   ) 
 

See also:
IWedge::SaveDefaults

SHORT EpadInkLib::_DEpadInk::connSetBacklight SHORT  BkLight,
SHORT  BkOnSeconds,
SHORT  BkIntensify
 

See also:
IWedge::ConnSetOptions

SHORT EpadInkLib::_DEpadInk::connSetBgImg SHORT  bgImgOpt,
BSTR  bgImgPath
 

SHORT EpadInkLib::_DEpadInk::connSetBlackThreshold SHORT  BlackVal  ) 
 

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

See also:
connStartDraw

ePadInk_SetBlackThreshold

SHORT EpadInkLib::_DEpadInk::connSetDebugParam BSTR  pKey,
BSTR  pValue
 

This method can be called before openConnection() is issued. One of the functions frequently used is to suppress the configuration dialog. To do so, set pKey = "openConfig" and pValue = "0".

See also:
gIEDebugGUI::SetDebugParam

SHORT EpadInkLib::_DEpadInk::connSetFont BSTR  LogFontStr,
SHORT  FontStrLen
 

Sets the current font. Requires previous execution of connStartDraw.

See also:
connStartDraw

connTextOut

SHORT EpadInkLib::_DEpadInk::connSetFriendlyName BSTR  sGUID,
BSTR  sNewName
 

See also:
gIIEPad::SetFriendlyName

SHORT EpadInkLib::_DEpadInk::connSetInkColor SHORT  InkColor  ) 
 

See also:
IWedge::ConnSetOptions

SHORT EpadInkLib::_DEpadInk::connSetInkOptions SHORT  backlight,
SHORT  seconds
 

See also:
IWedge::ConnSetOptions

SHORT EpadInkLib::_DEpadInk::connSetInkRegion SHORT  upperLeft_x,
SHORT  upperLeft_y,
SHORT  lowerRight_x,
SHORT  lowerRight_y
 

See also:
IWedge::ConnSetOptions

LONG EpadInkLib::_DEpadInk::ConnSetLayer SHORT  layer,
SHORT  intensity
 

LONG EpadInkLib::_DEpadInk::connSetMapInkingRegionOnly SHORT  sMapInkingRegionOnly  ) 
 

SHORT EpadInkLib::_DEpadInk::connSetUseSlowMethod SHORT  nUseSlowMethod  ) 
 

See also:
ePadInk_SetUseSlowMethod

SHORT EpadInkLib::_DEpadInk::connSetWhiteThreshold SHORT  WhiteVal  ) 
 

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

See also:
connStartDraw

ePadInk_SetWhiteThreshold

SHORT EpadInkLib::_DEpadInk::connStartDraw void   ) 
 

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

See also:
OpenConnection

SHORT EpadInkLib::_DEpadInk::connStopDraw SHORT  fSyncToDevice  ) 
 

Destroys the active graphics context for the current device.

See also:
connStartDraw

SHORT EpadInkLib::_DEpadInk::connTextOut SHORT  Layer,
SHORT  xStart,
SHORT  yStart,
BSTR  lpString,
SHORT  nStrlen
 

Draws the given text on the LCD at the given location using the current font. Requires previous execution of connStartDraw.

See also:
connStartDraw

connSetFont

SHORT EpadInkLib::_DEpadInk::GetNumDevices void   ) 
 

Returns the # of attached ePadInk devices. Note that the index # is zero-based, thus if a single unit is reported it's index will be 0:

              SHORT sNumDevices = pInk->GetNumDevices();
              if ( sNumDevices>0 ) {
                 ...
                 SHORT sResult = pInk->OpenConnection(0);
                 ...
              } // endif
            
See also:
gIIEPad::GetNumDevices

SHORT EpadInkLib::_DEpadInk::OpenConnection SHORT  nNumDevice  ) 
 

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

See also:
GetNumDevices

gIIEPad::OpenConnection


Generated on Tue Nov 21 11:11:30 2006 for ePadAPIs by  doxygen 1.4.6-NO