TGUI  1.3-dev
Loading...
Searching...
No Matches
EditBoxRenderer.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25
26#ifndef TGUI_EDIT_BOX_RENDERER_HPP
27#define TGUI_EDIT_BOX_RENDERER_HPP
28
29
30#include <TGUI/Renderers/WidgetRenderer.hpp>
31
33
34TGUI_MODULE_EXPORT namespace tgui
35{
36 class TGUI_API EditBoxRenderer : public WidgetRenderer
37 {
38 public:
39
40 using WidgetRenderer::WidgetRenderer;
41
42
50
51
58 TGUI_NODISCARD TextStyles getTextStyle() const;
59
60
72
73
80 TGUI_NODISCARD TextStyles getDefaultTextStyle() const;
81
82
89 void setBorders(const Borders& borders);
90
91
98 TGUI_NODISCARD Borders getBorders() const;
99
100
110 void setPadding(const Padding& padding);
111
112
121 TGUI_NODISCARD Padding getPadding() const;
122
123
130 void setCaretWidth(float width);
131
132
139 TGUI_NODISCARD float getCaretWidth() const;
140
141
148 void setTextColor(Color textColor);
149
150
157 TGUI_NODISCARD Color getTextColor() const;
158
159
167
168
175 TGUI_NODISCARD Color getTextColorDisabled() const;
176
177
182 void setTextColorFocused(Color textColor);
183
184
189 TGUI_NODISCARD Color getTextColorFocused() const;
190
191
198 void setSelectedTextColor(Color selectedTextColor);
199
200
207 TGUI_NODISCARD Color getSelectedTextColor() const;
208
209
216 void setSelectedTextBackgroundColor(Color selectedTextBackgroundColor);
217
218
225 TGUI_NODISCARD Color getSelectedTextBackgroundColor() const;
226
227
234 void setDefaultTextColor(Color defaultTextColor);
235
236
243 TGUI_NODISCARD Color getDefaultTextColor() const;
244
245
255
256
263 TGUI_NODISCARD Color getBackgroundColor() const;
264
265
275
276
283 TGUI_NODISCARD Color getBackgroundColorHover() const;
284
285
295
296
303 TGUI_NODISCARD Color getBackgroundColorDisabled() const;
304
305
313
314
319 TGUI_NODISCARD Color getBackgroundColorFocused() const;
320
321
328 void setCaretColor(Color caretColor);
329
330
337 TGUI_NODISCARD Color getCaretColor() const;
338
339
346 void setCaretColorHover(Color caretColor);
347
348
355 TGUI_NODISCARD Color getCaretColorHover() const;
356
357
362 void setCaretColorFocused(Color caretColor);
363
364
369 TGUI_NODISCARD Color getCaretColorFocused() const;
370
371
379
380
387 TGUI_NODISCARD Color getBorderColor() const;
388
389
397
398
405 TGUI_NODISCARD Color getBorderColorHover() const;
406
407
415
416
423 TGUI_NODISCARD Color getBorderColorDisabled() const;
424
425
431
432
437 TGUI_NODISCARD Color getBorderColorFocused() const;
438
439
448 void setTexture(const Texture& texture);
449
450
457 TGUI_NODISCARD const Texture& getTexture() const;
458
459
466 void setTextureHover(const Texture& texture);
467
468
475 TGUI_NODISCARD const Texture& getTextureHover() const;
476
477
484 void setTextureDisabled(const Texture& texture);
485
486
493 TGUI_NODISCARD const Texture& getTextureDisabled() const;
494
495
502 void setTextureFocused(const Texture& texture);
503
504
511 TGUI_NODISCARD const Texture& getTextureFocused() const;
512
513
515 };
516
518}
519
521
522#endif // TGUI_EDIT_BOX_RENDERER_HPP
Wrapper for colors.
Definition Color.hpp:72
Definition EditBoxRenderer.hpp:37
void setBorderColorFocused(Color color)
Changes the color of the borders used when the edit box is focused.
void setPadding(const Padding &padding)
Changes the padding of the edit box.
TGUI_NODISCARD const Texture & getTexture() const
Returns the image that is displayed.
void setDefaultTextColor(Color defaultTextColor)
Sets the color of the default text that can optionally be displayed when the edit box is empty.
void setBorders(const Borders &borders)
Changes the size of the borders.
TGUI_NODISCARD Color getSelectedTextBackgroundColor() const
Returns the background color of the selected text that will be used inside the edit box.
void setCaretColor(Color caretColor)
Sets the color that will be used inside the edit box for the blinking caret.
TGUI_NODISCARD Color getCaretColorFocused() const
Returns the color that will be used for the blinking caret when the edit box is focused.
TGUI_NODISCARD Color getBackgroundColorHover() const
Returns the color of the background in the hover state (mouse on edit box)
void setTextColorFocused(Color textColor)
Sets the text color that will be used inside the edit box when the edit box is focused.
TGUI_NODISCARD Color getSelectedTextColor() const
Returns the text color of the selected text that will be used inside the edit box.
TGUI_NODISCARD float getCaretWidth() const
Returns the caret width.
TGUI_NODISCARD TextStyles getDefaultTextStyle() const
Returns the text style of the default text (the text drawn when the edit box is empty)
void setSelectedTextBackgroundColor(Color selectedTextBackgroundColor)
Sets the background color of the selected text that will be used inside the edit box.
void setTextureFocused(const Texture &texture)
Changes the image that is drawn on top of the edit box image when the edit box is focused.
void setBorderColorDisabled(Color color)
Changes the color of the borders used when the edit box is disabled.
TGUI_NODISCARD Color getTextColor() const
Returns the text color that will be used inside the edit box.
void setBackgroundColor(Color color)
Changes the color of the background.
TGUI_NODISCARD Color getBorderColor() const
Returns the color of the borders.
void setBorderColor(Color color)
Changes the color of the borders.
TGUI_NODISCARD Color getBorderColorDisabled() const
Returns the color of the borders used when the edit box is disabled.
TGUI_NODISCARD const Texture & getTextureDisabled() const
Returns the image that is displayed when the edit box is disabled.
TGUI_NODISCARD Color getTextColorFocused() const
Returns the text color that will be used inside the edit box when the edit box is focused.
void setTextStyle(TextStyles style)
Changes the text style.
TGUI_NODISCARD const Texture & getTextureFocused() const
Returns the image that is drawn on top of the edit box image when the edit box is focused.
TGUI_NODISCARD const Texture & getTextureHover() const
Returns the image that is displayed when the mouse is located on top of the edit box.
void setTexture(const Texture &texture)
Changes the image that is displayed.
void setBackgroundColorFocused(Color color)
Changes the color of the background when the edit box is focused.
TGUI_NODISCARD TextStyles getTextStyle() const
Returns text style.
void setBackgroundColorDisabled(Color color)
Changes the color of the background when the edit box is disabled.
void setTextureDisabled(const Texture &texture)
Changes the image that is displayed when the edit box is disabled.
TGUI_NODISCARD Color getDefaultTextColor() const
Returns the color of the default text that can optionally be displayed when the edit box is empty.
void setDefaultTextStyle(TextStyles style)
Changes the text style of the default text (the text drawn when the edit box is empty)
void setTextureHover(const Texture &texture)
Changes the image that is displayed when the mouse is located on top of the edit box.
TGUI_NODISCARD Color getBorderColorHover() const
Returns the color of the borders used when the mouse is on top of the edit box.
TGUI_NODISCARD Padding getPadding() const
Returns the size of the padding.
TGUI_NODISCARD Color getCaretColor() const
Returns the color that will be used inside the edit box for the blinking caret.
void setCaretWidth(float width)
Changes the width of the caret.
void setBorderColorHover(Color color)
Changes the color of the borders used when the mouse is on top of the edit box.
TGUI_NODISCARD Color getTextColorDisabled() const
Returns the text color that will be used inside the edit box when the edit box is disabled.
void setSelectedTextColor(Color selectedTextColor)
Sets the text color of the selected text that will be used inside the edit box.
TGUI_NODISCARD Color getBackgroundColorDisabled() const
Returns the color of the background when the edit box is disabled.
void setTextColorDisabled(Color textColor)
Sets the text color that will be used inside the edit box when the edit box is disabled.
TGUI_NODISCARD Color getCaretColorHover() const
Returns the color that will be used for the blinking caret when the mouse is on top of the edit box.
TGUI_NODISCARD Borders getBorders() const
Returns the size of the borders.
void setBackgroundColorHover(Color color)
Changes the color of the background in the hover state (mouse on edit box, but not pressed)
void setCaretColorHover(Color caretColor)
Sets the color that will be used for the blinking caret when the mouse is on top of the edit box.
void setCaretColorFocused(Color caretColor)
Sets the color that will be used for the blinking caret when the edit box is focused.
TGUI_NODISCARD Color getBackgroundColor() const
Returns the color of the background.
TGUI_NODISCARD Color getBackgroundColorFocused() const
Returns the color of the background when the edit box is focused.
void setTextColor(Color textColor)
Sets the text color that will be used inside the edit box.
TGUI_NODISCARD Color getBorderColorFocused() const
Returns the color of the borders used when the edit box is focused.
Definition Outline.hpp:39
Wrapper for text styles.
Definition TextStyle.hpp:57
Texture wrapper that internally reuses resources when multiple Texture objects are loaded from the sa...
Definition Texture.hpp:57
Base class for all renderer classes.
Definition WidgetRenderer.hpp:72
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39