UFO: Alien Invasion
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ui_node_text.h
Go to the documentation of this file.
1 
5 /*
6 Copyright (C) 2002-2020 UFO: Alien Invasion.
7 
8 This program is free software; you can redistribute it and/or
9 modify it under the terms of the GNU General Public License
10 as published by the Free Software Foundation; either version 2
11 of the License, or (at your option) any later version.
12 
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16 
17 See the GNU General Public License for more details.
18 
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 
23 */
24 
25 #pragma once
26 
28 
30 public:
31  void draw(uiNode_t* node) override;
32  void onLeftClick(uiNode_t* node, int x, int y) override;
33  void onRightClick(uiNode_t* node, int x, int y) override;
34  bool onScroll(uiNode_t* node, int deltaX, int deltaY) override;
35  void onMouseMove(uiNode_t* node, int x, int y) override;
36  void onMouseDown(uiNode_t* node, int x, int y, int button) override;
37  void onMouseUp(uiNode_t* node, int x, int y, int button) override;
38  void onCapturedMouseMove(uiNode_t* node, int x, int y) override;
39  void onLoading(uiNode_t* node) override;
40  void onLoaded(uiNode_t* node) override;
41  int getCellHeight (uiNode_t* node) override;
42  void validateCache(uiNode_t* node);
43  void doLayout (uiNode_t* node) override;
44 protected:
45  void drawText (uiNode_t* node, const char* text, const linkedList_t* list, bool noDraw);
46  virtual void updateCache (uiNode_t* node);
47 };
48 
49 struct uiBehaviour_t;
50 struct uiAction_s;
51 
52 void UI_TextScrollEnd(const char* nodePath);
53 void UI_TextNodeSelectLine(uiNode_t* node, int num);
54 const char* UI_TextNodeGetSelectedText(uiNode_t* node, int num);
55 
56 void UI_RegisterTextNode(uiBehaviour_t* behaviour);
57 
58 typedef struct {
60 
61  int dataID;
62  int versionId;
65  const char* textSelected;
67  int lineHeight;
68  int tabWidth;
69  int longlines;
70  bool mousefx;
71 
73 
78 CASSERT(offsetof(textExtraData_t, super) == 0);
virtual void updateCache(uiNode_t *node)
void doLayout(uiNode_t *node) override
Call to update the node layout. This common code revalidates the node tree.
void UI_RegisterTextNode(uiBehaviour_t *behaviour)
void onMouseMove(uiNode_t *node, int x, int y) override
void onMouseUp(uiNode_t *node, int x, int y, int button) override
abstractScrollableExtraData_t super
Definition: ui_node_text.h:59
void onLoading(uiNode_t *node) override
void UI_TextScrollEnd(const char *nodePath)
Scroll to the bottom.
void onRightClick(uiNode_t *node, int x, int y) override
Calls the script command for a text node that is clickable via right mouse button.
const char * textSelected
Definition: ui_node_text.h:65
void onMouseDown(uiNode_t *node, int x, int y, int button) override
Track mouse down/up events to implement drag&drop-like scrolling, for touchscreen devices...
void UI_TextNodeSelectLine(uiNode_t *node, int num)
Change the selected line.
int getCellHeight(uiNode_t *node) override
Return size of the cell, which is the size (in virtual "pixel") which represent 1 in the scroll value...
void onLeftClick(uiNode_t *node, int x, int y) override
Calls the script command for a text node that is clickable.
void onCapturedMouseMove(uiNode_t *node, int x, int y) override
void validateCache(uiNode_t *node)
void drawText(uiNode_t *node, const char *text, const linkedList_t *list, bool noDraw)
Handles line breaks and drawing for shared data id.
CASSERT(offsetof(textExtraData_t, super)==0)
Atomic structure used to define most of the UI.
Definition: ui_nodes.h:80
base code for scrollable node
node behaviour, how a node work
Definition: ui_behaviour.h:39
const char * UI_TextNodeGetSelectedText(uiNode_t *node, int num)
void draw(uiNode_t *node) override
Draw a text node.
bool onScroll(uiNode_t *node, int deltaX, int deltaY) override
void onLoaded(uiNode_t *node) override
Atomic element to store UI scripts The parser use this atom to translate script action into many tree...
Definition: ui_actions.h:144