fe::ITextScalerFactory Class Reference
[Ferry Extensions library]

Factory to create text scaler editor extension. More...

Inheritance diagram for fe::ITextScalerFactory:

List of all members.

Public Member Functions
virtual double UC_DLL_CALL	getScale () const =0
virtual void UC_DLL_CALL	setScale (double scale)=0

---

Detailed Description

Factory to create text scaler editor extension.

This editor extension implements text scale feature. The following sample demonstrates how to scale text in editor:

#include "fe/ferry_extensions.h"


fe::IExtension*
scaleText(fe::FeHandle* editor)
{
    fe::IExtension* scaler = 0;

    // Create factory.
    fe::ITextScalerFactory* factory = Fe_CreateTextScalerFactory();
    if(factory)
    {   // Set scale factor.
        factory->setScale(1.3);

        // Create text scaler editor extension.
        scaler = factory->createExtension();

        // Once extension is created, factory can be deleted as it is
        // not needed any more.
        delete factory;

        if(scaler)
        {   // Attach to the editor, i.e. scale editor's text.
            if(!scaler->attachToEditor(editor))
            {   // Attach failed, delete scaler.
                delete scaler;
                scaler = 0;
            }
        }
    }

    // Caller should call 'scaler->detachFromEditor(editor)' or just simply
    // 'delete scaler' when scaling is not needed any more for the 'editor'.
    // Note: 'delete scaler' should be called anyway to free resources.
    return scaler;
}

No scale:

x1.3 scale:

See also:

Fe_CreateTextScalerFactory()

---

Member Function Documentation

virtual void UC_DLL_CALL fe::ITextScalerFactory::setScale

(

double

scale

)

[pure virtual]

Sets new scale factor. The effective scale factor is an absolute value of the given scale value.

Parameters:

scale

new scale factor.

virtual double UC_DLL_CALL fe::ITextScalerFactory::getScale

(

)

const [pure virtual]

Returns scale factor set with the previous call to setScale() or 1.0 if setScale() has not been called yet. Returns -1.0 if error occurred.

---

The documentation for this class was generated from the following file:

• fe/ext/text_scaler_factory.h