INudgeHandler Class Reference

#include <INudgeHandler.h>

Inheritance diagram for INudgeHandler:

Public Member Functions
virtual void	StartNudging ()=0
virtual void	DoNudge ()=0
virtual void	EndNudging ()=0
virtual void	SetLargeNudge (bool16 largeNudge)=0
virtual bool16	GetLargeNudge ()=0
virtual void	SetNudgeUp (bool16 nudgeUp)=0
virtual bool16	GetNudgeUp ()=0
virtual void	SetAssociateEditBox (IControlView *ebView)=0
virtual IControlView *	GetAssociateEditBox ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface supports nudging values in editboxes. There's some user behavior we want to support which requires us to have this fancy interface. Namely: If the user clicks once on a nudge arrow button for an editbox, we want to increase the value in the editbox, and notify so the action associated with the editbox will happen. If the user holds shift and clicks once on a nudge arrow button for an editbox, we want to increase the value in the editbox by a larger amount, and notify so the action associated with the editbox will happen. If the user clicks on the nudge arrow and holds down the mouse button, we want to do the nudging, but not actually do the action for the new value until they release the mouse. Typically a 3rd party would not have to call or implement this interface.

Member Function Documentation

virtual void INudgeHandler::DoNudge ( )

pure virtual

Nudge one increment

virtual void INudgeHandler::EndNudging ( )

pure virtual

Nudging is complete. This typically does a broadcast

virtual IControlView* INudgeHandler::GetAssociateEditBox ( )

pure virtual

Get the editbox we're going to be nudging.

Returns

the editbox widget we're nudging

virtual bool16 INudgeHandler::GetLargeNudge ( )

pure virtual

Get if we're doing large or small nudging.

Returns

kTrue if we are going to do large nudging.

virtual bool16 INudgeHandler::GetNudgeUp ( )

pure virtual

Get if we are going to nudge up or down.

Returns

kTrue if we're nudging up

virtual void INudgeHandler::SetAssociateEditBox ( IControlView *  ebView )

pure virtual

Set the editbox we're going to be nudging.

Parameters

ebView

the editbox widget we're going to nudge.

virtual void INudgeHandler::SetLargeNudge ( bool16  largeNudge )

pure virtual

Set if we're doing large or small nudging.

Parameters

largeNudge

true if we are going to do large nudging.

virtual void INudgeHandler::SetNudgeUp ( bool16  nudgeUp )

pure virtual

Set if we are going to nudge up or down.

Parameters

nudgeUp

kTrue if we are going to nudge up

virtual void INudgeHandler::StartNudging ( )

pure virtual

Nudging is beginning