libui-ng
A portable GUI library for C
ui.h
Go to the documentation of this file.
1// 6 april 2015
2
3// TODO add a uiVerifyControlType() function that can be used by control implementations to verify controls
4
5// TODOs
6// - make getters that return whether something exists accept a NULL pointer to discard the value (and thus only return that the thing exists?)
7// - const-correct everything
8// - normalize documentation between typedefs and structs
9
20#ifndef __LIBUI_UI_H__
21#define __LIBUI_UI_H__
22
23#include <stddef.h>
24#include <stdint.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30// this macro is generated by cmake
31#ifdef libui_EXPORTS
32#ifdef _WIN32
33#define _UI_EXTERN __declspec(dllexport) extern
34#else
35#define _UI_EXTERN __attribute__((visibility("default"))) extern
36#endif
37#else
38// TODO add __declspec(dllimport) on windows, but only if not static
39#define _UI_EXTERN extern
40#endif
41
42// C++ is really really really really really really dumb about enums, so screw that and just make them anonymous
43// This has the advantage of being ABI-able should we ever need an ABI...
44#define _UI_ENUM(s) typedef unsigned int s; enum
45
46// This constant is provided because M_PI is nonstandard.
47// This comes from Go's math.Pi, which in turn comes from http://oeis.org/A000796.
48#define uiPi 3.14159265358979323846264338327950288419716939937510582097494459
49
50// TODO uiBool?
51
52// uiForEach represents the return value from one of libui's various ForEach functions.
56};
57
59
61 size_t Size;
62};
63
64_UI_EXTERN const char *uiInit(uiInitOptions *options);
66_UI_EXTERN void uiFreeInitError(const char *err);
67
68_UI_EXTERN void uiMain(void);
70_UI_EXTERN int uiMainStep(int wait);
71_UI_EXTERN void uiQuit(void);
72
73_UI_EXTERN void uiQueueMain(void (*f)(void *data), void *data);
74
75// TODO standardize the looping behavior return type, either with some enum or something, and the test expressions throughout the code
76// TODO figure out what to do about looping and the exact point that the timer is rescheduled so we can document it; see https://github.com/andlabs/libui/pull/277
77// TODO (also in the above link) document that this cannot be called from any thread, unlike uiQueueMain()
78// TODO document that the minimum exact timing, either accuracy (timer burst, etc.) or granularity (15ms on Windows, etc.), is OS-defined
79// TODO also figure out how long until the initial tick is registered on all platforms to document
80// TODO also add a comment about how useful this could be in bindings, depending on the language being bound to
81_UI_EXTERN void uiTimer(int milliseconds, int (*f)(void *data), void *data);
82
83_UI_EXTERN void uiOnShouldQuit(int (*f)(void *data), void *data);
84
85
95_UI_EXTERN void uiFreeText(char *text);
96
97
103typedef struct uiControl uiControl;
104struct uiControl {
105 uint32_t Signature;
106 uint32_t OSSignature;
108 void (*Destroy)(uiControl *);
109 uintptr_t (*Handle)(uiControl *);
110 uiControl *(*Parent)(uiControl *);
114 void (*Show)(uiControl *);
115 void (*Hide)(uiControl *);
117 void (*Enable)(uiControl *);
118 void (*Disable)(uiControl *);
119};
120// TOOD add argument names to all arguments
121#define uiControl(this) ((uiControl *) (this))
122
135
144
153
163
172
181
189
198
209
217
225
235_UI_EXTERN uiControl *uiAllocControl(size_t n, uint32_t OSsig, uint32_t typesig, const char *typenamestr);
236
246
257
270
271// TODO Move this to private API? According to old/new.md this should be used by toplevel controls.
273
274
290typedef struct uiWindow uiWindow;
291#define uiWindow(this) ((uiWindow *) (this))
292
303
314_UI_EXTERN void uiWindowSetTitle(uiWindow *w, const char *title);
315
327_UI_EXTERN void uiWindowPosition(uiWindow *w, int *x, int *y);
328
341
356 void (*f)(uiWindow *sender, void *senderData), void *data);
357
367_UI_EXTERN void uiWindowContentSize(uiWindow *w, int *width, int *height);
368
379_UI_EXTERN void uiWindowSetContentSize(uiWindow *w, int width, int height);
380
389
399
414 void (*f)(uiWindow *sender, void *senderData), void *data);
415
432 int (*f)(uiWindow *sender, void *senderData), void *data);
433
447 void (*f)(uiWindow *sender, void *senderData), void *data);
448
457
466
476
485
494
505
514
524
537_UI_EXTERN uiWindow *uiNewWindow(const char *title, int width, int height, int hasMenubar);
538
539
547typedef struct uiButton uiButton;
548#define uiButton(this) ((uiButton *) (this))
549
560
570_UI_EXTERN void uiButtonSetText(uiButton *b, const char *text);
571
585 void (*f)(uiButton *sender, void *senderData), void *data);
586
596_UI_EXTERN uiButton *uiNewButton(const char *text);
597
598
609typedef struct uiBox uiBox;
610#define uiBox(this) ((uiBox *) (this))
611
623_UI_EXTERN void uiBoxAppend(uiBox *b, uiControl *child, int stretchy);
624
633
642_UI_EXTERN void uiBoxDelete(uiBox *b, int index);
643
654
665_UI_EXTERN void uiBoxSetPadded(uiBox *b, int padded);
666
676
686
687
695typedef struct uiCheckbox uiCheckbox;
696#define uiCheckbox(this) ((uiCheckbox *) (this))
697
708
718_UI_EXTERN void uiCheckboxSetText(uiCheckbox *c, const char *text);
719
734 void (*f)(uiCheckbox *sender, void *senderData), void *data);
735
744
753
764
765
773typedef struct uiEntry uiEntry;
774#define uiEntry(this) ((uiEntry *) (this))
775
786
796_UI_EXTERN void uiEntrySetText(uiEntry *e, const char *text);
797
811 void (*f)(uiEntry *sender, void *senderData), void *data);
812
821
829_UI_EXTERN void uiEntrySetReadOnly(uiEntry *e, int readonly);
830
838
848
859
860
868typedef struct uiLabel uiLabel;
869#define uiLabel(this) ((uiLabel *) (this))
870
881
891_UI_EXTERN void uiLabelSetText(uiLabel *l, const char *text);
892
902_UI_EXTERN uiLabel *uiNewLabel(const char *text);
903
904
915typedef struct uiTab uiTab;
916#define uiTab(this) ((uiTab *) (this))
917
926
937
952 void (*f)(uiTab *sender, void *senderData), void *data);
953
964_UI_EXTERN void uiTabAppend(uiTab *t, const char *name, uiControl *c);
965
977_UI_EXTERN void uiTabInsertAt(uiTab *t, const char *name, int index, uiControl *c);
978
987_UI_EXTERN void uiTabDelete(uiTab *t, int index);
988
997
1006_UI_EXTERN int uiTabMargined(uiTab *t, int index);
1007
1018_UI_EXTERN void uiTabSetMargined(uiTab *t, int index, int margined);
1019
1027
1028
1042typedef struct uiGroup uiGroup;
1043#define uiGroup(this) ((uiGroup *) (this))
1044
1055
1065_UI_EXTERN void uiGroupSetTitle(uiGroup *g, const char *title);
1066
1075
1084
1095
1105_UI_EXTERN uiGroup *uiNewGroup(const char *title);
1106
1107
1123typedef struct uiSpinbox uiSpinbox;
1124#define uiSpinbox(this) ((uiSpinbox *) (this))
1125
1134
1144
1159 void (*f)(uiSpinbox *sender, void *senderData), void *data);
1160
1176
1177
1192typedef struct uiSlider uiSlider;
1193#define uiSlider(this) ((uiSlider *) (this))
1194
1203
1212
1221
1230
1245 void (*f)(uiSlider *sender, void *senderData), void *data);
1246
1260 void (*f)(uiSlider *sender, void *senderData), void *data);
1261
1272_UI_EXTERN void uiSliderSetRange(uiSlider *s, int min, int max);
1273
1289
1290
1301#define uiProgressBar(this) ((uiProgressBar *) (this))
1302
1311
1326
1334
1335
1344#define uiSeparator(this) ((uiSeparator *) (this))
1345
1353
1361
1362
1371typedef struct uiCombobox uiCombobox;
1372#define uiCombobox(this) ((uiCombobox *) (this))
1373
1383_UI_EXTERN void uiComboboxAppend(uiCombobox *c, const char *text);
1384
1395_UI_EXTERN void uiComboboxInsertAt(uiCombobox *c, int index, const char *text);
1396
1408
1416
1425
1434
1443
1459 void (*f)(uiCombobox *sender, void *senderData), void *data);
1460
1468
1469
1483#define uiEditableCombobox(this) ((uiEditableCombobox *) (this))
1484
1495
1509
1520
1521// TODO what do we call a function that sets the currently selected item and fills the text field with it?
1522// editable comboboxes have no consistent concept of selected item
1523
1538 void (*f)(uiEditableCombobox *sender, void *senderData), void *data);
1539
1547
1548
1557#define uiRadioButtons(this) ((uiRadioButtons *) (this))
1558
1569
1578
1587
1602 void (*f)(uiRadioButtons *sender, void *senderData), void *data);
1603
1611
1612struct tm;
1630#define uiDateTimePicker(this) ((uiDateTimePicker *) (this))
1631
1641
1652
1667 void (*f)(uiDateTimePicker *sender, void *senderData), void *data);
1668
1676
1684
1692
1693
1703#define uiMultilineEntry(this) ((uiMultilineEntry *) (this))
1704
1715
1726
1737
1753 void (*f)(uiMultilineEntry *sender, void *senderData), void *data);
1754
1763
1772
1780
1790
1791
1798typedef struct uiMenuItem uiMenuItem;
1799#define uiMenuItem(this) ((uiMenuItem *) (this))
1800
1808
1818
1833 void (*f)(uiMenuItem *sender, uiWindow *window, void *senderData), void *data);
1834
1845
1856
1885typedef struct uiMenu uiMenu;
1886#define uiMenu(this) ((uiMenu *) (this))
1887
1899
1911
1921
1931
1941
1949
1961_UI_EXTERN uiMenu *uiNewMenu(const char *name);
1962
1963
1976
1989
2005
2020_UI_EXTERN void uiMsgBox(uiWindow *parent, const char *title, const char *description);
2021
2037_UI_EXTERN void uiMsgBoxError(uiWindow *parent, const char *title, const char *description);
2038
2039typedef struct uiArea uiArea;
2044
2046
2049 // TODO document that resizes cause a full redraw for non-scrolling areas; implementation-defined for scrolling areas
2051 // TODO document that on first show if the mouse is already in the uiArea then one gets sent with left=0
2052 // TODO what about when the area is hidden and then shown again?
2053 void (*MouseCrossed)(uiAreaHandler *, uiArea *, int left);
2056};
2057
2058// TODO RTL layouts?
2059// TODO reconcile edge and corner naming
2069 // TODO have one for keyboard resizes?
2070 // TODO GDK doesn't seem to have any others, including for keyboards...
2071 // TODO way to bring up the system menu instead?
2072};
2073
2074#define uiArea(this) ((uiArea *) (this))
2075// TODO give a better name
2076// TODO document the types of width and height
2077_UI_EXTERN void uiAreaSetSize(uiArea *a, int width, int height);
2078// TODO uiAreaQueueRedraw()
2080_UI_EXTERN void uiAreaScrollTo(uiArea *a, double x, double y, double width, double height);
2081// TODO document these can only be called within Mouse() handlers
2082// TODO should these be allowed on scrolling areas?
2083// TODO decide which mouse events should be accepted; Down is the only one guaranteed to work right now
2084// TODO what happens to events after calling this up to and including the next mouse up?
2085// TODO release capture?
2090
2093
2094 // TODO document that this is only defined for nonscrolling areas
2097
2098 double ClipX;
2099 double ClipY;
2102};
2103
2104typedef struct uiDrawPath uiDrawPath;
2108
2110
2116};
2117
2122};
2123
2128};
2129
2130// this is the default for botoh cairo and Direct2D (in the latter case, from the C++ helper functions)
2131// Core Graphics doesn't explicitly specify a default, but NSBezierPath allows you to choose one, and this is the initial value
2132// so we're good to use it too!
2133#define uiDrawDefaultMiterLimit 10.0
2134
2138};
2139
2141 double M11;
2142 double M12;
2143 double M21;
2144 double M22;
2145 double M31;
2146 double M32;
2147};
2148
2151
2152 // solid brushes
2153 double R;
2154 double G;
2155 double B;
2156 double A;
2157
2158 // gradient brushes
2159 double X0; // linear: start X, radial: start X
2160 double Y0; // linear: start Y, radial: start Y
2161 double X1; // linear: end X, radial: outer circle center X
2162 double Y1; // linear: end Y, radial: outer circle center Y
2163 double OuterRadius; // radial gradients only
2165 size_t NumStops;
2166 // TODO extend mode
2167 // cairo: none, repeat, reflect, pad; no individual control
2168 // Direct2D: repeat, reflect, pad; no individual control
2169 // Core Graphics: none, pad; before and after individually
2170 // TODO cairo documentation is inconsistent about pad
2171
2172 // TODO images
2173
2174 // TODO transforms
2175};
2176
2178 double Pos;
2179 double R;
2180 double G;
2181 double B;
2182 double A;
2183};
2184
2188 // TODO what if this is 0? on windows there will be a crash with dashing
2191 double *Dashes;
2192 // TOOD what if this is 1 on Direct2D?
2193 // TODO what if a dash is 0 on Cairo or Quartz?
2196};
2197
2200
2201_UI_EXTERN void uiDrawPathNewFigure(uiDrawPath *p, double x, double y);
2202_UI_EXTERN void uiDrawPathNewFigureWithArc(uiDrawPath *p, double xCenter, double yCenter, double radius, double startAngle, double sweep, int negative);
2203_UI_EXTERN void uiDrawPathLineTo(uiDrawPath *p, double x, double y);
2204// notes: angles are both relative to 0 and go counterclockwise
2205// TODO is the initial line segment on cairo and OS X a proper join?
2206// TODO what if sweep < 0?
2207_UI_EXTERN void uiDrawPathArcTo(uiDrawPath *p, double xCenter, double yCenter, double radius, double startAngle, double sweep, int negative);
2208_UI_EXTERN void uiDrawPathBezierTo(uiDrawPath *p, double c1x, double c1y, double c2x, double c2y, double endX, double endY);
2209// TODO quadratic bezier
2211
2212// TODO effect of these when a figure is already started
2213_UI_EXTERN void uiDrawPathAddRectangle(uiDrawPath *p, double x, double y, double width, double height);
2214
2217
2220
2221// TODO primitives:
2222// - rounded rectangles
2223// - elliptical arcs
2224// - quadratic bezier curves
2225
2227_UI_EXTERN void uiDrawMatrixTranslate(uiDrawMatrix *m, double x, double y);
2228_UI_EXTERN void uiDrawMatrixScale(uiDrawMatrix *m, double xCenter, double yCenter, double x, double y);
2229_UI_EXTERN void uiDrawMatrixRotate(uiDrawMatrix *m, double x, double y, double amount);
2230_UI_EXTERN void uiDrawMatrixSkew(uiDrawMatrix *m, double x, double y, double xamount, double yamount);
2236
2238
2239// TODO add a uiDrawPathStrokeToFill() or something like that
2241
2244
2245// uiAttribute stores information about an attribute in a
2246// uiAttributedString.
2247//
2248// You do not create uiAttributes directly; instead, you create a
2249// uiAttribute of a given type using the specialized constructor
2250// functions. For every Unicode codepoint in the uiAttributedString,
2251// at most one value of each attribute type can be applied.
2252//
2253// uiAttributes are immutable and the uiAttributedString takes
2254// ownership of the uiAttribute object once assigned, copying its
2255// contents as necessary.
2256// TODO define whether all this, for both uiTableValue and uiAttribute, is undefined behavior or a caught error
2258
2259// @role uiAttribute destructor
2260// uiFreeAttribute() frees a uiAttribute. You generally do not need to
2261// call this yourself, as uiAttributedString does this for you. In fact,
2262// it is an error to call this function on a uiAttribute that has been
2263// given to a uiAttributedString. You can call this, however, if you
2264// created a uiAttribute that you aren't going to use later.
2266
2267// uiAttributeType holds the possible uiAttribute types that may be
2268// returned by uiAttributeGetType(). Refer to the documentation for
2269// each type's constructor function for details on each type.
2281};
2282
2283// uiAttributeGetType() returns the type of a.
2284// TODO I don't like this name
2286
2287// uiNewFamilyAttribute() creates a new uiAttribute that changes the
2288// font family of the text it is applied to. family is copied; you do not
2289// need to keep it alive after uiNewFamilyAttribute() returns. Font
2290// family names are case-insensitive.
2292
2293// uiAttributeFamily() returns the font family stored in a. The
2294// returned string is owned by a. It is an error to call this on a
2295// uiAttribute that does not hold a font family.
2297
2298// uiNewSizeAttribute() creates a new uiAttribute that changes the
2299// size of the text it is applied to, in typographical points.
2301
2302// uiAttributeSize() returns the font size stored in a. It is an error to
2303// call this on a uiAttribute that does not hold a font size.
2305
2306// uiTextWeight represents possible text weights. These roughly
2307// map to the OS/2 text weight field of TrueType and OpenType
2308// fonts, or to CSS weight numbers. The named constants are
2309// nominal values; the actual values may vary by font and by OS,
2310// though this isn't particularly likely. Any value between
2311// uiTextWeightMinimum and uiTextWeightMaximum, inclusive,
2312// is allowed.
2313//
2314// Note that due to restrictions in early versions of Windows, some
2315// fonts have "special" weights be exposed in many programs as
2316// separate font families. This is perhaps most notable with
2317// Arial Black. libui does not do this, even on Windows (because the
2318// DirectWrite API libui uses on Windows does not do this); to
2319// specify Arial Black, use family Arial and weight uiTextWeightBlack.
2334};
2335
2336// uiNewWeightAttribute() creates a new uiAttribute that changes the
2337// weight of the text it is applied to. It is an error to specify a weight
2338// outside the range [uiTextWeightMinimum,
2339// uiTextWeightMaximum].
2341
2342// uiAttributeWeight() returns the font weight stored in a. It is an error
2343// to call this on a uiAttribute that does not hold a font weight.
2345
2346// uiTextItalic represents possible italic modes for a font. Italic
2347// represents "true" italics where the slanted glyphs have custom
2348// shapes, whereas oblique represents italics that are merely slanted
2349// versions of the normal glyphs. Most fonts usually have one or the
2350// other.
2355};
2356
2357// uiNewItalicAttribute() creates a new uiAttribute that changes the
2358// italic mode of the text it is applied to. It is an error to specify an
2359// italic mode not specified in uiTextItalic.
2361
2362// uiAttributeItalic() returns the font italic mode stored in a. It is an
2363// error to call this on a uiAttribute that does not hold a font italic
2364// mode.
2366
2367// uiTextStretch represents possible stretches (also called "widths")
2368// of a font.
2369//
2370// Note that due to restrictions in early versions of Windows, some
2371// fonts have "special" stretches be exposed in many programs as
2372// separate font families. This is perhaps most notable with
2373// Arial Condensed. libui does not do this, even on Windows (because
2374// the DirectWrite API libui uses on Windows does not do this); to
2375// specify Arial Condensed, use family Arial and stretch
2376// uiTextStretchCondensed.
2387};
2388
2389// uiNewStretchAttribute() creates a new uiAttribute that changes the
2390// stretch of the text it is applied to. It is an error to specify a strech
2391// not specified in uiTextStretch.
2393
2394// uiAttributeStretch() returns the font stretch stored in a. It is an
2395// error to call this on a uiAttribute that does not hold a font stretch.
2397
2398// uiNewColorAttribute() creates a new uiAttribute that changes the
2399// color of the text it is applied to. It is an error to specify an invalid
2400// color.
2401_UI_EXTERN uiAttribute *uiNewColorAttribute(double r, double g, double b, double a);
2402
2403// uiAttributeColor() returns the text color stored in a. It is an
2404// error to call this on a uiAttribute that does not hold a text color.
2405_UI_EXTERN void uiAttributeColor(const uiAttribute *a, double *r, double *g, double *b, double *alpha);
2406
2407// uiNewBackgroundAttribute() creates a new uiAttribute that
2408// changes the background color of the text it is applied to. It is an
2409// error to specify an invalid color.
2410_UI_EXTERN uiAttribute *uiNewBackgroundAttribute(double r, double g, double b, double a);
2411
2412// TODO reuse uiAttributeColor() for background colors, or make a new function...
2413
2414// uiUnderline specifies a type of underline to use on text.
2419 uiUnderlineSuggestion, // wavy or dotted underlines used for spelling/grammar checkers
2420};
2421
2422// uiNewUnderlineAttribute() creates a new uiAttribute that changes
2423// the type of underline on the text it is applied to. It is an error to
2424// specify an underline type not specified in uiUnderline.
2426
2427// uiAttributeUnderline() returns the underline type stored in a. It is
2428// an error to call this on a uiAttribute that does not hold an underline
2429// style.
2431
2432// uiUnderlineColor specifies the color of any underline on the text it
2433// is applied to, regardless of the type of underline. In addition to
2434// being able to specify a custom color, you can explicitly specify
2435// platform-specific colors for suggestion underlines; to use them
2436// correctly, pair them with uiUnderlineSuggestion (though they can
2437// be used on other types of underline as well).
2438//
2439// If an underline type is applied but no underline color is
2440// specified, the text color is used instead. If an underline color
2441// is specified without an underline type, the underline color
2442// attribute is ignored, but not removed from the uiAttributedString.
2447 uiUnderlineColorAuxiliary, // for instance, the color used by smart replacements on macOS or in Microsoft Office
2448};
2449
2450// uiNewUnderlineColorAttribute() creates a new uiAttribute that
2451// changes the color of the underline on the text it is applied to.
2452// It is an error to specify an underline color not specified in
2453// uiUnderlineColor.
2454//
2455// If the specified color type is uiUnderlineColorCustom, it is an
2456// error to specify an invalid color value. Otherwise, the color values
2457// are ignored and should be specified as zero.
2458_UI_EXTERN uiAttribute *uiNewUnderlineColorAttribute(uiUnderlineColor u, double r, double g, double b, double a);
2459
2460// uiAttributeUnderlineColor() returns the underline color stored in
2461// a. It is an error to call this on a uiAttribute that does not hold an
2462// underline color.
2463_UI_EXTERN void uiAttributeUnderlineColor(const uiAttribute *a, uiUnderlineColor *u, double *r, double *g, double *b, double *alpha);
2464
2465// uiOpenTypeFeatures represents a set of OpenType feature
2466// tag-value pairs, for applying OpenType features to text.
2467// OpenType feature tags are four-character codes defined by
2468// OpenType that cover things from design features like small
2469// caps and swashes to language-specific glyph shapes and
2470// beyond. Each tag may only appear once in any given
2471// uiOpenTypeFeatures instance. Each value is a 32-bit integer,
2472// often used as a Boolean flag, but sometimes as an index to choose
2473// a glyph shape to use.
2474//
2475// If a font does not support a certain feature, that feature will be
2476// ignored. (TODO verify this on all OSs)
2477//
2478// See the OpenType specification at
2479// https://www.microsoft.com/typography/otspec/featuretags.htm
2480// for the complete list of available features, information on specific
2481// features, and how to use them.
2482// TODO invalid features
2484
2485// uiOpenTypeFeaturesForEachFunc is the type of the function
2486// invoked by uiOpenTypeFeaturesForEach() for every OpenType
2487// feature in otf. Refer to that function's documentation for more
2488// details.
2489typedef uiForEach (*uiOpenTypeFeaturesForEachFunc)(const uiOpenTypeFeatures *otf, char a, char b, char c, char d, uint32_t value, void *data);
2490
2491// @role uiOpenTypeFeatures constructor
2492// uiNewOpenTypeFeatures() returns a new uiOpenTypeFeatures
2493// instance, with no tags yet added.
2495
2496// @role uiOpenTypeFeatures destructor
2497// uiFreeOpenTypeFeatures() frees otf.
2499
2500// uiOpenTypeFeaturesClone() makes a copy of otf and returns it.
2501// Changing one will not affect the other.
2503
2504// uiOpenTypeFeaturesAdd() adds the given feature tag and value
2505// to otf. The feature tag is specified by a, b, c, and d. If there is
2506// already a value associated with the specified tag in otf, the old
2507// value is removed.
2508_UI_EXTERN void uiOpenTypeFeaturesAdd(uiOpenTypeFeatures *otf, char a, char b, char c, char d, uint32_t value);
2509
2510// uiOpenTypeFeaturesRemove() removes the given feature tag
2511// and value from otf. If the tag is not present in otf,
2512// uiOpenTypeFeaturesRemove() does nothing.
2513_UI_EXTERN void uiOpenTypeFeaturesRemove(uiOpenTypeFeatures *otf, char a, char b, char c, char d);
2514
2515// uiOpenTypeFeaturesGet() determines whether the given feature
2516// tag is present in otf. If it is, *value is set to the tag's value and
2517// nonzero is returned. Otherwise, zero is returned.
2518//
2519// Note that if uiOpenTypeFeaturesGet() returns zero, value isn't
2520// changed. This is important: if a feature is not present in a
2521// uiOpenTypeFeatures, the feature is NOT treated as if its
2522// value was zero anyway. Script-specific font shaping rules and
2523// font-specific feature settings may use a different default value
2524// for a feature. You should likewise not treat a missing feature as
2525// having a value of zero either. Instead, a missing feature should
2526// be treated as having some unspecified default value.
2527_UI_EXTERN int uiOpenTypeFeaturesGet(const uiOpenTypeFeatures *otf, char a, char b, char c, char d, uint32_t *value);
2528
2529// uiOpenTypeFeaturesForEach() executes f for every tag-value
2530// pair in otf. The enumeration order is unspecified. You cannot
2531// modify otf while uiOpenTypeFeaturesForEach() is running.
2533
2534// uiNewFeaturesAttribute() creates a new uiAttribute that changes
2535// the font family of the text it is applied to. otf is copied; you may
2536// free it after uiNewFeaturesAttribute() returns.
2538
2539// uiAttributeFeatures() returns the OpenType features stored in a.
2540// The returned uiOpenTypeFeatures object is owned by a. It is an
2541// error to call this on a uiAttribute that does not hold OpenType
2542// features.
2544
2545// uiAttributedString represents a string of UTF-8 text that can
2546// optionally be embellished with formatting attributes. libui
2547// provides the list of formatting attributes, which cover common
2548// formatting traits like boldface and color as well as advanced
2549// typographical features provided by OpenType like superscripts
2550// and small caps. These attributes can be combined in a variety of
2551// ways.
2552//
2553// Attributes are applied to runs of Unicode codepoints in the string.
2554// Zero-length runs are elided. Consecutive runs that have the same
2555// attribute type and value are merged. Each attribute is independent
2556// of each other attribute; overlapping attributes of different types
2557// do not split each other apart, but different values of the same
2558// attribute type do.
2559//
2560// The empty string can also be represented by uiAttributedString,
2561// but because of the no-zero-length-attribute rule, it will not have
2562// attributes.
2563//
2564// A uiAttributedString takes ownership of all attributes given to
2565// it, as it may need to duplicate or delete uiAttribute objects at
2566// any time. By extension, when you free a uiAttributedString,
2567// all uiAttributes within will also be freed. Each method will
2568// describe its own rules in more details.
2569//
2570// In addition, uiAttributedString provides facilities for moving
2571// between grapheme clusters, which represent a character
2572// from the point of view of the end user. The cursor of a text editor
2573// is always placed on a grapheme boundary, so you can use these
2574// features to move the cursor left or right by one "character".
2575// TODO does uiAttributedString itself need this
2576//
2577// uiAttributedString does not provide enough information to be able
2578// to draw itself onto a uiDrawContext or respond to user actions.
2579// In order to do that, you'll need to use a uiDrawTextLayout, which
2580// is built from the combination of a uiAttributedString and a set of
2581// layout-specific properties.
2583
2584// uiAttributedStringForEachAttributeFunc is the type of the function
2585// invoked by uiAttributedStringForEachAttribute() for every
2586// attribute in s. Refer to that function's documentation for more
2587// details.
2588typedef uiForEach (*uiAttributedStringForEachAttributeFunc)(const uiAttributedString *s, const uiAttribute *a, size_t start, size_t end, void *data);
2589
2590// @role uiAttributedString constructor
2591// uiNewAttributedString() creates a new uiAttributedString from
2592// initialString. The string will be entirely unattributed.
2594
2595// @role uiAttributedString destructor
2596// uiFreeAttributedString() destroys the uiAttributedString s.
2597// It will also free all uiAttributes within.
2599
2600// uiAttributedStringString() returns the textual content of s as a
2601// '\0'-terminated UTF-8 string. The returned pointer is valid until
2602// the next change to the textual content of s.
2604
2605// uiAttributedStringLength() returns the number of UTF-8 bytes in
2606// the textual content of s, excluding the terminating '\0'.
2608
2609// uiAttributedStringAppendUnattributed() adds the '\0'-terminated
2610// UTF-8 string str to the end of s. The new substring will be
2611// unattributed.
2613
2614// uiAttributedStringInsertAtUnattributed() adds the '\0'-terminated
2615// UTF-8 string str to s at the byte position specified by at. The new
2616// substring will be unattributed; existing attributes will be moved
2617// along with their text.
2619
2620// TODO add the Append and InsertAtExtendingAttributes functions
2621// TODO and add functions that take a string + length
2622
2623// uiAttributedStringDelete() deletes the characters and attributes of
2624// s in the byte range [start, end).
2625_UI_EXTERN void uiAttributedStringDelete(uiAttributedString *s, size_t start, size_t end);
2626
2627// TODO add a function to uiAttributedString to get an attribute's value at a specific index or in a specific range, so we can edit
2628
2629// uiAttributedStringSetAttribute() sets a in the byte range [start, end)
2630// of s. Any existing attributes in that byte range of the same type are
2631// removed. s takes ownership of a; you should not use it after
2632// uiAttributedStringSetAttribute() returns.
2634
2635// uiAttributedStringForEachAttribute() enumerates all the
2636// uiAttributes in s. It is an error to modify s in f. Within f, s still
2637// owns the attribute; you can neither free it nor save it for later
2638// use.
2639// TODO reword the above for consistency (TODO and find out what I meant by that)
2640// TODO define an enumeration order (or mark it as undefined); also define how consecutive runs of identical attributes are handled here and sync with the definition of uiAttributedString itself
2642
2643// TODO const correct this somehow (the implementation needs to mutate the structure)
2645
2646// TODO const correct this somehow (the implementation needs to mutate the structure)
2648
2649// TODO const correct this somehow (the implementation needs to mutate the structure)
2651
2652// uiFontDescriptor provides a complete description of a font where
2653// one is needed. Currently, this means as the default font of a
2654// uiDrawTextLayout and as the data returned by uiFontButton.
2655// All the members operate like the respective uiAttributes.
2657
2659 // TODO const-correct this or figure out how to deal with this when getting a value
2660 char *Family;
2661 double Size;
2665};
2666
2669
2670// uiDrawTextLayout is a concrete representation of a
2671// uiAttributedString that can be displayed in a uiDrawContext.
2672// It includes information important for the drawing of a block of
2673// text, including the bounding box to wrap the text within, the
2674// alignment of lines of text within that box, areas to mark as
2675// being selected, and other things.
2676//
2677// Unlike uiAttributedString, the content of a uiDrawTextLayout is
2678// immutable once it has been created.
2679//
2680// TODO talk about OS-specific differences with text drawing that libui can't account for...
2682
2683// uiDrawTextAlign specifies the alignment of lines of text in a
2684// uiDrawTextLayout.
2685// TODO should this really have Draw in the name?
2690};
2691
2692// uiDrawTextLayoutParams describes a uiDrawTextLayout.
2693// DefaultFont is used to render any text that is not attributed
2694// sufficiently in String. Width determines the width of the bounding
2695// box of the text; the height is determined automatically.
2697
2698// TODO const-correct this somehow
2702 double Width;
2704};
2705
2706// @role uiDrawTextLayout constructor
2707// uiDrawNewTextLayout() creates a new uiDrawTextLayout from
2708// the given parameters.
2709//
2710// TODO
2711// - allow creating a layout out of a substring
2712// - allow marking compositon strings
2713// - allow marking selections, even after creation
2714// - add the following functions:
2715// - uiDrawTextLayoutHeightForWidth() (returns the height that a layout would need to be to display the entire string at a given width)
2716// - uiDrawTextLayoutRangeForSize() (returns what substring would fit in a given size)
2717// - uiDrawTextLayoutNewWithHeight() (limits amount of string used by the height)
2718// - some function to fix up a range (for text editing)
2720
2721// @role uiDrawFreeTextLayout destructor
2722// uiDrawFreeTextLayout() frees tl. The underlying
2723// uiAttributedString is not freed.
2725
2726// uiDrawText() draws tl in c with the top-left point of tl at (x, y).
2727_UI_EXTERN void uiDrawText(uiDrawContext *c, uiDrawTextLayout *tl, double x, double y);
2728
2729// uiDrawTextLayoutExtents() returns the width and height of tl
2730// in width and height. The returned width may be smaller than
2731// the width passed into uiDrawNewTextLayout() depending on
2732// how the text in tl is wrapped. Therefore, you can use this
2733// function to get the actual size of the text layout.
2734_UI_EXTERN void uiDrawTextLayoutExtents(uiDrawTextLayout *tl, double *width, double *height);
2735
2736// TODO metrics functions
2737
2738// TODO number of lines visible for clipping rect, range visible for clipping rect?
2739
2740
2752#define uiFontButton(this) ((uiFontButton *) (this))
2753
2764
2778 void (*f)(uiFontButton *sender, void *senderData), void *data);
2779
2789
2803
2813 uiModifierAlt = 1 << 1,
2816};
2817
2818// TODO document drag captures
2820 // TODO document what these mean for scrolling areas
2821 double X;
2822 double Y;
2823
2824 // TODO see draw above
2827
2828 int Down;
2829 int Up;
2830
2832
2834
2835 uint64_t Held1To64;
2836};
2837
2840 uiExtKeyInsert, // equivalent to "Help" on Apple keyboards
2850 uiExtKeyF1, // F1..F12 are guaranteed to be consecutive
2862 uiExtKeyN0, // numpad keys; independent of Num Lock state
2863 uiExtKeyN1, // N0..N9 are guaranteed to be consecutive
2878};
2879
2881 char Key;
2884
2886
2887 int Up;
2888};
2889
2890
2904#define uiColorButton(this) ((uiColorButton *) (this))
2905
2916_UI_EXTERN void uiColorButtonColor(uiColorButton *b, double *r, double *g, double *bl, double *a);
2917
2928_UI_EXTERN void uiColorButtonSetColor(uiColorButton *b, double r, double g, double bl, double a);
2929
2943 void (*f)(uiColorButton *sender, void *senderData), void *data);
2944
2952
2953
2969typedef struct uiForm uiForm;
2970#define uiForm(this) ((uiForm *) (this))
2971
2986_UI_EXTERN void uiFormAppend(uiForm *f, const char *label, uiControl *c, int stretchy);
2987
2995
3004_UI_EXTERN void uiFormDelete(uiForm *f, int index);
3005
3016
3027_UI_EXTERN void uiFormSetPadded(uiForm *f, int padded);
3028
3036
3037
3049};
3050
3062};
3063
3085typedef struct uiGrid uiGrid;
3086#define uiGrid(this) ((uiGrid *) (this))
3087
3103_UI_EXTERN void uiGridAppend(uiGrid *g, uiControl *c, int left, int top, int xspan, int yspan, int hexpand, uiAlign halign, int vexpand, uiAlign valign);
3104
3120_UI_EXTERN void uiGridInsertAt(uiGrid *g, uiControl *c, uiControl *existing, uiAt at, int xspan, int yspan, int hexpand, uiAlign halign, int vexpand, uiAlign valign);
3121
3132
3143_UI_EXTERN void uiGridSetPadded(uiGrid *g, int padded);
3144
3152
3153
3174typedef struct uiImage uiImage;
3175
3187_UI_EXTERN uiImage *uiNewImage(double width, double height);
3188
3196
3213_UI_EXTERN void uiImageAppend(uiImage *i, void *pixels, int pixelWidth, int pixelHeight, int byteStride);
3214
3264
3279
3292};
3293
3302
3313
3326
3342
3356
3370
3381
3392_UI_EXTERN uiTableValue *uiNewTableValueColor(double r, double g, double b, double a);
3393
3406_UI_EXTERN void uiTableValueColor(const uiTableValue *v, double *r, double *g, double *b, double *a);
3407
3408
3422
3445
3470
3478
3483
3496 uiTableValue *(*CellValue)(uiTableModelHandler *mh, uiTableModel *m, int row, int column);
3497
3511};
3512
3521
3531
3544
3556
3569// TODO reordering/moving
3570
3572#define uiTableModelColumnNeverEditable (-1)
3574#define uiTableModelColumnAlwaysEditable (-2)
3575
3593};
3594
3616};
3617
3639typedef struct uiTable uiTable;
3640#define uiTable(this) ((uiTable *) (this))
3641
3660 const char *name,
3661 int textModelColumn,
3662 int textEditableModelColumn,
3664
3680 const char *name,
3681 int imageModelColumn);
3682
3705 const char *name,
3706 int imageModelColumn,
3707 int textModelColumn,
3708 int textEditableModelColumn,
3710
3727 const char *name,
3728 int checkboxModelColumn,
3729 int checkboxEditableModelColumn);
3730
3755 const char *name,
3756 int checkboxModelColumn,
3757 int checkboxEditableModelColumn,
3758 int textModelColumn,
3759 int textEditableModelColumn,
3761
3778 const char *name,
3779 int progressModelColumn);
3780
3802 const char *name,
3803 int buttonModelColumn,
3804 int buttonClickableModelColumn);
3805
3814
3823
3832
3833
3848 void (*f)(uiTable *t, int row, void *data),
3849 void *data);
3850
3868 void (*f)(uiTable *t, int row, void *data),
3869 void *data);
3870
3884 int column,
3885 uiSortIndicator indicator);
3886
3896
3911 void (*f)(uiTable *sender, int column, void *senderData), void *data);
3912
3922
3936_UI_EXTERN void uiTableColumnSetWidth(uiTable *t, int column, int width);
3937
3961};
3962
3972
3984
3999_UI_EXTERN void uiTableOnSelectionChanged(uiTable *t, void (*f)(uiTable *t, void *data), void *data);
4000
4009{
4011 int *Rows;
4012};
4013
4025
4038
4046
4047#ifdef __cplusplus
4048}
4049#endif
4050
4051#endif
char * uiOpenFolder(uiWindow *parent)
Folder chooser dialog window to select a single folder.
char * uiSaveFile(uiWindow *parent)
Save file dialog window.
char * uiOpenFile(uiWindow *parent)
File chooser dialog window to select a single file.
void uiMsgBoxError(uiWindow *parent, const char *title, const char *description)
Error message box dialog window.
void uiMsgBox(uiWindow *parent, const char *title, const char *description)
Message box dialog window.
uiTableSelectionMode
Table selection modes.
Definition: ui.h:3950
uiSortIndicator
Sort indicators.
Definition: ui.h:3417
Definition: ui.h:2091
double AreaWidth
Definition: ui.h:2095
double ClipWidth
Definition: ui.h:2100
double ClipHeight
Definition: ui.h:2101
double AreaHeight
Definition: ui.h:2096
double ClipY
Definition: ui.h:2099
uiDrawContext * Context
Definition: ui.h:2092
double ClipX
Definition: ui.h:2098
Definition: ui.h:2047
void(* DragBroken)(uiAreaHandler *, uiArea *)
Definition: ui.h:2054
int(* KeyEvent)(uiAreaHandler *, uiArea *, uiAreaKeyEvent *)
Definition: ui.h:2055
void(* Draw)(uiAreaHandler *, uiArea *, uiAreaDrawParams *)
Definition: ui.h:2048
void(* MouseCrossed)(uiAreaHandler *, uiArea *, int left)
Definition: ui.h:2053
void(* MouseEvent)(uiAreaHandler *, uiArea *, uiAreaMouseEvent *)
Definition: ui.h:2050
Definition: ui.h:2880
char Key
Definition: ui.h:2881
int Up
Definition: ui.h:2887
uiExtKey ExtKey
Definition: ui.h:2882
uiModifiers Modifier
Definition: ui.h:2883
uiModifiers Modifiers
Definition: ui.h:2885
Definition: ui.h:2819
int Count
Definition: ui.h:2831
double X
Definition: ui.h:2821
double AreaHeight
Definition: ui.h:2826
int Down
Definition: ui.h:2828
uint64_t Held1To64
Definition: ui.h:2835
int Up
Definition: ui.h:2829
uiModifiers Modifiers
Definition: ui.h:2833
double Y
Definition: ui.h:2822
double AreaWidth
Definition: ui.h:2825
A boxlike container that holds a group of controls.
void uiBoxDelete(uiBox *b, int index)
Removes the control at index from the box.
uiBox * uiNewHorizontalBox(void)
Creates a new horizontal box.
void uiBoxSetPadded(uiBox *b, int padded)
Sets whether or not controls within the box are padded.
int uiBoxNumChildren(uiBox *b)
Returns the number of controls contained within the box.
void uiBoxAppend(uiBox *b, uiControl *child, int stretchy)
Appends a control to the box.
uiBox * uiNewVerticalBox(void)
Creates a new vertical box.
int uiBoxPadded(uiBox *b)
Returns whether or not controls within the box are padded.
A control that visually represents a button to be clicked by the user to trigger an action.
char * uiButtonText(uiButton *b)
Returns the button label text.
void uiButtonOnClicked(uiButton *b, void(*f)(uiButton *sender, void *senderData), void *data)
Registers a callback for when the button is clicked.
void uiButtonSetText(uiButton *b, const char *text)
Sets the button label text.
uiButton * uiNewButton(const char *text)
Creates a new button.
A control with a user checkable box accompanied by a text label.
void uiCheckboxSetChecked(uiCheckbox *c, int checked)
Sets whether or not the checkbox is checked.
uiCheckbox * uiNewCheckbox(const char *text)
Creates a new checkbox.
char * uiCheckboxText(uiCheckbox *c)
Returns the checkbox label text.
int uiCheckboxChecked(uiCheckbox *c)
Returns whether or the checkbox is checked.
void uiCheckboxOnToggled(uiCheckbox *c, void(*f)(uiCheckbox *sender, void *senderData), void *data)
Registers a callback for when the checkbox is toggled by the user.
void uiCheckboxSetText(uiCheckbox *c, const char *text)
Sets the checkbox label text.
A control with a color indicator that opens a color chooser when clicked.
uiColorButton * uiNewColorButton(void)
Creates a new color button.
void uiColorButtonOnChanged(uiColorButton *b, void(*f)(uiColorButton *sender, void *senderData), void *data)
Registers a callback for when the color is changed.
void uiColorButtonColor(uiColorButton *b, double *r, double *g, double *bl, double *a)
Returns the color button color.
void uiColorButtonSetColor(uiColorButton *b, double r, double g, double bl, double a)
Sets the color button color.
A control to select one item from a predefined list of items via a drop down menu.
void uiComboboxInsertAt(uiCombobox *c, int index, const char *text)
Inserts an item at index to the combo box.
void uiComboboxDelete(uiCombobox *c, int index)
Deletes an item at index from the combo box.
void uiComboboxClear(uiCombobox *c)
Deletes all items from the combo box.
void uiComboboxOnSelected(uiCombobox *c, void(*f)(uiCombobox *sender, void *senderData), void *data)
Registers a callback for when a combo box item is selected.
void uiComboboxAppend(uiCombobox *c, const char *text)
Appends an item to the combo box.
uiCombobox * uiNewCombobox(void)
Creates a new combo box.
void uiComboboxSetSelected(uiCombobox *c, int index)
Sets the item selected.
int uiComboboxSelected(uiCombobox *c)
Returns the index of the item selected.
int uiComboboxNumItems(uiCombobox *c)
Returns the number of items contained within the combo box.
Base class for GUI controls providing common methods.
Definition: ui.h:104
int uiControlVisible(uiControl *c)
Returns whether or not the control is visible.
void uiControlHide(uiControl *c)
Hides the control.
int(* Visible)(uiControl *)
Definition: ui.h:113
uint32_t OSSignature
Definition: ui.h:106
int(* Toplevel)(uiControl *)
Definition: ui.h:112
void(* SetParent)(uiControl *, uiControl *)
Definition: ui.h:111
int uiControlEnabledToUser(uiControl *c)
Returns whether or not the control can be interacted with by the user.
void uiControlDisable(uiControl *c)
Disables the control.
void uiControlDestroy(uiControl *c)
Dispose and free all allocated resources.
void uiControlEnable(uiControl *c)
Enables the control.
void(* Disable)(uiControl *)
Definition: ui.h:118
void(* Show)(uiControl *)
Definition: ui.h:114
void(* Destroy)(uiControl *)
Definition: ui.h:108
int uiControlEnabled(uiControl *c)
Returns whether or not the control is enabled.
uintptr_t uiControlHandle(uiControl *c)
Returns the control's OS-level handle.
void uiControlShow(uiControl *c)
Shows the control.
void uiFreeControl(uiControl *c)
Frees the memory associated with the control reference.
void uiControlVerifySetParent(uiControl *c, uiControl *parent)
Makes sure the control's parent can be set to parent.
int uiControlToplevel(uiControl *c)
Returns whether or not the control is a top level control.
void(* Hide)(uiControl *)
Definition: ui.h:115
void uiControlSetParent(uiControl *c, uiControl *parent)
Sets the control's parent.
uint32_t TypeSignature
Definition: ui.h:107
int(* Enabled)(uiControl *)
Definition: ui.h:116
uiControl * uiAllocControl(size_t n, uint32_t OSsig, uint32_t typesig, const char *typenamestr)
Allocates a uiControl.
uint32_t Signature
Definition: ui.h:105
uiControl * uiControlParent(uiControl *c)
Returns the parent control.
uintptr_t(* Handle)(uiControl *)
Definition: ui.h:109
void(* Enable)(uiControl *)
Definition: ui.h:117
A control to enter a date and/or time.
Definition: ui.h:1612
uiDateTimePicker * uiNewDateTimePicker(void)
Creates a new date picker.
void uiDateTimePickerOnChanged(uiDateTimePicker *d, void(*f)(uiDateTimePicker *sender, void *senderData), void *data)
Registers a callback for when the date time picker value is changed by the user.
void uiDateTimePickerSetTime(uiDateTimePicker *d, const struct tm *time)
Sets date and time of the data time picker.
uiDateTimePicker * uiNewTimePicker(void)
Creates a new date and time picker.
uiDateTimePicker * uiNewDatePicker(void)
Creates a new time picker.
void uiDateTimePickerTime(uiDateTimePicker *d, struct tm *time)
Returns date and time stored in the data time picker.
Definition: ui.h:2177
double R
Definition: ui.h:2179
double G
Definition: ui.h:2180
double Pos
Definition: ui.h:2178
double B
Definition: ui.h:2181
double A
Definition: ui.h:2182
Definition: ui.h:2149
double Y1
Definition: ui.h:2162
double B
Definition: ui.h:2155
size_t NumStops
Definition: ui.h:2165
double R
Definition: ui.h:2153
double Y0
Definition: ui.h:2160
double A
Definition: ui.h:2156
uiDrawBrushGradientStop * Stops
Definition: ui.h:2164
double X1
Definition: ui.h:2161
double X0
Definition: ui.h:2159
double OuterRadius
Definition: ui.h:2163
double G
Definition: ui.h:2154
uiDrawBrushType Type
Definition: ui.h:2150
Definition: ui.h:2140
double M32
Definition: ui.h:2146
double M11
Definition: ui.h:2141
double M22
Definition: ui.h:2144
double M31
Definition: ui.h:2145
double M21
Definition: ui.h:2143
double M12
Definition: ui.h:2142
Definition: ui.h:2185
size_t NumDashes
Definition: ui.h:2194
double DashPhase
Definition: ui.h:2195
double * Dashes
Definition: ui.h:2191
double Thickness
Definition: ui.h:2189
double MiterLimit
Definition: ui.h:2190
uiDrawLineJoin Join
Definition: ui.h:2187
uiDrawLineCap Cap
Definition: ui.h:2186
Definition: ui.h:2699
uiAttributedString * String
Definition: ui.h:2700
double Width
Definition: ui.h:2702
uiFontDescriptor * DefaultFont
Definition: ui.h:2701
uiDrawTextAlign Align
Definition: ui.h:2703
A control to select one item from a predefined list of items or enter ones own.
uiEditableCombobox * uiNewEditableCombobox(void)
Creates a new editable combo box.
void uiEditableComboboxOnChanged(uiEditableCombobox *c, void(*f)(uiEditableCombobox *sender, void *senderData), void *data)
Registers a callback for when an editable combo box item is selected or user text changed.
void uiEditableComboboxSetText(uiEditableCombobox *c, const char *text)
Sets the editable combo box text.
char * uiEditableComboboxText(uiEditableCombobox *c)
Returns the text of the editable combo box.
void uiEditableComboboxAppend(uiEditableCombobox *c, const char *text)
Appends an item to the editable combo box.
A control with a single line text entry field.
uiEntry * uiNewEntry(void)
Creates a new entry.
void uiEntryOnChanged(uiEntry *e, void(*f)(uiEntry *sender, void *senderData), void *data)
Registers a callback for when the user changes the entry's text.
char * uiEntryText(uiEntry *e)
Returns the entry's text.
void uiEntrySetText(uiEntry *e, const char *text)
Sets the entry's text.
uiEntry * uiNewPasswordEntry(void)
Creates a new entry suitable for sensitive inputs like passwords.
void uiEntrySetReadOnly(uiEntry *e, int readonly)
Sets whether or not the entry's text is read only.
uiEntry * uiNewSearchEntry(void)
Creates a new entry suitable for search.
int uiEntryReadOnly(uiEntry *e)
Returns whether or not the entry's text can be changed.
A button-like control that opens a font chooser when clicked.
void uiFontButtonOnChanged(uiFontButton *b, void(*f)(uiFontButton *sender, void *senderData), void *data)
Registers a callback for when the font is changed.
void uiFontButtonFont(uiFontButton *b, uiFontDescriptor *desc)
Returns the selected font.
uiFontButton * uiNewFontButton(void)
Creates a new font button.
void uiFreeFontButtonFont(uiFontDescriptor *desc)
Frees a uiFontDescriptor previously filled by uiFontButtonFont().
Definition: ui.h:2658
uiTextItalic Italic
Definition: ui.h:2663
uiTextWeight Weight
Definition: ui.h:2662
char * Family
Definition: ui.h:2660
uiTextStretch Stretch
Definition: ui.h:2664
double Size
Definition: ui.h:2661
A container control to organize contained controls as labeled fields.
void uiFormSetPadded(uiForm *f, int padded)
Sets whether or not controls within the box are padded.
int uiFormPadded(uiForm *f)
Returns whether or not controls within the form are padded.
void uiFormDelete(uiForm *f, int index)
Removes the control at index from the form.
void uiFormAppend(uiForm *f, const char *label, uiControl *c, int stretchy)
Appends a control with a label to the form.
uiForm * uiNewForm(void)
Creates a new form.
int uiFormNumChildren(uiForm *f)
Returns the number of controls contained within the form.
A control container to arrange containing controls in a grid.
void uiGridSetPadded(uiGrid *g, int padded)
Sets whether or not controls within the grid are padded.
int uiGridPadded(uiGrid *g)
Returns whether or not controls within the grid are padded.
void uiGridAppend(uiGrid *g, uiControl *c, int left, int top, int xspan, int yspan, int hexpand, uiAlign halign, int vexpand, uiAlign valign)
Appends a control to the grid.
uiGrid * uiNewGrid(void)
Creates a new grid.
void uiGridInsertAt(uiGrid *g, uiControl *c, uiControl *existing, uiAt at, int xspan, int yspan, int hexpand, uiAlign halign, int vexpand, uiAlign valign)
Inserts a control positioned in relation to another control within the grid.
A control container that adds a label to the contained child control.
void uiGroupSetTitle(uiGroup *g, const char *title)
Sets the group title.
uiGroup * uiNewGroup(const char *title)
Creates a new group.
void uiGroupSetChild(uiGroup *g, uiControl *c)
Sets the group's child.
char * uiGroupTitle(uiGroup *g)
Returns the group title.
void uiGroupSetMargined(uiGroup *g, int margined)
Sets whether or not the group has a margin.
int uiGroupMargined(uiGroup *g)
Returns whether or not the group has a margin.
A container for an image to be displayed on screen.
uiImage * uiNewImage(double width, double height)
Creates a new image container.
void uiImageAppend(uiImage *i, void *pixels, int pixelWidth, int pixelHeight, int byteStride)
Appends a new image representation.
void uiFreeImage(uiImage *i)
Frees the image container and all associated resources.
Definition: ui.h:60
size_t Size
Definition: ui.h:61
A control that displays non interactive text.
char * uiLabelText(uiLabel *l)
Returns the label text.
uiLabel * uiNewLabel(const char *text)
Creates a new label.
void uiLabelSetText(uiLabel *l, const char *text)
Sets the label text.
An application level menu bar.
uiMenuItem * uiMenuAppendAboutItem(uiMenu *m)
Appends a new About menu item.
uiMenuItem * uiMenuAppendItem(uiMenu *m, const char *name)
Appends a generic menu item.
uiMenuItem * uiMenuAppendQuitItem(uiMenu *m)
Appends a new Quit menu item.
uiMenuItem * uiMenuAppendPreferencesItem(uiMenu *m)
Appends a new Preferences menu item.
void uiMenuAppendSeparator(uiMenu *m)
Appends a new separator.
uiMenuItem * uiMenuAppendCheckItem(uiMenu *m, const char *name)
Appends a generic menu item with a checkbox.
uiMenu * uiNewMenu(const char *name)
Creates a new menu.
A menu item used in conjunction with uiMenu.
void uiMenuItemDisable(uiMenuItem *m)
Disables the menu item.
int uiMenuItemChecked(uiMenuItem *m)
Returns whether or not the menu item's checkbox is checked.
void uiMenuItemOnClicked(uiMenuItem *m, void(*f)(uiMenuItem *sender, uiWindow *window, void *senderData), void *data)
Registers a callback for when the menu item is clicked.
void uiMenuItemEnable(uiMenuItem *m)
Enables the menu item.
void uiMenuItemSetChecked(uiMenuItem *m, int checked)
Sets whether or not the menu item's checkbox is checked.
A control with a multi line text entry field.
void uiMultilineEntryOnChanged(uiMultilineEntry *e, void(*f)(uiMultilineEntry *sender, void *senderData), void *data)
Registers a callback for when the user changes the multi line entry's text.
void uiMultilineEntryAppend(uiMultilineEntry *e, const char *text)
Appends text to the multi line entry's text.
void uiMultilineEntrySetReadOnly(uiMultilineEntry *e, int readonly)
Sets whether or not the multi line entry's text is read only.
uiMultilineEntry * uiNewMultilineEntry(void)
Creates a new multi line entry that visually wraps text when lines overflow.
void uiMultilineEntrySetText(uiMultilineEntry *e, const char *text)
Sets the multi line entry's text.
uiMultilineEntry * uiNewNonWrappingMultilineEntry(void)
Creates a new multi line entry that scrolls horizontally when lines overflow.
char * uiMultilineEntryText(uiMultilineEntry *e)
Returns the multi line entry's text.
int uiMultilineEntryReadOnly(uiMultilineEntry *e)
Returns whether or not the multi line entry's text can be changed.
A control that visualizes the progress of a task via the fill level of a horizontal bar.
uiProgressBar * uiNewProgressBar(void)
Creates a new progress bar.
void uiProgressBarSetValue(uiProgressBar *p, int n)
Sets the progress bar value.
int uiProgressBarValue(uiProgressBar *p)
Returns the progress bar value.
A multiple choice control of check buttons from which only one can be selected at a time.
void uiRadioButtonsSetSelected(uiRadioButtons *r, int index)
Sets the item selected.
void uiRadioButtonsAppend(uiRadioButtons *r, const char *text)
Appends a radio button.
int uiRadioButtonsSelected(uiRadioButtons *r)
Returns the index of the item selected.
void uiRadioButtonsOnSelected(uiRadioButtons *r, void(*f)(uiRadioButtons *sender, void *senderData), void *data)
Registers a callback for when radio button is selected.
uiRadioButtons * uiNewRadioButtons(void)
Creates a new radio buttons instance.
A control to visually separate controls, horizontally or vertically.
uiSeparator * uiNewHorizontalSeparator(void)
Creates a new horizontal separator to separate controls being stacked vertically.
uiSeparator * uiNewVerticalSeparator(void)
Creates a new vertical separator to separate controls being stacked horizontally.
A control to display and modify integer values via a user draggable slider.
void uiSliderOnReleased(uiSlider *s, void(*f)(uiSlider *sender, void *senderData), void *data)
Registers a callback for when the slider is released from dragging.
uiSlider * uiNewSlider(int min, int max)
Creates a new slider.
int uiSliderHasToolTip(uiSlider *s)
Returns whether or not the slider has a tool tip.
int uiSliderValue(uiSlider *s)
Returns the slider value.
void uiSliderSetValue(uiSlider *s, int value)
Sets the slider value.
void uiSliderOnChanged(uiSlider *s, void(*f)(uiSlider *sender, void *senderData), void *data)
Registers a callback for when the slider value is changed by the user.
void uiSliderSetHasToolTip(uiSlider *s, int hasToolTip)
Sets whether or not the slider has a tool tip.
void uiSliderSetRange(uiSlider *s, int min, int max)
Sets the slider range.
A control to display and modify integer values via a text field or +/- buttons.
void uiSpinboxOnChanged(uiSpinbox *s, void(*f)(uiSpinbox *sender, void *senderData), void *data)
Registers a callback for when the spinbox value is changed by the user.
void uiSpinboxSetValue(uiSpinbox *s, int value)
Sets the spinbox value.
uiSpinbox * uiNewSpinbox(int min, int max)
Creates a new spinbox.
int uiSpinboxValue(uiSpinbox *s)
Returns the spinbox value.
A multi page control interface that displays one page at a time.
void uiTabAppend(uiTab *t, const char *name, uiControl *c)
Appends a control in form of a page/tab with label.
void uiTabSetMargined(uiTab *t, int index, int margined)
Sets whether or not the page/tab at index has a margin.
void uiTabOnSelected(uiTab *t, void(*f)(uiTab *sender, void *senderData), void *data)
Registers a callback for when a tab is selected.
int uiTabNumPages(uiTab *t)
Returns the number of pages contained.
void uiTabSetSelected(uiTab *t, int index)
Sets the tab selected.
int uiTabMargined(uiTab *t, int index)
Returns whether or not the page/tab at index has a margin.
int uiTabSelected(uiTab *t)
Returns the index of the tab selected.
void uiTabInsertAt(uiTab *t, const char *name, int index, uiControl *c)
Inserts a control in form of a page/tab with label at index.
void uiTabDelete(uiTab *t, int index)
Removes the control at index.
uiTab * uiNewTab(void)
Creates a new tab container.
A control to display data in a tabular fashion.
void uiTableAppendButtonColumn(uiTable *t, const char *name, int buttonModelColumn, int buttonClickableModelColumn)
Appends a column to the table containing a button.
void uiTableOnRowDoubleClicked(uiTable *t, void(*f)(uiTable *t, int row, void *data), void *data)
Registers a callback for when the user double clicks a table row.
uiTableSelection * uiTableGetSelection(uiTable *t)
Returns the current table selection.
void uiTableOnRowClicked(uiTable *t, void(*f)(uiTable *t, int row, void *data), void *data)
Registers a callback for when the user single clicks a table row.
void uiTableColumnSetWidth(uiTable *t, int column, int width)
Sets the table column width.
uiSortIndicator uiTableHeaderSortIndicator(uiTable *t, int column)
Returns the column's sort indicator displayed in the table header.
int uiTableHeaderVisible(uiTable *t)
Returns whether or not the table header is visible.
void uiTableAppendImageTextColumn(uiTable *t, const char *name, int imageModelColumn, int textModelColumn, int textEditableModelColumn, uiTableTextColumnOptionalParams *textParams)
Appends a column to the table that displays both an image and text.
void uiTableAppendCheckboxTextColumn(uiTable *t, const char *name, int checkboxModelColumn, int checkboxEditableModelColumn, int textModelColumn, int textEditableModelColumn, uiTableTextColumnOptionalParams *textParams)
Appends a column to the table containing a checkbox and text.
int uiTableColumnWidth(uiTable *t, int column)
Returns the table column width.
void uiTableAppendTextColumn(uiTable *t, const char *name, int textModelColumn, int textEditableModelColumn, uiTableTextColumnOptionalParams *textParams)
Appends a text column to the table.
void uiTableSetSelectionMode(uiTable *t, uiTableSelectionMode mode)
Sets the table selection mode.
void uiTableSetSelection(uiTable *t, uiTableSelection *sel)
Sets the current table selection clearing any previous selection.
uiTable * uiNewTable(uiTableParams *params)
Creates a new table.
void uiTableOnSelectionChanged(uiTable *t, void(*f)(uiTable *t, void *data), void *data)
Registers a callback for when the table selection changed.
void uiTableHeaderOnClicked(uiTable *t, void(*f)(uiTable *sender, int column, void *senderData), void *data)
Registers a callback for when a table column header is clicked.
void uiTableAppendCheckboxColumn(uiTable *t, const char *name, int checkboxModelColumn, int checkboxEditableModelColumn)
Appends a column to the table containing a checkbox.
void uiTableHeaderSetSortIndicator(uiTable *t, int column, uiSortIndicator indicator)
Sets the column's sort indicator displayed in the table header.
uiTableSelectionMode uiTableGetSelectionMode(uiTable *t)
Returns the table selection mode.
void uiTableAppendImageColumn(uiTable *t, const char *name, int imageModelColumn)
Appends an image column to the table.
void uiTableHeaderSetVisible(uiTable *t, int visible)
Sets whether or not the table header is visible.
void uiTableAppendProgressBarColumn(uiTable *t, const char *name, int progressModelColumn)
Appends a column to the table containing a progress bar.
Developer defined methods for data retrieval and setting.
Definition: ui.h:3460
void(* SetCellValue)(uiTableModelHandler *, uiTableModel *, int, int, const uiTableValue *)
Sets the cell value for (row, column).
Definition: ui.h:3510
int(* NumColumns)(uiTableModelHandler *, uiTableModel *)
Returns the number of columns in the uiTableModel.
Definition: ui.h:3469
uiTableValueType(* ColumnType)(uiTableModelHandler *, uiTableModel *, int column)
Returns the column type in for of a uiTableValueType.
Definition: ui.h:3477
int(* NumRows)(uiTableModelHandler *, uiTableModel *)
Returns the number of rows in the uiTableModel.
Definition: ui.h:3482
Table model delegate to retrieve data and inform about model changes.
uiTableModel * uiNewTableModel(uiTableModelHandler *mh)
Creates a new table model.
void uiTableModelRowChanged(uiTableModel *m, int index)
Informs all associated uiTable views that a row has been changed.
void uiFreeTableModel(uiTableModel *m)
Frees the table model.
void uiTableModelRowInserted(uiTableModel *m, int newIndex)
Informs all associated uiTable views that a new row has been added.
void uiTableModelRowDeleted(uiTableModel *m, int oldIndex)
Informs all associated uiTable views that a row has been deleted.
Table parameters passed to uiNewTable().
Definition: ui.h:3602
int RowBackgroundColorModelColumn
uiTableModel column that defines background color for each row,
Definition: ui.h:3615
uiTableModel * Model
Model holding the data to be displayed.
Definition: ui.h:3606
Holds an array of selected row indices for a table.
Definition: ui.h:4009
void uiFreeTableSelection(uiTableSelection *s)
Frees the given uiTableSelection and all it's resources.
int * Rows
Array containing selected row indices, NULL on empty selection.
Definition: ui.h:4011
int NumRows
Number of selected rows.
Definition: ui.h:4010
Optional parameters to control the appearance of text columns.
Definition: ui.h:3583
int ColorModelColumn
uiTableModel column that defines the text color for each cell.
Definition: ui.h:3592
Container to store values used in container related methods.
int uiTableValueInt(const uiTableValue *v)
Returns the integer value held internally.
void uiTableValueColor(const uiTableValue *v, double *r, double *g, double *b, double *a)
Returns the color value held internally.
void uiFreeTableValue(uiTableValue *v)
Frees the uiTableValue.
uiTableValue * uiNewTableValueImage(uiImage *img)
Creates a new table value to store an image.
uiTableValueType uiTableValueGetType(const uiTableValue *v)
Gets the uiTableValue type.
uiTableValue * uiNewTableValueString(const char *str)
Creates a new table value to store a text string.
const char * uiTableValueString(const uiTableValue *v)
Returns the string value held internally.
uiTableValue * uiNewTableValueInt(int i)
Creates a new table value to store an integer.
uiTableValue * uiNewTableValueColor(double r, double g, double b, double a)
Creates a new table value to store a color in.
uiImage * uiTableValueImage(const uiTableValue *v)
Returns a reference to the image contained.
A control that represents a top-level window.
int uiWindowFocused(uiWindow *w)
Returns whether or not the window is focused.
void uiWindowPosition(uiWindow *w, int *x, int *y)
Gets the window position.
void uiWindowSetContentSize(uiWindow *w, int width, int height)
Sets the window content size.
void uiWindowSetResizeable(uiWindow *w, int resizeable)
Sets whether or not the window is user resizeable.
void uiWindowOnClosing(uiWindow *w, int(*f)(uiWindow *sender, void *senderData), void *data)
Registers a callback for when the window is to be closed.
int uiWindowBorderless(uiWindow *w)
Returns whether or not the window is borderless.
int uiWindowMargined(uiWindow *w)
Returns whether or not the window has a margin.
void uiWindowOnContentSizeChanged(uiWindow *w, void(*f)(uiWindow *sender, void *senderData), void *data)
Registers a callback for when the window content size is changed.
int uiWindowFullscreen(uiWindow *w)
Returns whether or not the window is full screen.
void uiWindowSetBorderless(uiWindow *w, int borderless)
Sets whether or not the window is borderless.
int uiWindowResizeable(uiWindow *w)
Returns whether or not the window is user resizeable.
char * uiWindowTitle(uiWindow *w)
Returns the window title.
void uiWindowSetTitle(uiWindow *w, const char *title)
Sets the window title.
void uiWindowSetChild(uiWindow *w, uiControl *child)
Sets the window's child.
void uiWindowSetFullscreen(uiWindow *w, int fullscreen)
Sets whether or not the window is full screen.
void uiWindowSetPosition(uiWindow *w, int x, int y)
Moves the window to the specified position.
void uiWindowOnPositionChanged(uiWindow *w, void(*f)(uiWindow *sender, void *senderData), void *data)
Registers a callback for when the window moved.
void uiWindowContentSize(uiWindow *w, int *width, int *height)
Gets the window content size.
void uiWindowOnFocusChanged(uiWindow *w, void(*f)(uiWindow *sender, void *senderData), void *data)
Registers a callback for when the window focus changes.
void uiWindowSetMargined(uiWindow *w, int margined)
Sets whether or not the window has a margin.
uiWindow * uiNewWindow(const char *title, int width, int height, int hasMenubar)
Creates a new uiWindow.
void uiDrawMatrixMultiply(uiDrawMatrix *dest, uiDrawMatrix *src)
uiAttribute * uiNewUnderlineAttribute(uiUnderline u)
void uiFreeAttributedString(uiAttributedString *s)
uiWindowResizeEdge
Definition: ui.h:2060
@ uiWindowResizeEdgeTop
Definition: ui.h:2062
@ uiWindowResizeEdgeBottom
Definition: ui.h:2064
@ uiWindowResizeEdgeBottomLeft
Definition: ui.h:2067
@ uiWindowResizeEdgeLeft
Definition: ui.h:2061
@ uiWindowResizeEdgeRight
Definition: ui.h:2063
@ uiWindowResizeEdgeTopLeft
Definition: ui.h:2065
@ uiWindowResizeEdgeBottomRight
Definition: ui.h:2068
@ uiWindowResizeEdgeTopRight
Definition: ui.h:2066
const uiOpenTypeFeatures * uiAttributeFeatures(const uiAttribute *a)
uiTableValueType
uiTableValue types.
Definition: ui.h:3287
@ uiTableValueTypeImage
Definition: ui.h:3289
@ uiTableValueTypeInt
Definition: ui.h:3290
@ uiTableValueTypeColor
Definition: ui.h:3291
@ uiTableValueTypeString
Definition: ui.h:3288
uiOpenTypeFeatures * uiNewOpenTypeFeatures(void)
#define _UI_ENUM(s)
Definition: ui.h:44
void uiDrawSave(uiDrawContext *c)
void uiDrawFreeTextLayout(uiDrawTextLayout *tl)
void uiOpenTypeFeaturesForEach(const uiOpenTypeFeatures *otf, uiOpenTypeFeaturesForEachFunc f, void *data)
uiAttributedString * uiNewAttributedString(const char *initialString)
uiAt
Placement specifier to define placement in relation to another control.
Definition: ui.h:3057
@ uiAtTop
Place above control.
Definition: ui.h:3059
@ uiAtLeading
Place before control.
Definition: ui.h:3058
@ uiAtBottom
Place below control.
Definition: ui.h:3061
@ uiAtTrailing
Place behind control.
Definition: ui.h:3060
void uiDrawPathNewFigureWithArc(uiDrawPath *p, double xCenter, double yCenter, double radius, double startAngle, double sweep, int negative)
struct uiAttributedString uiAttributedString
Definition: ui.h:2582
uiAttribute * uiNewSizeAttribute(double size)
void uiLoadControlFont(uiFontDescriptor *f)
const char * uiInit(uiInitOptions *options)
void uiDrawPathAddRectangle(uiDrawPath *p, double x, double y, double width, double height)
size_t uiAttributedStringByteIndexToGrapheme(uiAttributedString *s, size_t pos)
size_t uiAttributedStringGraphemeToByteIndex(uiAttributedString *s, size_t pos)
uiForEach(* uiAttributedStringForEachAttributeFunc)(const uiAttributedString *s, const uiAttribute *a, size_t start, size_t end, void *data)
Definition: ui.h:2588
void uiMainSteps(void)
void uiAttributedStringDelete(uiAttributedString *s, size_t start, size_t end)
void uiDrawFill(uiDrawContext *c, uiDrawPath *path, uiDrawBrush *b)
uiArea * uiNewScrollingArea(uiAreaHandler *ah, int width, int height)
void uiAttributeColor(const uiAttribute *a, double *r, double *g, double *b, double *alpha)
uiTextItalic
Definition: ui.h:2351
@ uiTextItalicOblique
Definition: ui.h:2353
@ uiTextItalicItalic
Definition: ui.h:2354
@ uiTextItalicNormal
Definition: ui.h:2352
void uiDrawPathLineTo(uiDrawPath *p, double x, double y)
void uiDrawFreePath(uiDrawPath *p)
uiModifiers
Keyboard modifier keys.
Definition: ui.h:2811
@ uiModifierAlt
Alternate/Option key.
Definition: ui.h:2813
@ uiModifierSuper
Super/Command/Windows key.
Definition: ui.h:2815
@ uiModifierShift
Shift key.
Definition: ui.h:2814
@ uiModifierCtrl
Control key.
Definition: ui.h:2812
void uiFreeText(char *text)
Free the memory of a returned string.
void uiAttributeUnderlineColor(const uiAttribute *a, uiUnderlineColor *u, double *r, double *g, double *b, double *alpha)
uiOpenTypeFeatures * uiOpenTypeFeaturesClone(const uiOpenTypeFeatures *otf)
void uiTimer(int milliseconds, int(*f)(void *data), void *data)
void uiMain(void)
uiDrawTextAlign
Definition: ui.h:2686
@ uiDrawTextAlignCenter
Definition: ui.h:2688
@ uiDrawTextAlignLeft
Definition: ui.h:2687
@ uiDrawTextAlignRight
Definition: ui.h:2689
void uiFreeInitError(const char *err)
uiForEach(* uiOpenTypeFeaturesForEachFunc)(const uiOpenTypeFeatures *otf, char a, char b, char c, char d, uint32_t value, void *data)
Definition: ui.h:2489
struct uiAttribute uiAttribute
Definition: ui.h:2257
int uiOpenTypeFeaturesGet(const uiOpenTypeFeatures *otf, char a, char b, char c, char d, uint32_t *value)
struct uiDrawPath uiDrawPath
Definition: ui.h:2104
uiDrawTextLayout * uiDrawNewTextLayout(uiDrawTextLayoutParams *params)
uiAttributeType uiAttributeGetType(const uiAttribute *a)
uiTextWeight
Definition: ui.h:2320
@ uiTextWeightMaximum
Definition: ui.h:2333
@ uiTextWeightNormal
Definition: ui.h:2326
@ uiTextWeightBook
Definition: ui.h:2325
@ uiTextWeightMedium
Definition: ui.h:2327
@ uiTextWeightUltraLight
Definition: ui.h:2323
@ uiTextWeightBold
Definition: ui.h:2329
@ uiTextWeightUltraBold
Definition: ui.h:2330
@ uiTextWeightSemiBold
Definition: ui.h:2328
@ uiTextWeightUltraHeavy
Definition: ui.h:2332
@ uiTextWeightLight
Definition: ui.h:2324
@ uiTextWeightThin
Definition: ui.h:2322
@ uiTextWeightMinimum
Definition: ui.h:2321
@ uiTextWeightHeavy
Definition: ui.h:2331
struct uiDrawContext uiDrawContext
Definition: ui.h:2045
int uiDrawMatrixInvertible(uiDrawMatrix *m)
void uiQuit(void)
void uiAreaQueueRedrawAll(uiArea *a)
uiAttribute * uiNewFamilyAttribute(const char *family)
void uiUninit(void)
uiTextStretch uiAttributeStretch(const uiAttribute *a)
void uiAttributedStringAppendUnattributed(uiAttributedString *s, const char *str)
uiAttribute * uiNewColorAttribute(double r, double g, double b, double a)
void uiDrawMatrixTranslate(uiDrawMatrix *m, double x, double y)
const char * uiAttributedStringString(const uiAttributedString *s)
void uiDrawPathEnd(uiDrawPath *p)
void uiDrawText(uiDrawContext *c, uiDrawTextLayout *tl, double x, double y)
void uiOpenTypeFeaturesRemove(uiOpenTypeFeatures *otf, char a, char b, char c, char d)
void uiAttributedStringInsertAtUnattributed(uiAttributedString *s, const char *str, size_t at)
uiAttribute * uiNewFeaturesAttribute(const uiOpenTypeFeatures *otf)
void uiDrawClip(uiDrawContext *c, uiDrawPath *path)
uiUnderline uiAttributeUnderline(const uiAttribute *a)
void uiQueueMain(void(*f)(void *data), void *data)
uiTextWeight uiAttributeWeight(const uiAttribute *a)
double uiAttributeSize(const uiAttribute *a)
void uiDrawTransform(uiDrawContext *c, uiDrawMatrix *m)
uiAttribute * uiNewWeightAttribute(uiTextWeight weight)
uiAttribute * uiNewBackgroundAttribute(double r, double g, double b, double a)
uiAttributeType
Definition: ui.h:2270
@ uiAttributeTypeUnderline
Definition: ui.h:2278
@ uiAttributeTypeBackground
Definition: ui.h:2277
@ uiAttributeTypeFamily
Definition: ui.h:2271
@ uiAttributeTypeItalic
Definition: ui.h:2274
@ uiAttributeTypeColor
Definition: ui.h:2276
@ uiAttributeTypeUnderlineColor
Definition: ui.h:2279
@ uiAttributeTypeStretch
Definition: ui.h:2275
@ uiAttributeTypeSize
Definition: ui.h:2272
@ uiAttributeTypeFeatures
Definition: ui.h:2280
@ uiAttributeTypeWeight
Definition: ui.h:2273
void uiAreaBeginUserWindowMove(uiArea *a)
uiUnderline
Definition: ui.h:2415
@ uiUnderlineSuggestion
Definition: ui.h:2419
@ uiUnderlineSingle
Definition: ui.h:2417
@ uiUnderlineDouble
Definition: ui.h:2418
@ uiUnderlineNone
Definition: ui.h:2416
uiExtKey
Definition: ui.h:2838
@ uiExtKeyF8
Definition: ui.h:2857
@ uiExtKeyNSubtract
Definition: ui.h:2875
@ uiExtKeyF5
Definition: ui.h:2854
@ uiExtKeyF3
Definition: ui.h:2852
@ uiExtKeyN3
Definition: ui.h:2865
@ uiExtKeyPageUp
Definition: ui.h:2844
@ uiExtKeyF12
Definition: ui.h:2861
@ uiExtKeyF4
Definition: ui.h:2853
@ uiExtKeyRight
Definition: ui.h:2849
@ uiExtKeyNDot
Definition: ui.h:2872
@ uiExtKeyDelete
Definition: ui.h:2841
@ uiExtKeyNAdd
Definition: ui.h:2874
@ uiExtKeyN6
Definition: ui.h:2868
@ uiExtKeyNEnter
Definition: ui.h:2873
@ uiExtKeyDown
Definition: ui.h:2847
@ uiExtKeyF10
Definition: ui.h:2859
@ uiExtKeyN8
Definition: ui.h:2870
@ uiExtKeyN4
Definition: ui.h:2866
@ uiExtKeyInsert
Definition: ui.h:2840
@ uiExtKeyN0
Definition: ui.h:2862
@ uiExtKeyN5
Definition: ui.h:2867
@ uiExtKeyN1
Definition: ui.h:2863
@ uiExtKeyF11
Definition: ui.h:2860
@ uiExtKeyF1
Definition: ui.h:2850
@ uiExtKeyF2
Definition: ui.h:2851
@ uiExtKeyF6
Definition: ui.h:2855
@ uiExtKeyLeft
Definition: ui.h:2848
@ uiExtKeyUp
Definition: ui.h:2846
@ uiExtKeyEscape
Definition: ui.h:2839
@ uiExtKeyF7
Definition: ui.h:2856
@ uiExtKeyN7
Definition: ui.h:2869
@ uiExtKeyNDivide
Definition: ui.h:2877
@ uiExtKeyEnd
Definition: ui.h:2843
@ uiExtKeyN2
Definition: ui.h:2864
@ uiExtKeyHome
Definition: ui.h:2842
@ uiExtKeyF9
Definition: ui.h:2858
@ uiExtKeyPageDown
Definition: ui.h:2845
@ uiExtKeyN9
Definition: ui.h:2871
@ uiExtKeyNMultiply
Definition: ui.h:2876
#define _UI_EXTERN
Definition: ui.h:39
uiForEach
Definition: ui.h:53
@ uiForEachStop
Definition: ui.h:55
@ uiForEachContinue
Definition: ui.h:54
void uiAreaBeginUserWindowResize(uiArea *a, uiWindowResizeEdge edge)
void uiDrawTextLayoutExtents(uiDrawTextLayout *tl, double *width, double *height)
size_t uiAttributedStringLen(const uiAttributedString *s)
uiDrawPath * uiDrawNewPath(uiDrawFillMode fillMode)
uiAttribute * uiNewUnderlineColorAttribute(uiUnderlineColor u, double r, double g, double b, double a)
int uiDrawPathEnded(uiDrawPath *p)
void uiDrawPathNewFigure(uiDrawPath *p, double x, double y)
void uiDrawStroke(uiDrawContext *c, uiDrawPath *path, uiDrawBrush *b, uiDrawStrokeParams *p)
size_t uiAttributedStringNumGraphemes(uiAttributedString *s)
uiDrawLineJoin
Definition: ui.h:2124
@ uiDrawLineJoinRound
Definition: ui.h:2126
@ uiDrawLineJoinMiter
Definition: ui.h:2125
@ uiDrawLineJoinBevel
Definition: ui.h:2127
void uiFreeFontDescriptor(uiFontDescriptor *desc)
const char * uiAttributeFamily(const uiAttribute *a)
void uiDrawPathArcTo(uiDrawPath *p, double xCenter, double yCenter, double radius, double startAngle, double sweep, int negative)
uiDrawFillMode
Definition: ui.h:2135
@ uiDrawFillModeWinding
Definition: ui.h:2136
@ uiDrawFillModeAlternate
Definition: ui.h:2137
uiDrawLineCap
Definition: ui.h:2118
@ uiDrawLineCapRound
Definition: ui.h:2120
@ uiDrawLineCapFlat
Definition: ui.h:2119
@ uiDrawLineCapSquare
Definition: ui.h:2121
void uiOpenTypeFeaturesAdd(uiOpenTypeFeatures *otf, char a, char b, char c, char d, uint32_t value)
void uiDrawMatrixTransformSize(uiDrawMatrix *m, double *x, double *y)
void uiFreeOpenTypeFeatures(uiOpenTypeFeatures *otf)
uiTextItalic uiAttributeItalic(const uiAttribute *a)
void uiDrawMatrixSetIdentity(uiDrawMatrix *m)
void uiAreaSetSize(uiArea *a, int width, int height)
void uiDrawPathCloseFigure(uiDrawPath *p)
struct uiOpenTypeFeatures uiOpenTypeFeatures
Definition: ui.h:2483
void uiAttributedStringSetAttribute(uiAttributedString *s, uiAttribute *a, size_t start, size_t end)
struct uiArea uiArea
Definition: ui.h:2039
void uiDrawMatrixRotate(uiDrawMatrix *m, double x, double y, double amount)
uiAttribute * uiNewItalicAttribute(uiTextItalic italic)
int uiDrawMatrixInvert(uiDrawMatrix *m)
void uiUserBugCannotSetParentOnToplevel(const char *type)
struct uiDrawTextLayout uiDrawTextLayout
Definition: ui.h:2681
uiUnderlineColor
Definition: ui.h:2443
@ uiUnderlineColorCustom
Definition: ui.h:2444
@ uiUnderlineColorAuxiliary
Definition: ui.h:2447
@ uiUnderlineColorGrammar
Definition: ui.h:2446
@ uiUnderlineColorSpelling
Definition: ui.h:2445
void uiAreaScrollTo(uiArea *a, double x, double y, double width, double height)
void uiDrawMatrixScale(uiDrawMatrix *m, double xCenter, double yCenter, double x, double y)
uiAlign
Alignment specifiers to define placement within the reserved area.
Definition: ui.h:3044
@ uiAlignStart
Place at start.
Definition: ui.h:3046
@ uiAlignEnd
Place at end.
Definition: ui.h:3048
@ uiAlignFill
Fill area.
Definition: ui.h:3045
@ uiAlignCenter
Place in center.
Definition: ui.h:3047
uiDrawBrushType
Definition: ui.h:2111
@ uiDrawBrushTypeImage
Definition: ui.h:2115
@ uiDrawBrushTypeSolid
Definition: ui.h:2112
@ uiDrawBrushTypeLinearGradient
Definition: ui.h:2113
@ uiDrawBrushTypeRadialGradient
Definition: ui.h:2114
void uiOnShouldQuit(int(*f)(void *data), void *data)
uiArea * uiNewArea(uiAreaHandler *ah)
void uiDrawRestore(uiDrawContext *c)
void uiDrawMatrixTransformPoint(uiDrawMatrix *m, double *x, double *y)
void uiAttributedStringForEachAttribute(const uiAttributedString *s, uiAttributedStringForEachAttributeFunc f, void *data)
void uiDrawPathBezierTo(uiDrawPath *p, double c1x, double c1y, double c2x, double c2y, double endX, double endY)
uiTextStretch
Definition: ui.h:2377
@ uiTextStretchSemiCondensed
Definition: ui.h:2381
@ uiTextStretchExpanded
Definition: ui.h:2384
@ uiTextStretchExtraExpanded
Definition: ui.h:2385
@ uiTextStretchUltraExpanded
Definition: ui.h:2386
@ uiTextStretchExtraCondensed
Definition: ui.h:2379
@ uiTextStretchCondensed
Definition: ui.h:2380
@ uiTextStretchSemiExpanded
Definition: ui.h:2383
@ uiTextStretchNormal
Definition: ui.h:2382
@ uiTextStretchUltraCondensed
Definition: ui.h:2378
void uiDrawMatrixSkew(uiDrawMatrix *m, double x, double y, double xamount, double yamount)
void uiFreeAttribute(uiAttribute *a)
uiAttribute * uiNewStretchAttribute(uiTextStretch stretch)
int uiMainStep(int wait)
@ uiTableSelectionModeZeroOrMany
Allow zero or many (multiple) rows to be selected.
Definition: ui.h:3960
@ uiTableSelectionModeZeroOrOne
Allow zero or one row to be selected.
Definition: ui.h:3958
@ uiTableSelectionModeNone
Allow no row selection.
Definition: ui.h:3957
@ uiTableSelectionModeOne
Allow for exactly one row to be selected.
Definition: ui.h:3959
@ uiSortIndicatorNone
Definition: ui.h:3418
@ uiSortIndicatorDescending
Definition: ui.h:3420
@ uiSortIndicatorAscending
Definition: ui.h:3419