IGalleySwitch.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IGalleySwitch__
#define __IGalleySwitch__

#include "IPMUnknown.h"
#include "WritingModeUIID2.h"
#include "WritingModeID2.h"
#include "PMPoint.h"
#include "UIDList.h"

const ClassID kSwitchedToGalley = 'SwGl'; // these are broadcast by IGalleySwitch after it switches
const ClassID kSwitchedToLayout = 'SwLy';
const ClassID kSwitchingToGalley = 'SwGb'; // these are broadcast by IGalleySwitch before it switches
const ClassID kSwitchingToLayout = 'SwLb';
const ClassID kPreSwitchGalleyStory = 'BSGS'; // Broadcast before story switch in galley
const ClassID kPostSwitchGalleyStory = 'ASGS'; // Broadcast after story switch in galley

class IControlView;
class IFocusCache;
class ITextModel;
class IWaxRun;
class IDocument;

#define kMinPrintGalleyHeight 500

class IGalleySwitch : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IGALLEYSWITCH};
 
 enum {kInvalidUniqueID = 0};

 virtual ErrorCode OpenNewGalleyWindow(const UIDList &stories) = 0;

 virtual bool IsInGalley() = 0;
 
 virtual void SetGalleyStoryIndex(int32 index) = 0;
 
 virtual int32 GetGalleyStoryIndex() = 0;
 
 virtual UIDRef GetCurrentStoryRef() = 0;
 
 virtual IControlView *GetGalleyView() = 0;
 
 virtual uint32 GetUniqueSessionID() = 0;
};

#endif // __IGalleySwitch__