Skip to main content
Version: 14.x (API 14) [Legacy]

Class ImRaii.TextWrapDisposable

A wrapper around pushing text wrap positions.

Assembly: Dalamud.dll
Declaration
public sealed class ImRaii.TextWrapDisposable : IDisposable

Implements:
System.IDisposable

Properties

Count

Gets the number of text wrap positions currently pushed using this disposable.

Declaration
public int Count { get; }

Methods

Push(float, bool)

Push a text wrap position to the text wrap stack.

Declaration
public ImRaii.TextWrapDisposable Push(float localX, bool condition)
Returns

Dalamud.Interface.Utility.Raii.ImRaii.TextWrapDisposable: A disposable object that can be used to push further text wrap positions and pops those positions after leaving scope. Use with using.

Parameters
TypeNameDescription
System.SinglelocalXThe window-local X coordinate at which to wrap text. If this is negative, no wrapping, if it is 0, wrap from here to the end of the available content region, and if it is positive, wrap from here.
System.BooleanconditionIf this is false, the position is not pushed.

Push(float)

Push a text wrap position to the text wrap stack.

Declaration
public ImRaii.TextWrapDisposable Push(float localX)
Returns

Dalamud.Interface.Utility.Raii.ImRaii.TextWrapDisposable: A disposable object that can be used to push further text wrap positions and pops those positions after leaving scope. Use with using.

Parameters
TypeNameDescription
System.SinglelocalXThe window-local X coordinate at which to wrap text. If this is negative, no wrapping, if it is 0, wrap from here to the end of the available content region, and if it is positive, wrap from here.

Pop(int)

Pop a number of text wrap positions.

Declaration
public void Pop(int num = 1)
Parameters
TypeNameDescription
System.Int32numThe number of text wrap positions to pop. This is clamped to the number of positions pushed by this object.

Dispose()

Pop all pushed text wrap positions.

Declaration
public void Dispose()

Implements

  • System.IDisposable