aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/irrlicht-1.8/include/IGUITabControl.h
diff options
context:
space:
mode:
authorDavid Walter Seikel2013-01-13 18:54:10 +1000
committerDavid Walter Seikel2013-01-13 18:54:10 +1000
commit959831f4ef5a3e797f576c3de08cd65032c997ad (patch)
treee7351908be5995f0b325b2ebeaa02d5a34b82583 /libraries/irrlicht-1.8/include/IGUITabControl.h
parentAdd info about changes to Irrlicht. (diff)
downloadSledjHamr-959831f4ef5a3e797f576c3de08cd65032c997ad.zip
SledjHamr-959831f4ef5a3e797f576c3de08cd65032c997ad.tar.gz
SledjHamr-959831f4ef5a3e797f576c3de08cd65032c997ad.tar.bz2
SledjHamr-959831f4ef5a3e797f576c3de08cd65032c997ad.tar.xz
Remove damned ancient DOS line endings from Irrlicht. Hopefully I did not go overboard.
Diffstat (limited to '')
-rw-r--r--libraries/irrlicht-1.8/include/IGUITabControl.h272
1 files changed, 136 insertions, 136 deletions
diff --git a/libraries/irrlicht-1.8/include/IGUITabControl.h b/libraries/irrlicht-1.8/include/IGUITabControl.h
index 660c4d0..d9b4d12 100644
--- a/libraries/irrlicht-1.8/include/IGUITabControl.h
+++ b/libraries/irrlicht-1.8/include/IGUITabControl.h
@@ -1,136 +1,136 @@
1// Copyright (C) 2002-2012 Nikolaus Gebhardt 1// Copyright (C) 2002-2012 Nikolaus Gebhardt
2// This file is part of the "Irrlicht Engine". 2// This file is part of the "Irrlicht Engine".
3// For conditions of distribution and use, see copyright notice in irrlicht.h 3// For conditions of distribution and use, see copyright notice in irrlicht.h
4 4
5#ifndef __I_GUI_TAB_CONTROL_H_INCLUDED__ 5#ifndef __I_GUI_TAB_CONTROL_H_INCLUDED__
6#define __I_GUI_TAB_CONTROL_H_INCLUDED__ 6#define __I_GUI_TAB_CONTROL_H_INCLUDED__
7 7
8#include "IGUIElement.h" 8#include "IGUIElement.h"
9#include "SColor.h" 9#include "SColor.h"
10#include "IGUISkin.h" 10#include "IGUISkin.h"
11 11
12namespace irr 12namespace irr
13{ 13{
14namespace gui 14namespace gui
15{ 15{
16 //! A tab-page, onto which other gui elements could be added. 16 //! A tab-page, onto which other gui elements could be added.
17 /** IGUITab refers to the page itself, not to the tab in the tabbar of an IGUITabControl. */ 17 /** IGUITab refers to the page itself, not to the tab in the tabbar of an IGUITabControl. */
18 class IGUITab : public IGUIElement 18 class IGUITab : public IGUIElement
19 { 19 {
20 public: 20 public:
21 21
22 //! constructor 22 //! constructor
23 IGUITab(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle) 23 IGUITab(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
24 : IGUIElement(EGUIET_TAB, environment, parent, id, rectangle) {} 24 : IGUIElement(EGUIET_TAB, environment, parent, id, rectangle) {}
25 25
26 //! Returns zero based index of tab if in tabcontrol. 26 //! Returns zero based index of tab if in tabcontrol.
27 /** Can be accessed later IGUITabControl::getTab() by this number. 27 /** Can be accessed later IGUITabControl::getTab() by this number.
28 Note that this number can change when other tabs are inserted or removed . 28 Note that this number can change when other tabs are inserted or removed .
29 */ 29 */
30 virtual s32 getNumber() const = 0; 30 virtual s32 getNumber() const = 0;
31 31
32 //! sets if the tab should draw its background 32 //! sets if the tab should draw its background
33 virtual void setDrawBackground(bool draw=true) = 0; 33 virtual void setDrawBackground(bool draw=true) = 0;
34 34
35 //! sets the color of the background, if it should be drawn. 35 //! sets the color of the background, if it should be drawn.
36 virtual void setBackgroundColor(video::SColor c) = 0; 36 virtual void setBackgroundColor(video::SColor c) = 0;
37 37
38 //! returns true if the tab is drawing its background, false if not 38 //! returns true if the tab is drawing its background, false if not
39 virtual bool isDrawingBackground() const = 0; 39 virtual bool isDrawingBackground() const = 0;
40 40
41 //! returns the color of the background 41 //! returns the color of the background
42 virtual video::SColor getBackgroundColor() const = 0; 42 virtual video::SColor getBackgroundColor() const = 0;
43 43
44 //! sets the color of the text 44 //! sets the color of the text
45 virtual void setTextColor(video::SColor c) = 0; 45 virtual void setTextColor(video::SColor c) = 0;
46 46
47 //! gets the color of the text 47 //! gets the color of the text
48 virtual video::SColor getTextColor() const = 0; 48 virtual video::SColor getTextColor() const = 0;
49 }; 49 };
50 50
51 //! A standard tab control 51 //! A standard tab control
52 /** \par This element can create the following events of type EGUI_EVENT_TYPE: 52 /** \par This element can create the following events of type EGUI_EVENT_TYPE:
53 \li EGET_TAB_CHANGED 53 \li EGET_TAB_CHANGED
54 */ 54 */
55 class IGUITabControl : public IGUIElement 55 class IGUITabControl : public IGUIElement
56 { 56 {
57 public: 57 public:
58 58
59 //! constructor 59 //! constructor
60 IGUITabControl(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle) 60 IGUITabControl(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
61 : IGUIElement(EGUIET_TAB_CONTROL, environment, parent, id, rectangle) {} 61 : IGUIElement(EGUIET_TAB_CONTROL, environment, parent, id, rectangle) {}
62 62
63 //! Adds a tab 63 //! Adds a tab
64 virtual IGUITab* addTab(const wchar_t* caption, s32 id=-1) = 0; 64 virtual IGUITab* addTab(const wchar_t* caption, s32 id=-1) = 0;
65 65
66 //! Insert the tab at the given index 66 //! Insert the tab at the given index
67 /** \return The tab on success or NULL on failure. */ 67 /** \return The tab on success or NULL on failure. */
68 virtual IGUITab* insertTab(s32 idx, const wchar_t* caption, s32 id=-1) = 0; 68 virtual IGUITab* insertTab(s32 idx, const wchar_t* caption, s32 id=-1) = 0;
69 69
70 //! Removes a tab from the tabcontrol 70 //! Removes a tab from the tabcontrol
71 virtual void removeTab(s32 idx) = 0; 71 virtual void removeTab(s32 idx) = 0;
72 72
73 //! Clears the tabcontrol removing all tabs 73 //! Clears the tabcontrol removing all tabs
74 virtual void clear() = 0; 74 virtual void clear() = 0;
75 75
76 //! Returns amount of tabs in the tabcontrol 76 //! Returns amount of tabs in the tabcontrol
77 virtual s32 getTabCount() const = 0; 77 virtual s32 getTabCount() const = 0;
78 78
79 //! Returns a tab based on zero based index 79 //! Returns a tab based on zero based index
80 /** \param idx: zero based index of tab. Is a value betwenn 0 and getTabcount()-1; 80 /** \param idx: zero based index of tab. Is a value betwenn 0 and getTabcount()-1;
81 \return Returns pointer to the Tab. Returns 0 if no tab 81 \return Returns pointer to the Tab. Returns 0 if no tab
82 is corresponding to this tab. */ 82 is corresponding to this tab. */
83 virtual IGUITab* getTab(s32 idx) const = 0; 83 virtual IGUITab* getTab(s32 idx) const = 0;
84 84
85 //! Brings a tab to front. 85 //! Brings a tab to front.
86 /** \param idx: number of the tab. 86 /** \param idx: number of the tab.
87 \return Returns true if successful. */ 87 \return Returns true if successful. */
88 virtual bool setActiveTab(s32 idx) = 0; 88 virtual bool setActiveTab(s32 idx) = 0;
89 89
90 //! Brings a tab to front. 90 //! Brings a tab to front.
91 /** \param tab: pointer to the tab. 91 /** \param tab: pointer to the tab.
92 \return Returns true if successful. */ 92 \return Returns true if successful. */
93 virtual bool setActiveTab(IGUITab *tab) = 0; 93 virtual bool setActiveTab(IGUITab *tab) = 0;
94 94
95 //! Returns which tab is currently active 95 //! Returns which tab is currently active
96 virtual s32 getActiveTab() const = 0; 96 virtual s32 getActiveTab() const = 0;
97 97
98 //! get the the id of the tab at the given absolute coordinates 98 //! get the the id of the tab at the given absolute coordinates
99 /** \return The id of the tab or -1 when no tab is at those coordinates*/ 99 /** \return The id of the tab or -1 when no tab is at those coordinates*/
100 virtual s32 getTabAt(s32 xpos, s32 ypos) const = 0; 100 virtual s32 getTabAt(s32 xpos, s32 ypos) const = 0;
101 101
102 //! Set the height of the tabs 102 //! Set the height of the tabs
103 virtual void setTabHeight( s32 height ) = 0; 103 virtual void setTabHeight( s32 height ) = 0;
104 104
105 //! Get the height of the tabs 105 //! Get the height of the tabs
106 /** return Returns the height of the tabs */ 106 /** return Returns the height of the tabs */
107 virtual s32 getTabHeight() const = 0; 107 virtual s32 getTabHeight() const = 0;
108 108
109 //! set the maximal width of a tab. Per default width is 0 which means "no width restriction". 109 //! set the maximal width of a tab. Per default width is 0 which means "no width restriction".
110 virtual void setTabMaxWidth(s32 width ) = 0; 110 virtual void setTabMaxWidth(s32 width ) = 0;
111 111
112 //! get the maximal width of a tab 112 //! get the maximal width of a tab
113 virtual s32 getTabMaxWidth() const = 0; 113 virtual s32 getTabMaxWidth() const = 0;
114 114
115 //! Set the alignment of the tabs 115 //! Set the alignment of the tabs
116 /** Use EGUIA_UPPERLEFT or EGUIA_LOWERRIGHT */ 116 /** Use EGUIA_UPPERLEFT or EGUIA_LOWERRIGHT */
117 virtual void setTabVerticalAlignment( gui::EGUI_ALIGNMENT alignment ) = 0; 117 virtual void setTabVerticalAlignment( gui::EGUI_ALIGNMENT alignment ) = 0;
118 118
119 //! Get the alignment of the tabs 119 //! Get the alignment of the tabs
120 /** return Returns the alignment of the tabs */ 120 /** return Returns the alignment of the tabs */
121 virtual gui::EGUI_ALIGNMENT getTabVerticalAlignment() const = 0; 121 virtual gui::EGUI_ALIGNMENT getTabVerticalAlignment() const = 0;
122 122
123 //! Set the extra width added to tabs on each side of the text 123 //! Set the extra width added to tabs on each side of the text
124 virtual void setTabExtraWidth( s32 extraWidth ) = 0; 124 virtual void setTabExtraWidth( s32 extraWidth ) = 0;
125 125
126 //! Get the extra width added to tabs on each side of the text 126 //! Get the extra width added to tabs on each side of the text
127 /** return Returns the extra width of the tabs */ 127 /** return Returns the extra width of the tabs */
128 virtual s32 getTabExtraWidth() const = 0; 128 virtual s32 getTabExtraWidth() const = 0;
129 }; 129 };
130 130
131 131
132} // end namespace gui 132} // end namespace gui
133} // end namespace irr 133} // end namespace irr
134 134
135#endif 135#endif
136 136