InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IInLineEditController Class Referenceabstract

#include <IInLineEditController.h>

Inheritance diagram for IInLineEditController:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINLINEEDITCONTROLLER }
 

Public Member Functions

virtual bool16 BeginEditing ()=0
 
virtual bool16 StopEditing (bool16 syncData=kTrue, bool16 releaseKeyFocus=kTrue)=0
 
virtual bool16 IsBeingEdited () const =0
 
virtual void SyncFilteringNode ()=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

InLineEdit widget normally displayed as static text. Under certain event (e.g. double click), static text can be changed on the spot. This interface controls start and stop editing mode of InLineEdit widget.

Member Function Documentation

virtual bool16 IInLineEditController::BeginEditing ()
pure virtual

Switch InLineEdit widget into editing mode.

Returns
kTrue if entering editing mode successfully, kFalse otherwise
virtual bool16 IInLineEditController::IsBeingEdited () const
pure virtual

Return kTrue if being edited currently, kFalse otherwise

Returns
kTrue kTrue if being edited currently, kFalse otherwise
virtual bool16 IInLineEditController::StopEditing (bool16 syncData = kTrue,
bool16 releaseKeyFocus = kTrue 
)
pure virtual

Switch InLineEdit widget off editing mode.

Returns
kTrue if quiting editing mode successfully, kFalse otherwise