ITextBehaviour.h

Go to the documentation of this file.

/******************************************************************************
* ADOBE CONFIDENTIAL
* ___________________
*
*  Copyright [2013] Adobe Systems Incorporated
*  All Rights Reserved.
*
* NOTICE:  All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any.  The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by all applicable intellectual 
* property laws, including trade secret and copyright laws.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
******************************************************************************/

#ifndef ITEXT_BEHAVIOUR_H_
#define ITEXT_BEHAVIOUR_H_

#include "FCMPreConfig.h"
#include "FCMPluginInterface.h"
#include "IFCMUnknown.h"


/* -------------------------------------------------- Forward Decl */


/* -------------------------------------------------- Enums */

namespace DOM
{
    namespace FrameElement
    {
        enum OrientationMode
        {
            ORIENTATION_MODE_HORIZONTAL,
                

            ORIENTATION_MODE_VERTICAL
        };

            
        enum TextFlow
        {
            TEXT_FLOW_LEFT_TO_RIGHT,
                

            TEXT_FLOW_RIGHT_TO_LEFT
        };
        

        enum LineMode
        {
            LINE_MODE_SINGLE,
                

            LINE_MODE_MULTI,
                

            LINE_MODE_MULTI_NO_WRAP
        };
    }
}


/* -------------------------------------------------- Macros / Constants */


namespace DOM 
{
    namespace FrameElement
    {
    
        FCM::ConstFCMIID IID_ITEXT_BEHAVIOUR =
            {0xcd4a280, 0x95e3, 0x4476, {0xa0, 0x64, 0x41, 0x98, 0x4a, 0x58, 0x94, 0x33}};


        FCM::ConstFCMIID IID_ISTATIC_TEXT_BEHAVIOUR =
                {0x6327c2d6, 0xb763, 0x4ac9, {0x8f, 0xbd, 0xf4, 0xc2, 0x91, 0x34, 0xd1, 0x7c}};


        FCM::ConstFCMIID IID_IMODIFIABLE_TEXT_BEHAVIOUR =
            {0x6499d11f, 0x6af1, 0x4403, {0xbd, 0xb1, 0x76, 0x2, 0x14, 0xf3, 0x9d, 0x95}};


        FCM::ConstFCMIID IID_IDYNAMIC_TEXT_BEHAVIOUR =
            {0x94655a95, 0x990b, 0x4540, {0x91, 0x5b, 0x70, 0x52, 0x93, 0x32, 0x31, 0xf8}};


        FCM::ConstFCMIID IID_IINPUT_TEXT_BEHAVIOUR =
                {0x9d1e6460, 0x990f, 0x4d81, {0xbb, 0x24, 0x8d, 0x91, 0x59, 0xcd, 0x96, 0xf9}};            
        
    }
}


/* -------------------------------------------------- Structs / Unions */


/* -------------------------------------------------- Class Decl */

namespace DOM 
{
    namespace FrameElement
    {
        BEGIN_DECLARE_INTERFACE(ITextBehaviour, IID_ITEXT_BEHAVIOUR)

             
             virtual FCM::Result _FCMCALL IsSelectable(FCM::Boolean& selectable) = 0;
            
        END_DECLARE_INTERFACE 
            

        BEGIN_DECLARE_INTERFACE(IStaticTextBehaviour, IID_ISTATIC_TEXT_BEHAVIOUR) 
                
            virtual FCM::Result _FCMCALL GetOrientationMode(OrientationMode& orientationMode) = 0;
        

            virtual FCM::Result _FCMCALL GetFlow(TextFlow& flow) = 0;

        END_DECLARE_INTERFACE 


        BEGIN_DECLARE_INTERFACE(IModifiableTextBehaviour, IID_IMODIFIABLE_TEXT_BEHAVIOUR)
            
            virtual FCM::Result _FCMCALL GetInstanceName(FCM::StringRep16* ppName) = 0;
            

             virtual FCM::Result _FCMCALL GetLineMode(LineMode& lineMode) = 0;
        

            virtual FCM::Result _FCMCALL IsScrollable(FCM::Boolean& scrollable) = 0;
            

            virtual FCM::Result _FCMCALL IsBorderDrawn(FCM::Boolean& borderDrawn) = 0;
            

            virtual FCM::Result _FCMCALL GetRenderAsHtml(FCM::Boolean& renderAsHtml) = 0;            

        END_DECLARE_INTERFACE 
            

        BEGIN_DECLARE_INTERFACE(IDynamicTextBehaviour, IID_IDYNAMIC_TEXT_BEHAVIOUR)               
                
        END_DECLARE_INTERFACE 
            

        BEGIN_DECLARE_INTERFACE(IInputTextBehaviour, IID_IINPUT_TEXT_BEHAVIOUR)
                
            virtual FCM::Result _FCMCALL IsLineModePassword(FCM::Boolean& password) = 0;

        END_DECLARE_INTERFACE 
        
    }
}


/* -------------------------------------------------- Inline / Functions */


#include "FCMPostConfig.h"

#endif // ITEXT_BEHAVIOUR_H_