InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Facade::ITextPreferencesFacade Class Referenceabstract
Inheritance diagram for Facade::ITextPreferencesFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTPREFERENCESFACADE }
 

Public Member Functions

virtual bool GetTextToolConvertsFrames () const =0
 
virtual ErrorCode SetTextToolConvertsFrames (bool bConvertToText) const =0
 
virtual ErrorCode SetDynamicAutoFlowOptions (bool enabled, DynamicAutoFlowKind kind, bool requireMaster, bool preserveRectoVerso, bool allowAutoDelete, IDataBase *db) const =0
 
virtual bool GetDynamicAutoFlowOptions (DynamicAutoFlowKind &kind, bool &requireMaster, bool &preserveRectoVerso, bool &allowAutoDelete, IDataBase *db) const =0
 
virtual ErrorCode SetDynamicAutoFlowSynchronous (bool enabled, DynamicAutoFlowKind kind, bool requireMaster, bool preserveRectoVerso, bool allowAutoDelete, bool syncStatus, IDataBase *db) const =0
 
virtual bool GetDynamicAutoFlowSynchronousStatus (IDataBase *db, bool &syncStatus) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual bool Facade::ITextPreferencesFacade::GetDynamicAutoFlowOptions (DynamicAutoFlowKindkind,
bool & requireMaster,
bool & preserveRectoVerso,
bool & allowAutoDelete,
IDataBasedb 
) const
pure virtual

Get the GetDynamicAutoFlowOptions

Parameters
db[IN]: IDataBase of the document containing the setting, or nil to get the setting from the application workspace.
kind[OUT]: the current dynamic autoflow kind for the given workspace (application or document)
requireMaster[OUT]: Restrict auto-insertion of pages to overridden master text frames whose associated master text frame is empty.
preserveRectoVerso[OUT]: When auto-adding or auto-deleting pages during dynamic autoflow, preserve recto-verso orientation of pages. This option is only applicable when inserting/deleting pages in the middle of a document.
allowAutoDelete[OUT]: Enable the auto-deleting of pages with empty threaded text frames.
Returns
whether or not dynamic autoflow is enabled
virtual bool Facade::ITextPreferencesFacade::GetDynamicAutoFlowSynchronousStatus (IDataBasedb,
bool & syncStatus 
) const
pure virtual

Get the Synchronous Status for Dynamic Reflow

Parameters
db[IN]: IDataBase of the document containing the setting, or nil to get the setting from the application workspace.
syncStatus[OUT]: true, if smart re-flow works in a synchronous manner, else false.
Returns
whether or not dynamic smart re-flow is enabled
virtual bool Facade::ITextPreferencesFacade::GetTextToolConvertsFrames () const
pure virtual
Return whether or not the text tool converts empty frames to text frames.

Returns
true if the text tool converts empty frames to text frames. false otherwise.
virtual ErrorCode Facade::ITextPreferencesFacade::SetDynamicAutoFlowOptions (bool enabled,
DynamicAutoFlowKind kind,
bool requireMaster,
bool preserveRectoVerso,
bool allowAutoDelete,
IDataBasedb 
) const
pure virtual
Set Dynamic Autoflow Options

Parameters
enabled[IN]: Set whether or not to enable auto-page insertion
kind[IN]: New auto-insert page setting to specify where to add pages.
requireMaster[IN]: Restrict auto-insertion of pages to overridden master text frames whose associated master text frame is empty.
preserveRectoVerso[IN]: When auto-adding or auto-deleting pages during dynamic autoflow, preserve recto-verso orientation of pages. This option is only applicable when inserting/deleting pages in the middle of a document.
allowAutoDelete[IN]: Enable the auto-deleting of pages with empty threaded text frames.
db[IN]: IDataBase of doc holding the setting. If nil, then the option will be set in the application workspace.
Returns
kSuccess if successful. Otherwise, an error code.
virtual ErrorCode Facade::ITextPreferencesFacade::SetDynamicAutoFlowSynchronous (bool enabled,
DynamicAutoFlowKind kind,
bool requireMaster,
bool preserveRectoVerso,
bool allowAutoDelete,
bool syncStatus,
IDataBasedb 
) const
pure virtual
Set Dynamic Autoflow Options along with synchronous state which determines

if auto flow work synchronously or not

Parameters
enabled[IN]: Set whether or not to enable auto-page insertion
kind[IN]: New auto-insert page setting to specify where to add pages.
requireMaster[IN]: Restrict auto-insertion of pages to overridden master text frames whose associated master text frame is empty.
preserveRectoVerso[IN]: When auto-adding or auto-deleting pages during dynamic autoflow, preserve recto-verso orientation of pages. This option is only applicable when inserting/deleting pages in the middle of a document.
allowAutoDelete[IN]: Enable the auto-deleting of pages with empty threaded text frames.
syncStatus[IN]: set whether or not smart re-flow should work synchronously or via idle task.
db[IN]: IDataBase of doc holding the setting. If nil, then the option will be set in the application workspace.
Returns
kSuccess if successful. Otherwise, an error code.
virtual ErrorCode Facade::ITextPreferencesFacade::SetTextToolConvertsFrames (bool bConvertToText) const
pure virtual
Set whether or not the text tool converts empty frames to text frames.

Parameters
bConvertToTextThe new boolean to store
Returns
kSuccess if successful. Otherwise, an error code.