Tk\_GetJustifyFromObj(3) Tk Library Procedures Tk\_GetJustifyFromObj(3)

```

```

# [NAME](#NAME)

Tk\_GetJustifyFromObj, Tk\_GetJustify, Tk\_NameOfJustify - translate between strings and justification styles

# [SYNOPSIS](#SYNOPSIS)

```
#include <tk.h>

int
Tk_GetJustifyFromObj(interp, objPtr, justifyPtr)

int
Tk_GetJustify(interp, string, justifyPtr)

const char *
Tk_NameOfJustify(justify)
```

# [ARGUMENTS](#ARGUMENTS)

Tcl\_Interp *\*interp* (in)

Interpreter to use for error reporting, or NULL.

Tcl\_Obj *\*objPtr* (in/out)

String value contains name of justification style - one of “**left**”, “**right**”, or “**center**” - or a unique abbreviation of one. The internal rep will be modified to cache corresponding justify value.

const char *\*string* (in)

Same as *objPtr* except description of justification style is passed as a string.

int *\*justifyPtr* (out)

Pointer to location in which to store justify value corresponding to *objPtr* or *string*.

Tk\_Justify *justify* (in)

Justification style (one of the values listed below).

```
    
```

# [DESCRIPTION](#DESCRIPTION)

**Tk\_GetJustifyFromObj** places in *\*justifyPtr* the justify value corresponding to *objPtr*'s value. This value will be one of the following:

[**TK\_JUSTIFY\_LEFT**](#TK_JUSTIFY_LEFT)

Means that the text on each line should start at the left edge of the line; as a result, the right edges of lines may be ragged.

[**TK\_JUSTIFY\_RIGHT**](#TK_JUSTIFY_RIGHT)

Means that the text on each line should end at the right edge of the line; as a result, the left edges of lines may be ragged.

[**TK\_JUSTIFY\_CENTER**](#TK_JUSTIFY_CENTER)

Means that the text on each line should be centered; as a result, both the left and right edges of lines may be ragged.

Under normal circumstances the return value is **TCL\_OK** and *interp* is unused. If *objPtr* does not contain a valid justification style or an abbreviation of one of these names, **TCL\_ERROR** is returned, *\*justifyPtr* is unmodified, and an error message is stored in *interp*'s result if *interp* is not NULL. **Tk\_GetJustifyFromObj** caches information about the return value in *objPtr*, which speeds up future calls to **Tk\_GetJustifyFromObj** with the same *objPtr*.

**Tk\_GetJustify** is identical to **Tk\_GetJustifyFromObj** except that the description of the justification is specified with a string instead of an object. This prevents **Tk\_GetJustify** from caching the return value, so **Tk\_GetJustify** is less efficient than **Tk\_GetJustifyFromObj**.

**Tk\_NameOfJustify** is the logical inverse of **Tk\_GetJustify**. Given a justify value it returns a statically-allocated string corresponding to *justify*. If *justify* is not a legal justify value, then “unknown justification style” is returned.

# [KEYWORDS](#KEYWORDS)

center, fill, justification, string

8.1 Tk

---

Document: Tk_GetJustifyFromObj(3) from tk 9.1.0-r0 (Chainguard OS)
Source: https://downloads.sourceforge.net/sourceforge/tcl/tk9.1.0-src.tar.gz