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

#include <IEasterEgg.h>

Inheritance diagram for IEasterEgg:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IEASTEREGG }
 

Public Member Functions

virtual const char * GetKeyString ()=0
 
virtual void ShowEasterEgg (IWindow *window)=0
 
virtual void CloseEasterEgg ()=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

Not the most supported interface, the IEasterEgg interface is a service provider interface (kEasterEggService) that can be called when a certain key string is typed when the about box is open. IT MIGHT BE UNSUPPORTED RIGHT NOW.

Member Function Documentation

virtual void IEasterEgg::CloseEasterEgg ()
pure virtual

The object that calls ShowEasterEgg should call this before closing the window. This will give the egg an opportunity to stop any idle tasks it has running and gracefully shutdown.

virtual const char* IEasterEgg::GetKeyString ()
pure virtual

What sequence of keys must be typed before your easter egg is displayed? The strings are combined into a single state-machine that looks for matches.

Returns
the sequence of characters to match.
virtual void IEasterEgg::ShowEasterEgg (IWindow * window)
pure virtual

When the user types the necessary key string, the about box will call this method, passing in a pointer to the IWindow interface of the about box. Do what you will. Caveat Emptor and all that.

Parameters
windowis the window to display your handiwork in.