Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
GdkGraphicLabel.h
Go to the documentation of this file.
1 /**
2 * @file GdkGraphicLabel.h
3 * @brief Declares the GdkGraphicLabel class.
4 *
5 * @internal
6 * Copyright (C) 2018-2022 by LMI Technologies Inc. All rights reserved.
7 */
8 #ifndef GDK_GRAPHIC_LABEL_H
9 #define GDK_GRAPHIC_LABEL_H
10 
11 #include <Gdk/GdkDef.h>
12 
13 /**
14 * @class GdkGraphicLabel
15 * @extends kObject
16 * @ingroup Gdk-Data
17 * @brief Represents a label.
18 */
19 typedef kObject GdkGraphicLabel;
20 
21 /**
22 * Constructs a label object.
23 *
24 * @public @memberof GdkGraphicLabel
25 * @param label Destination for the constructed object handle.
26 * @param allocator Memory allocator (or kNULL for default).
27 * @return Operation status.
28 */
30 
31 /**
32 * Sets the text of a label
33 *
34 * @public @memberof GdkGraphicLabel
35 * @param label GdkGraphicLabel object.
36 * @param text Pointer to text of the label in UTF-8 character format
37 * @return Operation status.
38 */
39 GdkFx(kStatus)GdkGraphicLabel_SetText(GdkGraphicLabel label, const kChar *text);
40 
41 /**
42 * Sets the to the position of the label
43 *
44 * @public @memberof GdkGraphicLabel
45 * @param label GdkGraphicLabel object.
46 * @param position Pointer to position of label in space coordinates
47 * @return Operation status.
48 */
50 
51 #include <Gdk/Data/GdkGraphicLabel.x.h>
52 
53 #endif
Represents a label.
Essential Gdk declarations.
kStatus GdkGraphicLabel_SetPosition(GdkGraphicLabel label, kPoint3d64f *position)
Sets the to the position of the label.
kStatus GdkGraphicLabel_SetText(GdkGraphicLabel label, const kChar *text)
Sets the text of a label.
kStatus GdkGraphicLabel_Construct(GdkGraphicLabel *label, kObject allocator)
Constructs a label object.