Класс CD2DTextLayoutCD2DTextLayout Class

Оболочка для Идвритетекстлайаут.A wrapper for IDWriteTextLayout.

СинтаксисSyntax

class CD2DTextLayout : public CD2DResource;

ЧленыMembers

Открытые конструкторыPublic Constructors

nameName ОписаниеDescription
CD2DTextLayout::CD2DTextLayoutCD2DTextLayout::CD2DTextLayout Конструирует объект CD2DTextLayout.Constructs a CD2DTextLayout object.
CD2DTextLayout:: ~ CD2DTextLayoutCD2DTextLayout::~CD2DTextLayout ДеструкторThe destructor. Вызывается при уничтожении объекта макета текста D2D.Called when a D2D text layout object is being destroyed.

Открытые методыPublic Methods

nameName ОписаниеDescription
CD2DTextLayout:: CreateCD2DTextLayout::Create Создает CD2DTextLayout.Creates a CD2DTextLayout. (Переопределяет CD2DResource:: Create.)(Overrides CD2DResource::Create.)
CD2DTextLayout::D естройCD2DTextLayout::Destroy Уничтожает объект CD2DTextLayout.Destroys a CD2DTextLayout object. (Переопределяет CD2DResource::D естрой.)(Overrides CD2DResource::Destroy.)
CD2DTextLayout:: GetCD2DTextLayout::Get Возвращает интерфейс ИдвритетекстлайаутReturns IDWriteTextLayout interface
CD2DTextLayout:: ЖетфонтфамилинамеCD2DTextLayout::GetFontFamilyName Копирует имя семейства шрифтов для текста в указанной позиции.Copies the font family name of the text at the specified position.
CD2DTextLayout:: ЖетлокаленамеCD2DTextLayout::GetLocaleName Возвращает имя локали текста в указанной позиции.Gets the locale name of the text at the specified position.
CD2DTextLayout:: IsValidCD2DTextLayout::IsValid Проверяет допустимость ресурса (переопределяет CD2DResource:: IsValid.)Checks resource validity (Overrides CD2DResource::IsValid.)
CD2DTextLayout:: повторное созданиеCD2DTextLayout::ReCreate Повторно создает CD2DTextLayout.Re-creates a CD2DTextLayout. (Переопределяет CD2DResource:: recreate.)(Overrides CD2DResource::ReCreate.)
CD2DTextLayout:: СетфонтфамилинамеCD2DTextLayout::SetFontFamilyName Задает имя семейства шрифтов, заканчивающееся нулем, для текста в указанном текстовом диапазонеSets null-terminated font family name for text within a specified text range
CD2DTextLayout:: СетлокаленамеCD2DTextLayout::SetLocaleName Задает имя локали для текста в указанном текстовом диапазонеSets the locale name for text within a specified text range

Открытые операторыPublic Operators

ИмяName ОписаниеDescription
CD2DTextLayout:: operator Идвритетекстлайаут *CD2DTextLayout::operator IDWriteTextLayout* Возвращает интерфейс ИдвритетекстлайаутReturns IDWriteTextLayout interface

Защищенные члены данныхProtected Data Members

ИмяName ОписаниеDescription
CD2DTextLayout:: m_pTextLayoutCD2DTextLayout::m_pTextLayout Указатель на Идвритетекстлайаут.A pointer to an IDWriteTextLayout.

Иерархия наследованияInheritance Hierarchy

CObjectCObject

CD2DResourceCD2DResource

CD2DTextLayoutCD2DTextLayout

ТребованияRequirements

Заголовок: афксрендертаржет. hHeader: afxrendertarget.h

CD2DTextLayout:: ~ CD2DTextLayoutCD2DTextLayout::~CD2DTextLayout

ДеструкторThe destructor. Вызывается при уничтожении объекта макета текста D2D.Called when a D2D text layout object is being destroyed.

virtual ~CD2DTextLayout();

CD2DTextLayout::CD2DTextLayoutCD2DTextLayout::CD2DTextLayout

Конструирует объект CD2DTextLayout.Constructs a CD2DTextLayout object.

CD2DTextLayout(
    CRenderTarget* pParentTarget,
    const CString& strText,
    CD2DTextFormat& textFormat,
    const CD2DSizeF& sizeMax,
    BOOL bAutoDestroy = TRUE);

ПараметрыParameters

ппаренттаржетpParentTarget
Указатель на целевой объект прорисовки.A pointer to the render target.

стртекстstrText
Объект CString, содержащий строку для создания нового объекта CD2DTextLayout из.A CString object that contains the string to create a new CD2DTextLayout object from.

textFormattextFormat
Объект CString, содержащий формат, применяемый к строке.A CString object that contains the format to apply to the string.

сиземаксsizeMax
Размер поля макета.The size of the layout box.

баутодестройbAutoDestroy
Указывает, что объект будет уничтожен владельцем (Ппаренттаржет).Indicates that the object will be destroyed by owner (pParentTarget).

CD2DTextLayout:: CreateCD2DTextLayout::Create

Создает CD2DTextLayout.Creates a CD2DTextLayout.

virtual HRESULT Create(CRenderTarget* */);

Возвращаемое значениеReturn Value

Если метод завершается успешно, возвращает значение S_OK.If the method succeeds, it returns S_OK. В противном случае возвращается код ошибки HRESULT.Otherwise, it returns an HRESULT error code.

CD2DTextLayout::D естройCD2DTextLayout::Destroy

Уничтожает объект CD2DTextLayout.Destroys a CD2DTextLayout object.

virtual void Destroy();

CD2DTextLayout:: GetCD2DTextLayout::Get

Возвращает интерфейс ИдвритетекстлайаутReturns IDWriteTextLayout interface

IDWriteTextLayout* Get();

Возвращаемое значениеReturn Value

Указатель на интерфейс Идвритетекстлайаут или значение NULL, если объект еще не инициализирован.Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet.

CD2DTextLayout:: ЖетфонтфамилинамеCD2DTextLayout::GetFontFamilyName

Копирует имя семейства шрифтов для текста в указанной позиции.Copies the font family name of the text at the specified position.

CString GetFontFamilyName(
    UINT32 currentPosition,
    DWRITE_TEXT_RANGE* textRange = NULL) const;

ПараметрыParameters

currentPositioncurrentPosition
Расположение текста для проверки.The position of the text to examine.

textRangetextRange
Диапазон текста с тем же форматированием, что и у текста в позиции, заданной параметром currentPosition.The range of text that has the same formatting as the text at the position specified by currentPosition. Это означает, что выполнение имеет точное форматирование в соответствии с указанной позицией, включая, но не ограниченное именем семейства шрифтов.This means the run has the exact formatting as the position specified, including but not limited to the font family name.

Возвращаемое значениеReturn Value

Объект CString, содержащий имя текущего семейства шрифтов.CString object that contains the current font family name.

CD2DTextLayout:: ЖетлокаленамеCD2DTextLayout::GetLocaleName

Возвращает имя локали текста в указанной позиции.Gets the locale name of the text at the specified position.

CString GetLocaleName(
    UINT32 currentPosition,
    DWRITE_TEXT_RANGE* textRange = NULL) const;

ПараметрыParameters

currentPositioncurrentPosition
Расположение текста для проверки.The position of the text to inspect.

textRangetextRange
Диапазон текста с тем же форматированием, что и у текста в позиции, заданной параметром currentPosition.The range of text that has the same formatting as the text at the position specified by currentPosition. Это означает, что выполнение имеет точное форматирование в соответствии с заданной позицией, включая, но не ограниченное названием языкового стандарта.This means the run has the exact formatting as the position specified, including but not limited to the locale name.

Возвращаемое значениеReturn Value

Объект CString, содержащий текущее имя языкового стандарта.CString object that contains the current locale name.

CD2DTextLayout:: IsValidCD2DTextLayout::IsValid

Проверка действительности ресурсовChecks resource validity

virtual BOOL IsValid() const;

Возвращаемое значениеReturn Value

Значение TRUE, если ресурс является допустимым; в противном случае — FALSE.TRUE if resource is valid; otherwise FALSE.

CD2DTextLayout:: m_pTextLayoutCD2DTextLayout::m_pTextLayout

Указатель на Идвритетекстлайаут.A pointer to an IDWriteTextLayout.

IDWriteTextLayout* m_pTextLayout;

CD2DTextLayout:: operator Идвритетекстлайаут *CD2DTextLayout::operator IDWriteTextLayout*

Возвращает интерфейс ИдвритетекстлайаутReturns IDWriteTextLayout interface

operator IDWriteTextLayout*();

Возвращаемое значениеReturn Value

Указатель на интерфейс Идвритетекстлайаут или значение NULL, если объект еще не инициализирован.Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet.

CD2DTextLayout:: повторное созданиеCD2DTextLayout::ReCreate

Повторно создает CD2DTextLayout.Re-creates a CD2DTextLayout.

virtual HRESULT ReCreate(CRenderTarget* */);

Возвращаемое значениеReturn Value

Если метод завершается успешно, возвращает значение S_OK.If the method succeeds, it returns S_OK. В противном случае возвращается код ошибки HRESULT.Otherwise, it returns an HRESULT error code.

CD2DTextLayout:: СетфонтфамилинамеCD2DTextLayout::SetFontFamilyName

Задает имя семейства шрифтов, заканчивающееся нулем, для текста в указанном текстовом диапазонеSets null-terminated font family name for text within a specified text range

BOOL SetFontFamilyName(
    LPCWSTR pwzFontFamilyName,
    DWRITE_TEXT_RANGE textRange);

ПараметрыParameters

пвзфонтфамилинамеpwzFontFamilyName
Имя семейства шрифтов, которое применяется ко всей текстовой строке в диапазоне, заданном аргументом textRangeThe font family name that applies to the entire text string within the range specified by textRange

textRangetextRange
Диапазон текста, к которому применяется это изменениеText range to which this change applies

Возвращаемое значениеReturn Value

Если метод завершается с ошибкой, возвращается значение TRUE.If the method succeeds, it returns TRUE. В противном случае возвращается значение FALSE.Otherwise, it returns FALSE

CD2DTextLayout:: СетлокаленамеCD2DTextLayout::SetLocaleName

Задает имя локали для текста в указанном текстовом диапазонеSets the locale name for text within a specified text range

BOOL SetLocaleName(
    LPCWSTR pwzLocaleName,
    DWRITE_TEXT_RANGE textRange);

ПараметрыParameters

пвзлокаленамеpwzLocaleName
Строка имени локали, заканчивающаяся нулемA null-terminated locale name string

textRangetextRange
Диапазон текста, к которому применяется это изменениеText range to which this change applies

Возвращаемое значениеReturn Value

Если метод завершается с ошибкой, возвращается значение TRUE.If the method succeeds, it returns TRUE. В противном случае возвращается значение FALSE.Otherwise, it returns FALSE

См. также разделSee also

КлассыClasses