ADMBaseControl Class Reference

Base class for ADM controls. More...

#include <ADMBaseControl.h>

Inherited by ADMButton, and ADMMoveProgress.

List of all members.

Public Member Functions

virtual void ConnectToControl (ADMItemRef control, unsigned int uFlags=CFNotify)
 Call to connect an ADMBaseControl object to an ADM control.

Protected Types

enum  CreateFlags
 

Connection flags for callbacks.


Protected Member Functions

 ADMBaseControl (ADMItemRef control, unsigned int uFlags)
 Constructor for initialized controls.
 ADMBaseControl ()
 Default constructor for uninitialized controls; use ConnectToControl() later.
virtual void OnDraw (ADMDrawerRef inDrawer)
 Called when the control is to be drawn.
virtual void OnNotify (ADMNotifierRef notifier)
 Called when the user clicks the control.

Static Protected Member Functions

static void ASAPI DrawCallback (ADMItemRef itemRef, ADMDrawerRef inDrawer)
 Called by Acrobat when the control is to be drawn.
static void ASAPI NotifyCallback (ADMItemRef itemRef, ADMNotifierRef notifier)
 Called by Acrobat when the user has interacted with the control.

Protected Attributes

ADMItemRef m_refItem
 ADM reference of the control.

Detailed Description

Base class for ADM controls.

Definition at line 36 of file ADMBaseControl.h.


Constructor & Destructor Documentation

ADMBaseControl::ADMBaseControl ( ADMItemRef  control,
unsigned int  uFlags 
) [inline, protected]

Constructor for initialized controls.

Parameters:
control Reference to the ADM control
uFlags Connection flags

Definition at line 45 of file ADMBaseControl.h.

References ConnectToControl().


Member Function Documentation

void ADMBaseControl::ConnectToControl ( ADMItemRef  control,
unsigned int  uFlags = CFNotify 
) [virtual]

Call to connect an ADMBaseControl object to an ADM control.

Parameters:
control Reference to the ADM control
uFlags Connection flags

Reimplemented in ADMLinkButton, and ADMMoveProgress.

Definition at line 32 of file ADMBaseControl.cpp.

References DrawCallback(), m_refItem, and NotifyCallback().

Referenced by ADMBaseControl(), ADMBaseDialog::ConnectControl(), ADMBaseDialog::SetCancelBtn(), and ADMBaseDialog::SetOKBtn().

void ASAPI ADMBaseControl::DrawCallback ( ADMItemRef  itemRef,
ADMDrawerRef  inDrawer 
) [static, protected]

Called by Acrobat when the control is to be drawn.

Parameters:
itemRef Reference of the item to be drawn
inDrawer Reference of the drawing ADM object

Definition at line 51 of file ADMBaseControl.cpp.

References m_refItem, and OnDraw().

Referenced by ConnectToControl().

void ASAPI ADMBaseControl::NotifyCallback ( ADMItemRef  itemRef,
ADMNotifierRef  notifier 
) [static, protected]

Called by Acrobat when the user has interacted with the control.

Parameters:
itemRef Reference to the ADM control
notifier ADM notification object

Definition at line 72 of file ADMBaseControl.cpp.

References m_refItem, and OnNotify().

Referenced by ConnectToControl().

virtual void ADMBaseControl::OnDraw ( ADMDrawerRef  inDrawer  )  [inline, protected, virtual]

Called when the control is to be drawn.

Parameters:
inDrawer Referense to the ADM drawing object

By default, performs the ADM default drawing

Reimplemented in ADMLinkButton, and ADMMoveProgress.

Definition at line 78 of file ADMBaseControl.h.

References m_refItem.

Referenced by DrawCallback().

virtual void ADMBaseControl::OnNotify ( ADMNotifierRef  notifier  )  [inline, protected, virtual]

Called when the user clicks the control.

Parameters:
notifier Reference to the ADM notification object

By default, performs the default ADM handling of the click

Reimplemented in ADMButton, and ADMCloseDialogButton.

Definition at line 85 of file ADMBaseControl.h.

References m_refItem.

Referenced by NotifyCallback(), and ADMButton::OnNotify().


The documentation for this class was generated from the following files:

Generated on Thu Dec 17 17:37:08 2009 for CCInfo PDF Plugin by doxygen 1.6.1