IDisplayPointer Interface

IID_IDisplayPointer

{3050F69E-98B5-11CF-BB82-00AA00BDCE0B}

This interface provides methods that control display pointers, which enable you to mark sections of an HTML document for editing based on the document's on-screen rendering.

Documentation: IDisplayPointer Interface

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDisplayPointer Methods

Description

MoveToPoint

Moves this display pointer to the specified coordinates on a page.

MoveUnit

Moves a display pointer to the specified position.

PositionMarkupPointer

Positions a markup pointer at the location of the display pointer to which this interface refers.

MoveToPointer

Moves this display pointer to the position of another display pointer.

SetPointerGravity

Sets the pointer gravity for the display pointer.

GetPointerGravity

Retrieves the pointer gravity for the display pointer.

SetDisplayGravity

Sets the display gravity for the display pointer.

GetDisplayGravity

Retrieves the display gravity for the display pointer.

IsPositioned

Determines whether the display pointer has been positioned.

Unposition

Sets the display pointer to an unpositioned state.

IsEqualTo

Determines whether two display pointers specify the same position in the markup of an HTML document.

IsLeftOf

Determines whether the display pointer this interface refers to is to the left of another one.

IsRightOf

Determines whether the display pointer this interface refers to is to the right of another one.

IsAtBOL

Determines whether the display pointer is at the beginning of a line.

MoveToMarkupPointer

Moves this display pointer to the position of a markup pointer.

ScrollIntoView

Scrolls the location indicated by the display pointer into view.

GetLineInfo

Retrieves information about the line that the display pointer is on.

GetFlowElement

Retrieves the innermost element containing the display pointer that is a flow layout element.

QueryBreaks

Determines whether a line break or a block break, if any, occurs at the display pointer's location.

MoveToPoint

FUNCTION IDisplayPointer_MoveToPoint ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ptPoint AS POINTAPI _
, BYVAL eCoordSystem AS LONG _
, BYVAL pElementContext AS DWORD _
, BYVAL dwHitTestOptions AS DWORD _
, BYREF pdwHitTestResults AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IDisplayPointer_MoveToPoint (pthis, ptPoint, eCoordSystem, pElementContext, dwHitTestOptions, pdwHitTestResults) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveUnit

FUNCTION IDisplayPointer_MoveUnit ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL eMoveUnit AS LONG _
, BYVAL lXPos AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IDisplayPointer_MoveUnit (pthis, eMoveUnit, lXPos) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

PositionMarkupPointer

FUNCTION IDisplayPointer_PositionMarkupPointer ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pMarkupPointer AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[5] USING IDisplayPointer_PositionMarkupPointer (pthis, pMarkupPointer) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveToPointer

FUNCTION IDisplayPointer_MoveToPointer ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pDispPointer AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IDisplayPointer_MoveToPointer (pthis, pDispPointer) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetPointerGravity

FUNCTION IDisplayPointer_SetPointerGravity ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL eGravity AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IDisplayPointer_SetPointerGravity (pthis, eGravity) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetPointerGravity

FUNCTION IDisplayPointer_GetPointerGravity ( _
  BYVAL pthis AS DWORD PTR _
, BYREF peGravity AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IDisplayPointer_GetPointerGravity (pthis, peGravity) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetDisplayGravity

FUNCTION IDisplayPointer_SetDisplayGravity ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL eGravity AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IDisplayPointer_SetDisplayGravity (pthis, eGravity) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetPointerGravity

FUNCTION IDisplayPointer_GetDisplayGravity ( _
  BYVAL pthis AS DWORD PTR _
, BYREF peGravity AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IDisplayPointer_GetDisplayGravity (pthis, peGravity) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsPositioned

FUNCTION IDisplayPointer_IsPositioned ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pfPositioned AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IDisplayPointer_IsPositioned (pthis, pfPositioned) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Unposition

FUNCTION IDisplayPointer_Unposition ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[12] USING IDisplayPointer_Unposition (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsEqualTo

FUNCTION IDisplayPointer_IsEqualTo ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pDispPointer AS DWORD _
, BYREF pfIsEqual AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[13] USING IDisplayPointer_IsEqualTo (pthis, pDispPointer, pfIsEqual) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsLeftOf

FUNCTION IDisplayPointer_IsLeftOf ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pDispPointer AS DWORD _
, BYREF pfIsLeftOf AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[14] USING IDisplayPointer_IsLeftOf (pthis, pDispPointer, pfIsLeftOf) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsRightOf

FUNCTION IDisplayPointer_IsRightOf ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pDispPointer AS DWORD _
, BYREF pfIsRightOf AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[15] USING IDisplayPointer_IsRightOf (pthis, pDispPointer, pfIsRightOf) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsAtBOL

FUNCTION IDisplayPointer_IsAtBOL ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pfBool AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[16] USING IDisplayPointer_IsAtBOL (pthis, pfBool) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveToMarkupPointer

FUNCTION IDisplayPointer_MoveToMarkupPointer ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointer AS DWORD _
, BYVAL pDispLineContext AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[17] USING IDisplayPointer_MoveToMarkupPointer (pthis, pPointer, pDispLineContext) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

ScrollIntoView

FUNCTION IDisplayPointer_ScrollIntoView ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[18] USING IDisplayPointer_ScrollIntoView (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetLineInfo

FUNCTION IDisplayPointer_GetLineInfo ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppLineInfo AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[19] USING IDisplayPointer_GetLineInfo (pthis, ppLineInfo) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetFlowElement

FUNCTION IDisplayPointer_GetFlowElement ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppLayoutElement AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[20] USING IDisplayPointer_GetFlowElement (pthis, ppLayoutElement) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

QueryBreaks

FUNCTION IDisplayPointer_QueryBreaks ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pdwBreaks AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[21] USING IDisplayPointer_QueryBreaks (pthis, pdwBreaks) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION