All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Attributes | List of all members
xornsch_text Struct Reference

Schematic text or attribute. More...

#include <xornstorage.h>

Public Attributes

struct xorn_double2d pos
 Coordinates of the origin of the text item in mils. More...
int color
 Color index. More...
int text_size
 Size of the text in points. More...
bool visibility
 Visibility of the text. More...
int show_name_value
 Attribute visibility control. More...
int angle
 Angle of the text in degrees. More...
int alignment
 Alignment (i.e., relative location of the origin) of the text. More...
struct xorn_string text
 The text strings. More...

Detailed Description

Schematic text or attribute.

Text objects can be attached to another object; attaching other object types is unsupported.

If the string has the form name=value, the text object is considered an attribute; otherwise, it represents informative lines of text. An attribute not attached to any object is a “toplevel” attribute. These attributes are useful when you need to convey some info about a schematic page or symbol and need the netlister to have access to this info.

Valid in schematic and symbol files.

Definition at line 241 of file xornstorage.h.

Member Data Documentation


Alignment (i.e., relative location of the origin) of the text.

The alignment field can take a value from 0 to 8. The following diagram shows what the values for the alignment field mean:


Definition at line 248 of file xornstorage.h.


Angle of the text in degrees.

The angle of the text can only take on one of the following values: 0, 90, 180, 270. A value of 270 will always generate upright text.

Definition at line 247 of file xornstorage.h.


Color index.

See also
gEDA colors

Definition at line 243 of file xornstorage.h.


Coordinates of the origin of the text item in mils.

Definition at line 242 of file xornstorage.h.


Attribute visibility control.

The show_name_value is an enumerated type:

SHOW NAME VALUE = 0 (show both name and value of an attribute)
SHOW VALUE = 1 (show only the value of an attribute)
SHOW NAME = 2 (show only the name of an attribute)

The show_name_value field is only valid if the string is an attribute, i.e. has the form name=value.

Definition at line 246 of file xornstorage.h.


The text strings.

The maximum length of any single text string is 1024, however there is no limit to the number of text string lines.

The text strings can have overbars if the text is embedded in two overbar markers (“\_”). A single backslash needs to be written as “\\”.



The string “R/W” has an overbar over the “W”.

Definition at line 249 of file xornstorage.h.


Size of the text in points.

The minimum size is 2 points (1/72 of an inch). There is no maximum size.

Definition at line 244 of file xornstorage.h.


Visibility of the text.

The visibility field is an enumerated type:


Definition at line 245 of file xornstorage.h.

The documentation for this struct was generated from the following files: