From 21dbe499cd5a47ec0112e1dd5d8a1dff674a4a23 Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Sat, 28 Dec 2013 17:04:11 +0100 Subject: [PATCH] [DEV] add new doc model --- 001_bases.html | 202 +-- base.css | 23 +- class_ewol__Compositing.html | 180 +++ class_ewol__Context.html | 485 +++++++ class_ewol__Dimension.html | 324 +++++ class_ewol__DrawProperty.html | 121 ++ class_ewol__EventShortCut.html | 144 ++ class_ewol__GlyphProperty.html | 181 +++ class_ewol__Kerning.html | 160 +++ class_ewol__Object.html | 473 +++++++ class_ewol__Resource.html | 187 +++ class_ewol__Widget.html | 1054 ++++++++++++++ class_ewol__compositing__Area.html | 195 +++ class_ewol__compositing__Drawing.html | 327 +++++ class_ewol__compositing__Image.html | 300 ++++ class_ewol__compositing__Shaper.html | 255 ++++ class_ewol__compositing__Sprite.html | 143 ++ class_ewol__compositing__Text.html | 570 ++++++++ class_ewol__compositing__TextDecoration.html | 122 ++ class_ewol__context__CommandLine.html | 143 ++ class_ewol__context__ConfigFont.html | 179 +++ class_ewol__context__Fps.html | 138 ++ class_ewol__context__InputLimit.html | 111 ++ class_ewol__context__InputManager.html | 175 +++ class_ewol__context__InputPoperty.html | 165 +++ class_ewol__event__Entry.html | 158 +++ class_ewol__event__EntrySystem.html | 116 ++ class_ewol__event__Input.html | 158 +++ class_ewol__event__InputSystem.html | 140 ++ class_ewol__event__Time.html | 164 +++ class_ewol__key__Special.html | 260 ++++ class_ewol__object__Config.html | 134 ++ class_ewol__object__ConfigElement.html | 140 ++ class_ewol__object__EventExtGen.html | 121 ++ class_ewol__object__Manager.html | 163 +++ class_ewol__object__Message.html | 146 ++ class_ewol__object__MultiCast.html | 140 ++ ..._ewol__object__MultiCast__MessageList.html | 122 ++ class_ewol__resource__Colored3DObject.html | 180 +++ class_ewol__resource__ConfigFile.html | 169 +++ class_ewol__resource__FontBase.html | 155 +++ class_ewol__resource__FontFreeType.html | 169 +++ class_ewol__resource__Manager.html | 177 +++ class_ewol__resource__Program.html | 482 +++++++ class_ewol__resource__Shader.html | 179 +++ ...s_ewol__resource__SimpleConfigElement.html | 143 ++ class_ewol__resource__Texture.html | 216 +++ class_ewol__resource__TextureFile.html | 130 ++ class_ewol__resource__TexturedFont.html | 197 +++ ...s_ewol__resource__VirtualBufferObject.html | 236 ++++ ..._ewol__resource__progAttributeElement.html | 125 ++ class_ewol__widget__Button.html | 416 ++++++ class_ewol__widget__ButtonColor.html | 199 +++ class_ewol__widget__CheckBox.html | 188 +++ class_ewol__widget__ColorBar.html | 162 +++ class_ewol__widget__ColorChooser.html | 154 +++ class_ewol__widget__Composer.html | 177 +++ class_ewol__widget__Container.html | 233 ++++ class_ewol__widget__ContainerN.html | 303 ++++ class_ewol__widget__ContextMenu.html | 226 +++ class_ewol__widget__Entry.html | 439 ++++++ class_ewol__widget__FileChooser.html | 190 +++ class_ewol__widget__Gird.html | 310 +++++ class_ewol__widget__Gird__GirdProperties.html | 118 ++ class_ewol__widget__Image.html | 322 +++++ class_ewol__widget__Joystick.html | 217 +++ class_ewol__widget__Label.html | 196 +++ class_ewol__widget__Layer.html | 129 ++ class_ewol__widget__List.html | 215 +++ class_ewol__widget__ListFileSystem.html | 230 ++++ class_ewol__widget__Manager.html | 224 +++ class_ewol__widget__Menu.html | 160 +++ class_ewol__widget__MenuElement.html | 152 ++ class_ewol__widget__Parameter.html | 172 +++ class_ewol__widget__ParameterList.html | 199 +++ class_ewol__widget__PopUp.html | 292 ++++ class_ewol__widget__ProgressBar.html | 200 +++ class_ewol__widget__Scroll.html | 223 +++ class_ewol__widget__Sizer.html | 269 ++++ class_ewol__widget__Slider.html | 219 +++ class_ewol__widget__Spacer.html | 183 +++ class_ewol__widget__StdPopUp.html | 182 +++ class_ewol__widget__WSlider.html | 289 ++++ class_ewol__widget__WidgetScrooled.html | 219 +++ class_ewol__widget__Windows.html | 315 +++++ class_ewol__widget__elementPL.html | 142 ++ enum_ewol__Dimension__distance.html | 140 ++ enum_ewol__Widget__annimationMode.html | 115 ++ enum_ewol__compositing__Text__aligneMode.html | 125 ++ ...l__context__clipBoard__clipboardListe.html | 162 +++ enum_ewol__context__cursorDisplay.html | 184 +++ enum_ewol__font__mode.html | 117 ++ enum_ewol__gravity.html | 133 ++ enum_ewol__key__keyboard.html | 277 ++++ enum_ewol__key__status.html | 151 ++ enum_ewol__key__type.html | 129 ++ enum_ewol__openGL__openGlFlags.html | 239 ++++ enum_ewol__orientation.html | 112 ++ enum_ewol__widget__Button__buttonLock.html | 124 ++ ..._ewol__widget__Composer__composerMode.html | 115 ++ ...ol__widget__ContextMenu__markPosition.html | 125 ++ ..._ewol__widget__Joystick__joystickMode.html | 110 ++ enum_ewol__widget__Scroll__highSpeedMode.html | 130 ++ enum_ewol__widget__Sizer__animation.html | 130 ++ enum_ewol__widget__Sizer__displayMode.html | 112 ++ enum_ewol__widget__WSlider__sladingMode.html | 115 ++ ...widget__WidgetScrooled__scrollingMode.html | 118 ++ ...ol__widget__Windows__popUpMessageType.html | 124 ++ ewol__Compositing.html | 259 ---- ewol__Context.html | 707 ---------- ewol__Dimension.html | 453 ------ ewol__DrawProperty.html | 167 --- ewol__EventShortCut.html | 174 --- ewol__GlyphProperty.html | 212 --- ewol__Kerning.html | 214 --- ewol__Object.html | 629 --------- ewol__Resource.html | 264 ---- ewol__Widget.html | 1226 ----------------- ewol__compositing__Area.html | 289 ---- ewol__compositing__Drawing.html | 517 ------- ewol__compositing__Image.html | 428 ------ ewol__compositing__Shaper.html | 390 ------ ewol__compositing__Sprite.html | 197 --- ewol__compositing__Text.html | 844 ------------ ewol__compositing__TextDecoration.html | 167 --- ewol__context__CommandLine.html | 213 --- ewol__context__ConfigFont.html | 254 ---- ewol__context__Fps.html | 217 --- ewol__context__InputLimit.html | 159 --- ewol__context__InputManager.html | 324 ----- ewol__context__InputPoperty.html | 159 --- ewol__context__clipBoard__clipboardListe.html | 149 -- ewol__context__cursorDisplay.html | 149 -- ewol__event__Entry.html | 230 ---- ewol__event__EntrySystem.html | 166 --- ewol__event__Input.html | 230 ---- ewol__event__InputSystem.html | 200 --- ewol__event__Time.html | 238 ---- ewol__font__mode.html | 149 -- ewol__gravity.html | 149 -- ewol__key__Special.html | 359 ----- ewol__key__keyboard.html | 149 -- ewol__key__status.html | 149 -- ewol__key__type.html | 149 -- ewol__object__Config.html | 196 --- ewol__object__ConfigElement.html | 207 --- ewol__object__EventExtGen.html | 159 --- ewol__object__Manager.html | 244 ---- ewol__object__Message.html | 213 --- ewol__object__MultiCast.html | 207 --- ewol__object__MultiCast__MessageList.html | 164 --- ewol__openGL__openGlFlags.html | 149 -- ewol__orientation.html | 149 -- ewol__resource__Colored3DObject.html | 238 ---- ewol__resource__ConfigFile.html | 244 ---- ewol__resource__FontBase.html | 234 ---- ewol__resource__FontFreeType.html | 260 ---- ewol__resource__Manager.html | 261 ---- ewol__resource__Program.html | 694 ---------- ewol__resource__Shader.html | 272 ---- ewol__resource__SimpleConfigElement.html | 206 --- ewol__resource__Texture.html | 277 ---- ewol__resource__TextureFile.html | 225 --- ewol__resource__TexturedFont.html | 273 ---- ewol__resource__VirtualBufferObject.html | 354 ----- ewol__resource__progAttributeElement.html | 161 --- ewol__widget__Button.html | 435 ------ ewol__widget__ButtonColor.html | 292 ---- ewol__widget__CheckBox.html | 253 ---- ewol__widget__ColorBar.html | 229 --- ewol__widget__ColorChooser.html | 215 --- ewol__widget__Composer.html | 265 ---- ewol__widget__Container.html | 302 ---- ewol__widget__ContainerN.html | 371 ----- ewol__widget__ContextMenu.html | 276 ---- ewol__widget__Entry.html | 516 ------- ewol__widget__FileChooser.html | 255 ---- ewol__widget__Gird.html | 421 ------ ewol__widget__Gird__GirdProperties.html | 155 --- ewol__widget__Image.html | 361 ----- ewol__widget__Joystick.html | 273 ---- ewol__widget__Label.html | 275 ---- ewol__widget__Layer.html | 201 --- ewol__widget__List.html | 328 ----- ewol__widget__ListFileSystem.html | 315 ----- ewol__widget__Manager.html | 308 ----- ewol__widget__Menu.html | 270 ---- ewol__widget__MenuElement.html | 163 --- ewol__widget__Parameter.html | 241 ---- ewol__widget__ParameterList.html | 289 ---- ewol__widget__PopUp.html | 335 ----- ewol__widget__ProgressBar.html | 254 ---- ewol__widget__Scroll.html | 280 ---- ewol__widget__Sizer.html | 326 ----- ewol__widget__Slider.html | 261 ---- ewol__widget__Spacer.html | 244 ---- ewol__widget__StdPopUp.html | 259 ---- ewol__widget__WSlider.html | 331 ----- ewol__widget__WidgetScrooled.html | 281 ---- ewol__widget__Windows.html | 416 ------ ewol__widget__elementPL.html | 174 --- index.html | 209 ++- library_ewol.html | 133 ++ menu.css | 122 +- namespace_MacOs.html | 142 ++ namespace_ewol.html | 240 ++++ namespace_ewol__audio.html | 133 ++ namespace_ewol__audio__effects.html | 148 ++ namespace_ewol__audio__music.html | 202 +++ namespace_ewol__audio__wav.html | 106 ++ namespace_ewol__compositing.html | 100 ++ namespace_ewol__context.html | 106 ++ namespace_ewol__context__clipBoard.html | 159 +++ namespace_ewol__event.html | 133 ++ namespace_ewol__font.html | 95 ++ namespace_ewol__key.html | 122 ++ namespace_ewol__object.html | 111 ++ namespace_ewol__openGL.html | 264 ++++ namespace_ewol__portAudio.html | 112 ++ namespace_ewol__resource.html | 117 ++ namespace_ewol__widget.html | 100 ++ tutorial_000_Build.html | 207 ++- tutorial_001_HelloWord.html | 205 ++- 223 files changed, 24470 insertions(+), 27110 deletions(-) create mode 100644 class_ewol__Compositing.html create mode 100644 class_ewol__Context.html create mode 100644 class_ewol__Dimension.html create mode 100644 class_ewol__DrawProperty.html create mode 100644 class_ewol__EventShortCut.html create mode 100644 class_ewol__GlyphProperty.html create mode 100644 class_ewol__Kerning.html create mode 100644 class_ewol__Object.html create mode 100644 class_ewol__Resource.html create mode 100644 class_ewol__Widget.html create mode 100644 class_ewol__compositing__Area.html create mode 100644 class_ewol__compositing__Drawing.html create mode 100644 class_ewol__compositing__Image.html create mode 100644 class_ewol__compositing__Shaper.html create mode 100644 class_ewol__compositing__Sprite.html create mode 100644 class_ewol__compositing__Text.html create mode 100644 class_ewol__compositing__TextDecoration.html create mode 100644 class_ewol__context__CommandLine.html create mode 100644 class_ewol__context__ConfigFont.html create mode 100644 class_ewol__context__Fps.html create mode 100644 class_ewol__context__InputLimit.html create mode 100644 class_ewol__context__InputManager.html create mode 100644 class_ewol__context__InputPoperty.html create mode 100644 class_ewol__event__Entry.html create mode 100644 class_ewol__event__EntrySystem.html create mode 100644 class_ewol__event__Input.html create mode 100644 class_ewol__event__InputSystem.html create mode 100644 class_ewol__event__Time.html create mode 100644 class_ewol__key__Special.html create mode 100644 class_ewol__object__Config.html create mode 100644 class_ewol__object__ConfigElement.html create mode 100644 class_ewol__object__EventExtGen.html create mode 100644 class_ewol__object__Manager.html create mode 100644 class_ewol__object__Message.html create mode 100644 class_ewol__object__MultiCast.html create mode 100644 class_ewol__object__MultiCast__MessageList.html create mode 100644 class_ewol__resource__Colored3DObject.html create mode 100644 class_ewol__resource__ConfigFile.html create mode 100644 class_ewol__resource__FontBase.html create mode 100644 class_ewol__resource__FontFreeType.html create mode 100644 class_ewol__resource__Manager.html create mode 100644 class_ewol__resource__Program.html create mode 100644 class_ewol__resource__Shader.html create mode 100644 class_ewol__resource__SimpleConfigElement.html create mode 100644 class_ewol__resource__Texture.html create mode 100644 class_ewol__resource__TextureFile.html create mode 100644 class_ewol__resource__TexturedFont.html create mode 100644 class_ewol__resource__VirtualBufferObject.html create mode 100644 class_ewol__resource__progAttributeElement.html create mode 100644 class_ewol__widget__Button.html create mode 100644 class_ewol__widget__ButtonColor.html create mode 100644 class_ewol__widget__CheckBox.html create mode 100644 class_ewol__widget__ColorBar.html create mode 100644 class_ewol__widget__ColorChooser.html create mode 100644 class_ewol__widget__Composer.html create mode 100644 class_ewol__widget__Container.html create mode 100644 class_ewol__widget__ContainerN.html create mode 100644 class_ewol__widget__ContextMenu.html create mode 100644 class_ewol__widget__Entry.html create mode 100644 class_ewol__widget__FileChooser.html create mode 100644 class_ewol__widget__Gird.html create mode 100644 class_ewol__widget__Gird__GirdProperties.html create mode 100644 class_ewol__widget__Image.html create mode 100644 class_ewol__widget__Joystick.html create mode 100644 class_ewol__widget__Label.html create mode 100644 class_ewol__widget__Layer.html create mode 100644 class_ewol__widget__List.html create mode 100644 class_ewol__widget__ListFileSystem.html create mode 100644 class_ewol__widget__Manager.html create mode 100644 class_ewol__widget__Menu.html create mode 100644 class_ewol__widget__MenuElement.html create mode 100644 class_ewol__widget__Parameter.html create mode 100644 class_ewol__widget__ParameterList.html create mode 100644 class_ewol__widget__PopUp.html create mode 100644 class_ewol__widget__ProgressBar.html create mode 100644 class_ewol__widget__Scroll.html create mode 100644 class_ewol__widget__Sizer.html create mode 100644 class_ewol__widget__Slider.html create mode 100644 class_ewol__widget__Spacer.html create mode 100644 class_ewol__widget__StdPopUp.html create mode 100644 class_ewol__widget__WSlider.html create mode 100644 class_ewol__widget__WidgetScrooled.html create mode 100644 class_ewol__widget__Windows.html create mode 100644 class_ewol__widget__elementPL.html create mode 100644 enum_ewol__Dimension__distance.html create mode 100644 enum_ewol__Widget__annimationMode.html create mode 100644 enum_ewol__compositing__Text__aligneMode.html create mode 100644 enum_ewol__context__clipBoard__clipboardListe.html create mode 100644 enum_ewol__context__cursorDisplay.html create mode 100644 enum_ewol__font__mode.html create mode 100644 enum_ewol__gravity.html create mode 100644 enum_ewol__key__keyboard.html create mode 100644 enum_ewol__key__status.html create mode 100644 enum_ewol__key__type.html create mode 100644 enum_ewol__openGL__openGlFlags.html create mode 100644 enum_ewol__orientation.html create mode 100644 enum_ewol__widget__Button__buttonLock.html create mode 100644 enum_ewol__widget__Composer__composerMode.html create mode 100644 enum_ewol__widget__ContextMenu__markPosition.html create mode 100644 enum_ewol__widget__Joystick__joystickMode.html create mode 100644 enum_ewol__widget__Scroll__highSpeedMode.html create mode 100644 enum_ewol__widget__Sizer__animation.html create mode 100644 enum_ewol__widget__Sizer__displayMode.html create mode 100644 enum_ewol__widget__WSlider__sladingMode.html create mode 100644 enum_ewol__widget__WidgetScrooled__scrollingMode.html create mode 100644 enum_ewol__widget__Windows__popUpMessageType.html delete mode 100644 ewol__Compositing.html delete mode 100644 ewol__Context.html delete mode 100644 ewol__Dimension.html delete mode 100644 ewol__DrawProperty.html delete mode 100644 ewol__EventShortCut.html delete mode 100644 ewol__GlyphProperty.html delete mode 100644 ewol__Kerning.html delete mode 100644 ewol__Object.html delete mode 100644 ewol__Resource.html delete mode 100644 ewol__Widget.html delete mode 100644 ewol__compositing__Area.html delete mode 100644 ewol__compositing__Drawing.html delete mode 100644 ewol__compositing__Image.html delete mode 100644 ewol__compositing__Shaper.html delete mode 100644 ewol__compositing__Sprite.html delete mode 100644 ewol__compositing__Text.html delete mode 100644 ewol__compositing__TextDecoration.html delete mode 100644 ewol__context__CommandLine.html delete mode 100644 ewol__context__ConfigFont.html delete mode 100644 ewol__context__Fps.html delete mode 100644 ewol__context__InputLimit.html delete mode 100644 ewol__context__InputManager.html delete mode 100644 ewol__context__InputPoperty.html delete mode 100644 ewol__context__clipBoard__clipboardListe.html delete mode 100644 ewol__context__cursorDisplay.html delete mode 100644 ewol__event__Entry.html delete mode 100644 ewol__event__EntrySystem.html delete mode 100644 ewol__event__Input.html delete mode 100644 ewol__event__InputSystem.html delete mode 100644 ewol__event__Time.html delete mode 100644 ewol__font__mode.html delete mode 100644 ewol__gravity.html delete mode 100644 ewol__key__Special.html delete mode 100644 ewol__key__keyboard.html delete mode 100644 ewol__key__status.html delete mode 100644 ewol__key__type.html delete mode 100644 ewol__object__Config.html delete mode 100644 ewol__object__ConfigElement.html delete mode 100644 ewol__object__EventExtGen.html delete mode 100644 ewol__object__Manager.html delete mode 100644 ewol__object__Message.html delete mode 100644 ewol__object__MultiCast.html delete mode 100644 ewol__object__MultiCast__MessageList.html delete mode 100644 ewol__openGL__openGlFlags.html delete mode 100644 ewol__orientation.html delete mode 100644 ewol__resource__Colored3DObject.html delete mode 100644 ewol__resource__ConfigFile.html delete mode 100644 ewol__resource__FontBase.html delete mode 100644 ewol__resource__FontFreeType.html delete mode 100644 ewol__resource__Manager.html delete mode 100644 ewol__resource__Program.html delete mode 100644 ewol__resource__Shader.html delete mode 100644 ewol__resource__SimpleConfigElement.html delete mode 100644 ewol__resource__Texture.html delete mode 100644 ewol__resource__TextureFile.html delete mode 100644 ewol__resource__TexturedFont.html delete mode 100644 ewol__resource__VirtualBufferObject.html delete mode 100644 ewol__resource__progAttributeElement.html delete mode 100644 ewol__widget__Button.html delete mode 100644 ewol__widget__ButtonColor.html delete mode 100644 ewol__widget__CheckBox.html delete mode 100644 ewol__widget__ColorBar.html delete mode 100644 ewol__widget__ColorChooser.html delete mode 100644 ewol__widget__Composer.html delete mode 100644 ewol__widget__Container.html delete mode 100644 ewol__widget__ContainerN.html delete mode 100644 ewol__widget__ContextMenu.html delete mode 100644 ewol__widget__Entry.html delete mode 100644 ewol__widget__FileChooser.html delete mode 100644 ewol__widget__Gird.html delete mode 100644 ewol__widget__Gird__GirdProperties.html delete mode 100644 ewol__widget__Image.html delete mode 100644 ewol__widget__Joystick.html delete mode 100644 ewol__widget__Label.html delete mode 100644 ewol__widget__Layer.html delete mode 100644 ewol__widget__List.html delete mode 100644 ewol__widget__ListFileSystem.html delete mode 100644 ewol__widget__Manager.html delete mode 100644 ewol__widget__Menu.html delete mode 100644 ewol__widget__MenuElement.html delete mode 100644 ewol__widget__Parameter.html delete mode 100644 ewol__widget__ParameterList.html delete mode 100644 ewol__widget__PopUp.html delete mode 100644 ewol__widget__ProgressBar.html delete mode 100644 ewol__widget__Scroll.html delete mode 100644 ewol__widget__Sizer.html delete mode 100644 ewol__widget__Slider.html delete mode 100644 ewol__widget__Spacer.html delete mode 100644 ewol__widget__StdPopUp.html delete mode 100644 ewol__widget__WSlider.html delete mode 100644 ewol__widget__WidgetScrooled.html delete mode 100644 ewol__widget__Windows.html delete mode 100644 ewol__widget__elementPL.html create mode 100644 library_ewol.html create mode 100644 namespace_MacOs.html create mode 100644 namespace_ewol.html create mode 100644 namespace_ewol__audio.html create mode 100644 namespace_ewol__audio__effects.html create mode 100644 namespace_ewol__audio__music.html create mode 100644 namespace_ewol__audio__wav.html create mode 100644 namespace_ewol__compositing.html create mode 100644 namespace_ewol__context.html create mode 100644 namespace_ewol__context__clipBoard.html create mode 100644 namespace_ewol__event.html create mode 100644 namespace_ewol__font.html create mode 100644 namespace_ewol__key.html create mode 100644 namespace_ewol__object.html create mode 100644 namespace_ewol__openGL.html create mode 100644 namespace_ewol__portAudio.html create mode 100644 namespace_ewol__resource.html create mode 100644 namespace_ewol__widget.html diff --git a/001_bases.html b/001_bases.html index 6e0e7517..c9ad2c59 100644 --- a/001_bases.html +++ b/001_bases.html @@ -9,133 +9,73 @@
-

ewol Library

- +

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
@@ -157,5 +97,13 @@ I will Explain the main points:
+ diff --git a/base.css b/base.css index 22c4ee25..d350ffec 100644 --- a/base.css +++ b/base.css @@ -55,14 +55,15 @@ body { text-shadow: 0 1px 0 #ce4213; padding: 10px 20px 10px; margin-left: -20px; - //overflow:scroll; - //overflow-x:hidden; + overflow:scroll; + overflow-y:auto; + overflow-x:hidden; } -/* -.navbar ul { - font-size: 15px; -}; -*/ +.navbar-fixed-top a { + text-decoration: none; + color: #000000; +} + h1, h2, h3, h4, h5, h6 { display: block; margin: 10px 0; @@ -95,7 +96,15 @@ pre { border-radius: 4px; } +.enumeration-list td { + padding-left:10px; + padding-right:10px; +} +.parameter-list td { + padding-left:5px; + padding-right:5px; +} .code-function { text-decoration:none; diff --git a/class_ewol__Compositing.html b/class_ewol__Compositing.html new file mode 100644 index 00000000..a2d55c13 --- /dev/null +++ b/class_ewol__Compositing.html @@ -0,0 +1,180 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::Compositing

Description:

+ +

+

Associated Namespace:

+

Constructor and Destructor:

+
++              Compositing   (void );
+ virtual      ~Compositing  (void );
+
+

Synopsis:

+
+#         mat4 m_matrixApply;
+ virtual void draw          (bool _disableDepthTest) = 0;
+ virtual void clear         (void );
+ virtual void resetMatrix   (void );
+ virtual void translate     (const vec3 & _vect);
+ virtual void rotate        (const vec3 & _vect,
                              float _angle);
+ virtual void scale         (const vec3 & _vect);
+ virtual void setMatrix     (const mat4 & _mat);
+
+

Object Hierarchy:

+
+ewol::Compositing
  +--> ewol::compositing::Drawing
  +--> ewol::compositing::Area
  +--> ewol::compositing::Shaper
  +--> ewol::compositing::Image
  +--> ewol::compositing::Text
+

Detail:

+

m_matrixApply

+# mat4 m_matrixApply;
+ +
+
+
+

Compositing

++  Compositing (void );
+generic constructor
+
+
+

~Compositing

++ virtual  ~Compositing (void );
+Generic destructor
+
+
+

draw

++ virtual void draw (bool _disableDepthTest) = 0;
+Virtal pure function that request the draw of all openGl elements
+
+
+

clear

++ virtual void clear (void );
+clear alll tre registered element in the current element
+
+
+

resetMatrix

++ virtual void resetMatrix (void );
+reset to the eye matrix the openGL mouving system
+
+
+

translate

++ virtual void translate (const vec3 & _vect);
+translate the current display of this element
    + + +
    Parameter [input]:_vect The translation vector to apply at the transformation matrix
    +
+ +
+
+

rotate

++ virtual void rotate (const vec3 & _vect,
                       float _angle);
+rotate the curent display of this element
    + + +
    Parameter [input]:_vect The rotation vector to apply at the transformation matrix
    +
+ +
+
+

scale

++ virtual void scale (const vec3 & _vect);
+scale the current diaplsy of this element
    + + +
    Parameter [input]:_vect The scaling vector to apply at the transformation matrix
    +
+ +
+
+

setMatrix

++ virtual void setMatrix (const mat4 & _mat);
+set the transformation matrix
    + + +
    Parameter [input]:_mat The new matrix.
    +
+ +
+
+
+ + + diff --git a/class_ewol__Context.html b/class_ewol__Context.html new file mode 100644 index 00000000..8abbd550 --- /dev/null +++ b/class_ewol__Context.html @@ -0,0 +1,485 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::Context

Description:

+ +

+

Associated Namespace:

+

Constructor and Destructor:

+
++                                          Context                   (int32_t _argc,
                                                                      const char* _argv);
+ virtual                                  ~Context                  (void );
+
+

Synopsis:

+
++         ewol::context::CommandLine &     getCmd                    (void );
+         ewol::context::ConfigFont &      getFontDefault            (void );
+         ewol::widget::Manager &          getWidgetManager          (void );
+         ewol::object::Manager &          getEObjectManager         (void );
+         ewol::resource::Manager &        getResourcesManager       (void );
#         void                             lockContext               (void );
#         void                             unLockContext             (void );
+ virtual void                             setArchiveDir             (int _mode,
                                                                      const char* _str);
+ virtual void                             OS_SetInputMotion         (int _pointerID,
                                                                      const vec2 & _pos);
+ virtual void                             OS_SetInputState          (int _pointerID,
                                                                      bool _isDown,
                                                                      const vec2 & _pos);
+ virtual void                             OS_SetMouseMotion         (int _pointerID,
                                                                      const vec2 & _pos);
+ virtual void                             OS_SetMouseState          (int _pointerID,
                                                                      bool _isDown,
                                                                      const vec2 & _pos);
+ virtual void                             OS_SetKeyboard            (ewol::key::Special & _special,
                                                                      char32_t _myChar,
                                                                      bool _isDown,
                                                                      bool _isARepeateKey);
+ virtual void                             OS_SetKeyboardMove        (ewol::key::Special & _special,
                                                                      enum ewol::key::keyboard _move,
                                                                      bool _isDown,
                                                                      bool _isARepeateKey);
+ virtual void                             OS_Suspend                (void );
+ virtual void                             OS_Resume                 (void );
+         void                             requestUpdateSize         (void );
+         bool                             OS_Draw                   (bool _displayEveryTime);
+         void                             onObjectRemove            (ewol::Object* _removeObject);
+         void                             resetIOEvent              (void );
+         void                             OS_OpenGlContextDestroy   (void );
+         void                             OS_Stop                   (void );
+ virtual void                             stop                      (void );
+         void                             setWindows                (ewol::widget::Windows* _windows);
+         ewol::widget::Windows*           getWindows                (void );
+         const vec2 &                     getSize                   (void );
+ virtual void                             OS_Resize                 (const vec2 & _size);
+ virtual void                             setSize                   (const vec2 & _size);
+         void                             OS_Move                   (const vec2 & _pos);
+ virtual void                             setPos                    (const vec2 & _pos);
+         void                             OS_Hide                   (void );
+ virtual void                             hide                      (void );
+         void                             OS_Show                   (void );
+ virtual void                             show                      (void );
+         void                             forceRedrawAll            (void );
+         void                             inputEventTransfertWidget (ewol::Widget* _source,
                                                                      ewol::Widget* _destination);
+         void                             inputEventGrabPointer     (ewol::Widget* _widget);
+         void                             inputEventUnGrabPointer   (void );
+ virtual void                             keyboardShow              (void );
+ virtual void                             keyboardHide              (void );
+ virtual void                             clipBoardGet              (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+ virtual void                             clipBoardSet              (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+         void                             OS_ClipBoardArrive        (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+ virtual void                             setTitle                  (const std::string & _title);
+ virtual void                             forceOrientation          (enum ewol::orientation _orientation);
+ virtual void                             grabPointerEvents         (bool _isGrabbed,
                                                                      const vec2 & _forcedPosition);
+ virtual void                             setCursor                 (enum ewol::context::cursorDisplay _newCursor);
+ virtual void                             setIcon                   (const std::string & _inputFile);
+         int64_t                          getTime                   (void );
+         int                              main                      (int _argc,
                                                                      const char* _argv);
+
+

Detail:

+

getCmd

++ ewol::context::CommandLine & getCmd (void );
+ +
+
+
+

getFontDefault

++ ewol::context::ConfigFont & getFontDefault (void );
+ +
+
+
+

getWidgetManager

++ ewol::widget::Manager & getWidgetManager (void );
+ +
+
+
+

getEObjectManager

++ ewol::object::Manager & getEObjectManager (void );
+ +
+
+
+

getResourcesManager

++ ewol::resource::Manager & getResourcesManager (void );
+ +
+
+
+

Context

++  Context (int32_t _argc,
            const char* _argv);
+ +
+
+
+

~Context

++ virtual  ~Context (void );
+ +
+
+
+

lockContext

+# void lockContext (void );
+set the curent interface.
Note: this lock the main mutex
+
+
+

unLockContext

+# void unLockContext (void );
+set the curent interface at NULL.
Note: this un-lock the main mutex
+
+
+

setArchiveDir

++ virtual void setArchiveDir (int _mode,
                              const char* _str);
+ +
+
+
+

OS_SetInputMotion

++ virtual void OS_SetInputMotion (int _pointerID,
                                  const vec2 & _pos);
+ +
+
+
+

OS_SetInputState

++ virtual void OS_SetInputState (int _pointerID,
                                 bool _isDown,
                                 const vec2 & _pos);
+ +
+
+
+

OS_SetMouseMotion

++ virtual void OS_SetMouseMotion (int _pointerID,
                                  const vec2 & _pos);
+ +
+
+
+

OS_SetMouseState

++ virtual void OS_SetMouseState (int _pointerID,
                                 bool _isDown,
                                 const vec2 & _pos);
+ +
+
+
+

OS_SetKeyboard

++ virtual void OS_SetKeyboard (ewol::key::Special & _special,
                               char32_t _myChar,
                               bool _isDown,
                               bool _isARepeateKey);
+ +
+
+
+

OS_SetKeyboardMove

++ virtual void OS_SetKeyboardMove (ewol::key::Special & _special,
                                   enum ewol::key::keyboard _move,
                                   bool _isDown,
                                   bool _isARepeateKey);
+ +
+
+
+

OS_Suspend

++ virtual void OS_Suspend (void );
+The current context is suspended
+
+
+

OS_Resume

++ virtual void OS_Resume (void );
+The current context is resumed
+
+
+

requestUpdateSize

++ void requestUpdateSize (void );
+ +
+
+
+

OS_Draw

++ bool OS_Draw (bool _displayEveryTime);
+ +
+
+
+

onObjectRemove

++ void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

resetIOEvent

++ void resetIOEvent (void );
+reset event management for the IO like Input ou Mouse or keyborad
+
+
+

OS_OpenGlContextDestroy

++ void OS_OpenGlContextDestroy (void );
+The OS inform that the openGL constext has been destroy == > use to automaticly reload the texture and other thinks ...
+
+
+

OS_Stop

++ void OS_Stop (void );
+The OS Inform that the Window has been killed
+
+
+

stop

++ virtual void stop (void );
+The application request that the Window will be killed
+
+
+

setWindows

++ void setWindows (ewol::widget::Windows* _windows);
+set the current windows to display :
+ +
+
+

getWindows

++ ewol::widget::Windows* getWindows (void );
+get the current windows that is displayed
+ +
+
+

getSize

++ const vec2 & getSize (void );
+get the current windows size
    + +
    Return: the current size ...
    +
+ +
+
+

OS_Resize

++ virtual void OS_Resize (const vec2 & _size);
+The OS inform that the current windows has change his size.
    + + +
    Parameter [input]:_size new size of the windows.
    +
+ +
+
+

setSize

++ virtual void setSize (const vec2 & _size);
+The application request a change of his curent size.
    + + +
    Parameter [input]:_size new Requested size of the windows.
    +
+ +
+
+

OS_Move

++ void OS_Move (const vec2 & _pos);
+The OS inform that the current windows has change his position.
    + + +
    Parameter [input]:_pos New position of the Windows.
    +
+ +
+
+

setPos

++ virtual void setPos (const vec2 & _pos);
+The Application request that the current windows will change his position.
    + + +
    Parameter [input]:_pos New position of the Windows requested.
    +
+ +
+
+

OS_Hide

++ void OS_Hide (void );
+The OS inform that the Windows is now Hidden.
+
+
+

hide

++ virtual void hide (void );
+The Application request that the Windows will be Hidden.
+
+
+

OS_Show

++ void OS_Show (void );
+The OS inform that the Windows is now visible.
+
+
+

show

++ virtual void show (void );
+The Application request that the Windows will be visible.
+
+
+

forceRedrawAll

++ void forceRedrawAll (void );
+Redraw all the windows
+
+
+

inputEventTransfertWidget

++ void inputEventTransfertWidget (ewol::Widget* _source,
                                  ewol::Widget* _destination);
+This is to transfert the event from one widget to another one
+ +
+
+

inputEventGrabPointer

++ void inputEventGrabPointer (ewol::Widget* _widget);
+This fonction lock the pointer properties to move in relative instead of absolute
+ +
+
+

inputEventUnGrabPointer

++ void inputEventUnGrabPointer (void );
+This fonction un-lock the pointer properties to move in relative instead of absolute
+
+
+

keyboardShow

++ virtual void keyboardShow (void );
+display the virtal keyboard (for touch system only)
+
+
+

keyboardHide

++ virtual void keyboardHide (void );
+Hide the virtal keyboard (for touch system only)
+
+
+

clipBoardGet

++ virtual void clipBoardGet (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+Inform the Gui that we want to have a copy of the clipboard
+ +
+
+

clipBoardSet

++ virtual void clipBoardSet (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+Inform the Gui that we are the new owner of the clipboard
+ +
+
+

OS_ClipBoardArrive

++ void OS_ClipBoardArrive (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+Call by the OS when a clipboard arrive to US (previously requested by a widget)
+ +
+
+

setTitle

++ virtual void setTitle (const std::string & _title);
+set the new title of the windows
+ +
+
+

forceOrientation

++ virtual void forceOrientation (enum ewol::orientation _orientation);
+force the screen orientation (availlable on portable elements ...
+ +
+
+

grabPointerEvents

++ virtual void grabPointerEvents (bool _isGrabbed,
                                  const vec2 & _forcedPosition);
+get all the event from the X system
    + + + +
    Parameter [input]:_isGrabbed "true" if all the event will be get, false if we want only ours.
    Parameter [input]:_forcedPosition the position where the mouse might be reset at every events ...
    +
+ +
+
+

setCursor

++ virtual void setCursor (enum ewol::context::cursorDisplay _newCursor);
+set the cursor display type.
+ +
+
+

setIcon

++ virtual void setIcon (const std::string & _inputFile);
+set the Icon of the program
+ +
+
+

getTime

++ int64_t getTime (void );
+get the curent time in micro-second
Note: : must be implemented in all system OS implementation
    + +
    Return: The curent time of the process
    +
+ +
+
+

main

++ int main (int _argc,
            const char* _argv);
+This is the only one things the User might done in his main();
Note: : must be implemented in all system OPS implementation
Note: To answare you before you ask the question, this is really simple: + Due to the fect that the current system is multiple-platform, you "main" + Does not exist in the android platform, then ewol call other start + and stop function, to permit to have only one code
Note: The main can not be in the ewol, due to the fact thet is an librairy
    + + + +
    Parameter [input]:_argc Standard argc
    Parameter [input]:_argv Standard argv
    Return: normal error int for the application error management
    +
+ +
+
+
+ + + diff --git a/class_ewol__Dimension.html b/class_ewol__Dimension.html new file mode 100644 index 00000000..9bdb84f3 --- /dev/null +++ b/class_ewol__Dimension.html @@ -0,0 +1,324 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::Dimension

Description:

+in the dimention class we store the data as the more usefull unit (pixel) +but one case need to be dynamic the %, then when requested in % the register the % value

+

enum:

+ +

Constructor and Destructor:

+
++                   Dimension            (void );
+                   Dimension            (const vec2 & _size,
                                          enum ewol::Dimension::distance _type);
+                   Dimension            (const std::string & _config);
+                   Dimension            (const char* _config);
+                   ~Dimension           (void );
+
+

Synopsis:

+
++                   operator std::string (void ) const;
+ vec2              get                  (enum distance _type) const;
+ void              set                  (const vec2 & _size,
                                          enum distance _type);
+ vec2              getPixel             (void ) const;
+ vec2              getPourcent          (void ) const;
+ vec2              getMeter             (void ) const;
+ vec2              getCentimeter        (void ) const;
+ vec2              getMillimeter        (void ) const;
+ vec2              getKilometer         (void ) const;
+ vec2              getInch              (void ) const;
+ vec2              getFoot              (void ) const;
+ const Dimension & operator =           (const Dimension & _obj);
+ bool              operator ==          (const Dimension & _obj) const;
+ bool              operator !=          (const Dimension & _obj) const;
+ enum distance     getType              (void ) const;
+ void              init                 (void );
+ void              unInit               (void );
+ void              setPixelRatio        (const vec2 & _ratio,
                                          enum ewol::Dimension::distance _type);
+ void              setPixelWindowsSize  (const vec2 & _size);
+ vec2              getWindowsSize       (enum ewol::Dimension::distance _type);
+ float             getWindowsDiag       (enum ewol::Dimension::distance _type);
+
+

Detail:

+

Dimension

++  Dimension (void );
+Constructor (default :0,0 mode pixel)
+
+
+

Dimension

++  Dimension (const vec2 & _size,
              enum ewol::Dimension::distance _type);
+Constructor
+ +
+
+

Dimension

++  Dimension (const std::string & _config);
+Constructor
+ +
+
+

Dimension

++  Dimension (const char* _config);
+Constructor
    + + +
    Parameter [input]:_config dimension configuration.
    +
+ +
+
+

~Dimension

++  ~Dimension (void );
+Destructor
+
+
+

operator std::string

++  operator std::string (void ) const;
+string cast :
+
+
+

get

++ vec2 get (enum distance _type) const;
+get the current dimention in requested type
    + + +
    Parameter [input]:_type Type of unit requested.
    Return: dimention requested.
    +
+ +
+
+

set

++ void set (const vec2 & _size,
            enum distance _type);
+set the current dimention in requested type
    + + + +
    Parameter [input]:_size Dimention to set
    Parameter [input]:_type Type of unit requested.
    +
+ +
+
+

getPixel

++ vec2 getPixel (void ) const;
+get the current dimention in pixel
    + +
    Return: dimention in Pixel
    +
+ +
+
+

getPourcent

++ vec2 getPourcent (void ) const;
+get the current dimention in Pourcent
    + +
    Return: dimention in Pourcent
    +
+ +
+
+

getMeter

++ vec2 getMeter (void ) const;
+get the current dimention in Meter
    + +
    Return: dimention in Meter
    +
+ +
+
+

getCentimeter

++ vec2 getCentimeter (void ) const;
+get the current dimention in Centimeter
    + +
    Return: dimention in Centimeter
    +
+ +
+
+

getMillimeter

++ vec2 getMillimeter (void ) const;
+get the current dimention in Millimeter
    + +
    Return: dimention in Millimeter
    +
+ +
+
+

getKilometer

++ vec2 getKilometer (void ) const;
+get the current dimention in Kilometer
    + +
    Return: dimention in Kilometer
    +
+ +
+
+

getInch

++ vec2 getInch (void ) const;
+get the current dimention in Inch
    + +
    Return: dimention in Inch
    +
+ +
+
+

getFoot

++ vec2 getFoot (void ) const;
+get the current dimention in Foot
    + +
    Return: dimention in Foot
    +
+ +
+
+

operator =

++ const Dimension & operator = (const Dimension & _obj);
+ += assigment
+
+
+

operator ==

++ bool operator == (const Dimension & _obj) const;
+ +== operator
+
+
+

operator !=

++ bool operator != (const Dimension & _obj) const;
+ +!= operator
+
+
+

getType

++ enum distance getType (void ) const;
+
    + +
    Return: the type
    +
+ +
+
+

init

++ void init (void );
+basic init
+
+
+

unInit

++ void unInit (void );
+basic un-init
+
+
+

setPixelRatio

++ void setPixelRatio (const vec2 & _ratio,
                      enum ewol::Dimension::distance _type);
+set the Milimeter ratio for calculation
+ +
+
+

setPixelWindowsSize

++ void setPixelWindowsSize (const vec2 & _size);
+set the current Windows size
    + + +
    Parameter [input]:size size of the current windows in pixel.
    +
+ +
+
+

getWindowsSize

++ vec2 getWindowsSize (enum ewol::Dimension::distance _type);
+get the Windows size in the request unit
+ +
+
+

getWindowsDiag

++ float getWindowsDiag (enum ewol::Dimension::distance _type);
+get the Windows diagonal size in the request unit
+ +
+
+
+ + + diff --git a/class_ewol__DrawProperty.html b/class_ewol__DrawProperty.html new file mode 100644 index 00000000..eb038c7f --- /dev/null +++ b/class_ewol__DrawProperty.html @@ -0,0 +1,121 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::DrawProperty

Synopsis:

+
++ ivec2 m_windowsSize;
+ ivec2 m_origin;
+ ivec2 m_size;
+ void  limit         (const vec2 & _origin,
                       const vec2 & _size);
+
+

Detail:

+

m_windowsSize

++ ivec2 m_windowsSize;
+ +Windows compleate size
+
+
+

m_origin

++ ivec2 m_origin;
+ +Windows clipping upper widget (can not be <0)
+
+
+

m_size

++ ivec2 m_size;
+ +Windows clipping upper widget (can not be <0 and >m_windowsSize)
+
+
+

limit

++ void limit (const vec2 & _origin,
              const vec2 & _size);
+ +
+
+
+
+ + + diff --git a/class_ewol__EventShortCut.html b/class_ewol__EventShortCut.html new file mode 100644 index 00000000..d294c37d --- /dev/null +++ b/class_ewol__EventShortCut.html @@ -0,0 +1,144 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::EventShortCut

Constructor and Destructor:

+
++                    EventShortCut   (void );
+                    ~EventShortCut  (void );
+
+

Synopsis:

+
++ bool               broadcastEvent;
+ const char*        generateEventId;
+ std::string        eventData;
+ ewol::key::Special specialKey;
+ char32_t           unicodeValue;
+
+

Detail:

+

broadcastEvent

++ bool broadcastEvent;
+ +if it is true, then the message is sent to all the system
+
+
+

generateEventId

++ const char* generateEventId;
+ +Local generated event
+
+
+

eventData

++ std::string eventData;
+ +data link with the event
+
+
+

specialKey

++ ewol::key::Special specialKey;
+ +special board key
+
+
+

unicodeValue

++ char32_t unicodeValue;
+ +0 if not used +ewol::EVENT_KB_MOVE_TYPE_NONE if not used
+
+
+

EventShortCut

++  EventShortCut (void );
+ +
+
+
+

~EventShortCut

++  ~EventShortCut (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__GlyphProperty.html b/class_ewol__GlyphProperty.html new file mode 100644 index 00000000..05d08263 --- /dev/null +++ b/class_ewol__GlyphProperty.html @@ -0,0 +1,181 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::GlyphProperty

Constructor and Destructor:

+
++                            GlyphProperty     (void );
+
+

Synopsis:

+
++ char32_t                   m_UVal;
+ int32_t                    m_glyphIndex;
+ ivec2                      m_sizeTexture;
+ ivec2                      m_bearing;
+ ivec2                      m_advance;
+ vec2                       m_texturePosStart;
+ vec2                       m_texturePosSize;
+ float                      kerningGet        (const char32_t _charcode);
+ void                       kerningAdd        (const char32_t _charcode,
                                                float _value);
+ void                       kerningClear      (void );
+ bool                       exist             (void ) const;
+ void                       setNotExist       (void );
+
+

Detail:

+

m_UVal

++ char32_t m_UVal;
+ +Unicode value
+
+
+

m_glyphIndex

++ int32_t m_glyphIndex;
+ +Glyph index in the system
+
+
+

m_sizeTexture

++ ivec2 m_sizeTexture;
+ +size of the element to display
+
+
+

m_bearing

++ ivec2 m_bearing;
+ +offset to display the data (can be negatif id the texture sise is bigger than the theoric places in the string)
+
+
+

m_advance

++ ivec2 m_advance;
+ +space use in the display for this specific char
+
+
+

m_texturePosStart

++ vec2 m_texturePosStart;
+ +Texture normalised position (START)
+
+
+

m_texturePosSize

++ vec2 m_texturePosSize;
+ +Texture normalised position (SIZE)
+
+
+

GlyphProperty

++  GlyphProperty (void );
+ +
+
+
+

kerningGet

++ float kerningGet (const char32_t _charcode);
+ +
+
+
+

kerningAdd

++ void kerningAdd (const char32_t _charcode,
                   float _value);
+ +
+
+
+

kerningClear

++ void kerningClear (void );
+ +
+
+
+

exist

++ bool exist (void ) const;
+get the status of the char, if it exist or not in the FONT
    + +
    Return: true if the char is availlable, false otherwise
    +
+ +
+
+

setNotExist

++ void setNotExist (void );
+set the element doen not exist !!!
+
+
+
+ + + diff --git a/class_ewol__Kerning.html b/class_ewol__Kerning.html new file mode 100644 index 00000000..f9837e20 --- /dev/null +++ b/class_ewol__Kerning.html @@ -0,0 +1,160 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::Kerning

Description:

+Kerning properties of one specific Glyph with an other
+Without Kerning : +
+
+                                    
+       \          /      /\         
+        \        /      /  \        
+         \      /      /    \       
+          \    /      /
           \  /      /        \     
+            \/      /          \    
+       v          v a          a    
+

+With Kerning : +
+
+                                    
+       \          /  /\             
+        \        /  /  \            
+         \      /  /    \           
+          \    /  /
           \  /  /        \         
+            \/  /          \        
+       v        a v        a        
+
+
Note: The "Kerning" is the methode to provide a better display for some string like + the "VA" has 2 letter that overlap themself. This name Kerning

+

Constructor and Destructor:

+
++          Kerning  (void );
+          Kerning  (const char32_t _charcode,
                     const float _value);
+          ~Kerning (void );
+
+

Synopsis:

+
++ char32_t m_UVal;
+ float    m_value;
+
+

Detail:

+

m_UVal

++ char32_t m_UVal;
+ +unicode value (the previous character that must be before)
+
+
+

m_value

++ float m_value;
+ +kerning real offset
+
+
+

Kerning

++  Kerning (void );
+Simple constructor that allow to allocate the std::vector element
+
+
+

Kerning

++  Kerning (const char32_t _charcode,
            const float _value);
+Normal constructor
    + + + +
    Parameter [input]:_charcode The Unicode value of the coresponding character that might be before
    Parameter [input]:_value The Kerning value of the offset (nb pixel number)
    +
+ +
+
+

~Kerning

++  ~Kerning (void );
+normal destructor
+
+
+
+ + + diff --git a/class_ewol__Object.html b/class_ewol__Object.html new file mode 100644 index 00000000..e50108a5 --- /dev/null +++ b/class_ewol__Object.html @@ -0,0 +1,473 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::Object

Description:

+Basic message classes for ewol system +this class mermit at every Object to communicate between them.

+

Associated Namespace:

+

Constructor and Destructor:

+
++                                                          Object              (void );
+                                                          Object              (const std::string & _name);
+ virtual                                                  ~Object             (void );
+
+

Synopsis:

+
++         const char* const                                configName;
#         void                                             autoDestroy         (void );
+         void                                             removeObject        (void );
+         const char* const                                getObjectType       (void );
+         std::string                                      getTypeDescription  (void );
+         bool                                             isTypeCompatible    (const std::string & _type);
#         void                                             addObjectType       (const char* _type);
#         bool                                             m_static;
+         bool                                             getStatic           (void );
+         int32_t                                          getId               (void );
#         void                                             addEventId          (const char* _generateEventId);
#         void                                             generateEventId     (const char* _generateEventId,
                                                                                const std::string & _data);
#         void                                             sendMultiCast       (const char* const _messageId,
                                                                                const std::string & _data);
#         void                                             registerMultiCast   (const char* const _messageId);
+         void                                             registerOnEvent     (ewol::Object* _destinationObject,
                                                                                const char* _eventId,
                                                                                const char* _eventIdgenerated,
                                                                                const std::string & _overloadData);
+         void                                             unRegisterOnEvent   (ewol::Object* _destinationObject,
                                                                                const char* _eventId);
+ virtual void                                             onObjectRemove      (ewol::Object* _removeObject);
+ virtual void                                             onReceiveMessage    (const ewol::object::Message & _msg);
#         void                                             registerConfig      (const char* _config,
                                                                                const char* _type,
                                                                                const char* _control,
                                                                                const char* _description,
                                                                                const char* _default);
# virtual bool                                             onSetConfig         (const ewol::object::Config & _conf);
# virtual bool                                             onGetConfig         (const char* _config,
                                                                                std::string & _result) const;
+ virtual const std::vector<ewol::object::ConfigElement> & getConfigList       (void );
+         bool                                             setConfig           (const ewol::object::Config & _conf);
+         bool                                             setConfig           (const std::string & _config,
                                                                                const std::string & _value);
+         bool                                             setConfigNamed      (const std::string & _objectName,
                                                                                const std::string & _config,
                                                                                const std::string & _value);
+         bool                                             setConfigNamed      (const std::string & _objectName,
                                                                                const ewol::object::Config & _conf);
+         std::string                                      getConfig           (const char* _config) const;
+         std::string                                      getConfig           (const std::string & _config) const;
#         std::string                                      m_name;
+         const std::string &                              getName             (void ) const;
+         void                                             setName             (const std::string & _name);
+ virtual bool                                             loadXML             (exml::Element* _node);
+ virtual bool                                             storeXML            (exml::Element* _node) const;
+         ewol::object::Manager &                          getObjectManager    (void );
+         ewol::object::MultiCast &                        getMultiCast        (void );
+         ewol::Context &                                  getContext          (void );
+         void                                             setStatusResource   (bool _val);
+         bool                                             getStatusResource   (void );
+
+

Object Hierarchy:

+
+ewol::Object
  +--> ewol::Widget
  +--> ewol::Resource
+

Detail:

+

configName

++ const char* const configName;
+ +
+
+
+

Object

++  Object (void );
+Constructor.
+
+
+

Object

++  Object (const std::string & _name);
+Constructor.
+ +
+
+

~Object

++ virtual  ~Object (void );
+Destructor
+
+
+

autoDestroy

+# void autoDestroy (void );
+Auto-destroy the object
+
+
+

removeObject

++ void removeObject (void );
+Asynchronous removing the object
+
+
+

getObjectType

++ const char* const getObjectType (void );
+get the current Object type of the Object
    + +
    Return: the last type name of the element
    +
+ +
+
+

getTypeDescription

++ std::string getTypeDescription (void );
+Get the herarchie of the Object type.
+ +
+
+

isTypeCompatible

++ bool isTypeCompatible (const std::string & _type);
+check if the element herited from a specific type
+ +
+
+

addObjectType

+# void addObjectType (const char* _type);
+Add a type of the list of Object.
    + + +
    Parameter [input]:_type new type to add.
    +
+ +
+
+

m_static

+# bool m_static;
+ +set this variable at true if this element must not be auto destroy (exemple : use static object)
+
+
+

getStatic

++ bool getStatic (void );
+get the static status of the Object == > mark at true if the user set the object mark as static allocated element ==> not auto remove element
    + +
    Return: true if it might not be removed == > usefull for conficuration class
    +
+ +
+
+

getId

++ int32_t getId (void );
+get the UniqueId of the Object
    + +
    Return: the requested ID
    +
+ +
+
+

addEventId

+# void addEventId (const char* _generateEventId);
+add a specific event Id in the list to prevent wrong link on a Object
    + + +
    Parameter [input]:_generateEventId event Id to add
    +
+ +
+
+

generateEventId

+# void generateEventId (const char* _generateEventId,
                        const std::string & _data);
+generate event on all registered Object
+ +
+
+

sendMultiCast

+# void sendMultiCast (const char* const _messageId,
                      const std::string & _data);
+generate Multicast event on all Object requested the event
+ +
+
+

registerMultiCast

+# void registerMultiCast (const char* const _messageId);
+Register of the arrival of a Multicast message
    + + +
    Parameter [input]:_messageId Event Id waiting for...
    +
+ +
+
+

registerOnEvent

++ void registerOnEvent (ewol::Object* _destinationObject,
                        const char* _eventId,
                        const char* _eventIdgenerated,
                        const std::string & _overloadData);
+Register an Object over an other to get event on the second...
+ +
+
+

unRegisterOnEvent

++ void unRegisterOnEvent (ewol::Object* _destinationObject,
                          const char* _eventId);
+Un-Register an Object over an other.
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+

registerConfig

+# void registerConfig (const char* _config,
                       const char* _type,
                       const char* _control,
                       const char* _description,
                       const char* _default);
+the Object add a configuration capabilities
    + + + + + + +
    Parameter [input]:_config Configuration name.
    Parameter [input]:_type Type of the config.
    Parameter [input]:_control control of the current type.
    Parameter [input]:_description Descritpion on the current type.
    Parameter [input]:_default Default value of this parameter.
    +
+ +
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+

getConfigList

++ virtual const std::vector<ewol::object::ConfigElement> & getConfigList (void );
+get all the configuration list
+ +
+
+

setConfig

++ bool setConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object (systrem mode)
+ +
+
+

setConfig

++ bool setConfig (const std::string & _config,
                  const std::string & _value);
+ +
+
+
+

setConfigNamed

++ bool setConfigNamed (const std::string & _objectName,
                       const std::string & _config,
                       const std::string & _value);
+ +
+
+
+

setConfigNamed

++ bool setConfigNamed (const std::string & _objectName,
                       const ewol::object::Config & _conf);
+ +
+
+
+

getConfig

++ std::string getConfig (const char* _config) const;
+Configuration get from the curent Object (systrem mode)
+ +
+
+

getConfig

++ std::string getConfig (const std::string & _config) const;
+ +
+
+
+

m_name

+# std::string m_name;
+ +name of the element ...
+
+
+

getName

++ const std::string & getName (void ) const;
+get the Object name
+ +
+
+

setName

++ void setName (const std::string & _name);
+get the Widget name
+ +
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+

storeXML

++ virtual bool storeXML (exml::Element* _node) const;
+store properties in this XML node.
+ +
+
+

getObjectManager

++ ewol::object::Manager & getObjectManager (void );
+ + +
+
+

getMultiCast

++ ewol::object::MultiCast & getMultiCast (void );
+ + +
+
+

getContext

++ ewol::Context & getContext (void );
+get the curent the system inteface.
+ +
+
+

setStatusResource

++ void setStatusResource (bool _val);
+Declare this element as a resource (or singleton) this mean the element will +not be auto Remove at the end of the programm. It just notify that it is not removed.
    + + +
    Parameter [input]:_val Value of the type of the element.
    +
+ +
+
+

getStatusResource

++ bool getStatusResource (void );
+Get the resource status of the element.
    + +
    Return: the resource status.
    +
+ +
+
+
+ + + diff --git a/class_ewol__Resource.html b/class_ewol__Resource.html new file mode 100644 index 00000000..6ffb8ca9 --- /dev/null +++ b/class_ewol__Resource.html @@ -0,0 +1,187 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::Resource

Description:

+ +

+

Associated Namespace:

+

Constructor and Destructor:

+
++                                   Resource            (void );
+                                   Resource            (const std::string & _name);
+ virtual                           ~Resource           (void );
+
+

Synopsis:

+
++         void                      increment           (void );
+         bool                      decrement           (void );
+         int32_t                   getCounter          (void );
#         uint8_t                   m_resourceLevel;
+         uint8_t                   getResourceLevel    (void );
+ virtual void                      updateContext       (void );
+ virtual void                      removeContext       (void );
+ virtual void                      removeContextToLate (void );
+ virtual void                      reload              (void );
+         ewol::resource::Manager & getManager          (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> ewol::Resource
         +--> ewol::resource::Colored3DObject
         +--> ewol::resource::Program
         +--> ewol::resource::Texture
         +--> ewol::resource::Shader
         +--> ewol::resource::ConfigFile
         +--> ewol::resource::VirtualBufferObject
         +--> ewol::resource::FontBase
         +--> ege::resource::Mesh
+

Detail:

+

Resource

++  Resource (void );
+ +
+
+
+

Resource

++  Resource (const std::string & _name);
+ +
+
+
+

~Resource

++ virtual  ~Resource (void );
+ +
+
+
+

increment

++ void increment (void );
+ +
+
+
+

decrement

++ bool decrement (void );
+ +
+
+
+

getCounter

++ int32_t getCounter (void );
+ +
+
+
+

m_resourceLevel

+# uint8_t m_resourceLevel;
+ +Level of the resource ==> for updata priority [0..5] 0 must be update first.
+
+
+

getResourceLevel

++ uint8_t getResourceLevel (void );
+ +
+
+
+

updateContext

++ virtual void updateContext (void );
+ +
+
+
+

removeContext

++ virtual void removeContext (void );
+ +
+
+
+

removeContextToLate

++ virtual void removeContextToLate (void );
+ +
+
+
+

reload

++ virtual void reload (void );
+ +
+
+
+

getManager

++ ewol::resource::Manager & getManager (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__Widget.html b/class_ewol__Widget.html new file mode 100644 index 00000000..442d195e --- /dev/null +++ b/class_ewol__Widget.html @@ -0,0 +1,1054 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::Widget

Description:

+Widget class is the main widget interface, it hase some generic properties: +:INDENT: Receive Event (keyboard / mouse / ...)

+

Associated Namespace:

+

enum:

+ +

Constructor and Destructor:

+
++                                           Widget                      (void );
+ virtual                                   ~Widget                     (void );
+
+

Synopsis:

+
++         const char* const                 configFill;
+         const char* const                 configExpand;
+         const char* const                 configHide;
+         const char* const                 configFocus;
+         const char* const                 configMinSize;
+         const char* const                 configMaxSize;
+         const char* const                 configGravity;
#         ewol::Widget*                     m_up;
+         void                              setUpperWidget              (ewol::Widget* _upper);
+         void                              removeUpperWidget           (void );
+         ewol::Widget*                     getUpperWidget              (void );
#         vec2                              m_size;
#         vec2                              m_minSize;
#         vec2                              m_maxSize;
+ virtual vec2                              relativePosition            (const vec2 & _pos);
+ virtual void                              calculateSize               (const vec2 & _available);
+ virtual vec2                              getSize                     (void );
+ virtual void                              calculateMinMaxSize         (void );
+ virtual vec2                              getCalculateMinSize         (void );
+ virtual vec2                              getCalculateMaxSize         (void );
#         vec2                              m_offset;
+ virtual void                              setOffset                   (const vec2 & _newVal);
+ virtual const vec2 &                      getOffset                   (void );
#         float                             m_zoom;
+ virtual void                              setZoom                     (float _newVal);
+ virtual float                             getZoom                     (void );
#         vec2                              m_origin;
+ virtual void                              setOrigin                   (const vec2 & _pos);
+ virtual vec2                              getOrigin                   (void );
#         ewol::Dimension                   m_userMinSize;
+         void                              setMinSize                  (const ewol::Dimension & _size);
+         void                              setNoMinSize                (void );
+         const ewol::Dimension &           getMinSize                  (void );
+ virtual void                              checkMinSize                (void );
#         ewol::Dimension                   m_userMaxSize;
+         void                              setMaxSize                  (const ewol::Dimension & _size);
+         void                              setNoMaxSize                (void );
+         const ewol::Dimension &           getMaxSize                  (void );
+ virtual void                              checkMaxSize                (void );
#         bvec2                             m_userExpand;
+ virtual void                              setExpand                   (const bvec2 & _newExpand);
+ virtual bvec2                             getExpand                   (void );
+ virtual bvec2                             canExpand                   (void );
#         bvec2                             m_userFill;
+ virtual void                              setFill                     (const bvec2 & _newFill);
+ virtual const bvec2 &                     getFill                     (void );
+         const bvec2 &                     canFill                     (void );
#         bool                              m_hide;
+ virtual void                              hide                        (void );
+ virtual void                              show                        (void );
+ virtual bool                              isHide                      (void );
+ virtual void                              setGravity                  (enum ewol::gravity _gravity);
+ virtual enum ewol::gravity                getGravity                  (void );
+ virtual bool                              getFocus                    (void );
+ virtual bool                              canHaveFocus                (void );
+ virtual bool                              setFocus                    (void );
+ virtual bool                              rmFocus                     (void );
+ virtual void                              setCanHaveFocus             (bool _canFocusState);
+ virtual void                              keepFocus                   (void );
# virtual void                              onGetFocus                  (void );
# virtual void                              onLostFocus                 (void );
+ virtual int32_t                           getMouseLimit               (void );
+ virtual void                              setMouseLimit               (int32_t _numberState);
+ virtual bool                              getKeyboardRepeate          (void );
# virtual void                              setKeyboardRepeate          (bool _state);
# virtual void                              showKeyboard                (void );
# virtual void                              hideKeyboard                (void );
#         void                              periodicCallDisable         (void );
#         void                              periodicCallEnable          (float _callInSecond);
+         int64_t                           systemGetCallDeltaTime      (void ) const;
+         int64_t                           systemGetLastCallTime       (void ) const;
+         void                              systemSetLastCallTime       (int64_t _time);
+ virtual void                              periodicCall                (const ewol::event::Time & _event);
+ virtual ewol::Widget*                     getWidgetAtPos              (const vec2 & _pos);
+ virtual ewol::Widget*                     getWidgetNamed              (const std::string & _widgetName);
+ virtual bool                              systemEventInput            (ewol::event::InputSystem & _event);
# virtual bool                              onEventInput                (const ewol::event::Input & _event);
+ virtual bool                              systemEventEntry            (ewol::event::EntrySystem & _event);
# virtual bool                              onEventEntry                (const ewol::event::Entry & _event);
+ virtual void                              onEventClipboard            (enum ewol::context::clipBoard::clipboardListe _clipboardID);
# virtual void                              shortCutAdd                 (const char* _descriptiveString,
                                                                         const char* _generateEventId,
                                                                         std::string _data,
                                                                         bool _broadcast);
# virtual void                              shortCutClean               (void );
+ virtual bool                              onEventShortCut             (ewol::key::Special & _special,
                                                                         char32_t _unicodeValue,
                                                                         enum ewol::key::keyboard _kbMove,
                                                                         bool _isDown);
#         bool                              m_needRegenerateDisplay;
# virtual void                              markToRedraw                (void );
# virtual bool                              needRedraw                  (void );
+ virtual void                              systemDraw                  (const DrawProperty & _displayProp);
# virtual void                              onDraw                      (void );
+ virtual void                              onRegenerateDisplay         (void );
+ virtual void                              grabCursor                  (void );
+ virtual void                              unGrabCursor                (void );
+ virtual bool                              getGrabStatus               (void );
+ virtual void                              setCursor                   (enum ewol::context::cursorDisplay _newCursor);
+ virtual enum ewol::context::cursorDisplay getCursor                   (void );
+ virtual void                              onObjectRemove              (ewol::Object* _removeObject);
+ virtual bool                              loadXML                     (exml::Element* _node);
# virtual bool                              onSetConfig                 (const ewol::object::Config & _conf);
# virtual bool                              onGetConfig                 (const char* _config,
                                                                         std::string & _result) const;
+         void                              requestUpdateSize           (void );
+         ewol::widget::Manager &           getWidgetManager            (void );
+         ewol::widget::Windows*            getWindows                  (void );
+         const char* const                 configAnnimationAddType;
+         const char* const                 configAnnimationAddTime;
+         const char* const                 configAnnimationRemoveType;
+         const char* const                 configAnnimationRemoveTime;
+         const char* const                 eventAnnimationStart;
+         const char* const                 eventAnnimationRatio;
+         const char* const                 eventAnnimationStop;
#         float                             m_annimationratio;
#         const char*                       m_annimationType;
#         float                             m_annimationTime;
#         void                              addAnnimationType           (enum ewol::Widget::annimationMode _mode,
                                                                         const char* _type);
+         void                              setAnnimationType           (enum ewol::Widget::annimationMode _mode,
                                                                         const std::string & _type);
+         void                              setAnnimationTime           (enum ewol::Widget::annimationMode _mode,
                                                                         float _time);
+         bool                              startAnnimation             (enum ewol::Widget::annimationMode _mode);
+         bool                              stopAnnimation              (void );
# virtual bool                              onStartAnnimation           (enum ewol::Widget::annimationMode _mode);
# virtual void                              onStopAnnimation            (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> ewol::Widget
         +--> ewol::widget::Button
         +--> ewol::widget::ButtonColor
         +--> ewol::widget::WidgetScrooled
         +--> ewol::widget::Joystick
         +--> ewol::widget::Slider
         +--> ewol::widget::Spacer
         +--> ewol::widget::Label
         +--> ewol::widget::Image
         +--> ewol::widget::ProgressBar
         +--> ewol::widget::CheckBox
         +--> ewol::widget::Windows
         +--> ewol::widget::Container
         +--> ewol::widget::ContainerN
         +--> ewol::widget::Gird
         +--> ewol::widget::Entry
         +--> ewol::widget::ColorBar
         +--> ege::widget::Mesh
         +--> ege::widget::Scene
+

Detail:

+

configFill

++ const char* const configFill;
+ +
+
+
+

configExpand

++ const char* const configExpand;
+ +
+
+
+

configHide

++ const char* const configHide;
+ +
+
+
+

configFocus

++ const char* const configFocus;
+ +
+
+
+

configMinSize

++ const char* const configMinSize;
+ +
+
+
+

configMaxSize

++ const char* const configMaxSize;
+ +
+
+
+

configGravity

++ const char* const configGravity;
+ +
+
+
+

Widget

++  Widget (void );
+Constructor of the widget classes
    + +
    Return: (no execption generated (not managed in embended platform))
    +
+ +
+
+

~Widget

++ virtual  ~Widget (void );
+Destructor of the widget classes
+
+
+

m_up

+# ewol::Widget* m_up;
+ +uppper widget in the tree of widget
+
+
+

setUpperWidget

++ void setUpperWidget (ewol::Widget* _upper);
+set the upper widget of this widget.
+ +
+
+

removeUpperWidget

++ void removeUpperWidget (void );
+remove the upper widget of this widget.
+
+
+

getUpperWidget

++ ewol::Widget* getUpperWidget (void );
+get the upper widget (father).
+
+
+

m_size

+# vec2 m_size;
+ +internal : current size of the widget
+
+
+

m_minSize

+# vec2 m_minSize;
+ +internal : minimum size of the widget
+
+
+

m_maxSize

+# vec2 m_maxSize;
+ +internal : maximum size of the widget
+
+
+

relativePosition

++ virtual vec2 relativePosition (const vec2 & _pos);
+convert the absolute position in the local Position (Relative)
    + + +
    Parameter [input]:_pos Absolute position that you request convertion
    Return: the relative position
    +
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _available);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

getSize

++ virtual vec2 getSize (void );
+get the widget size
Note: : INTERNAL EWOL SYSTEM
    + +
    Return: Requested size
    +
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

getCalculateMinSize

++ virtual vec2 getCalculateMinSize (void );
+get the widget minimum size calculated
Note: : INTERNAL EWOL SYSTEM
    + +
    Return: Requested size
    +
+ +
+
+

getCalculateMaxSize

++ virtual vec2 getCalculateMaxSize (void );
+get the widget maximum size calculated
Note: : INTERNAL EWOL SYSTEM
    + +
    Return: Requested size
    +
+ +
+
+

m_offset

+# vec2 m_offset;
+ +Offset of the display in the viewport
+
+
+

setOffset

++ virtual void setOffset (const vec2 & _newVal);
+set the zoom property of the widget.
    + + +
    Parameter [input]:_newVal offset value.
    +
+ +
+
+

getOffset

++ virtual const vec2 & getOffset (void );
+get the offset property of the widget.
    + +
    Return: The current offset value.
    +
+ +
+
+

m_zoom

+# float m_zoom;
+ +generic widget zoom
+
+
+

setZoom

++ virtual void setZoom (float _newVal);
+set the zoom property of the widget
    + + +
    Parameter [input]:_newVal newZoom value
    +
+ +
+
+

getZoom

++ virtual float getZoom (void );
+get the zoom property of the widget
    + +
    Return: the current zoom value
    +
+ +
+
+

m_origin

+# vec2 m_origin;
+ +internal ... I do not really known how i can use it ...
+
+
+

setOrigin

++ virtual void setOrigin (const vec2 & _pos);
+set origin at the widget (must be an parrent widget that set this parameter). +This represent the absolute origin in the program windows
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_pos Position of the origin
    +
+ +
+
+

getOrigin

++ virtual vec2 getOrigin (void );
+get the origin (obsolute position in the windows)
    + +
    Return: coordonate of the origin requested
    +
+ +
+
+

m_userMinSize

+# ewol::Dimension m_userMinSize;
+ +user define the minimum size of the widget
+
+
+

setMinSize

++ void setMinSize (const ewol::Dimension & _size);
+User set the minimum size he want to set the display
+ +
+
+

setNoMinSize

++ void setNoMinSize (void );
+User set No minimum size.
+
+
+

getMinSize

++ const ewol::Dimension & getMinSize (void );
+get the current calculated min size
+ +
+
+

checkMinSize

++ virtual void checkMinSize (void );
+Check if the current min size is compatible with the user minimum size + If it is not the user minimum size will overWrite the minimum size set.
Note: : INTERNAL EWOL SYSTEM
+
+
+

m_userMaxSize

+# ewol::Dimension m_userMaxSize;
+ +user define the maximum size of the widget
+
+
+

setMaxSize

++ void setMaxSize (const ewol::Dimension & _size);
+User set the maximum size he want to set the display
+ +
+
+

setNoMaxSize

++ void setNoMaxSize (void );
+User set No maximum size.
+
+
+

getMaxSize

++ const ewol::Dimension & getMaxSize (void );
+get the current maximum size
+ +
+
+

checkMaxSize

++ virtual void checkMaxSize (void );
+Check if the current max size is compatible with the user maximum size + If it is not the user maximum size will overWrite the maximum size set.
Note: : INTERNAL EWOL SYSTEM
+
+
+

m_userExpand

+# bvec2 m_userExpand;
+ +
+
+
+

setExpand

++ virtual void setExpand (const bvec2 & _newExpand);
+set the expend capabilities (x&y)
    + + +
    Parameter [input]:_newExpend 2D boolean repensent the capacity to expend
    +
+ +
+
+

getExpand

++ virtual bvec2 getExpand (void );
+get the expend capabilities (x&y) (set by the user)
    + +
    Return: 2D boolean repensent the capacity to expend
    +
+ +
+
+

canExpand

++ virtual bvec2 canExpand (void );
+get the expend capabilities (x&y)
Note: : INTERNAL EWOL SYSTEM
    + +
    Return: 2D boolean repensent the capacity to expend
    +
+ +
+
+

m_userFill

+# bvec2 m_userFill;
+ +
+
+
+

setFill

++ virtual void setFill (const bvec2 & _newFill);
+set the x&y filling capacity
    + + +
    Parameter [input]:_newFill new x&y fill state
    +
+ +
+
+

getFill

++ virtual const bvec2 & getFill (void );
+set the x&y filling capacity set by the user
    + +
    Return: bvec2 repensent the capacity to x&y filling (set by the user)
    +
+ +
+
+

canFill

++ const bvec2 & canFill (void );
+get the filling capabilities x&y
Note: : INTERNAL EWOL SYSTEM
    + +
    Return: bvec2 repensent the capacity to x&y filling
    +
+ +
+
+

m_hide

+# bool m_hide;
+ +hide a widget on the display
+
+
+

hide

++ virtual void hide (void );
+set the widget hidden
+
+
+

show

++ virtual void show (void );
+set the widget visible
+
+
+

isHide

++ virtual bool isHide (void );
+get the visibility of the widget
    + +
    Return: true: if the widget is hiden, false: it is visible
    +
+ +
+
+

setGravity

++ virtual void setGravity (enum ewol::gravity _gravity);
+set the widget gravity
+ +
+
+

getGravity

++ virtual enum ewol::gravity getGravity (void );
+get the widget gravity
+ +
+
+

getFocus

++ virtual bool getFocus (void );
+get the focus state of the widget
    + +
    Return: focus state
    +
+ +
+
+

canHaveFocus

++ virtual bool canHaveFocus (void );
+get the capability to have focus
    + +
    Return: State capability to have focus
    +
+ +
+
+

setFocus

++ virtual bool setFocus (void );
+set focus on this widget
    + +
    Return: return true if the widget keep the focus
    +
+ +
+
+

rmFocus

++ virtual bool rmFocus (void );
+remove the focus on this widget
    + +
    Return: return true if the widget have release his focus (if he has it)
    +
+ +
+
+

setCanHaveFocus

++ virtual void setCanHaveFocus (bool _canFocusState);
+set the capability to have the focus
    + + +
    Parameter [input]:_canFocusState new focus capability
    +
+ +
+
+

keepFocus

++ virtual void keepFocus (void );
+keep the focus on this widget == > this remove the previous focus on all other widget
+
+
+

onGetFocus

+# virtual void onGetFocus (void );
+Event of the focus has been grep by the current widget
+
+
+

onLostFocus

+# virtual void onLostFocus (void );
+Event of the focus has been lost by the current widget
+
+
+

getMouseLimit

++ virtual int32_t getMouseLimit (void );
+get the number of mouse event supported
    + +
    Return: return the number of event that the mouse supported [0..3]
    +
+ +
+
+

setMouseLimit

++ virtual void setMouseLimit (int32_t _numberState);
+get the number of mouse event supported
    + + +
    Parameter [input]:_numberState The number of event that the mouse supported [0..3]
    +
+ +
+
+

getKeyboardRepeate

++ virtual bool getKeyboardRepeate (void );
+get the keyboard repeating event supporting.
    + +
    Return: true : the event can be repeated.<br/>false : the event must not be repeated.
    +
+ +
+
+

setKeyboardRepeate

+# virtual void setKeyboardRepeate (bool _state);
+set the keyboard repeating event supporting.
    + + +
    Parameter [input]:_state The repeating status (true: enable, false disable).
    +
+ +
+
+

showKeyboard

+# virtual void showKeyboard (void );
+display the virtual keyboard (if needed)
+
+
+

hideKeyboard

+# virtual void hideKeyboard (void );
+Hide the virtual keyboard (if needed)
+
+
+

periodicCallDisable

+# void periodicCallDisable (void );
+disable the periodic call.
+
+
+

periodicCallEnable

+# void periodicCallEnable (float _callInSecond);
+disable the periodic call.
    + + +
    Parameter [input]:_callInSecond periodic call in second (float)
    +
+ +
+
+

systemGetCallDeltaTime

++ int64_t systemGetCallDeltaTime (void ) const;
+{SYSTEM} get a reference of the periodic call delta time
    + +
    Return: the perodic time delta call -1 : disable / 0 : every time / else in US
    +
+ +
+
+

systemGetLastCallTime

++ int64_t systemGetLastCallTime (void ) const;
+{SYSTEM} get a reference of the periodic call time
    + +
    Return: Last call from the periodic call
    +
+ +
+
+

systemSetLastCallTime

++ void systemSetLastCallTime (int64_t _time);
+{SYSTEM} get a reference of the periodic call time
    + +
    Return: Last call from the periodic call
    +
+ +
+
+

periodicCall

++ virtual void periodicCall (const ewol::event::Time & _event);
+periodic call of this widget
+ +
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

getWidgetNamed

++ virtual ewol::Widget* getWidgetNamed (const std::string & _widgetName);
+get the widget if it have this name or one of the subwidget with the same name
+ +
+
+

systemEventInput

++ virtual bool systemEventInput (ewol::event::InputSystem & _event);
+{SYSTEM} system event input (only meta widget might overwrite this function).
+ +
+
+

onEventInput

+# virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

systemEventEntry

++ virtual bool systemEventEntry (ewol::event::EntrySystem & _event);
+{SYSTEM} Entry event (only meta widget might overwrite this function).
+ +
+
+

onEventEntry

+# virtual bool onEventEntry (const ewol::event::Entry & _event);
+Entry event. + represent the physical event : + - Keyboard (key event and move event) + - Accelerometer + - Joystick
+ +
+
+

onEventClipboard

++ virtual void onEventClipboard (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+Event on a past event == > this event is asynchronous due to all system does not support direct getting datas
Note: : need to have focus ...
+ +
+
+

shortCutAdd

+# virtual void shortCutAdd (const char* _descriptiveString,
                            const char* _generateEventId,
                            std::string _data,
                            bool _broadcast);
+add a specific shortcut with his description
+ +
+
+

shortCutClean

+# virtual void shortCutClean (void );
+remove all curent shortCut
+
+
+

onEventShortCut

++ virtual bool onEventShortCut (ewol::key::Special & _special,
                                char32_t _unicodeValue,
                                enum ewol::key::keyboard _kbMove,
                                bool _isDown);
+Event on a short-cut of this Widget (in case of return false, the event on the keyevent will arrive in the function @ref onEventKb).
Note: To prevent some error when you get an event get it if it is down and Up ... == > like this it could not generate some ununderstanding error.
+ +
+
+

m_needRegenerateDisplay

+# bool m_needRegenerateDisplay;
+ +the display might be done the next regeneration
+
+
+

markToRedraw

+# virtual void markToRedraw (void );
+The widget mark itself that it need to regenerate the nest time.
+
+
+

needRedraw

+# virtual bool needRedraw (void );
+get the need of the redrawing of the widget and reset it to false
    + +
    Return: true if we need to redraw<br/>false if we have no need to redraw
    +
+ +
+
+

systemDraw

++ virtual void systemDraw (const DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_displayProp properties of the current display
    +
+ +
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

grabCursor

++ virtual void grabCursor (void );
+Grab the cursor : This get all the mouvement of the mouse in PC mode, and generate an ofset instead of a position.
Note: : the generation of the offset is due to the fact the cursor position is forced at the center of the widget.
Note: This done nothing in "Finger" or "Stylet" mode.
+
+
+

unGrabCursor

++ virtual void unGrabCursor (void );
+Un-Grab the cursor (default mode cursor offset)
+
+
+

getGrabStatus

++ virtual bool getGrabStatus (void );
+get the grabbing status of the cursor.
    + +
    Return: true if the cursor is curently grabbed
    +
+ +
+
+

setCursor

++ virtual void setCursor (enum ewol::context::cursorDisplay _newCursor);
+set the cursor display type.
+ +
+
+

getCursor

++ virtual enum ewol::context::cursorDisplay getCursor (void );
+get the currrent cursor.
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+

requestUpdateSize

++ void requestUpdateSize (void );
+need to be call When the size of the current widget have change == > this force the system to recalculate all the widget positions
+
+
+

getWidgetManager

++ ewol::widget::Manager & getWidgetManager (void );
+get the current Widget Manager
+
+
+

getWindows

++ ewol::widget::Windows* getWindows (void );
+get the curent Windows
+
+
+

configAnnimationAddType

++ const char* const configAnnimationAddType;
+ +
+
+
+

configAnnimationAddTime

++ const char* const configAnnimationAddTime;
+ +
+
+
+

configAnnimationRemoveType

++ const char* const configAnnimationRemoveType;
+ +
+
+
+

configAnnimationRemoveTime

++ const char* const configAnnimationRemoveTime;
+ +
+
+
+

eventAnnimationStart

++ const char* const eventAnnimationStart;
+ +event when start annimation
+
+
+

eventAnnimationRatio

++ const char* const eventAnnimationRatio;
+ +event when % of annimation change (integer)
+
+
+

eventAnnimationStop

++ const char* const eventAnnimationStop;
+ +event when stop annimation
+
+
+

m_annimationratio

+# float m_annimationratio;
+ +Ratio of the annimation [0..1]
+
+
+

m_annimationType

+# const char* m_annimationType;
+ +type of start annimation (default NULL ==> no annimation)
+
+
+

m_annimationTime

+# float m_annimationTime;
+ +time to produce start annimation
+
+
+

addAnnimationType

+# void addAnnimationType (enum ewol::Widget::annimationMode _mode,
                          const char* _type);
+Add a annimation type capabilities of this widget.
+ +
+
+

setAnnimationType

++ void setAnnimationType (enum ewol::Widget::annimationMode _mode,
                          const std::string & _type);
+set a annimation type.
+ +
+
+

setAnnimationTime

++ void setAnnimationTime (enum ewol::Widget::annimationMode _mode,
                          float _time);
+set a annimation time to produce.
+ +
+
+

startAnnimation

++ bool startAnnimation (enum ewol::Widget::annimationMode _mode);
+Start the annimation.
+ +
+
+

stopAnnimation

++ bool stopAnnimation (void );
+Stop/Break the annimation.
    + +
    Return: true if an annimation will be stoped, false ==> no curent annimation and no event wil be generated
    +
+ +
+
+

onStartAnnimation

+# virtual bool onStartAnnimation (enum ewol::Widget::annimationMode _mode);
+Event when start the annimation.
+ +
+
+

onStopAnnimation

+# virtual void onStopAnnimation (void );
+Event when Stop the annimation.
+
+
+
+ + + diff --git a/class_ewol__compositing__Area.html b/class_ewol__compositing__Area.html new file mode 100644 index 00000000..a17effdf --- /dev/null +++ b/class_ewol__compositing__Area.html @@ -0,0 +1,195 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::compositing::Area

Description:

+ +

+

Constructor and Destructor:

+
++                                Area         (const ivec2 & _size);
+                                ~Area        (void );
+
+

Synopsis:

+
++ void                           draw         (bool _disableDepthTest);
+ void                           clear        (void );
+ const vec3 &                   getPos       (void );
+ void                           setPos       (const vec3 & _pos);
+ void                           setPos       (const vec2 & _pos);
+ void                           setRelPos    (const vec3 & _pos);
+ void                           setRelPos    (const vec2 & _pos);
+ void                           print        (const ivec2 & _size);
+ egami::Image &                 get          (void );
+ void                           flush        (void );
+
+

Object Hierarchy:

+
++ewol::Compositing
  +--> ewol::compositing::Area
+

Detail:

+

Area

++  Area (const ivec2 & _size);
+generic constructor
    + + +
    Parameter [input]:_size Basic size of the area.
    +
+ +
+
+

~Area

++  ~Area (void );
+generic destructor
+
+
+

draw

++ void draw (bool _disableDepthTest);
+draw All the refistered text in the current element on openGL
+
+
+

clear

++ void clear (void );
+clear alll the registered element in the current element
+
+
+

getPos

++ const vec3 & getPos (void );
+get the current display position (sometime needed in the gui control)
    + +
    Return: the current position.
    +
+ +
+
+

setPos

++ void setPos (const vec3 & _pos);
+set position for the next text writen
    + + +
    Parameter [input]:_pos Position of the text (in 3D)
    +
+ +
+
+

setPos

++ void setPos (const vec2 & _pos);
+ +
+
+
+

setRelPos

++ void setRelPos (const vec3 & _pos);
+set relative position for the next text writen
    + + +
    Parameter [input]:_pos ofset apply of the text (in 3D)
    +
+ +
+
+

setRelPos

++ void setRelPos (const vec2 & _pos);
+ +
+
+
+

print

++ void print (const ivec2 & _size);
+add a compleate of the image to display with the requested size
    + + +
    Parameter [input]:_size size of the output image
    +
+ +
+
+

get

++ egami::Image & get (void );
+ +
+
+
+

flush

++ void flush (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__compositing__Drawing.html b/class_ewol__compositing__Drawing.html new file mode 100644 index 00000000..0808560e --- /dev/null +++ b/class_ewol__compositing__Drawing.html @@ -0,0 +1,327 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::compositing::Drawing

Description:

+ +

+

Constructor and Destructor:

+
++                                Drawing            (void );
+                                ~Drawing           (void );
+
+

Synopsis:

+
++ void                           draw               (bool _disableDepthTest);
+ void                           clear              (void );
+ const vec3 &                   getPos             (void );
+ void                           setPos             (const vec3 & _pos);
+ void                           setPos             (const vec2 & _pos);
+ void                           setRelPos          (const vec3 & _pos);
+ void                           setRelPos          (const vec2 & _pos);
+ void                           setColor           (const etk::Color<> & _color);
+ void                           setColorBg         (const etk::Color<> & _color);
+ void                           setClippingWidth   (const vec3 & _pos,
                                                     const vec3 & _width);
+ void                           setClippingWidth   (const vec2 & _pos,
                                                     const vec2 & _width);
+ void                           setClipping        (const vec3 & _pos,
                                                     const vec3 & _posEnd);
+ void                           setClipping        (const vec2 & _pos,
                                                     const vec2 & _posEnd);
+ void                           setClippingMode    (bool _newMode);
+ void                           setThickness       (float _thickness);
+ void                           addVertex          (void );
+ void                           lineTo             (const vec3 & _dest);
+ void                           lineTo             (const vec2 & _dest);
+ void                           lineRel            (const vec3 & _vect);
+ void                           lineRel            (const vec2 & _vect);
+ void                           rectangle          (const vec3 & _dest);
+ void                           rectangle          (const vec2 & _dest);
+ void                           rectangleWidth     (const vec3 & _size);
+ void                           rectangleWidth     (const vec2 & _size);
+ void                           cube               (const vec3 & _dest);
+ void                           circle             (float _radius,
                                                     float _angleStart,
                                                     float _angleStop);
+
+

Object Hierarchy:

+
++ewol::Compositing
  +--> ewol::compositing::Drawing
+

Detail:

+

Drawing

++  Drawing (void );
+Basic constructor
+
+
+

~Drawing

++  ~Drawing (void );
+Basic destructor
+
+
+

draw

++ void draw (bool _disableDepthTest);
+draw All the refistered text in the current element on openGL
+
+
+

clear

++ void clear (void );
+clear alll tre registered element in the current element
+
+
+

getPos

++ const vec3 & getPos (void );
+get the current display position (sometime needed in the gui control)
    + +
    Return: the current position.
    +
+ +
+
+

setPos

++ void setPos (const vec3 & _pos);
+set position for the next text writen
    + + +
    Parameter [input]:_pos Position of the text (in 3D)
    +
+ +
+
+

setPos

++ void setPos (const vec2 & _pos);
+ +
+
+
+

setRelPos

++ void setRelPos (const vec3 & _pos);
+set relative position for the next text writen
    + + +
    Parameter [input]:_pos ofset apply of the text (in 3D)
    +
+ +
+
+

setRelPos

++ void setRelPos (const vec2 & _pos);
+ +
+
+
+

setColor

++ void setColor (const etk::Color<> & _color);
+set the Color of the current foreground font
+ +
+
+

setColorBg

++ void setColorBg (const etk::Color<> & _color);
+set the background color of the font (for selected Text (not the global BG))
+ +
+
+

setClippingWidth

++ void setClippingWidth (const vec3 & _pos,
                         const vec3 & _width);
+Request a clipping area for the text (next draw only)
    + + +
    Parameter [input]:_width Width size of the clipping
    +
+ +
+
+

setClippingWidth

++ void setClippingWidth (const vec2 & _pos,
                         const vec2 & _width);
+ +
+
+
+

setClipping

++ void setClipping (const vec3 & _pos,
                    const vec3 & _posEnd);
+Request a clipping area for the text (next draw only)
    + + + +
    Parameter [input]:_pos Start position of the clipping
    Parameter [input]:_posEnd End position of the clipping
    +
+ +
+
+

setClipping

++ void setClipping (const vec2 & _pos,
                    const vec2 & _posEnd);
+ +
+
+
+

setClippingMode

++ void setClippingMode (bool _newMode);
+enable/Disable the clipping (without lose the current clipping position)
_newMode The new status of the clipping
+
+
+

setThickness

++ void setThickness (float _thickness);
+Specify the line thickness for the next elements
    + + +
    Parameter [input]:_thickness The thickness disired for the next print
    +
+ +
+
+

addVertex

++ void addVertex (void );
+add a point reference at the current position (this is a vertex reference at the current position
+
+
+

lineTo

++ void lineTo (const vec3 & _dest);
+draw a line to a specific position
    + + +
    Parameter [input]:_dest Position of the end of the line.
    +
+ +
+
+

lineTo

++ void lineTo (const vec2 & _dest);
+ +
+
+
+

lineRel

++ void lineRel (const vec3 & _vect);
+Relative drawing a line (spacial vector)
    + + +
    Parameter [input]:_vect Vector of the curent line.
    +
+ +
+
+

lineRel

++ void lineRel (const vec2 & _vect);
+ +
+
+
+

rectangle

++ void rectangle (const vec3 & _dest);
+draw a 2D rectangle to the position requested.
    + + +
    Parameter [input]:_dest Position the the end of the rectangle
    +
+ +
+
+

rectangle

++ void rectangle (const vec2 & _dest);
+ +
+
+
+

rectangleWidth

++ void rectangleWidth (const vec3 & _size);
+draw a 2D rectangle to the requested size.
    + + +
    Parameter [input]:_size size of the rectangle
    +
+ +
+
+

rectangleWidth

++ void rectangleWidth (const vec2 & _size);
+ +
+
+
+

cube

++ void cube (const vec3 & _dest);
+draw a 3D rectangle to the position requested.
    + + +
    Parameter [input]:_dest Position the the end of the rectangle
    +
+ +
+
+

circle

++ void circle (float _radius,
               float _angleStart,
               float _angleStop);
+draw a 2D circle with the specify rafdius parameter.
    + + + + +
    Parameter [input]:_radius Distence to the dorder
    Parameter [input]:_angleStart start angle of this circle ([0..2PI] otherwithe == > disable)
    Parameter [input]:_angleStop stop angle of this circle ([0..2PI] otherwithe == > disable)
    +
+ +
+
+
+ + + diff --git a/class_ewol__compositing__Image.html b/class_ewol__compositing__Image.html new file mode 100644 index 00000000..9cfba45b --- /dev/null +++ b/class_ewol__compositing__Image.html @@ -0,0 +1,300 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::compositing::Image

Description:

+ +

+

Constructor and Destructor:

+
++                                Image              (const std::string & _imageName);
+ virtual                                ~Image             (void );
+
+

Synopsis:

+
++ void                           draw               (bool _disableDepthTest);
+ void                           clear              (void );
+ const vec3 &                   getPos             (void );
+ void                           setPos             (const vec3 & _pos);
+ void                           setPos             (const vec2 & _pos);
+ void                           setRelPos          (const vec3 & _pos);
+ void                           setRelPos          (const vec2 & _pos);
+ void                           setColor           (const etk::Color<> & _color);
+ void                           setClippingWidth   (const vec3 & _pos,
                                                     vec3 _width);
+ void                           setClippingWidth   (const vec2 & _pos,
                                                     const vec2 & _width);
+ void                           setClipping        (const vec3 & _pos,
                                                     vec3 _posEnd);
+ void                           setClipping        (const vec2 & _pos,
                                                     const vec2 & _posEnd);
+ void                           setClippingMode    (bool _newMode);
+ void                           setAngle           (float _angleRad);
+ void                           print              (const ivec2 & _size);
+ void                           print              (const vec2 & _size);
+ void                           printPart          (const vec2 & _size,
                                                     const vec2 & _sourcePosStart,
                                                     const vec2 & _sourcePosStop);
+ void                           setSource          (const std::string & _newFile,
                                                     int32_t _size);
+ void                           setSource          (const std::string & _newFile,
                                                     const vec2 & _size);
+ bool                           hasSources         (void );
+ vec2                           getRealSize        (void );
+
+

Object Hierarchy:

+
++ewol::Compositing
  +--> ewol::compositing::Image
         +--> ewol::compositing::Sprite
+

Detail:

+

Image

++  Image (const std::string & _imageName);
+generic constructor
+ +
+
+

~Image

++ virtual  ~Image (void );
+generic destructor
+
+
+

draw

++ void draw (bool _disableDepthTest);
+draw All the refistered text in the current element on openGL
    + + +
    Parameter [input]:_disableDepthTest disable the Depth test for display
    +
+ +
+
+

clear

++ void clear (void );
+clear alll tre registered element in the current element
+
+
+

getPos

++ const vec3 & getPos (void );
+get the current display position (sometime needed in the gui control)
    + +
    Return: the current position.
    +
+ +
+
+

setPos

++ void setPos (const vec3 & _pos);
+set position for the next text writen
    + + +
    Parameter [input]:_pos Position of the text (in 3D)
    +
+ +
+
+

setPos

++ void setPos (const vec2 & _pos);
+ +
+
+
+

setRelPos

++ void setRelPos (const vec3 & _pos);
+set relative position for the next text writen
    + + +
    Parameter [input]:_pos ofset apply of the text (in 3D)
    +
+ +
+
+

setRelPos

++ void setRelPos (const vec2 & _pos);
+ +
+
+
+

setColor

++ void setColor (const etk::Color<> & _color);
+set the Color of the current foreground font
+ +
+
+

setClippingWidth

++ void setClippingWidth (const vec3 & _pos,
                         vec3 _width);
+Request a clipping area for the text (next draw only)
    + + + +
    Parameter [input]:_pos Start position of the clipping
    Parameter [input]:_width Width size of the clipping
    +
+ +
+
+

setClippingWidth

++ void setClippingWidth (const vec2 & _pos,
                         const vec2 & _width);
+ +
+
+
+

setClipping

++ void setClipping (const vec3 & _pos,
                    vec3 _posEnd);
+Request a clipping area for the text (next draw only)
    + + + +
    Parameter [input]:_pos Start position of the clipping
    Parameter [input]:_posEnd End position of the clipping
    +
+ +
+
+

setClipping

++ void setClipping (const vec2 & _pos,
                    const vec2 & _posEnd);
+ +
+
+
+

setClippingMode

++ void setClippingMode (bool _newMode);
+enable/Disable the clipping (without lose the current clipping position)
_newMode The new status of the clipping
+
+
+

setAngle

++ void setAngle (float _angleRad);
+set a unique rotation of this element (not set in the rotate Generic system)
    + + +
    Parameter [input]:_angle Angle to set in radiant.
    +
+ +
+
+

print

++ void print (const ivec2 & _size);
+add a compleate of the image to display with the requested size
    + + +
    Parameter [input]:_size size of the output image
    +
+ +
+
+

print

++ void print (const vec2 & _size);
+ +
+
+
+

printPart

++ void printPart (const vec2 & _size,
                  const vec2 & _sourcePosStart,
                  const vec2 & _sourcePosStop);
+add a part of the image to display with the requested size
    + + + + +
    Parameter [input]:_size size of the output image
    Parameter [input]:_sourcePosStart Start position in the image [0..1] (can be bigger but this repeate the image).
    Parameter [input]:_sourcePosStop Stop position in the image [0..1] (can be bigger but this repeate the image).
    +
+ +
+
+

setSource

++ void setSource (const std::string & _newFile,
                  int32_t _size);
+change the image Source == > can not be done to display 2 images at the same time ...
+ +
+
+

setSource

++ void setSource (const std::string & _newFile,
                  const vec2 & _size);
+ +
+
+
+

hasSources

++ bool hasSources (void );
+Sometimes the user declare an image but not allocate the ressources all the time, this is to know it ..
    + +
    Return: the validity od the resources.
    +
+ +
+
+

getRealSize

++ vec2 getRealSize (void );
+get the source image registered size in the file (<0 when multiple size image)
    + +
    Return: tre image registered size
    +
+ +
+
+
+ + + diff --git a/class_ewol__compositing__Shaper.html b/class_ewol__compositing__Shaper.html new file mode 100644 index 00000000..c86795c7 --- /dev/null +++ b/class_ewol__compositing__Shaper.html @@ -0,0 +1,255 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::compositing::Shaper

Description:

+the Shaper system is a basic theme configuration for every widget, it corespond at a background display described by a pool of files

+

Constructor and Destructor:

+
++                              Shaper                    (const std::string & _shaperName);
+                              ~Shaper                   (void );
+
+

Synopsis:

+
++ void                         draw                      (bool _disableDepthTest);
+ void                         clear                     (void );
+ bool                         changeStatusIn            (int32_t _newStatusId);
+ int32_t                      getCurrentDisplayedStatus (void );
+ int32_t                      getNextDisplayedStatus    (void );
+ float                        getTransitionStatus       (void );
+ bool                         periodicCall              (const ewol::event::Time & _event);
+ void                         setOrigin                 (const vec2 & _newOri);
+ void                         setSize                   (const vec2 & _newSize);
+ void                         setInsideSize             (const vec2 & _newInsideSize);
+ void                         setInsidePos              (const vec2 & _newInsidePos);
+ vec2                         getPadding                (void );
+ void                         setSource                 (const std::string & _newFile);
+ const std::string &          getSource                 (void ) const;
+ bool                         hasSources                (void );
+
+

Object Hierarchy:

+
++ewol::Compositing
  +--> ewol::compositing::Shaper
+

Detail:

+

Shaper

++  Shaper (const std::string & _shaperName);
+generic constructor
+ +
+
+

~Shaper

++  ~Shaper (void );
+generic destructor
+
+
+

draw

++ void draw (bool _disableDepthTest);
+draw All the refistered text in the current element on openGL
+
+
+

clear

++ void clear (void );
+clear alll tre registered element in the current element
+
+
+

changeStatusIn

++ bool changeStatusIn (int32_t _newStatusId);
+change the current status in an other
    + + +
    Parameter [input]:_newStatusId the next new status requested
    Return: true The widget must call this fuction periodicly (and redraw itself)<br/>false No need to request the periodic call.
    +
+ +
+
+

getCurrentDisplayedStatus

++ int32_t getCurrentDisplayedStatus (void );
+get the current displayed status of the shaper
    + +
    Return: The Status Id
    +
+ +
+
+

getNextDisplayedStatus

++ int32_t getNextDisplayedStatus (void );
+get the next displayed status of the shaper
    + +
    Return: The next status Id (-1 if no status in next)
    +
+ +
+
+

getTransitionStatus

++ float getTransitionStatus (void );
+get the current trasion status
    + +
    Return: value of the transition status (0.0f when no activity)
    +
+ +
+
+

periodicCall

++ bool periodicCall (const ewol::event::Time & _event);
+Same as the widfget periodic call (this is for change display)
+ +
+
+

setOrigin

++ void setOrigin (const vec2 & _newOri);
+set the widget origin (needed fot the display)
    + + +
    Parameter [input]:_newOri : the new widget origin
    +
+ +
+
+

setSize

++ void setSize (const vec2 & _newSize);
+set the widget size (needed fot the display)
    + + +
    Parameter [input]:_newSize : the new widget size
    +
+ +
+
+

setInsideSize

++ void setInsideSize (const vec2 & _newInsideSize);
+set the internal widget size
    + + +
    Parameter [input]:_newInsidePos : the subelement size.
    +
+ +
+
+

setInsidePos

++ void setInsidePos (const vec2 & _newInsidePos);
+set the internal widget position
    + + +
    Parameter [input]:_newInsidePos : the subelement position
    +
+ +
+
+

getPadding

++ vec2 getPadding (void );
+get the padding declared by the user in the config file
    + +
    Return: the padding property
    +
+ +
+
+

setSource

++ void setSource (const std::string & _newFile);
+change the shaper Source
+ +
+
+

getSource

++ const std::string & getSource (void ) const;
+get the shaper file Source
+ +
+
+

hasSources

++ bool hasSources (void );
+Sometimes the user declare an image but not allocate the ressources all the time, this is to know it ..
+ +
+
+
+ + + diff --git a/class_ewol__compositing__Sprite.html b/class_ewol__compositing__Sprite.html new file mode 100644 index 00000000..6625b928 --- /dev/null +++ b/class_ewol__compositing__Sprite.html @@ -0,0 +1,143 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::compositing::Sprite

Description:

+ +

+

Constructor and Destructor:

+
++       Sprite              (const std::string & _imageName,
                             const ivec2 & _nbSprite);
+ virtual       ~Sprite             ();
+
+

Synopsis:

+
+# ivec2 m_nbSprite;
# vec2  m_unitarySpriteSize;
+ void  printSprite         (const ivec2 & _spriteID,
                             const vec2 & _size);
+ void  printSprite         (const ivec2 & _spriteID,
                             const vec3 & _size);
+
+

Object Hierarchy:

+
++ewol::Compositing
  +--> +ewol::compositing::Image
         +--> ewol::compositing::Sprite
+

Detail:

+

m_nbSprite

+# ivec2 m_nbSprite;
+ +number of sprite in vertical and horizontal
+
+
+

m_unitarySpriteSize

+# vec2 m_unitarySpriteSize;
+ +size of a unique sprite
+
+
+

Sprite

++  Sprite (const std::string & _imageName,
           const ivec2 & _nbSprite);
+ +
+
+
+

~Sprite

++ virtual  ~Sprite ();
+ +
+
+
+

printSprite

++ void printSprite (const ivec2 & _spriteID,
                    const vec2 & _size);
+ +
+
+
+

printSprite

++ void printSprite (const ivec2 & _spriteID,
                    const vec3 & _size);
+ +
+
+
+
+ + + diff --git a/class_ewol__compositing__Text.html b/class_ewol__compositing__Text.html new file mode 100644 index 00000000..745660e3 --- /dev/null +++ b/class_ewol__compositing__Text.html @@ -0,0 +1,570 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::compositing::Text

Description:

+ +

+

enum:

+ +

Constructor and Destructor:

+
++                                                  Text                   (const std::string & _fontName,
                                                                           int32_t _fontSize);
+                                                  ~Text                  (void );
+
+

Synopsis:

+
++         ewol::compositing::Drawing &             getDrawing             (void );
+ virtual void                                     translate              (const vec3 & _vect);
+ virtual void                                     rotate                 (const vec3 & _vect,
                                                                           float _angle);
+ virtual void                                     scale                  (const vec3 & _vect);
+         void                                     draw                   (bool _disableDepthTest);
+         void                                     draw                   (const mat4 & _transformationMatrix,
                                                                           bool _enableDepthTest);
+         void                                     clear                  (void );
+         void                                     reset                  (void );
+         const vec3 &                             getPos                 (void );
+         void                                     setPos                 (const vec3 & _pos);
+         void                                     setPos                 (const vec2 & _pos);
+         void                                     setRelPos              (const vec3 & _pos);
+         void                                     setRelPos              (const vec2 & _pos);
+         void                                     setColor               (const etk::Color<> & _color);
+         void                                     setColorBg             (const etk::Color<> & _color);
+         void                                     setClippingWidth       (const vec3 & _pos,
                                                                           const vec3 & _width);
+         void                                     setClippingWidth       (const vec2 & _pos,
                                                                           const vec2 & _width);
+         void                                     setClipping            (const vec3 & _pos,
                                                                           const vec3 & _posEnd);
+         void                                     setClipping            (const vec2 & _pos,
                                                                           const vec2 & _posEnd);
+         void                                     setClippingMode        (bool _newMode);
+         void                                     setFontSize            (int32_t _fontSize);
+         void                                     setFontName            (const std::string & _fontName);
+         void                                     setFont                (std::string _fontName,
                                                                           int32_t _fontSize);
+         void                                     setFontMode            (enum ewol::font::mode _mode);
+         enum ewol::font::mode                    getFontMode            (void );
+         void                                     setFontBold            (bool _status);
+         void                                     setFontItalic          (bool _status);
+         void                                     setKerningMode         (bool _newMode);
+         void                                     setDistanceFieldMode   (bool _newMode);
+         void                                     print                  (const std::string & _text);
+         void                                     print                  (const std::u32string & _text);
+         void                                     printDecorated         (const std::string & _text);
+         void                                     printHTML              (const std::string & _text);
+         void                                     print                  (const std::string & _text,
                                                                           const std::vector<TextDecoration> & _decoration);
+         void                                     print                  (const std::u32string & _text,
                                                                           const std::vector<TextDecoration> & _decoration);
+         void                                     print                  (const char32_t & _charcode);
+         void                                     forceLineReturn        (void );
+         void                                     setTextAlignement      (float _startTextpos,
                                                                           float _stopTextPos,
                                                                           enum ewol::compositing::Text::aligneMode _alignement);
+         void                                     disableAlignement      (void );
+         enum ewol::compositing::Text::aligneMode getAlignement          (void );
+         vec3                                     calculateSizeHTML      (const std::string & _text);
+         vec3                                     calculateSizeDecorated (const std::string & _text);
+         vec3                                     calculateSize          (const std::string & _text);
+         vec3                                     calculateSize          (const char32_t & _charcode);
+         void                                     printCursor            (bool _isInsertMode,
                                                                           float _cursorSize);
+         void                                     disableCursor          (void );
+         void                                     setCursorPos           (int32_t _cursorPos);
+         void                                     setCursorSelection     (int32_t _cursorPos,
                                                                           int32_t _selectionStartPos);
+         void                                     setSelectionColor      (const etk::Color<> & _color);
+         void                                     setCursorColor         (const etk::Color<> & _color);
+
+

Object Hierarchy:

+
++ewol::Compositing
  +--> ewol::compositing::Text
+

Detail:

+

getDrawing

++ ewol::compositing::Drawing & getDrawing (void );
+ +
+
+
+

Text

++  Text (const std::string & _fontName,
         int32_t _fontSize);
+generic constructor
+ +
+
+

~Text

++  ~Text (void );
+generic destructor
+
+
+

translate

++ virtual void translate (const vec3 & _vect);
+translate the current display of this element
    + + +
    Parameter [input]:_vect The translation vector to apply at the transformation matrix
    +
+ +
+
+

rotate

++ virtual void rotate (const vec3 & _vect,
                       float _angle);
+rotate the curent display of this element
    + + +
    Parameter [input]:_vect The rotation vector to apply at the transformation matrix
    +
+ +
+
+

scale

++ virtual void scale (const vec3 & _vect);
+scale the current diaplsy of this element
    + + +
    Parameter [input]:_vect The scaling vector to apply at the transformation matrix
    +
+ +
+
+

draw

++ void draw (bool _disableDepthTest);
+ void draw (const mat4 & _transformationMatrix,
             bool _enableDepthTest);
+draw All the refistered text in the current element on openGL
+
+
+

clear

++ void clear (void );
+clear all the registered element in the current element
+
+
+

reset

++ void reset (void );
+clear all the intermediate result detween 2 prints
+
+
+

getPos

++ const vec3 & getPos (void );
+get the current display position (sometime needed in the gui control)
    + +
    Return: the current position.
    +
+ +
+
+

setPos

++ void setPos (const vec3 & _pos);
+ void setPos (const vec2 & _pos);
+set position for the next text writen
    + + +
    Parameter [input]:_pos Position of the text (in 3D)
    +
+ +
+
+

setRelPos

++ void setRelPos (const vec3 & _pos);
+ void setRelPos (const vec2 & _pos);
+set relative position for the next text writen
    + + +
    Parameter [input]:_pos ofset apply of the text (in 3D)
    +
+ +
+
+

setColor

++ void setColor (const etk::Color<> & _color);
+set the Color of the current foreground font
+ +
+
+

setColorBg

++ void setColorBg (const etk::Color<> & _color);
+set the background color of the font (for selected Text (not the global BG))
+ +
+
+

setClippingWidth

++ void setClippingWidth (const vec3 & _pos,
                         const vec3 & _width);
+ void setClippingWidth (const vec2 & _pos,
                         const vec2 & _width);
+Request a clipping area for the text (next draw only)
    + + + +
    Parameter [input]:_pos Start position of the clipping
    Parameter [input]:_width Width size of the clipping
    +
+ +
+
+

setClipping

++ void setClipping (const vec3 & _pos,
                    const vec3 & _posEnd);
+ void setClipping (const vec2 & _pos,
                    const vec2 & _posEnd);
+Request a clipping area for the text (next draw only)
    + + + +
    Parameter [input]:_pos Start position of the clipping
    Parameter [input]:_posEnd End position of the clipping
    +
+ +
+
+

setClippingMode

++ void setClippingMode (bool _newMode);
+enable/Disable the clipping (without lose the current clipping position)
_newMode The new status of the clipping
+
+
+

setFontSize

++ void setFontSize (int32_t _fontSize);
+Specify the font size (this reset the internal element of the current text (system requirement)
    + + +
    Parameter [input]:_fontSize New font size
    +
+ +
+
+

setFontName

++ void setFontName (const std::string & _fontName);
+Specify the font name (this reset the internal element of the current text (system requirement)
+ +
+
+

setFont

++ void setFont (std::string _fontName,
                int32_t _fontSize);
+Specify the font property (this reset the internal element of the current text (system requirement)
+ +
+
+

setFontMode

++ void setFontMode (enum ewol::font::mode _mode);
+Specify the font mode for the next @ref print
+ +
+
+

getFontMode

++ enum ewol::font::mode getFontMode (void );
+get the current font mode
+ +
+
+

setFontBold

++ void setFontBold (bool _status);
+enable or disable the bold mode
    + + +
    Parameter [input]:_status The new status for this display property
    +
+ +
+
+

setFontItalic

++ void setFontItalic (bool _status);
+enable or disable the italic mode
    + + +
    Parameter [input]:_status The new status for this display property
    +
+ +
+
+

setKerningMode

++ void setKerningMode (bool _newMode);
+set the activation of the Kerning for the display (if it existed)
    + + +
    Parameter [input]:_newMode enable/Diasable the kerning on this font.
    +
+ +
+
+

setDistanceFieldMode

++ void setDistanceFieldMode (bool _newMode);
+Request the distance field mode for this text display
    + + +
    Parameter [input]:_newMode enable/Diasable the Distance Field on this font.
    +
+ +
+
+

print

++ void print (const std::string & _text);
+ void print (const std::u32string & _text);
+display a compleat string in the current element.
+ +
+
+

printDecorated

++ void printDecorated (const std::string & _text);
+display a compleat string in the current element with the generic decoration specification. (basic html data)
+
+<br/>
+<br/><br/><br/>
+<center>
+	text exemple <b>in bold</b> other text <b>bold part <i>boldItalic part</i></b> an other thext
+	<font color="#FF0000">colored text <b>bold color text</b> <i>bold italic text</i> normal color text</font> the end of the string<br/>
+	an an other thext
+</center>
+<br/><br/><br/>
+<left>
+	plop 1
+</left>
+<br/><br/><br/>
+<right>
+	plop 2
+</right>
+<br/><br/><br/>
+<justify>
+	Un exemple de text
+</justify>
+
+
Note: This is parsed with tiny xml, then be carfull that the XML is correct, and all balises are closed ... otherwite the display can not be done
+ +
+
+

printHTML

++ void printHTML (const std::string & _text);
+display a compleat string in the current element with the generic decoration specification. (basic html data)
+
+<html>
+	<body>
+		<br/>
+		<br/><br/><br/>
+		<center>
+			text exemple <b>in bold</b> other text <b>bold part <i>boldItalic part</i></b> an other thext
+			<font color="#FF0000">colored text <b>bold color text</b> <i>bold italic text</i> normal color text</font> the end of the string<br/>
+			an an other thext
+		</center>
+		<br/><br/><br/>
+		<left>
+			plop 1
+		</left>
+		<br/><br/><br/>
+		<right>
+			plop 2
+		</right>
+		<br/><br/><br/>
+		<justify>
+			Un exemple de text
+		</justify>
+	</body>
+</html>
+
+
Note: This is parsed with tiny xml, then be carfull that the XML is correct, and all balises are closed ... otherwite the display can not be done
+ +
+
+

print

++ void print (const std::string & _text,
              const std::vector<TextDecoration> & _decoration);
+ void print (const std::u32string & _text,
              const std::vector<TextDecoration> & _decoration);
+display a compleat string in the current element whith specific decorations (advence mode).
+ +
+
+

print

++ void print (const char32_t & _charcode);
+display the current char in the current element (note that the kerning is availlable if the position is not changed)
    + + +
    Parameter [input]:_charcode Char that might be dispalyed
    +
+ +
+
+

forceLineReturn

++ void forceLineReturn (void );
+This generate the line return == > it return to the alignement position start and at the correct line position ==> it might be use to not know the line height
+
+
+

setTextAlignement

++ void setTextAlignement (float _startTextpos,
                          float _stopTextPos,
                          enum ewol::compositing::Text::aligneMode _alignement);
+This generate the possibility to generate the big text property
Note: The text align in center change of line every display done (even if it was just a char)
+ +
+
+

disableAlignement

++ void disableAlignement (void );
+disable the alignement system
+
+
+

getAlignement

++ enum ewol::compositing::Text::aligneMode getAlignement (void );
+get the current alignement property
+ +
+
+

calculateSizeHTML

++ vec3 calculateSizeHTML (const std::string & _text);
+calculate a theoric text size
+ +
+
+

calculateSizeDecorated

++ vec3 calculateSizeDecorated (const std::string & _text);
+calculate a theoric text size
+ +
+
+

calculateSize

++ vec3 calculateSize (const std::string & _text);
+calculate a theoric text size
+ +
+
+

calculateSize

++ vec3 calculateSize (const char32_t & _charcode);
+calculate a theoric charcode size
    + + +
    Parameter [input]:_charcode The µUnicode value to calculate dimention.
    Return: The theoric size used.
    +
+ +
+
+

printCursor

++ void printCursor (bool _isInsertMode,
                    float _cursorSize);
+draw a cursor at the specify position
    + + + +
    Parameter [input]:_isInsertMode True if the insert mode is activated
    Parameter [input]:_cursorSize The sizae of the cursor that might be set when insert mode is set [default 20]
    +
+ +
+
+

disableCursor

++ void disableCursor (void );
+remove the cursor display
+
+
+

setCursorPos

++ void setCursorPos (int32_t _cursorPos);
+set a cursor at a specific position:
    + + +
    Parameter [input]:_cursorPos id of the cursor position
    +
+ +
+
+

setCursorSelection

++ void setCursorSelection (int32_t _cursorPos,
                           int32_t _selectionStartPos);
+set a cursor at a specific position with his associated selection:
    + + + +
    Parameter [input]:_cursorPos id of the cursor position
    Parameter [input]:_selectionStartPos id of the starting of the selection
    +
+ +
+
+

setSelectionColor

++ void setSelectionColor (const etk::Color<> & _color);
+change the selection color
+ +
+
+

setCursorColor

++ void setCursorColor (const etk::Color<> & _color);
+change the cursor color
+ +
+
+
+ + + diff --git a/class_ewol__compositing__TextDecoration.html b/class_ewol__compositing__TextDecoration.html new file mode 100644 index 00000000..31ddd4fe --- /dev/null +++ b/class_ewol__compositing__TextDecoration.html @@ -0,0 +1,122 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::compositing::TextDecoration

Description:

+This class represent the specific display for every char in the string ...

+

Constructor and Destructor:

+
++              TextDecoration (void );
+
+

Synopsis:

+
++ etk::Color<> m_colorBg;
+ etk::Color<> m_colorFg;
+
+

Detail:

+

m_colorBg

++ etk::Color<> m_colorBg;
+ +display background color
+
+
+

m_colorFg

++ etk::Color<> m_colorFg;
+ +display foreground color +display mode Regular/Bold/Italic/BoldItalic
+
+
+

TextDecoration

++  TextDecoration (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__context__CommandLine.html b/class_ewol__context__CommandLine.html new file mode 100644 index 00000000..ac0a093c --- /dev/null +++ b/class_ewol__context__CommandLine.html @@ -0,0 +1,143 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::context::CommandLine

Description:

+ +

+

Synopsis:

+
++ void                     parse      (int32_t _argc,
                                       const char* _argv);
+ int32_t                  size       (void );
+ const std::string &      get        (int32_t _id);
+ void                     add        (const std::string & _newElement);
+ void                     remove     (int32_t _id);
+
+

Detail:

+

parse

++ void parse (int32_t _argc,
              const char* _argv);
+Parse the command line parameters
+
+
+

size

++ int32_t size (void );
+get the number of element in the Command line
    + +
    Return: the number of element
    +
+ +
+
+

get

++ const std::string & get (int32_t _id);
+get an element with a specific ID
+ +
+
+

add

++ void add (const std::string & _newElement);
+add one element at the Command line
+ +
+
+

remove

++ void remove (int32_t _id);
+remove an element
+ +
+
+
+ + + diff --git a/class_ewol__context__ConfigFont.html b/class_ewol__context__ConfigFont.html new file mode 100644 index 00000000..c63bd420 --- /dev/null +++ b/class_ewol__context__ConfigFont.html @@ -0,0 +1,179 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::context::ConfigFont

Description:

+ +

+

Constructor and Destructor:

+
++                     ConfigFont     (void );
+                     ~ConfigFont    (void );
+
+

Synopsis:

+
++ void                setFolder      (const std::string & _folder);
+ const std::string & getFolder      (void );
+ void                set            (const std::string & _fontName,
                                      int32_t _size);
+ const std::string & getName        (void );
+ int32_t             getSize        (void );
+ void                setUseExternal (bool _val);
+ bool                getUseExternal (void );
+
+

Detail:

+

ConfigFont

++  ConfigFont (void );
+ +Constructor / destructor
+
+
+

~ConfigFont

++  ~ConfigFont (void );
+ +
+
+
+

setFolder

++ void setFolder (const std::string & _folder);
+Specify the default font folder for the Ewol search system (only needed when embended font)
+ +
+
+

getFolder

++ const std::string & getFolder (void );
+get the default font folder.
+ +
+
+

set

++ void set (const std::string & _fontName,
            int32_t _size);
+set the defaut font for all the widgets and basics display.
+ +
+
+

getName

++ const std::string & getName (void );
+get the current default font name
+
+
+

getSize

++ int32_t getSize (void );
+get the default font size.
    + +
    Return: the font size.
    +
+ +
+
+

setUseExternal

++ void setUseExternal (bool _val);
+set use of internal/external Font
    + + +
    Parameter [input]:_val true to enable search of internal data.
    +
+ +
+
+

getUseExternal

++ bool getUseExternal (void );
+get the use of internal/external Font
    + +
    Return: true to enable search of internal data.
    +
+ +
+
+
+ + + diff --git a/class_ewol__context__Fps.html b/class_ewol__context__Fps.html new file mode 100644 index 00000000..fa615be4 --- /dev/null +++ b/class_ewol__context__Fps.html @@ -0,0 +1,138 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::context::Fps

Description:

+This class is designed to count the number of frame per second in the main renderer system

+

Constructor and Destructor:

+
++             Fps              (const char* displayName,
                                bool displayFPS);
+             ~Fps             (void );
+
+

Synopsis:

+
++ void        tic              (void );
+ void        toc              (bool displayTime);
+ void        incrementCounter (void );
+ void        draw             (void );
+
+

Detail:

+

Fps

++  Fps (const char* displayName,
        bool displayFPS);
+Constructor
+
+
+

~Fps

++  ~Fps (void );
+Destructor
+
+
+

tic

++ void tic (void );
+this might be call every time a diplay start
+
+
+

toc

++ void toc (bool displayTime);
+this might be call every time a diplay stop, it do the display every second
    + + +
    Parameter [input]:displayTime display curent time of the frame.
    +
+ +
+
+

incrementCounter

++ void incrementCounter (void );
+this might be call when a display is really done
+
+
+

draw

++ void draw (void );
+draw debug display ...
+
+
+
+ + + diff --git a/class_ewol__context__InputLimit.html b/class_ewol__context__InputLimit.html new file mode 100644 index 00000000..3c370f94 --- /dev/null +++ b/class_ewol__context__InputLimit.html @@ -0,0 +1,111 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::context::InputLimit

Description:

+internal structure

+

Synopsis:

+
++ int32_t sepatateTime;
+ int32_t DpiOffset;
+
+

Detail:

+

sepatateTime

++ int32_t sepatateTime;
+ +
+
+
+

DpiOffset

++ int32_t DpiOffset;
+ +
+
+
+
+ + + diff --git a/class_ewol__context__InputManager.html b/class_ewol__context__InputManager.html new file mode 100644 index 00000000..77860f04 --- /dev/null +++ b/class_ewol__context__InputManager.html @@ -0,0 +1,175 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::context::InputManager

Description:

+ +

+

Constructor and Destructor:

+
++                 InputManager          (ewol::Context & _context);
+                 ~InputManager         (void );
+
+

Synopsis:

+
++ void            setDpi                (int32_t newDPI);
+ void            motion                (enum ewol::key::type _type,
                                         int _pointerID,
                                         vec2 _pos);
+ void            state                 (enum ewol::key::type _type,
                                         int _pointerID,
                                         bool _isDown,
                                         vec2 _pos);
+ void            onObjectRemove        (ewol::Object* _removeObject);
+ void            newLayerSet           (void );
+ void            transfertEvent        (ewol::Widget* _source,
                                         ewol::Widget* _destination);
+ void            grabPointer           (ewol::Widget* _widget);
+ void            unGrabPointer         (void );
+
+

Detail:

+

InputManager

++  InputManager (ewol::Context & _context);
+ +
+
+
+

~InputManager

++  ~InputManager (void );
+ +
+
+
+

setDpi

++ void setDpi (int32_t newDPI);
+ +
+
+
+

motion

++ void motion (enum ewol::key::type _type,
               int _pointerID,
               vec2 _pos);
+ +
+
+
+

state

++ void state (enum ewol::key::type _type,
              int _pointerID,
              bool _isDown,
              vec2 _pos);
+ +
+
+
+

onObjectRemove

++ void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

newLayerSet

++ void newLayerSet (void );
+a new layer on the windows is set == > might remove all the property of the current element ...
+
+
+

transfertEvent

++ void transfertEvent (ewol::Widget* _source,
                       ewol::Widget* _destination);
+This is to transfert the event from one widget to another one
+ +
+
+

grabPointer

++ void grabPointer (ewol::Widget* _widget);
+This fonction lock the pointer properties to move in relative instead of absolute
+ +
+
+

unGrabPointer

++ void unGrabPointer (void );
+This fonction un-lock the pointer properties to move in relative instead of absolute
+
+
+
+ + + diff --git a/class_ewol__context__InputPoperty.html b/class_ewol__context__InputPoperty.html new file mode 100644 index 00000000..9ea38a87 --- /dev/null +++ b/class_ewol__context__InputPoperty.html @@ -0,0 +1,165 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::context::InputPoperty

Description:

+internal structure

+

Synopsis:

+
++ bool          isUsed;
+ int32_t       destinationInputId;
+ int64_t       lastTimeEvent;
+ ewol::Widget* curentWidgetEvent;
+ vec2          origin;
+ vec2          size;
+ vec2          downStart;
+ vec2          posEvent;
+ bool          isDown;
+ bool          isInside;
+ int32_t       nbClickEvent;
+
+

Detail:

+

isUsed

++ bool isUsed;
+ +
+
+
+

destinationInputId

++ int32_t destinationInputId;
+ +
+
+
+

lastTimeEvent

++ int64_t lastTimeEvent;
+ +
+
+
+

curentWidgetEvent

++ ewol::Widget* curentWidgetEvent;
+ +
+
+
+

origin

++ vec2 origin;
+ +
+
+
+

size

++ vec2 size;
+ +
+
+
+

downStart

++ vec2 downStart;
+ +
+
+
+

posEvent

++ vec2 posEvent;
+ +
+
+
+

isDown

++ bool isDown;
+ +
+
+
+

isInside

++ bool isInside;
+ +
+
+
+

nbClickEvent

++ int32_t nbClickEvent;
+ +
+
+
+
+ + + diff --git a/class_ewol__event__Entry.html b/class_ewol__event__Entry.html new file mode 100644 index 00000000..8591464d --- /dev/null +++ b/class_ewol__event__Entry.html @@ -0,0 +1,158 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::event::Entry

Description:

+ +

+

Constructor and Destructor:

+
++                                  Entry         (enum ewol::key::keyboard _type,
                                                  enum ewol::key::status _status,
                                                  ewol::key::Special _specialKey,
                                                  char32_t _char);
+
+

Synopsis:

+
++ void                             setType       (enum ewol::key::keyboard _type);
+ const enum ewol::key::keyboard & getType       (void ) const;
+ void                             setStatus     (enum ewol::key::status _status);
+ const enum ewol::key::status &   getStatus     (void ) const;
+ void                             setSpecialKey (const ewol::key::Special & _specialKey);
+ const ewol::key::Special &       getSpecialKey (void ) const;
+ void                             setChar       (char32_t _char);
+ const char32_t &                 getChar       (void ) const;
+
+

Detail:

+

Entry

++  Entry (enum ewol::key::keyboard _type,
          enum ewol::key::status _status,
          ewol::key::Special _specialKey,
          char32_t _char);
+ +
+
+
+

setType

++ void setType (enum ewol::key::keyboard _type);
+ +
+
+
+

getType

++ const enum ewol::key::keyboard & getType (void ) const;
+ +
+
+
+

setStatus

++ void setStatus (enum ewol::key::status _status);
+ +
+
+
+

getStatus

++ const enum ewol::key::status & getStatus (void ) const;
+ +
+
+
+

setSpecialKey

++ void setSpecialKey (const ewol::key::Special & _specialKey);
+ +
+
+
+

getSpecialKey

++ const ewol::key::Special & getSpecialKey (void ) const;
+ +
+
+
+

setChar

++ void setChar (char32_t _char);
+ +
+
+
+

getChar

++ const char32_t & getChar (void ) const;
+ +
+
+
+
+ + + diff --git a/class_ewol__event__EntrySystem.html b/class_ewol__event__EntrySystem.html new file mode 100644 index 00000000..cf36fd49 --- /dev/null +++ b/class_ewol__event__EntrySystem.html @@ -0,0 +1,116 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::event::EntrySystem

Description:

+ +

+

Constructor and Destructor:

+
++                    EntrySystem (enum ewol::key::keyboard _type,
                                  enum ewol::key::status _status,
                                  ewol::key::Special _specialKey,
                                  char32_t _char);
+
+

Synopsis:

+
++ ewol::event::Entry m_event;
+
+

Detail:

+

EntrySystem

++  EntrySystem (enum ewol::key::keyboard _type,
                enum ewol::key::status _status,
                ewol::key::Special _specialKey,
                char32_t _char);
+ +
+
+
+

m_event

++ ewol::event::Entry m_event;
+ +
+
+
+
+ + + diff --git a/class_ewol__event__Input.html b/class_ewol__event__Input.html new file mode 100644 index 00000000..32b3d34a --- /dev/null +++ b/class_ewol__event__Input.html @@ -0,0 +1,158 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::event::Input

Description:

+ +

+

Constructor and Destructor:

+
++                                Input     (enum ewol::key::type _type,
                                            enum ewol::key::status _status,
                                            uint8_t _id,
                                            const vec2 & _pos);
+
+

Synopsis:

+
++ void                           setType   (enum ewol::key::type _type);
+ const enum ewol::key::type &   getType   (void ) const;
+ void                           setStatus (enum ewol::key::status _status);
+ const enum ewol::key::status & getStatus (void ) const;
+ void                           setId     (uint8_t _id);
+ const uint8_t &                getId     (void ) const;
+ void                           setPos    (const vec2 & _pos);
+ const vec2 &                   getPos    (void ) const;
+
+

Detail:

+

Input

++  Input (enum ewol::key::type _type,
          enum ewol::key::status _status,
          uint8_t _id,
          const vec2 & _pos);
+ +
+
+
+

setType

++ void setType (enum ewol::key::type _type);
+ +
+
+
+

getType

++ const enum ewol::key::type & getType (void ) const;
+ +
+
+
+

setStatus

++ void setStatus (enum ewol::key::status _status);
+ +
+
+
+

getStatus

++ const enum ewol::key::status & getStatus (void ) const;
+ +
+
+
+

setId

++ void setId (uint8_t _id);
+ +
+
+
+

getId

++ const uint8_t & getId (void ) const;
+ +
+
+
+

setPos

++ void setPos (const vec2 & _pos);
+ +
+
+
+

getPos

++ const vec2 & getPos (void ) const;
+ +
+
+
+
+ + + diff --git a/class_ewol__event__InputSystem.html b/class_ewol__event__InputSystem.html new file mode 100644 index 00000000..6fedbd97 --- /dev/null +++ b/class_ewol__event__InputSystem.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::event::InputSystem

Description:

+ +

+

Constructor and Destructor:

+
++                    InputSystem   (enum ewol::key::type _type,
                                    enum ewol::key::status _status,
                                    uint8_t _id,
                                    const vec2 & _pos,
                                    ewol::Widget* _dest,
                                    int32_t _realIdEvent);
+
+

Synopsis:

+
++ ewol::event::Input m_event;
+ void               setDestWidget (ewol::Widget* _dest);
+ ewol::Widget*      getDestWidget (void ) const;
+ void               setRealId     (int32_t _realIdEvent);
+ int32_t            getRealId     (void ) const;
+
+

Detail:

+

InputSystem

++  InputSystem (enum ewol::key::type _type,
                enum ewol::key::status _status,
                uint8_t _id,
                const vec2 & _pos,
                ewol::Widget* _dest,
                int32_t _realIdEvent);
+ +
+
+
+

m_event

++ ewol::event::Input m_event;
+ +
+
+
+

setDestWidget

++ void setDestWidget (ewol::Widget* _dest);
+ +
+
+
+

getDestWidget

++ ewol::Widget* getDestWidget (void ) const;
+ +
+
+
+

setRealId

++ void setRealId (int32_t _realIdEvent);
+ +
+
+
+

getRealId

++ int32_t getRealId (void ) const;
+ +
+
+
+
+ + + diff --git a/class_ewol__event__Time.html b/class_ewol__event__Time.html new file mode 100644 index 00000000..140a93e6 --- /dev/null +++ b/class_ewol__event__Time.html @@ -0,0 +1,164 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::event::Time

Description:

+ +

+

Constructor and Destructor:

+
++         Time              (int64_t _timeSystem,
                             int64_t _timeUpAppl,
                             float _timeDelta,
                             float _timeDeltaCall);
+
+

Synopsis:

+
++ void    setTime           (int64_t _timeSystem);
+ int64_t getTime           (void ) const;
+ void    setApplWakeUpTime (int64_t _timeUpAppl);
+ int64_t getApplWakeUpTime (void ) const;
+ int64_t getApplUpTime     (void ) const;
+ void    setDelta          (float _timeDelta);
+ float   getDelta          (void ) const;
+ void    setDeltaCall      (float _timeDeltaCall);
+ float   getDeltaCall      (void ) const;
+
+

Detail:

+

Time

++  Time (int64_t _timeSystem,
         int64_t _timeUpAppl,
         float _timeDelta,
         float _timeDeltaCall);
+ +
+
+
+

setTime

++ void setTime (int64_t _timeSystem);
+ +
+
+
+

getTime

++ int64_t getTime (void ) const;
+ +
+
+
+

setApplWakeUpTime

++ void setApplWakeUpTime (int64_t _timeUpAppl);
+ +
+
+
+

getApplWakeUpTime

++ int64_t getApplWakeUpTime (void ) const;
+ +
+
+
+

getApplUpTime

++ int64_t getApplUpTime (void ) const;
+ +
+
+
+

setDelta

++ void setDelta (float _timeDelta);
+ +
+
+
+

getDelta

++ float getDelta (void ) const;
+ +
+
+
+

setDeltaCall

++ void setDeltaCall (float _timeDeltaCall);
+ +
+
+
+

getDeltaCall

++ float getDeltaCall (void ) const;
+ +
+
+
+
+ + + diff --git a/class_ewol__key__Special.html b/class_ewol__key__Special.html new file mode 100644 index 00000000..942c0768 --- /dev/null +++ b/class_ewol__key__Special.html @@ -0,0 +1,260 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::key::Special

Description:

+This class consider generic special keyborad key (insert, control, shift ...)

+

Constructor and Destructor:

+
++          Special     (void );
+
+

Synopsis:

+
++ bool     getCapsLock (void ) const;
+ void     setCapsLock (bool _value);
+ bool     getShift    (void ) const;
+ void     setShift    (bool _value);
+ bool     getCtrl     (void ) const;
+ void     setCtrl     (bool _value);
+ bool     getMeta     (void ) const;
+ void     setMeta     (bool _value);
+ bool     getAlt      (void ) const;
+ void     setAlt      (bool _value);
+ bool     getAltGr    (void ) const;
+ void     setAltGr    (bool _value);
+ bool     getNumLock  (void ) const;
+ void     setNumLock  (bool _value);
+ bool     getInsert   (void ) const;
+ void     setInsert   (bool _value);
+
+

Detail:

+

Special

++  Special (void );
+Main constructor
+
+
+

getCapsLock

++ bool getCapsLock (void ) const;
+get the current CapLock Status
    + +
    Return: The CapLock value
    +
+ +
+
+

setCapsLock

++ void setCapsLock (bool _value);
+set the current CapLock Status
    + + +
    Parameter [input]:_value The new CapLock value
    +
+ +
+
+

getShift

++ bool getShift (void ) const;
+Get the current Shift key status
    + +
    Return: The Shift value
    +
+ +
+
+

setShift

++ void setShift (bool _value);
+Set the current Shift key status
    + + +
    Parameter [input]:_value The new Shift value
    +
+ +
+
+

getCtrl

++ bool getCtrl (void ) const;
+Get the Current Control key status
    + +
    Return: The Control value
    +
+ +
+
+

setCtrl

++ void setCtrl (bool _value);
+Set the Current Control key status
    + + +
    Parameter [input]:_value The new Control value
    +
+ +
+
+

getMeta

++ bool getMeta (void ) const;
+Get the current Meta key status (also named windows or apple key)
    + +
    Return: The Meta value (name Windows key, apple key, command key ...)
    +
+ +
+
+

setMeta

++ void setMeta (bool _value);
+Set the current Meta key status (also named windows or apple key)
    + + +
    Parameter [input]:_value The new Meta value (name Windows key, apple key, command key ...)
    +
+ +
+
+

getAlt

++ bool getAlt (void ) const;
+Get the current Alt key status
    + +
    Return: The Alt value
    +
+ +
+
+

setAlt

++ void setAlt (bool _value);
+Set the current Alt key status
    + + +
    Parameter [input]:_value The new Alt value
    +
+ +
+
+

getAltGr

++ bool getAltGr (void ) const;
+Get the current Alt-Gr key status
    + +
    Return: The Alt-gr value (does not exist on MacOs)
    +
+ +
+
+

setAltGr

++ void setAltGr (bool _value);
+Set the current Alt-Gr key status
    + + +
    Parameter [input]:_value The new Alt-gr value (does not exist on MacOs)
    +
+ +
+
+

getNumLock

++ bool getNumLock (void ) const;
+Get the current Ver-num key status
    + +
    Return: The Numerical Lock value
    +
+ +
+
+

setNumLock

++ void setNumLock (bool _value);
+Set the current Ver-num key status
    + + +
    Parameter [input]:_value The new Numerical Lock value
    +
+ +
+
+

getInsert

++ bool getInsert (void ) const;
+Get the current Intert key status
    + +
    Return: The Insert value
    +
+ +
+
+

setInsert

++ void setInsert (bool _value);
+Set the current Intert key status
    + + +
    Parameter [input]:_value The new Insert value
    +
+ +
+
+
+ + + diff --git a/class_ewol__object__Config.html b/class_ewol__object__Config.html new file mode 100644 index 00000000..720d7502 --- /dev/null +++ b/class_ewol__object__Config.html @@ -0,0 +1,134 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::object::Config

Description:

+ +

+

Constructor and Destructor:

+
++                     Config    (const char* _config,
                                 const std::string & _data);
+
+

Synopsis:

+
++ void                setConfig (const char* _config);
+ const char*         getConfig (void ) const;
+ void                setData   (const std::string & _data);
+ const std::string & getData   (void ) const;
+
+

Detail:

+

Config

++  Config (const char* _config,
           const std::string & _data);
+ +
+
+
+

setConfig

++ void setConfig (const char* _config);
+ +
+
+
+

getConfig

++ const char* getConfig (void ) const;
+ +
+
+
+

setData

++ void setData (const std::string & _data);
+ +
+
+
+

getData

++ const std::string & getData (void ) const;
+ +
+
+
+
+ + + diff --git a/class_ewol__object__ConfigElement.html b/class_ewol__object__ConfigElement.html new file mode 100644 index 00000000..e1e7ea53 --- /dev/null +++ b/class_ewol__object__ConfigElement.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::object::ConfigElement

Description:

+ +

+

Constructor and Destructor:

+
++             ConfigElement  (const char* _config,
                              const char* _type,
                              const char* _control,
                              const char* _description,
                              const char* _default);
+
+

Synopsis:

+
++ const char* getConfig      (void ) const;
+ const char* getType        (void ) const;
+ const char* getControl     (void ) const;
+ const char* getDescription (void ) const;
+ const char* getDefault     (void ) const;
+
+

Detail:

+

ConfigElement

++  ConfigElement (const char* _config,
                  const char* _type,
                  const char* _control,
                  const char* _description,
                  const char* _default);
+ +
+
+
+

getConfig

++ const char* getConfig (void ) const;
+ +
+
+
+

getType

++ const char* getType (void ) const;
+ +
+
+
+

getControl

++ const char* getControl (void ) const;
+ +
+
+
+

getDescription

++ const char* getDescription (void ) const;
+ +
+
+
+

getDefault

++ const char* getDefault (void ) const;
+ +
+
+
+
+ + + diff --git a/class_ewol__object__EventExtGen.html b/class_ewol__object__EventExtGen.html new file mode 100644 index 00000000..c924f59a --- /dev/null +++ b/class_ewol__object__EventExtGen.html @@ -0,0 +1,121 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::object::EventExtGen

Synopsis:

+
++ const char*   localEventId;
+ ewol::Object* destObject;
+ const char*   destEventId;
+ std::string   overloadData;
+
+

Detail:

+

localEventId

++ const char* localEventId;
+ +local event Id generation
+
+
+

destObject

++ ewol::Object* destObject;
+ +destination widget that might be call
+
+
+

destEventId

++ const char* destEventId;
+ +generated event ID on the distant widget
+
+
+

overloadData

++ std::string overloadData;
+ +sometimes the user prefer to receive some specific data on an event (instead of the one sed by the widget)
+
+
+
+ + + diff --git a/class_ewol__object__Manager.html b/class_ewol__object__Manager.html new file mode 100644 index 00000000..0ded7f8f --- /dev/null +++ b/class_ewol__object__Manager.html @@ -0,0 +1,163 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::object::Manager

Description:

+ +

+

Constructor and Destructor:

+
++                            Manager                  (void );
+                            ~Manager                 (void );
+
+

Synopsis:

+
++ void                       unInit                   (void );
+ void                       add                      (ewol::Object* _object);
+ void                       rm                       (ewol::Object* _object);
+ int32_t                    getNumberObject          (void );
+ void                       autoRemove               (ewol::Object* _object);
+ void                       removeAllAutoRemove      (void );
+ ewol::Object*              get                      (const std::string & _name);
+ ewol::object::MultiCast &  multiCast                (void );
+
+

Detail:

+

Manager

++  Manager (void );
+ +
+
+
+

~Manager

++  ~Manager (void );
+ +
+
+
+

unInit

++ void unInit (void );
+remove all resources (un-init) out of the destructor (due to the system implementation)
+
+
+

add

++ void add (ewol::Object* _object);
+ +
+
+
+

rm

++ void rm (ewol::Object* _object);
+ +
+
+
+

getNumberObject

++ int32_t getNumberObject (void );
+ +
+
+
+

autoRemove

++ void autoRemove (ewol::Object* _object);
+ +
+
+
+

removeAllAutoRemove

++ void removeAllAutoRemove (void );
+ +
+
+
+

get

++ ewol::Object* get (const std::string & _name);
+ +
+
+
+

multiCast

++ ewol::object::MultiCast & multiCast (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__object__Message.html b/class_ewol__object__Message.html new file mode 100644 index 00000000..7658ff68 --- /dev/null +++ b/class_ewol__object__Message.html @@ -0,0 +1,146 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::object::Message

Description:

+ +

+

Constructor and Destructor:

+
++                     Message        (ewol::Object* _caller,
                                      const char* _message,
                                      const std::string & _data);
+
+

Synopsis:

+
++ void                setCaller      (ewol::Object* _caller);
+ ewol::Object*       getCaller      (void ) const;
+ void                setMessage     (const char* _message);
+ const char*         getMessage     (void ) const;
+ void                setData        (const std::string & _data);
+ const std::string & getData        (void ) const;
+
+

Detail:

+

Message

++  Message (ewol::Object* _caller,
            const char* _message,
            const std::string & _data);
+ +
+
+
+

setCaller

++ void setCaller (ewol::Object* _caller);
+ +
+
+
+

getCaller

++ ewol::Object* getCaller (void ) const;
+ +
+
+
+

setMessage

++ void setMessage (const char* _message);
+ +
+
+
+

getMessage

++ const char* getMessage (void ) const;
+ +
+
+
+

setData

++ void setData (const std::string & _data);
+ +
+
+
+

getData

++ const std::string & getData (void ) const;
+ +
+
+
+
+ + + diff --git a/class_ewol__object__MultiCast.html b/class_ewol__object__MultiCast.html new file mode 100644 index 00000000..03694962 --- /dev/null +++ b/class_ewol__object__MultiCast.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::object::MultiCast

Description:

+ +

+

Constructor and Destructor:

+
++                          MultiCast     (void );
+                          ~MultiCast    (void );
+
+

Synopsis:

+
++ void                     anonymousSend (const char* const _messageId,
                                          const std::string & _data);
+ void                     send          (ewol::Object* _object,
                                          const char* const _message,
                                          const std::string & _data);
+ void                     rm            (ewol::Object* _object);
+ void                     add           (ewol::Object* _object,
                                          const char* const _message);
+
+

Detail:

+

MultiCast

++  MultiCast (void );
+ +
+
+
+

~MultiCast

++  ~MultiCast (void );
+ +
+
+
+

anonymousSend

++ void anonymousSend (const char* const _messageId,
                      const std::string & _data);
+ +
+
+
+

send

++ void send (ewol::Object* _object,
             const char* const _message,
             const std::string & _data);
+ +
+
+
+

rm

++ void rm (ewol::Object* _object);
+ +
+
+
+

add

++ void add (ewol::Object* _object,
            const char* const _message);
+ +
+
+
+
+ + + diff --git a/class_ewol__object__MultiCast__MessageList.html b/class_ewol__object__MultiCast__MessageList.html new file mode 100644 index 00000000..8e4cfae9 --- /dev/null +++ b/class_ewol__object__MultiCast__MessageList.html @@ -0,0 +1,122 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::object::MultiCast::MessageList

Description:

+ +

+

Constructor and Destructor:

+
++               MessageList (const char* _message,
                             ewol::Object* _object);
+
+

Synopsis:

+
++ const char*   m_message;
+ ewol::Object* m_object;
+
+

Detail:

+

MessageList

++  MessageList (const char* _message,
                ewol::Object* _object);
+ +
+
+
+

m_message

++ const char* m_message;
+ +
+
+
+

m_object

++ ewol::Object* m_object;
+ +
+
+
+
+ + + diff --git a/class_ewol__resource__Colored3DObject.html b/class_ewol__resource__Colored3DObject.html new file mode 100644 index 00000000..aa9d7add --- /dev/null +++ b/class_ewol__resource__Colored3DObject.html @@ -0,0 +1,180 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::Colored3DObject

Description:

+ +

+

Constructor and Destructor:

+
+#                                          Colored3DObject  (void );
# virtual                                  ~Colored3DObject (void );
+
+

Synopsis:

+
+#         ewol::resource::Program*         m_GLprogram;
#         int32_t                          m_GLPosition;
#         int32_t                          m_GLMatrix;
#         int32_t                          m_GLColor;
+ virtual void                             draw         (std::vector<vec3> & _vertices,
                                                         const etk::Color<float> & _color,
                                                         bool _updateDepthBuffer,
                                                         bool _depthtest);
+ virtual void                             draw         (std::vector<vec3> & _vertices,
                                                         const etk::Color<float> & _color,
                                                         mat4 & _transformationMatrix,
                                                         bool _updateDepthBuffer,
                                                         bool _depthtest);
+ virtual void                             drawLine     (std::vector<vec3> & _vertices,
                                                         const etk::Color<float> & _color,
                                                         mat4 & _transformationMatrix,
                                                         bool _updateDepthBuffer,
                                                         bool _depthtest);
+         ewol::resource::Colored3DObject* keep         (void );
+         void                             release      (ewol::resource::Colored3DObject* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> ewol::resource::Colored3DObject
+

Detail:

+

m_GLprogram

+# ewol::resource::Program* m_GLprogram;
+ +
+
+
+

m_GLPosition

+# int32_t m_GLPosition;
+ +
+
+
+

m_GLMatrix

+# int32_t m_GLMatrix;
+ +
+
+
+

m_GLColor

+# int32_t m_GLColor;
+ +
+
+
+

Colored3DObject

+#  Colored3DObject (void );
+ +
+
+
+

~Colored3DObject

+# virtual  ~Colored3DObject (void );
+ +
+
+
+

draw

++ virtual void draw (std::vector<vec3> & _vertices,
                     const etk::Color<float> & _color,
                     bool _updateDepthBuffer,
                     bool _depthtest);
+ +
+
+
+

draw

++ virtual void draw (std::vector<vec3> & _vertices,
                     const etk::Color<float> & _color,
                     mat4 & _transformationMatrix,
                     bool _updateDepthBuffer,
                     bool _depthtest);
+ +
+
+
+

drawLine

++ virtual void drawLine (std::vector<vec3> & _vertices,
                         const etk::Color<float> & _color,
                         mat4 & _transformationMatrix,
                         bool _updateDepthBuffer,
                         bool _depthtest);
+ +
+
+
+

keep

++ ewol::resource::Colored3DObject* keep (void );
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::Colored3DObject* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__ConfigFile.html b/class_ewol__resource__ConfigFile.html new file mode 100644 index 00000000..596f8fa9 --- /dev/null +++ b/class_ewol__resource__ConfigFile.html @@ -0,0 +1,169 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::ConfigFile

Description:

+ +

+

Constructor and Destructor:

+
+#                                                   ConfigFile    (const std::string & _filename);
# virtual                                                   ~ConfigFile   (void );
+
+

Synopsis:

+
++ void                                              reload        (void );
+ int32_t                                           request       (const std::string & _paramName);
+ int32_t                                           getInteger    (int32_t _id);
+ float                                             getFloat      (int32_t _id);
+ std::string &                                     getString     (int32_t _id);
+ ewol::resource::ConfigFile*                       keep          (const std::string & _filename);
+ void                                              release       (ewol::resource::ConfigFile* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> ewol::resource::ConfigFile
+

Detail:

+

ConfigFile

+#  ConfigFile (const std::string & _filename);
+ +
+
+
+

~ConfigFile

+# virtual  ~ConfigFile (void );
+ +
+
+
+

reload

++ void reload (void );
+ +
+
+
+

request

++ int32_t request (const std::string & _paramName);
+ +
+
+
+

getInteger

++ int32_t getInteger (int32_t _id);
+ +
+
+
+

getFloat

++ float getFloat (int32_t _id);
+ +
+
+
+

getString

++ std::string & getString (int32_t _id);
+ +
+
+
+

keep

++ ewol::resource::ConfigFile* keep (const std::string & _filename);
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::ConfigFile* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__FontBase.html b/class_ewol__resource__FontBase.html new file mode 100644 index 00000000..1756da8f --- /dev/null +++ b/class_ewol__resource__FontBase.html @@ -0,0 +1,155 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::FontBase

Description:

+ +

+

Constructor and Destructor:

+
++                 FontBase         (const std::string & _fontName);
+ virtual         ~FontBase        (void );
+
+

Synopsis:

+
++ virtual bool    getGlyphProperty (int32_t _fontSize,
                                    ewol::GlyphProperty & _property) = 0;
+ virtual bool    drawGlyph        (egami::Image & _imageOut,
                                    int32_t _fontSize,
                                    ivec2 _glyphPosition,
                                    ewol::GlyphProperty & _property,
                                    int8_t _posInImage) = 0;
+ virtual vec2    getSize          (int32_t _fontSize,
                                    const std::string & _unicodeString) = 0;
+ virtual int32_t getHeight        (int32_t _fontSize) = 0;
+ virtual void    generateKerning  (int32_t _fontSize,
                                    std::vector<ewol::GlyphProperty> & _listGlyph);
+ virtual void    display          (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> ewol::resource::FontBase
                +--> ewol::resource::FontFreeType
+

Detail:

+

FontBase

++  FontBase (const std::string & _fontName);
+ +
+
+
+

~FontBase

++ virtual  ~FontBase (void );
+ +
+
+
+

getGlyphProperty

++ virtual bool getGlyphProperty (int32_t _fontSize,
                                 ewol::GlyphProperty & _property) = 0;
+ +
+
+
+

drawGlyph

++ virtual bool drawGlyph (egami::Image & _imageOut,
                          int32_t _fontSize,
                          ivec2 _glyphPosition,
                          ewol::GlyphProperty & _property,
                          int8_t _posInImage) = 0;
+ +
+
+
+

getSize

++ virtual vec2 getSize (int32_t _fontSize,
                        const std::string & _unicodeString) = 0;
+ +
+
+
+

getHeight

++ virtual int32_t getHeight (int32_t _fontSize) = 0;
+ +
+
+
+

generateKerning

++ virtual void generateKerning (int32_t _fontSize,
                                std::vector<ewol::GlyphProperty> & _listGlyph);
+ +
+
+
+

display

++ virtual void display (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__resource__FontFreeType.html b/class_ewol__resource__FontFreeType.html new file mode 100644 index 00000000..67271d0c --- /dev/null +++ b/class_ewol__resource__FontFreeType.html @@ -0,0 +1,169 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::FontFreeType

Description:

+ +

+

Constructor and Destructor:

+
+#                           FontFreeType     (const std::string & _fontName);
#                           ~FontFreeType    (void );
+
+

Synopsis:

+
++ bool                      getGlyphProperty (int32_t _fontSize,
                                              ewol::GlyphProperty & _property);
+ bool                      drawGlyph        (egami::Image & _imageOut,
                                              int32_t _fontSize,
                                              ivec2 _glyphPosition,
                                              ewol::GlyphProperty & _property,
                                              int8_t _posInImage);
+ vec2                      getSize          (int32_t _fontSize,
                                              const std::string & _unicodeString);
+ int32_t                   getHeight        (int32_t _fontSize);
+ void                      generateKerning  (int32_t _fontSize,
                                              std::vector<ewol::GlyphProperty> & _listGlyph);
+ ewol::resource::FontBase* keep             (const std::string & _filename);
+ void                      release          (ewol::resource::FontBase* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> +ewol::resource::FontBase
                +--> ewol::resource::FontFreeType
+

Detail:

+

FontFreeType

+#  FontFreeType (const std::string & _fontName);
+ +
+
+
+

~FontFreeType

+#  ~FontFreeType (void );
+ +
+
+
+

getGlyphProperty

++ bool getGlyphProperty (int32_t _fontSize,
                         ewol::GlyphProperty & _property);
+ +
+
+
+

drawGlyph

++ bool drawGlyph (egami::Image & _imageOut,
                  int32_t _fontSize,
                  ivec2 _glyphPosition,
                  ewol::GlyphProperty & _property,
                  int8_t _posInImage);
+ +
+
+
+

getSize

++ vec2 getSize (int32_t _fontSize,
                const std::string & _unicodeString);
+ +
+
+
+

getHeight

++ int32_t getHeight (int32_t _fontSize);
+ +
+
+
+

generateKerning

++ void generateKerning (int32_t _fontSize,
                        std::vector<ewol::GlyphProperty> & _listGlyph);
+ +
+
+
+

keep

++ ewol::resource::FontBase* keep (const std::string & _filename);
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::FontBase* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__Manager.html b/class_ewol__resource__Manager.html new file mode 100644 index 00000000..0d886492 --- /dev/null +++ b/class_ewol__resource__Manager.html @@ -0,0 +1,177 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::Manager

Description:

+ +

+

Constructor and Destructor:

+
++                                      Manager                 (void );
+                                      ~Manager                (void );
+
+

Synopsis:

+
++         void                         unInit                  (void );
+         void                         display                 (void );
+         void                         reLoadResources         (void );
+         void                         update                  (ewol::Resource* _object);
+         void                         updateContext           (void );
+         void                         contextHasBeenDestroyed (void );
+         ewol::Resource*              localKeep               (const std::string & _filename);
+         void                         localAdd                (ewol::Resource* _object);
+         bool                         release                 (ewol::Resource* & _object);
+ virtual void                         onObjectRemove          (ewol::Object* _removeObject);
+
+

Detail:

+

Manager

++  Manager (void );
+initialize the internal variable
+
+
+

~Manager

++  ~Manager (void );
+Uninitiamize the resource manager, free all resources previously requested
Note: when not free == > generate warning, because the segfault can appear after...
+
+
+

unInit

++ void unInit (void );
+remove all resources (un-init) out of the destructor (due to the system implementation)
+
+
+

display

++ void display (void );
+display in the log all the resources loaded ...
+
+
+

reLoadResources

++ void reLoadResources (void );
+Reload all resources from files, and send there in openGL card if needed.
Note: If file is reference at THEME:XXX:filename if the Theme change the file will reload the newOne
+
+
+

update

++ void update (ewol::Resource* _object);
+Call by the system to send all the needed data on the graphic card chen they change ...
+ +
+
+

updateContext

++ void updateContext (void );
+Call by the system chen the openGL Context has been unexpectially removed == > This reload all the texture, VBO and other ....
+
+
+

contextHasBeenDestroyed

++ void contextHasBeenDestroyed (void );
+This is to inform the resources manager that we have no more openGl context ...
+
+
+

localKeep

++ ewol::Resource* localKeep (const std::string & _filename);
+ +
+
+
+

localAdd

++ void localAdd (ewol::Resource* _object);
+ +
+
+
+

release

++ bool release (ewol::Resource* & _object);
+release a resources and free it if the Last release is call.
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+ +
+
+
+
+ + + diff --git a/class_ewol__resource__Program.html b/class_ewol__resource__Program.html new file mode 100644 index 00000000..6c3039cc --- /dev/null +++ b/class_ewol__resource__Program.html @@ -0,0 +1,482 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::Program

Description:

+Program is a compilation of some fragment Shader and vertex Shader. This construct automaticly this assiciation +The input file must have the form : "myFile.prog" +The data is simple : +<pre> +# Comment line ... paid attention at the space at the end of lines, they are considered like a part of the file ... +# The folder is automaticly get from the program file basic folder +filename1.vert +filename2.frag +filename3.vert +filename4.frag +</pre>

+

Constructor and Destructor:

+
+#                                                   Program              (const std::string & filename);
# virtual                                                   ~Program             (void );
+
+

Synopsis:

+
++ int32_t                                           getAttribute         (std::string _elementName);
+ void                                              sendAttribute        (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          void* _pointer,
                                                                          int32_t _jumpBetweenSample);
+ void                                              sendAttributePointer (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          ewol::resource::VirtualBufferObject* _vbo,
                                                                          int32_t _index,
                                                                          int32_t _jumpBetweenSample,
                                                                          int32_t _offset);
+ int32_t                                           getUniform           (std::string _elementName);
+ void                                              uniformMatrix4fv     (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          mat4 _pointer,
                                                                          bool _transpose);
+ void                                              uniform1f            (int32_t _idElem,
                                                                          float _value1);
+ void                                              uniform2f            (int32_t _idElem,
                                                                          float _value1,
                                                                          float _value2);
+ void                                              uniform3f            (int32_t _idElem,
                                                                          float _value1,
                                                                          float _value2,
                                                                          float _value3);
+ void                                              uniform4f            (int32_t _idElem,
                                                                          float _value1,
                                                                          float _value2,
                                                                          float _value3,
                                                                          float _value4);
+ void                                              uniform1i            (int32_t _idElem,
                                                                          int32_t _value1);
+ void                                              uniform2i            (int32_t _idElem,
                                                                          int32_t _value1,
                                                                          int32_t _value2);
+ void                                              uniform3i            (int32_t _idElem,
                                                                          int32_t _value1,
                                                                          int32_t _value2,
                                                                          int32_t _value3);
+ void                                              uniform4i            (int32_t _idElem,
                                                                          int32_t _value1,
                                                                          int32_t _value2,
                                                                          int32_t _value3,
                                                                          int32_t _value4);
+ void                                              uniform1fv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const float* _value);
+ void                                              uniform2fv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const float* _value);
+ void                                              uniform3fv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const float* _value);
+ void                                              uniform4fv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const float* _value);
+ void                                              uniform1iv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const int32_t* _value);
+ void                                              uniform2iv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const int32_t* _value);
+ void                                              uniform3iv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const int32_t* _value);
+ void                                              uniform4iv           (int32_t _idElem,
                                                                          int32_t _nbElement,
                                                                          const int32_t* _value);
+ void                                              uniform2             (int32_t _idElem,
                                                                          const vec2 & _value);
+ void                                              uniform3             (int32_t _idElem,
                                                                          const vec3 & _value);
+ void                                              uniform4             (int32_t _idElem,
                                                                          const vec4 & _value);
+ void                                              uniform2             (int32_t _idElem,
                                                                          const ivec2 & _value);
+ void                                              uniform3             (int32_t _idElem,
                                                                          const ivec3 & _value);
+ void                                              uniform4             (int32_t _idElem,
                                                                          const ivec4 & _value);
+ void                                              use                  (void );
+ void                                              setTexture0          (int32_t _idElem,
                                                                          GLint _textureOpenGlID);
+ void                                              setTexture1          (int32_t _idElem,
                                                                          GLint _textureOpenGlID);
+ void                                              unUse                (void );
+ void                                              updateContext        (void );
+ void                                              removeContext        (void );
+ void                                              removeContextToLate  (void );
+ void                                              reload               (void );
+ ewol::resource::Program*                          keep                 (const std::string & _filename);
+ void                                              release              (ewol::resource::Program* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> ewol::resource::Program
+

Detail:

+

Program

+#  Program (const std::string & filename);
+Contructor of an opengl Program.
+ +
+
+

~Program

+# virtual  ~Program (void );
+Destructor, remove the current Program.
+
+
+

getAttribute

++ int32_t getAttribute (std::string _elementName);
+User request an attribute on this program.
Note: The attribute is send to the fragment shaders
+ +
+
+

sendAttribute

++ void sendAttribute (int32_t _idElem,
                      int32_t _nbElement,
                      void* _pointer,
                      int32_t _jumpBetweenSample);
+Send attribute table to the spefified ID attribure (not send if does not really exist in the openGL program).
    + + + + + +
    Parameter [input]:_idElem Id of the Attribute that might be sended.
    Parameter [input]:_nbElement Specifies the number of elements that are to be modified.
    Parameter [input]:_pointer Pointer on the data that might be sended.
    Parameter [input]:_jumpBetweenSample Number of byte to jump between 2 vertex (this permit to enterlace informations)
    +
+ +
+
+

sendAttributePointer

++ void sendAttributePointer (int32_t _idElem,
                             int32_t _nbElement,
                             ewol::resource::VirtualBufferObject* _vbo,
                             int32_t _index,
                             int32_t _jumpBetweenSample,
                             int32_t _offset);
+ +
+
+
+

getUniform

++ int32_t getUniform (std::string _elementName);
+User request an Uniform on this program.
Note: uniform value is availlable for all the fragment shader in the program (only one value for all)
+ +
+
+

uniformMatrix4fv

++ void uniformMatrix4fv (int32_t _idElem,
                         int32_t _nbElement,
                         mat4 _pointer,
                         bool _transpose);
+Send a uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Specifies the number of elements that are to be modified. This should be 1 if the targeted uniform variable is not an array, and 1 or more if it is an array.
    Parameter [input]:_pointer Pointer on the data that might be sended
    Parameter [input]:_transpose Transpose the matrix (needed all the taime in the normal openGl access (only not done in the openGL-ES2 due to the fact we must done it ourself)
    +
+ +
+
+

uniform1f

++ void uniform1f (int32_t _idElem,
                  float _value1);
+Send 1 float uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    +
+ +
+
+

uniform2f

++ void uniform2f (int32_t _idElem,
                  float _value1,
                  float _value2);
+Send 2 float uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    Parameter [input]:_value2 Value to send at the Uniform
    +
+ +
+
+

uniform3f

++ void uniform3f (int32_t _idElem,
                  float _value1,
                  float _value2,
                  float _value3);
+Send 3 float uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    Parameter [input]:_value2 Value to send at the Uniform
    Parameter [input]:_value3 Value to send at the Uniform
    +
+ +
+
+

uniform4f

++ void uniform4f (int32_t _idElem,
                  float _value1,
                  float _value2,
                  float _value3,
                  float _value4);
+Send 4 float uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    Parameter [input]:_value2 Value to send at the Uniform
    Parameter [input]:_value3 Value to send at the Uniform
    Parameter [input]:_value4 Value to send at the Uniform
    +
+ +
+
+

uniform1i

++ void uniform1i (int32_t _idElem,
                  int32_t _value1);
+Send 1 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    +
+ +
+
+

uniform2i

++ void uniform2i (int32_t _idElem,
                  int32_t _value1,
                  int32_t _value2);
+Send 2 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    Parameter [input]:_value2 Value to send at the Uniform
    +
+ +
+
+

uniform3i

++ void uniform3i (int32_t _idElem,
                  int32_t _value1,
                  int32_t _value2,
                  int32_t _value3);
+Send 3 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    Parameter [input]:_value2 Value to send at the Uniform
    Parameter [input]:_value3 Value to send at the Uniform
    +
+ +
+
+

uniform4i

++ void uniform4i (int32_t _idElem,
                  int32_t _value1,
                  int32_t _value2,
                  int32_t _value3,
                  int32_t _value4);
+Send 4 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_value1 Value to send at the Uniform
    Parameter [input]:_value2 Value to send at the Uniform
    Parameter [input]:_value3 Value to send at the Uniform
    Parameter [input]:_value4 Value to send at the Uniform
    +
+ +
+
+

uniform1fv

++ void uniform1fv (int32_t _idElem,
                   int32_t _nbElement,
                   const float* _value);
+Send "vec1" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform2fv

++ void uniform2fv (int32_t _idElem,
                   int32_t _nbElement,
                   const float* _value);
+Send "vec2" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform3fv

++ void uniform3fv (int32_t _idElem,
                   int32_t _nbElement,
                   const float* _value);
+Send "vec3" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform4fv

++ void uniform4fv (int32_t _idElem,
                   int32_t _nbElement,
                   const float* _value);
+Send "vec4" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform1iv

++ void uniform1iv (int32_t _idElem,
                   int32_t _nbElement,
                   const int32_t* _value);
+Send "ivec1" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform2iv

++ void uniform2iv (int32_t _idElem,
                   int32_t _nbElement,
                   const int32_t* _value);
+Send "ivec2" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the Attribute that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform3iv

++ void uniform3iv (int32_t _idElem,
                   int32_t _nbElement,
                   const int32_t* _value);
+Send "ivec3" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform4iv

++ void uniform4iv (int32_t _idElem,
                   int32_t _nbElement,
                   const int32_t* _value);
+Send "ivec4" uniform element to the spefified ID (not send if does not really exist in the openGL program)
    + + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_nbElement Number of element sended
    Parameter [input]:_value Pointer on the data
    +
+ +
+
+

uniform2

++ void uniform2 (int32_t _idElem,
                 const vec2 & _value);
+ +
+
+
+

uniform3

++ void uniform3 (int32_t _idElem,
                 const vec3 & _value);
+ +
+
+
+

uniform4

++ void uniform4 (int32_t _idElem,
                 const vec4 & _value);
+ +
+
+
+

uniform2

++ void uniform2 (int32_t _idElem,
                 const ivec2 & _value);
+ +
+
+
+

uniform3

++ void uniform3 (int32_t _idElem,
                 const ivec3 & _value);
+ +
+
+
+

uniform4

++ void uniform4 (int32_t _idElem,
                 const ivec4 & _value);
+ +
+
+
+

use

++ void use (void );
+Request the processing of this program
+
+
+

setTexture0

++ void setTexture0 (int32_t _idElem,
                    GLint _textureOpenGlID);
+set the testure Id on the specify uniform element.
    + + + +
    Parameter [input]:_idElem Id of the uniform that might be sended.
    Parameter [input]:_textureOpenGlID Real openGL texture ID
    +
+ +
+
+

setTexture1

++ void setTexture1 (int32_t _idElem,
                    GLint _textureOpenGlID);
+ +
+
+
+

unUse

++ void unUse (void );
+Stop the processing of this program
+
+
+

updateContext

++ void updateContext (void );
+This load/reload the data in the opengl context, needed when removed previously.
+
+
+

removeContext

++ void removeContext (void );
+remove the data from the opengl context.
+
+
+

removeContextToLate

++ void removeContextToLate (void );
+Special android spec! It inform us that all context is removed and after notify us...
+
+
+

reload

++ void reload (void );
+Relode the shader from the file. used when a request of resouces reload is done.
Note: this is really usefull when we tested the new themes or shader developpements.
+
+
+

keep

++ ewol::resource::Program* keep (const std::string & _filename);
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::Program* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__Shader.html b/class_ewol__resource__Shader.html new file mode 100644 index 00000000..f76cd05a --- /dev/null +++ b/class_ewol__resource__Shader.html @@ -0,0 +1,179 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::Shader

Description:

+Shader is a specific resources for opengl, used only in @ref Program. This are components of the renderer pipe-line

+

Constructor and Destructor:

+
+#                         Shader              (const std::string & _filename);
# virtual                         ~Shader             (void );
+
+

Synopsis:

+
++ GLuint                  getGL_ID            (void );
+ GLenum                  getShaderType       (void );
+ void                    updateContext       (void );
+ void                    removeContext       (void );
+ void                    removeContextToLate (void );
+ void                    reload              (void );
+ ewol::resource::Shader* keep                (const std::string & _filename);
+ void                    release             (ewol::resource::Shader* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> ewol::resource::Shader
+

Detail:

+

Shader

+#  Shader (const std::string & _filename);
+Contructor of an opengl Shader
+ +
+
+

~Shader

+# virtual  ~Shader (void );
+Destructor, remove the current Shader
+
+
+

getGL_ID

++ GLuint getGL_ID (void );
+get the opengl reference id of this shader.
    + +
    Return: The opengl id.
    +
+ +
+
+

getShaderType

++ GLenum getShaderType (void );
+get the opengl type of this shader.
    + +
    Return: The type of this loaded shader.
    +
+ +
+
+

updateContext

++ void updateContext (void );
+This load/reload the data in the opengl context, needed when removed previously.
+
+
+

removeContext

++ void removeContext (void );
+remove the data from the opengl context.
+
+
+

removeContextToLate

++ void removeContextToLate (void );
+Special android spec! It inform us that all context is removed and after notify us...
+
+
+

reload

++ void reload (void );
+Relode the shader from the file. used when a request of resouces reload is done.
Note: this is really usefull when we tested the new themes or shader developpements.
+
+
+

keep

++ ewol::resource::Shader* keep (const std::string & _filename);
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::Shader* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__SimpleConfigElement.html b/class_ewol__resource__SimpleConfigElement.html new file mode 100644 index 00000000..f86becfd --- /dev/null +++ b/class_ewol__resource__SimpleConfigElement.html @@ -0,0 +1,143 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::SimpleConfigElement

Constructor and Destructor:

+
++               SimpleConfigElement  (const std::string & _name);
+               ~SimpleConfigElement (void );
+
+

Synopsis:

+
++ std::string   m_paramName;
+ void          parse        (const std::string & value);
+ int32_t       getInteger   (void );
+ float         getFloat     (void );
+ std::string & getString    (void );
+
+

Detail:

+

m_paramName

++ std::string m_paramName;
+ +
+
+
+

SimpleConfigElement

++  SimpleConfigElement (const std::string & _name);
+ +
+
+
+

~SimpleConfigElement

++  ~SimpleConfigElement (void );
+ +
+
+
+

parse

++ void parse (const std::string & value);
+ +
+
+
+

getInteger

++ int32_t getInteger (void );
+ +
+
+
+

getFloat

++ float getFloat (void );
+ +
+
+
+

getString

++ std::string & getString (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__resource__Texture.html b/class_ewol__resource__Texture.html new file mode 100644 index 00000000..f4aa6ba0 --- /dev/null +++ b/class_ewol__resource__Texture.html @@ -0,0 +1,216 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::Texture

Description:

+ +

+

Constructor and Destructor:

+
+#                          Texture             (const std::string & _filename);
#                          Texture             (void );
#                          ~Texture            (void );
+
+

Synopsis:

+
+# egami::Image             m_data;
# GLuint                   m_texId;
# vec2                     m_endPointSize;
# bool                     m_loaded;
+ void                     updateContext       (void );
+ void                     removeContext       (void );
+ void                     removeContextToLate (void );
+ GLuint                   getId               (void );
+ vec2                     getUsableSize       (void );
+ void                     setImageSize        (ivec2 newSize);
+ egami::Image &           get                 (void );
+ void                     flush               (void );
+ ewol::resource::Texture* keep                (void );
+ void                     release             (ewol::resource::Texture* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> ewol::resource::Texture
                +--> ewol::resource::TexturedFont
                +--> ewol::resource::TextureFile
+

Detail:

+

m_data

+# egami::Image m_data;
+ +
+
+
+

m_texId

+# GLuint m_texId;
+ +
+
+
+

m_endPointSize

+# vec2 m_endPointSize;
+ +
+
+
+

m_loaded

+# bool m_loaded;
+ +
+
+
+

updateContext

++ void updateContext (void );
+ +
+
+
+

removeContext

++ void removeContext (void );
+ +
+
+
+

removeContextToLate

++ void removeContextToLate (void );
+ +
+
+
+

getId

++ GLuint getId (void );
+ +
+
+
+

getUsableSize

++ vec2 getUsableSize (void );
+ +
+
+
+

Texture

+#  Texture (const std::string & _filename);
+ +
+
+
+

Texture

+#  Texture (void );
+ +
+
+
+

~Texture

+#  ~Texture (void );
+ +
+
+
+

setImageSize

++ void setImageSize (ivec2 newSize);
+ +
+
+
+

get

++ egami::Image & get (void );
+ +
+
+
+

flush

++ void flush (void );
+ +
+
+
+

keep

++ ewol::resource::Texture* keep (void );
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::Texture* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__TextureFile.html b/class_ewol__resource__TextureFile.html new file mode 100644 index 00000000..0a97ca7d --- /dev/null +++ b/class_ewol__resource__TextureFile.html @@ -0,0 +1,130 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::TextureFile

Description:

+ +

+

Synopsis:

+
++ const vec2 &                 getRealSize     (void );
+ ewol::resource::TextureFile* keep            (const std::string & _filename,
                                                ivec2 _size);
+ void                         release         (ewol::resource::TextureFile* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> +ewol::resource::Texture
                +--> ewol::resource::TextureFile
+

Detail:

+

getRealSize

++ const vec2 & getRealSize (void );
+ +
+
+
+

keep

++ ewol::resource::TextureFile* keep (const std::string & _filename,
                                     ivec2 _size);
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::TextureFile* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__TexturedFont.html b/class_ewol__resource__TexturedFont.html new file mode 100644 index 00000000..064cb03a --- /dev/null +++ b/class_ewol__resource__TexturedFont.html @@ -0,0 +1,197 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::TexturedFont

Description:

+ +

+

Constructor and Destructor:

+
+#                               TexturedFont    (const std::string & _fontName);
#                               ~TexturedFont   (void );
+
+

Synopsis:

+
++ std::vector<GlyphProperty>    m_listElement;
+ int32_t                       getHeight       (const enum ewol::font::mode _displayMode);
+ int32_t                       getFontSize     (void );
+ int32_t                       getIndex        (char32_t _charcode,
                                                 const enum ewol::font::mode _displayMode);
+ ewol::GlyphProperty*          getGlyphPointer (const char32_t & _charcode,
                                                 const enum ewol::font::mode _displayMode);
+ enum ewol::font::mode         getWrappingMode (const enum ewol::font::mode _source);
+ ewol::resource::TexturedFont* keep            (const std::string & _filename);
+ void                          release         (ewol::resource::TexturedFont* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> +ewol::resource::Texture
                +--> ewol::resource::TexturedFont
+

Detail:

+

m_listElement

++ std::vector<GlyphProperty> m_listElement;
+ +
+
+
+

TexturedFont

+#  TexturedFont (const std::string & _fontName);
+ +
+
+
+

~TexturedFont

+#  ~TexturedFont (void );
+ +
+
+
+

getHeight

++ int32_t getHeight (const enum ewol::font::mode _displayMode);
+get the display height of this font
+ +
+
+

getFontSize

++ int32_t getFontSize (void );
+get the font height (user friendly)
    + +
    Return: Dimention of the font the user requested
    +
+ +
+
+

getIndex

++ int32_t getIndex (char32_t _charcode,
                    const enum ewol::font::mode _displayMode);
+get the ID of a unicode charcode
+ +
+
+

getGlyphPointer

++ ewol::GlyphProperty* getGlyphPointer (const char32_t & _charcode,
                                        const enum ewol::font::mode _displayMode);
+get the pointer on the coresponding glyph
+ +
+
+

getWrappingMode

++ enum ewol::font::mode getWrappingMode (const enum ewol::font::mode _source);
+The wrapping mode is used to prevent the non existance of a specific mode. + For exemple when a blod mode does not exist, this resend a regular mode.
+ +
+
+

keep

++ ewol::resource::TexturedFont* keep (const std::string & _filename);
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::TexturedFont* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__VirtualBufferObject.html b/class_ewol__resource__VirtualBufferObject.html new file mode 100644 index 00000000..f05ceb85 --- /dev/null +++ b/class_ewol__resource__VirtualBufferObject.html @@ -0,0 +1,236 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::VirtualBufferObject

Description:

+VirtualBufferObject is a specific resources for opengl, this load the data directly in the graphic card ad keep these inside

+

Constructor and Destructor:

+
+#                                      VirtualBufferObject  (int32_t _number);
# virtual                                      ~VirtualBufferObject (void );
+
+

Synopsis:

+
++ GLuint                               getGL_ID            (int32_t id);
+ std::vector<float> &                 getRefBuffer        (int32_t id);
+ void                                 pushOnBuffer        (int32_t id,
                                                            const vec3 & data);
+ vec3                                 getOnBufferVec3     (int32_t id,
                                                            int32_t elementID);
+ int32_t                              sizeOnBufferVec3    (int32_t id);
+ void                                 pushOnBuffer        (int32_t id,
                                                            const vec2 & data);
+ vec2                                 getOnBufferVec2     (int32_t id,
                                                            int32_t elementID);
+ int32_t                              sizeOnBufferVec2    (int32_t id);
+ void                                 retreiveData        (void );
+ void                                 flush               (void );
+ void                                 updateContext       (void );
+ void                                 removeContext       (void );
+ void                                 removeContextToLate (void );
+ void                                 reload              (void );
+ ewol::resource::VirtualBufferObject* keep                (int32_t _number);
+ void                                 release             (ewol::resource::VirtualBufferObject* & _object);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Resource
         +--> ewol::resource::VirtualBufferObject
+

Detail:

+

VirtualBufferObject

+#  VirtualBufferObject (int32_t _number);
+Constructor of this VBO.
    + + +
    Parameter [input]:accesMode Acces mode : ???
    +
+ +
+
+

~VirtualBufferObject

+# virtual  ~VirtualBufferObject (void );
+Destructor of this VBO.
+
+
+

getGL_ID

++ GLuint getGL_ID (int32_t id);
+get the real openGL ID.
    + +
    Return: the Ogl id reference of this VBO.
    +
+ +
+
+

getRefBuffer

++ std::vector<float> & getRefBuffer (int32_t id);
+get a reference on hte buffer data for this VBO.
+ +
+
+

pushOnBuffer

++ void pushOnBuffer (int32_t id,
                     const vec3 & data);
+push data on a buffer with a custum type :
    + + + +
    Parameter [input]:id Id of the buffer requested.
    Parameter [input]:data Direct data that might be set.
    +
+ +
+
+

getOnBufferVec3

++ vec3 getOnBufferVec3 (int32_t id,
                        int32_t elementID);
+ +
+
+
+

sizeOnBufferVec3

++ int32_t sizeOnBufferVec3 (int32_t id);
+ +
+
+
+

pushOnBuffer

++ void pushOnBuffer (int32_t id,
                     const vec2 & data);
+push data on a buffer with a custum type :
    + + + +
    Parameter [input]:id Id of the buffer requested.
    Parameter [input]:data Direct data that might be set.
    +
+ +
+
+

getOnBufferVec2

++ vec2 getOnBufferVec2 (int32_t id,
                        int32_t elementID);
+ +
+
+
+

sizeOnBufferVec2

++ int32_t sizeOnBufferVec2 (int32_t id);
+ +
+
+
+

retreiveData

++ void retreiveData (void );
+get the data from the graphic card.
+
+
+

flush

++ void flush (void );
+Send the data to the graphic card.
+
+
+

updateContext

++ void updateContext (void );
+This load/reload the data in the opengl context, needed when removed previously.
+
+
+

removeContext

++ void removeContext (void );
+remove the data from the opengl context.
+
+
+

removeContextToLate

++ void removeContextToLate (void );
+Special android spec! It inform us that all context is removed and after notify us...
+
+
+

reload

++ void reload (void );
+Relode the shader from the file. used when a request of resouces reload is done.
Note: this is really usefull when we tested the new themes or shader developpements.
+
+
+

keep

++ ewol::resource::VirtualBufferObject* keep (int32_t _number);
+keep the resource pointer.
Note: Never free this pointer by your own...
+ +
+
+

release

++ void release (ewol::resource::VirtualBufferObject* & _object);
+release the keeped resources
+ +
+
+
+ + + diff --git a/class_ewol__resource__progAttributeElement.html b/class_ewol__resource__progAttributeElement.html new file mode 100644 index 00000000..7d4bab5a --- /dev/null +++ b/class_ewol__resource__progAttributeElement.html @@ -0,0 +1,125 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::resource::progAttributeElement

Description:

+In a openGL program we need some data to communicate with them, we register all the name requested by the user in this structure:
Note: Register all requested element permit to abstract the fact that some element does not exist and remove control of existance from upper code. + This is important to note when the Program is reloaded the elements availlable can change.

+

Associated Namespace:

+

Synopsis:

+
++ std::string m_name;
+ GLint       m_elementId;
+ bool        m_isAttribute;
+ bool        m_isLinked;
+
+

Detail:

+

m_name

++ std::string m_name;
+ +Name of the element
+
+
+

m_elementId

++ GLint m_elementId;
+ +
+
+

m_isAttribute

++ bool m_isAttribute;
+ +true if it was an attribute element, otherwite it was an uniform
+
+
+

m_isLinked

++ bool m_isLinked;
+ +if this element does not exist this is false
+
+
+
+ + + diff --git a/class_ewol__widget__Button.html b/class_ewol__widget__Button.html new file mode 100644 index 00000000..4a4de4b1 --- /dev/null +++ b/class_ewol__widget__Button.html @@ -0,0 +1,416 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Button

Description:

+a composed button is a button with an inside composed with the specify XML element +==> this permit to generate standard element simple

+

enum:

+ +

Constructor and Destructor:

+
++                                   Button               (const std::string & _shaperName);
+ virtual                           ~Button              (void );
+
+

Synopsis:

+
++         void                      init                 (ewol::widget::Manager & _widgetManager);
+         const char* const         eventPressed;
+         const char* const         eventDown;
+         const char* const         eventUp;
+         const char* const         eventEnter;
+         const char* const         eventLeave;
+         const char* const         eventValue;
+         const char* const         configToggle;
+         const char* const         configLock;
+         const char* const         configValue;
+         const char* const         configShaper;
+         void                      setShaperName        (const std::string & _shaperName);
#         ewol::Widget*             m_subWidget;
+         void                      setSubWidget         (ewol::Widget* _subWidget);
+         void                      setSubWidgetToggle   (ewol::Widget* _subWidget);
+         ewol::Widget*             getSubWidget         (void ) const;
+         ewol::Widget*             getSubWidgetToggle   (void ) const;
#         bool                      m_value;
+         void                      setValue             (bool _val);
+         bool                      getValue             (void ) const;
+         void                      setLock              (enum buttonLock _lock);
+         enum buttonLock           getLock              (void ) const;
#         bool                      m_toggleMode;
+         void                      setToggleMode        (bool _togg);
+         bool                      getToggleMode        (void ) const;
# virtual void                      onDraw               (void );
# virtual bool                      onSetConfig          (const ewol::object::Config & _conf);
# virtual bool                      onGetConfig          (const char* _config,
                                                          std::string & _result) const;
+ virtual void                      calculateMinMaxSize  (void );
+ virtual void                      calculateSize        (const vec2 & _availlable);
+ virtual void                      onRegenerateDisplay  (void );
+ virtual void                      systemDraw           (const ewol::DrawProperty & _displayProp);
+ virtual bool                      onEventInput         (const ewol::event::Input & _event);
+ virtual bool                      onEventEntry         (const ewol::event::Entry & _event);
+ virtual bool                      loadXML              (exml::Element* _node);
+ virtual ewol::Widget*             getWidgetNamed       (const std::string & _widgetName);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Button
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

eventPressed

++ const char* const eventPressed;
+ +
+
+
+

eventDown

++ const char* const eventDown;
+ +
+
+
+

eventUp

++ const char* const eventUp;
+ +
+
+
+

eventEnter

++ const char* const eventEnter;
+ +
+
+
+

eventLeave

++ const char* const eventLeave;
+ +
+
+
+

eventValue

++ const char* const eventValue;
+ +
+
+
+

configToggle

++ const char* const configToggle;
+ +
+
+
+

configLock

++ const char* const configLock;
+ +
+
+
+

configValue

++ const char* const configValue;
+ +
+
+
+

configShaper

++ const char* const configShaper;
+ +
+
+
+

Button

++  Button (const std::string & _shaperName);
+Constructor
+ +
+
+

~Button

++ virtual  ~Button (void );
+Destructor
+
+
+

setShaperName

++ void setShaperName (const std::string & _shaperName);
+set the shaper name (use the contructer one this permit to not noad unused shaper)
+ +
+
+

m_subWidget

+# ewol::Widget* m_subWidget;
+ +subwidget of the button
+
+
+

setSubWidget

++ void setSubWidget (ewol::Widget* _subWidget);
+Specify the current widget
+ +
+
+

setSubWidgetToggle

++ void setSubWidgetToggle (ewol::Widget* _subWidget);
+Specify the current widget
+ +
+
+

getSubWidget

++ ewol::Widget* getSubWidget (void ) const;
+get the current displayed composition
+ +
+
+

getSubWidgetToggle

++ ewol::Widget* getSubWidgetToggle (void ) const;
+get the current displayed composition
+ +
+
+

m_value

+# bool m_value;
+ +Current state of the button.
+
+
+

setValue

++ void setValue (bool _val);
+set the currentValue of the Button (pressed or not)
Note: Work only in toggle mode
    + + +
    Parameter [input]:_val New value of the button
    +
+ +
+
+

getValue

++ bool getValue (void ) const;
+get the current button value.
    + +
    Return: True : The button is pressed.<br/>false : The button is released.
    +
+ +
+
+

setLock

++ void setLock (enum buttonLock _lock);
+set the button lock state.
    + + +
    Parameter [input]:_lock New lock mode of the button
    +
+ +
+
+

getLock

++ enum buttonLock getLock (void ) const;
+get the current button lock value.
    + +
    Return: The requested lock mode
    +
+ +
+
+

m_toggleMode

+# bool m_toggleMode;
+ +The button is able to toggle.
+
+
+

setToggleMode

++ void setToggleMode (bool _togg);
+change the toggle mode.
    + + +
    Parameter [input]:_togg New toggle mode
    +
+ +
+
+

getToggleMode

++ bool getToggleMode (void ) const;
+get the current toggle mode.
    + +
    Return: the current toggle mode.
    +
+ +
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

onEventEntry

++ virtual bool onEventEntry (const ewol::event::Entry & _event);
+Entry event. + represent the physical event : + - Keyboard (key event and move event) + - Accelerometer + - Joystick
+ +
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+

getWidgetNamed

++ virtual ewol::Widget* getWidgetNamed (const std::string & _widgetName);
+get the widget if it have this name or one of the subwidget with the same name
+ +
+
+
+ + + diff --git a/class_ewol__widget__ButtonColor.html b/class_ewol__widget__ButtonColor.html new file mode 100644 index 00000000..d84ce52b --- /dev/null +++ b/class_ewol__widget__ButtonColor.html @@ -0,0 +1,199 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ButtonColor

Description:

+ +

+

Constructor and Destructor:

+
++                                    ButtonColor          (etk::Color<> _baseColor,
                                                           std::string _shaperName);
+ virtual                            ~ButtonColor         (void );
+
+

Synopsis:

+
++         const char* const          eventChange;
+         void                       init                 (ewol::widget::Manager & _widgetManager);
+         void                       setShaperName        (std::string _shaperName);
+         etk::Color<>               getValue             (void );
+         void                       setValue             (etk::Color<> _color);
# virtual void                       onDraw               (void );
+ virtual void                       calculateMinMaxSize  (void );
+ virtual void                       onRegenerateDisplay  (void );
+ virtual bool                       onEventInput         (const ewol::event::Input & _event);
+ virtual void                       onReceiveMessage     (const ewol::object::Message & _msg);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::ButtonColor
+

Detail:

+

eventChange

++ const char* const eventChange;
+ +
+
+
+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

ButtonColor

++  ButtonColor (etk::Color<> _baseColor,
                std::string _shaperName);
+Main constructor.
+ +
+
+

~ButtonColor

++ virtual  ~ButtonColor (void );
+Main destructor.
+
+
+

setShaperName

++ void setShaperName (std::string _shaperName);
+set the shaper name (use the contructer one this permit to not noad unused shaper).
+ +
+
+

getValue

++ etk::Color<> getValue (void );
+get the current color of the color selection widget
+ +
+
+

setValue

++ void setValue (etk::Color<> _color);
+Specify the current color.
+ +
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+
+ + + diff --git a/class_ewol__widget__CheckBox.html b/class_ewol__widget__CheckBox.html new file mode 100644 index 00000000..d8be56a7 --- /dev/null +++ b/class_ewol__widget__CheckBox.html @@ -0,0 +1,188 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::CheckBox

Description:

+ +

+

Constructor and Destructor:

+
++                                    CheckBox            (const std::string & newLabel);
+ virtual                            ~CheckBox           (void );
+
+

Synopsis:

+
++         const char* const          eventClicked;
+         void                       init                (ewol::widget::Manager & _widgetManager);
+         void                       setLabel            (std::string newLabel);
+         void                       setValue            (bool val);
+         bool                       getValue            (void );
# virtual void                       onDraw              (void );
+ virtual void                       calculateMinMaxSize (void );
+ virtual void                       onRegenerateDisplay (void );
+ virtual bool                       onEventInput        (const ewol::event::Input & _event);
+ virtual bool                       onEventEntry        (const ewol::event::Entry & _event);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::CheckBox
+

Detail:

+

eventClicked

++ const char* const eventClicked;
+ +
+
+
+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

CheckBox

++  CheckBox (const std::string & newLabel);
+ +
+
+
+

~CheckBox

++ virtual  ~CheckBox (void );
+ +
+
+
+

setLabel

++ void setLabel (std::string newLabel);
+ +
+
+
+

setValue

++ void setValue (bool val);
+ +
+
+
+

getValue

++ bool getValue (void );
+ +
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

onEventEntry

++ virtual bool onEventEntry (const ewol::event::Entry & _event);
+Entry event. + represent the physical event : + - Keyboard (key event and move event) + - Accelerometer + - Joystick
+ +
+
+
+ + + diff --git a/class_ewol__widget__ColorBar.html b/class_ewol__widget__ColorBar.html new file mode 100644 index 00000000..aa1930b0 --- /dev/null +++ b/class_ewol__widget__ColorBar.html @@ -0,0 +1,162 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ColorBar

Description:

+ +

+

Constructor and Destructor:

+
++                                    ColorBar            (void );
+ virtual                            ~ColorBar           (void );
+
+

Synopsis:

+
++         const char* const          eventChange;
+         etk::Color<>               getCurrentColor     (void );
+         void                       setCurrentColor     (etk::Color<> _newOne);
# virtual void                       onDraw              (void );
+ virtual void                       calculateMinMaxSize (void );
+ virtual void                       onRegenerateDisplay (void );
+ virtual bool                       onEventInput        (const ewol::event::Input & _event);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::ColorBar
+

Detail:

+

eventChange

++ const char* const eventChange;
+ +
+
+
+

ColorBar

++  ColorBar (void );
+ +
+
+
+

~ColorBar

++ virtual  ~ColorBar (void );
+ +
+
+
+

getCurrentColor

++ etk::Color<> getCurrentColor (void );
+ +
+
+
+

setCurrentColor

++ void setCurrentColor (etk::Color<> _newOne);
+ +
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+
+ + + diff --git a/class_ewol__widget__ColorChooser.html b/class_ewol__widget__ColorChooser.html new file mode 100644 index 00000000..a60d04e4 --- /dev/null +++ b/class_ewol__widget__ColorChooser.html @@ -0,0 +1,154 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ColorChooser

Constructor and Destructor:

+
++                                 ColorChooser     (void );
+                                 ~ColorChooser    (void );
+
+

Synopsis:

+
++         const char* const       eventChange;
+ virtual void                    onReceiveMessage (const ewol::object::Message & _msg);
+ virtual void                    onObjectRemove   (ewol::Object* _removeObject);
+         void                    setColor         (etk::Color<> _newColor);
+         etk::Color<>            getColor         (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::ContainerN
                +--> +ewol::widget::Sizer
                       +--> ewol::widget::ColorChooser
+

Detail:

+

eventChange

++ const char* const eventChange;
+ +
+
+
+

ColorChooser

++  ColorChooser (void );
+ +
+
+
+

~ColorChooser

++  ~ColorChooser (void );
+ +
+
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

setColor

++ void setColor (etk::Color<> _newColor);
+ +
+
+
+

getColor

++ etk::Color<> getColor (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__widget__Composer.html b/class_ewol__widget__Composer.html new file mode 100644 index 00000000..3369e16c --- /dev/null +++ b/class_ewol__widget__Composer.html @@ -0,0 +1,177 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Composer

Description:

+the composer widget is a widget that create a link on a string.file to parse the data and generate some widget tree

+

enum:

+ +

Constructor and Destructor:

+
++      Composer                  (void );
+      Composer                  (enum composerMode _mode,
                                  const std::string & _data);
+      ~Composer                 (void );
+
+

Synopsis:

+
++ bool loadFromFile              (const std::string & _fileName);
+ bool loadFromString            (const std::string & _composerXmlString);
# void registerOnEventNameWidget (const std::string & _subWidgetName,
                                  const char* _eventId,
                                  const char* _eventIdgenerated,
                                  const std::string & _overloadData);
+ void registerOnEventNameWidget (ewol::Object* _destinationObject,
                                  const std::string & _subWidgetName,
                                  const char* _eventId,
                                  const char* _eventIdgenerated,
                                  const std::string & _overloadData);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::Container
                +--> ewol::widget::Composer
+

Detail:

+

Composer

++  Composer (void );
+Constructor
+
+
+

Composer

++  Composer (enum composerMode _mode,
             const std::string & _data);
+Constructor
+ +
+
+

~Composer

++  ~Composer (void );
+Destructor
+
+
+

loadFromFile

++ bool loadFromFile (const std::string & _fileName);
+load a composition with a file
+ +
+
+

loadFromString

++ bool loadFromString (const std::string & _composerXmlString);
+load a composition with a file
+ +
+
+

registerOnEventNameWidget

+# void registerOnEventNameWidget (const std::string & _subWidgetName,
                                  const char* _eventId,
                                  const char* _eventIdgenerated,
                                  const std::string & _overloadData);
+Register an Event an named widget. @see registerOnEvent
Note: : To used when herited from this object.
+ +
+
+

registerOnEventNameWidget

++ void registerOnEventNameWidget (ewol::Object* _destinationObject,
                                  const std::string & _subWidgetName,
                                  const char* _eventId,
                                  const char* _eventIdgenerated,
                                  const std::string & _overloadData);
+Register an Event an named widget. @see registerOnEvent
Note: : To used when NOT herited from this object.
+ +
+
+
+ + + diff --git a/class_ewol__widget__Container.html b/class_ewol__widget__Container.html new file mode 100644 index 00000000..553c7ebe --- /dev/null +++ b/class_ewol__widget__Container.html @@ -0,0 +1,233 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Container

Description:

+the Cotainer widget is a widget that have an only one subWidget

+

Constructor and Destructor:

+
++                       Container              (ewol::Widget* _subElement);
+                       ~Container             (void );
+
+

Synopsis:

+
+#         ewol::Widget* m_subWidget;
+         ewol::Widget* getSubWidget           (void );
+         void          setSubWidget           (ewol::Widget* _newWidget);
+         void          subWidgetRemove        (void );
+ virtual void          subWidgetRemoveDelayed (void );
+ virtual void          systemDraw             (const ewol::DrawProperty & _displayProp);
+ virtual void          onRegenerateDisplay    (void );
+ virtual void          onObjectRemove         (ewol::Object* _removeObject);
+ virtual void          calculateSize          (const vec2 & _availlable);
+ virtual void          calculateMinMaxSize    (void );
+ virtual ewol::Widget* getWidgetAtPos         (const vec2 & _pos);
+ virtual ewol::Widget* getWidgetNamed         (const std::string & _widgetName);
+ virtual bool          loadXML                (exml::Element* _node);
+ virtual void          setOffset              (const vec2 & _newVal);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Container
                +--> ewol::widget::PopUp
                +--> ewol::widget::ContextMenu
                +--> ewol::widget::Scroll
                +--> ewol::widget::Composer
+

Detail:

+

m_subWidget

+# ewol::Widget* m_subWidget;
+ +
+
+
+

Container

++  Container (ewol::Widget* _subElement);
+Constructor
+
+
+

~Container

++  ~Container (void );
+Destructor
+
+
+

getSubWidget

++ ewol::Widget* getSubWidget (void );
+get the main node widget
+ +
+
+

setSubWidget

++ void setSubWidget (ewol::Widget* _newWidget);
+set the subWidget node widget.
+ +
+
+

subWidgetRemove

++ void subWidgetRemove (void );
+remove the subWidget node.
+
+
+

subWidgetRemoveDelayed

++ virtual void subWidgetRemoveDelayed (void );
+remove the subWidget node (delayed to prevent remove in the callbback).
+
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

getWidgetNamed

++ virtual ewol::Widget* getWidgetNamed (const std::string & _widgetName);
+get the widget if it have this name or one of the subwidget with the same name
+ +
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+

setOffset

++ virtual void setOffset (const vec2 & _newVal);
+set the zoom property of the widget.
+ +
+
+
+ + + diff --git a/class_ewol__widget__ContainerN.html b/class_ewol__widget__ContainerN.html new file mode 100644 index 00000000..f5fc0cd2 --- /dev/null +++ b/class_ewol__widget__ContainerN.html @@ -0,0 +1,303 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ContainerN

Description:

+the Cotainer widget is a widget that have an only one subWidget

+

Constructor and Destructor:

+
++                                    ContainerN                (void );
+                                    ~ContainerN               (void );
+
+

Synopsis:

+
+#         std::vector<ewol::Widget*> m_subWidget;
#         bvec2                      m_lockExpand;
#         bvec2                      m_subExpend;
+         void                       lockExpand                (const bvec2 & _lockExpand);
+ virtual bvec2                      canExpand                 (void );
+ virtual void                       subWidgetRemoveAll        (void );
+ virtual void                       subWidgetRemoveAllDelayed (void );
+ virtual int32_t                    subWidgetAdd              (ewol::Widget* _newWidget);
+         int32_t                    subWidgetAddBack          (ewol::Widget* _newWidget);
+         int32_t                    subWidgetAddEnd           (ewol::Widget* _newWidget);
+ virtual int32_t                    subWidgetAddStart         (ewol::Widget* _newWidget);
+         int32_t                    subWidgetAddFront         (ewol::Widget* _newWidget);
+ virtual void                       subWidgetRemove           (ewol::Widget* _newWidget);
+ virtual void                       subWidgetUnLink           (ewol::Widget* _newWidget);
+ virtual void                       systemDraw                (const ewol::DrawProperty & _displayProp);
+ virtual void                       onRegenerateDisplay       (void );
+ virtual void                       onObjectRemove            (ewol::Object* _removeObject);
+ virtual void                       calculateSize             (const vec2 & _availlable);
+ virtual void                       calculateMinMaxSize       (void );
+ virtual ewol::Widget*              getWidgetAtPos            (const vec2 & _pos);
+ virtual ewol::Widget*              getWidgetNamed            (const std::string & _widgetName);
+ virtual bool                       loadXML                   (exml::Element* _node);
+ virtual void                       setOffset                 (const vec2 & _newVal);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::ContainerN
                +--> ewol::widget::Sizer
                +--> ewol::widget::WSlider
                +--> ewol::widget::Layer
+

Detail:

+

m_subWidget

+# std::vector<ewol::Widget*> m_subWidget;
+ +
+
+
+

ContainerN

++  ContainerN (void );
+Constructor
+
+
+

~ContainerN

++  ~ContainerN (void );
+Destructor
+
+
+

m_lockExpand

+# bvec2 m_lockExpand;
+ +Lock the expend of the sub widget to this one == > this permit to limit bigger subWidget
+
+
+

m_subExpend

+# bvec2 m_subExpend;
+ +reference of the sub element expention requested.
+
+
+

lockExpand

++ void lockExpand (const bvec2 & _lockExpand);
+Limit the expend properties to the current widget (no contamination)
    + + +
    Parameter [input]:_lockExpend Lock mode of the expend properties
    +
+ +
+
+

canExpand

++ virtual bvec2 canExpand (void );
+get the expend capabilities (x&y)
Note: : INTERNAL EWOL SYSTEM
    + +
    Return: 2D boolean repensent the capacity to expend
    +
+ +
+
+

subWidgetRemoveAll

++ virtual void subWidgetRemoveAll (void );
+remove all sub element from the widget.
+
+
+

subWidgetRemoveAllDelayed

++ virtual void subWidgetRemoveAllDelayed (void );
+remove all sub element from the widget (delayed to prevent remove in the callbback).
+
+
+

subWidgetAdd

++ virtual int32_t subWidgetAdd (ewol::Widget* _newWidget);
+add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
+ +
+
+

subWidgetAddBack

++ int32_t subWidgetAddBack (ewol::Widget* _newWidget);
+ +
+
+
+

subWidgetAddEnd

++ int32_t subWidgetAddEnd (ewol::Widget* _newWidget);
+ +
+
+
+

subWidgetAddStart

++ virtual int32_t subWidgetAddStart (ewol::Widget* _newWidget);
+add at start position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
+ +
+
+

subWidgetAddFront

++ int32_t subWidgetAddFront (ewol::Widget* _newWidget);
+ +
+
+
+

subWidgetRemove

++ virtual void subWidgetRemove (ewol::Widget* _newWidget);
+remove definitly a widget from the system and this layer.
+ +
+
+

subWidgetUnLink

++ virtual void subWidgetUnLink (ewol::Widget* _newWidget);
+Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...)
+ +
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

getWidgetNamed

++ virtual ewol::Widget* getWidgetNamed (const std::string & _widgetName);
+get the widget if it have this name or one of the subwidget with the same name
+ +
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+

setOffset

++ virtual void setOffset (const vec2 & _newVal);
+set the zoom property of the widget.
+ +
+
+
+ + + diff --git a/class_ewol__widget__ContextMenu.html b/class_ewol__widget__ContextMenu.html new file mode 100644 index 00000000..b4ef8b6e --- /dev/null +++ b/class_ewol__widget__ContextMenu.html @@ -0,0 +1,226 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ContextMenu

enum:

+ +

Constructor and Destructor:

+
++                                    ContextMenu         (const std::string & _shaperName);
+ virtual                            ~ContextMenu        (void );
+
+

Synopsis:

+
++         void                       init                (ewol::widget::Manager & _widgetManager);
+         const char* const          configArrowPosition;
+         const char* const          configArrowMode;
+         const char* const          configShaper;
+         void                       setShaperName       (const std::string & _shaperName);
+         void                       setPositionMark     (enum markPosition position,
                                                          vec2 arrowPos);
# virtual void                       onDraw              (void );
# virtual bool                       onSetConfig         (const ewol::object::Config & _conf);
# virtual bool                       onGetConfig         (const char* _config,
                                                          std::string & _result) const;
+ virtual void                       onRegenerateDisplay (void );
+ virtual bool                       onEventInput        (const ewol::event::Input & _event);
+ virtual void                       calculateSize       (const vec2 & availlable);
+ virtual void                       calculateMinMaxSize (void );
+ virtual ewol::Widget*              getWidgetAtPos      (const vec2 & pos);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::Container
                +--> ewol::widget::ContextMenu
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

configArrowPosition

++ const char* const configArrowPosition;
+ +
+
+
+

configArrowMode

++ const char* const configArrowMode;
+ +
+
+
+

configShaper

++ const char* const configShaper;
+ +
+
+
+

ContextMenu

++  ContextMenu (const std::string & _shaperName);
+ +
+
+
+

~ContextMenu

++ virtual  ~ContextMenu (void );
+ +
+
+
+

setShaperName

++ void setShaperName (const std::string & _shaperName);
+set the shaper name (use the contructer one this permit to not noad unused shaper)
+ +
+
+

setPositionMark

++ void setPositionMark (enum markPosition position,
                        vec2 arrowPos);
+ +
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+
+ + + diff --git a/class_ewol__widget__Entry.html b/class_ewol__widget__Entry.html new file mode 100644 index 00000000..94664612 --- /dev/null +++ b/class_ewol__widget__Entry.html @@ -0,0 +1,439 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Entry

Constructor and Destructor:

+
++                                   Entry                       (std::string _newData);
+ virtual                           ~Entry                      (void );
+
+

Synopsis:

+
++         const char* const         eventClick;
+         const char* const         eventEnter;
+         const char* const         eventModify;
+         const char* const         configMaxChar;
+         const char* const         configRegExp;
+         const char* const         configColorFg;
+         const char* const         configColorBg;
+         const char* const         configEmptyMessage;
+         void                      init                        (ewol::widget::Manager & _widgetManager);
#         void                      setInternalValue            (const std::string & _newData);
+         void                      setValue                    (const std::string & _newData);
+         std::string               getValue                    (void ) const;
+         void                      setMaxChar                  (int32_t _nbMax);
+         int32_t                   getMaxChar                  (void ) const;
+         void                      setRegExp                   (const std::string & _expression);
+         std::string               getRegExp                   (void ) const;
# virtual void                      markToUpdateTextPosition    (void );
# virtual void                      updateTextPosition          (void );
# virtual void                      updateCursorPosition        (const vec2 & _pos,
                                                                 bool _Selection);
+ virtual void                      copySelectionToClipBoard    (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+ virtual void                      removeSelected              (void );
+         void                      setColorText                (const etk::Color<> & _color);
+         const etk::Color<> &      getColorText                (void ) const;
+         void                      setColorTextSelected        (const etk::Color<> & _color);
+         const etk::Color<> &      getColorTextSelected        (void ) const;
+         void                      setEmptyText                (const std::string & _text);
+         const std::string &       getEmptyText                (void ) const;
+ virtual void                      onRegenerateDisplay         (void );
+ virtual bool                      onEventInput                (const ewol::event::Input & _event);
+ virtual bool                      onEventEntry                (const ewol::event::Entry & _event);
+ virtual void                      onReceiveMessage            (const ewol::object::Message & _msg);
+ virtual void                      onEventClipboard            (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+ virtual void                      calculateMinMaxSize         (void );
# virtual void                      onDraw                      (void );
# virtual void                      onGetFocus                  (void );
# virtual void                      onLostFocus                 (void );
# virtual void                      changeStatusIn              (int32_t _newStatusId);
# virtual void                      periodicCall                (const ewol::event::Time & _event);
# virtual bool                      onSetConfig                 (const ewol::object::Config & _conf);
# virtual bool                      onGetConfig                 (const char* _config,
                                                                 std::string & _result) const;
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Entry
+

Detail:

+

eventClick

++ const char* const eventClick;
+ +
+
+
+

eventEnter

++ const char* const eventEnter;
+ +
+
+
+

eventModify

++ const char* const eventModify;
+ +
+
+
+

configMaxChar

++ const char* const configMaxChar;
+ +
+
+
+

configRegExp

++ const char* const configRegExp;
+ +
+
+
+

configColorFg

++ const char* const configColorFg;
+ +
+
+
+

configColorBg

++ const char* const configColorBg;
+ +
+
+
+

configEmptyMessage

++ const char* const configEmptyMessage;
+ +
+
+
+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

Entry

++  Entry (std::string _newData);
+Contuctor
+ +
+
+

~Entry

++ virtual  ~Entry (void );
+Destuctor
+
+
+

setInternalValue

+# void setInternalValue (const std::string & _newData);
+internal check the value with RegExp checking
+ +
+
+

setValue

++ void setValue (const std::string & _newData);
+set a new value on the entry.
+ +
+
+

getValue

++ std::string getValue (void ) const;
+get the current value in the entry
+ +
+
+

setMaxChar

++ void setMaxChar (int32_t _nbMax);
+Limit the number of Unicode character in the entry
    + + +
    Parameter [input]:_nbMax Number of max character set in the List (0x7FFFFFFF for no limit)
    +
+ +
+
+

getMaxChar

++ int32_t getMaxChar (void ) const;
+Limit the number of Unicode character in the entry
    + +
    Return: Number of max character set in the List.
    +
+ +
+
+

setRegExp

++ void setRegExp (const std::string & _expression);
+Limit the input entry at a regular expression... (by default it is "")
+ +
+
+

getRegExp

++ std::string getRegExp (void ) const;
+get the regualar expression limitation
+ +
+
+

markToUpdateTextPosition

+# virtual void markToUpdateTextPosition (void );
+informe the system thet the text change and the start position change
+
+
+

updateTextPosition

+# virtual void updateTextPosition (void );
+update the display position start == > depending of the position of the Cursor and the size of the Data inside
+
+
+

updateCursorPosition

+# virtual void updateCursorPosition (const vec2 & _pos,
                                     bool _Selection);
+change the cursor position with the curent position requested on the display
Note: The display is automaticly requested when change apear.
    + + +
    Parameter [input]:_pos Absolute position of the event
    +
+ +
+
+

copySelectionToClipBoard

++ virtual void copySelectionToClipBoard (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+Copy the selected data on the specify clipboard
+ +
+
+

removeSelected

++ virtual void removeSelected (void );
+remove the selected area
Note: This request a regeneration of the display
+
+
+

setColorText

++ void setColorText (const etk::Color<> & _color);
+set text color.
+ +
+
+

getColorText

++ const etk::Color<> & getColorText (void ) const;
+get the color for the text.
+ +
+
+

setColorTextSelected

++ void setColorTextSelected (const etk::Color<> & _color);
+set text backgroung color when selected.
+ +
+
+

getColorTextSelected

++ const etk::Color<> & getColorTextSelected (void ) const;
+get the selected color for the text in selection mode.
+ +
+
+

setEmptyText

++ void setEmptyText (const std::string & _text);
+set The text displayed when nothing is in the entry.
+ +
+
+

getEmptyText

++ const std::string & getEmptyText (void ) const;
+get The text displayed when nothing is in the entry.
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

onEventEntry

++ virtual bool onEventEntry (const ewol::event::Entry & _event);
+Entry event. + represent the physical event : + - Keyboard (key event and move event) + - Accelerometer + - Joystick
+ +
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+

onEventClipboard

++ virtual void onEventClipboard (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+Event on a past event == > this event is asynchronous due to all system does not support direct getting datas
Note: : need to have focus ...
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onGetFocus

+# virtual void onGetFocus (void );
+Event of the focus has been grep by the current widget
+
+
+

onLostFocus

+# virtual void onLostFocus (void );
+Event of the focus has been lost by the current widget
+
+
+

changeStatusIn

+# virtual void changeStatusIn (int32_t _newStatusId);
+ +
+
+
+

periodicCall

+# virtual void periodicCall (const ewol::event::Time & _event);
+periodic call of this widget
+ +
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+
+ + + diff --git a/class_ewol__widget__FileChooser.html b/class_ewol__widget__FileChooser.html new file mode 100644 index 00000000..681c8b49 --- /dev/null +++ b/class_ewol__widget__FileChooser.html @@ -0,0 +1,190 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::FileChooser

Constructor and Destructor:

+
++                                       FileChooser             (void );
+ virtual                               ~FileChooser            (void );
+
+

Synopsis:

+
++         const char* const             eventCancel;
+         const char* const             eventValidate;
+         void                          setTitle                (const std::string & _label);
+         void                          setValidateLabel        (const std::string & _label);
+         void                          setCancelLabel          (const std::string & _label);
+         void                          setFolder               (const std::string & _folder);
+         void                          setFileName             (const std::string & _filename);
+         std::string                   getCompleateFileName    (void );
+         void                          updateCurrentFolder     (void );
+ virtual void                          onReceiveMessage        (const ewol::object::Message & _msg);
+ virtual void                          onObjectRemove          (ewol::Object* _removeObject);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::Container
                +--> +ewol::widget::PopUp
                       +--> ewol::widget::FileChooser
+

Detail:

+

eventCancel

++ const char* const eventCancel;
+ +
+
+
+

eventValidate

++ const char* const eventValidate;
+ +
+
+
+

FileChooser

++  FileChooser (void );
+ +
+
+
+

~FileChooser

++ virtual  ~FileChooser (void );
+ +
+
+
+

setTitle

++ void setTitle (const std::string & _label);
+ +
+
+
+

setValidateLabel

++ void setValidateLabel (const std::string & _label);
+ +
+
+
+

setCancelLabel

++ void setCancelLabel (const std::string & _label);
+ +
+
+
+

setFolder

++ void setFolder (const std::string & _folder);
+ +
+
+
+

setFileName

++ void setFileName (const std::string & _filename);
+ +
+
+
+

getCompleateFileName

++ std::string getCompleateFileName (void );
+ +
+
+
+

updateCurrentFolder

++ void updateCurrentFolder (void );
+ +
+
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+
+ + + diff --git a/class_ewol__widget__Gird.html b/class_ewol__widget__Gird.html new file mode 100644 index 00000000..b0fe7267 --- /dev/null +++ b/class_ewol__widget__Gird.html @@ -0,0 +1,310 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Gird

Constructor and Destructor:

+
++                                     Gird                (int32_t _colNumber);
+ virtual                             ~Gird               (void );
+
+

Synopsis:

+
++         void                        init                (ewol::widget::Manager & _widgetManager);
+         void                        setColNumber        (int32_t _colNumber);
+         void                        setColSize          (int32_t _colId,
                                                           int32_t _size);
+         void                        setRowSize          (int32_t _size);
+         int32_t                     getColSize          (int32_t _colId);
+         int32_t                     getRowSize          (void );
+         void                        setGravityButtom    (void );
+         void                        setGravityTop       (void );
+ virtual void                        subWidgetRemoveAll  (void );
+ virtual void                        subWidgetAdd        (int32_t _colId,
                                                           int32_t _rowId,
                                                           ewol::Widget* _newWidget);
+ virtual void                        subWidgetRemove     (ewol::Widget* _newWidget);
+ virtual void                        subWidgetRemove     (int32_t _colId,
                                                           int32_t _rowId);
+ virtual void                        subWidgetUnLink     (ewol::Widget* _newWidget);
+ virtual void                        subWidgetUnLink     (int32_t _colId,
                                                           int32_t _rowId);
+         void                        setBorderSize       (const ivec2 & _newBorderSize);
+         const ivec2 &               getBorderSize       (void );
+ virtual void                        systemDraw          (const ewol::DrawProperty & _displayProp);
+ virtual void                        onRegenerateDisplay (void );
+ virtual ewol::Widget*               getWidgetAtPos      (const vec2 & pos);
+ virtual void                        onObjectRemove      (ewol::Object* _removeObject);
+ virtual void                        calculateSize       (const vec2 & _availlable);
+ virtual void                        calculateMinMaxSize (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Gird
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

Gird

++  Gird (int32_t _colNumber);
+Constructor
+
+
+

~Gird

++ virtual  ~Gird (void );
+Desstructor
+
+
+

setColNumber

++ void setColNumber (int32_t _colNumber);
+set the number of colomn
    + + +
    Parameter [input]:colNumber Nuber of colomn
    +
+ +
+
+

setColSize

++ void setColSize (int32_t _colId,
                   int32_t _size);
+change a size view of a colomn.
    + + + +
    Parameter [input]:colId Id of the colomn [0..x].
    Parameter [input]:size size of the colomn.
    +
+ +
+
+

setRowSize

++ void setRowSize (int32_t _size);
+change a size view of a line.
    + + +
    Parameter [input]:size size of the line.
    +
+ +
+
+

getColSize

++ int32_t getColSize (int32_t _colId);
+get the size view of a colomn.
    + + +
    Parameter [input]:colId Id of the colomn [0..x].
    Return: The size of the colomn.
    +
+ +
+
+

getRowSize

++ int32_t getRowSize (void );
+get the size view of the lines.
    + +
    Return: The size of the lines.
    +
+ +
+
+

setGravityButtom

++ void setGravityButtom (void );
+set the gravity of the widget on the Button (index 0 is on buttom)
+
+
+

setGravityTop

++ void setGravityTop (void );
+set the gravity of the widget on the Top (index 0 is on top)
+
+
+

subWidgetRemoveAll

++ virtual void subWidgetRemoveAll (void );
+remove all sub element from the widget.
+
+
+

subWidgetAdd

++ virtual void subWidgetAdd (int32_t _colId,
                             int32_t _rowId,
                             ewol::Widget* _newWidget);
+add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
+ +
+
+

subWidgetRemove

++ virtual void subWidgetRemove (ewol::Widget* _newWidget);
+remove definitly a widget from the system and this Gird.
+ +
+
+

subWidgetRemove

++ virtual void subWidgetRemove (int32_t _colId,
                                int32_t _rowId);
+remove definitly a widget from the system and this Gird.
    + + + +
    Parameter [input]:_colId Id of the colomn [0..x].
    Parameter [input]:_rowId Id of the row [0..y].
    +
+ +
+
+

subWidgetUnLink

++ virtual void subWidgetUnLink (ewol::Widget* _newWidget);
+Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...).
+ +
+
+

subWidgetUnLink

++ virtual void subWidgetUnLink (int32_t _colId,
                                int32_t _rowId);
+Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...).
    + + + +
    Parameter [input]:_colId Id of the colomn [0..x].
    Parameter [input]:_rowId Id of the row [0..y].
    +
+ +
+
+

setBorderSize

++ void setBorderSize (const ivec2 & _newBorderSize);
+set the current border size of the current element:
    + + +
    Parameter [input]:_newBorderSize The border size to set (0 if not used)
    +
+ +
+
+

getBorderSize

++ const ivec2 & getBorderSize (void );
+get the current border size of the current element:
    + +
    Return: the border size (0 if not used)
    +
+ +
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+
+ + + diff --git a/class_ewol__widget__Gird__GirdProperties.html b/class_ewol__widget__Gird__GirdProperties.html new file mode 100644 index 00000000..2bc2e4b7 --- /dev/null +++ b/class_ewol__widget__Gird__GirdProperties.html @@ -0,0 +1,118 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Gird::GirdProperties

Description:

+ +

+

Synopsis:

+
++ ewol::Widget* widget;
+ int32_t       row;
+ int32_t       col;
+
+

Detail:

+

widget

++ ewol::Widget* widget;
+ +
+
+
+

row

++ int32_t row;
+ +
+
+
+

col

++ int32_t col;
+ +
+
+
+
+ + + diff --git a/class_ewol__widget__Image.html b/class_ewol__widget__Image.html new file mode 100644 index 00000000..30b0f60b --- /dev/null +++ b/class_ewol__widget__Image.html @@ -0,0 +1,322 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Image

Constructor and Destructor:

+
++                                  Image               (const std::string & _file,
                                                        const ewol::Dimension & _border);
+ virtual                          ~Image              (void );
+
+

Synopsis:

+
++         const char* const        eventPressed;
+         const char* const        configRatio;
+         const char* const        configSize;
+         const char* const        configBorder;
+         const char* const        configSource;
+         void                     init                (ewol::widget::Manager & _widgetManager);
#         ewol::compositing::Image m_compositing;
+         void                     set                 (const std::string & _file,
                                                        const ewol::Dimension & _border);
#         std::string              m_fileName;
+         void                     setFile             (const std::string & _file);
+         const std::string &      getFile             (void ) const;
#         ewol::Dimension          m_border;
+         void                     setBorder           (const ewol::Dimension & _border);
+         const ewol::Dimension &  getBorder           (void ) const;
#         ewol::Dimension          m_imageSize;
+         void                     setImageSize        (const ewol::Dimension & _size);
+         const ewol::Dimension &  getImageSize        (void ) const;
#         bool                     m_keepRatio;
+         void                     setKeepRatio        (bool _keep);
+         bool                     getKeepRatio        (void ) const;
# virtual void                     onDraw              (void );
# virtual bool                     onSetConfig         (const ewol::object::Config & _conf);
# virtual bool                     onGetConfig         (const char* _config,
                                                        std::string & _result) const;
+ virtual void                     calculateMinMaxSize (void );
+ virtual void                     onRegenerateDisplay (void );
+ virtual bool                     onEventInput        (const ewol::event::Input & _event);
+ virtual bool                     loadXML             (exml::Element* _node);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Image
+

Detail:

+

eventPressed

++ const char* const eventPressed;
+ +
+
+
+

configRatio

++ const char* const configRatio;
+ +
+
+
+

configSize

++ const char* const configSize;
+ +
+
+
+

configBorder

++ const char* const configBorder;
+ +
+
+
+

configSource

++ const char* const configSource;
+ +
+
+
+

init

++ void init (ewol::widget::Manager & _widgetManager);
+Main call of recording the widget on the List of "widget named creator"
+
+
+

m_compositing

+# ewol::compositing::Image m_compositing;
+ +compositing element of the image.
+
+
+

Image

++  Image (const std::string & _file,
          const ewol::Dimension & _border);
+ +
+
+

~Image

++ virtual  ~Image (void );
+ +
+
+

set

++ void set (const std::string & _file,
            const ewol::Dimension & _border);
+set All the configuration of the current image
+ +
+
+

m_fileName

+# std::string m_fileName;
+ +file name of the image.
+
+
+

setFile

++ void setFile (const std::string & _file);
+set the new filename
+ +
+
+

getFile

++ const std::string & getFile (void ) const;
+get the file displayed
+ +
+
+

m_border

+# ewol::Dimension m_border;
+ +border to add at the image.
+
+
+

setBorder

++ void setBorder (const ewol::Dimension & _border);
+set tge Border size around the image
+ +
+
+

getBorder

++ const ewol::Dimension & getBorder (void ) const;
+get the current border request at the image
+ +
+
+

m_imageSize

+# ewol::Dimension m_imageSize;
+ +border to add at the image.
+
+
+

setImageSize

++ void setImageSize (const ewol::Dimension & _size);
+set tge Border size around the image
+ +
+
+

getImageSize

++ const ewol::Dimension & getImageSize (void ) const;
+get the current border request at the image
+ +
+
+

m_keepRatio

+# bool m_keepRatio;
+ +keep the image ratio between width and hight
+
+
+

setKeepRatio

++ void setKeepRatio (bool _keep);
+set the current status of keeping ratio.
    + + +
    Parameter [input]:_keep The new status of keeping the ratio of this image.
    +
+ +
+
+

getKeepRatio

++ bool getKeepRatio (void ) const;
+get the current status of keeping ratio.
    + +
    Return: The status of keeping the ratio of this image.
    +
+ +
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+
+ + + diff --git a/class_ewol__widget__Joystick.html b/class_ewol__widget__Joystick.html new file mode 100644 index 00000000..90b85183 --- /dev/null +++ b/class_ewol__widget__Joystick.html @@ -0,0 +1,217 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Joystick

enum:

+ +

Constructor and Destructor:

+
++                           Joystick            (void );
+ virtual                   ~Joystick           (void );
+
+

Synopsis:

+
++         const char* const eventEnable;
+         const char* const eventDisable;
+         const char* const eventMove;
+         void              setLockMode         (bool _lockWhenOut);
+         void              setDisplayMode      (enum joystickMode _newMode);
+         void              ratio               (float _newRatio);
+         void              background          (std::string _imageNameInData,
                                                 bool _display);
+         void              foreground          (std::string _imageNameInData);
+         void              getProperty         (float & _distance,
                                                 float & _angle);
+ virtual void              calculateSize       (const vec2 & _availlable);
+ virtual void              onRegenerateDisplay (void );
+ virtual bool              onEventInput        (const ewol::event::Input & _event);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Joystick
+

Detail:

+

eventEnable

++ const char* const eventEnable;
+ +
+
+
+

eventDisable

++ const char* const eventDisable;
+ +
+
+
+

eventMove

++ const char* const eventMove;
+ +
+
+
+

Joystick

++  Joystick (void );
+ +
+
+
+

~Joystick

++ virtual  ~Joystick (void );
+ +
+
+
+

setLockMode

++ void setLockMode (bool _lockWhenOut);
+ +
+
+
+

setDisplayMode

++ void setDisplayMode (enum joystickMode _newMode);
+ +
+
+
+

ratio

++ void ratio (float _newRatio);
+set the ratio of the widget joystick
    + + +
    Parameter [input]:_newRatio the new ratio that might be set
    +
+ +
+
+

background

++ void background (std::string _imageNameInData,
                   bool _display);
+set the Background of the widget joystick
+ +
+
+

foreground

++ void foreground (std::string _imageNameInData);
+set the Foreground of the widget joystick
+ +
+
+

getProperty

++ void getProperty (float & _distance,
                    float & _angle);
+get the property of the joystick
    + + + +
    Parameter [output]:_distance distance to the center
    Parameter [output]:_angle angle of the joy
    +
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+
+ + + diff --git a/class_ewol__widget__Label.html b/class_ewol__widget__Label.html new file mode 100644 index 00000000..de98579f --- /dev/null +++ b/class_ewol__widget__Label.html @@ -0,0 +1,196 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Label

Constructor and Destructor:

+
++                                 Label               (std::string _newLabel);
+ virtual                         ~Label              (void );
+
+

Synopsis:

+
++         const char* const       eventPressed;
+         void                    init                (ewol::widget::Manager & _widgetManager);
+         void                    setLabel            (const std::string & _newLabel);
+         void                    setValue            (const std::string & _newLabel);
+         std::string             getLabel            (void );
+         std::string             getValue            (void );
# virtual void                    onDraw              (void );
+ virtual void                    calculateMinMaxSize (void );
+ virtual void                    onRegenerateDisplay (void );
+ virtual bool                    onEventInput        (const ewol::event::Input & _event);
+ virtual bool                    loadXML             (exml::Element* _node);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Label
+

Detail:

+

eventPressed

++ const char* const eventPressed;
+ +
+
+
+

init

++ void init (ewol::widget::Manager & _widgetManager);
+Main call of recording the widget on the List of "widget named creator"
+
+
+

Label

++  Label (std::string _newLabel);
+Constructor
+ +
+
+

~Label

++ virtual  ~Label (void );
+destructor
+
+
+

setLabel

++ void setLabel (const std::string & _newLabel);
+change the label displayed
+ +
+
+

setValue

++ void setValue (const std::string & _newLabel);
+ +
+
+
+

getLabel

++ std::string getLabel (void );
+get the current displayed label
+ +
+
+

getValue

++ std::string getValue (void );
+ +
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+
+ + + diff --git a/class_ewol__widget__Layer.html b/class_ewol__widget__Layer.html new file mode 100644 index 00000000..4b31c9eb --- /dev/null +++ b/class_ewol__widget__Layer.html @@ -0,0 +1,129 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Layer

Constructor and Destructor:

+
++                       Layer          (void );
+ virtual               ~Layer         (void );
+
+

Synopsis:

+
++         void          init           (ewol::widget::Manager & _widgetManager);
+ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::ContainerN
                +--> ewol::widget::Layer
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+Main call of recording the widget on the List of "widget named creator"
+
+
+

Layer

++  Layer (void );
+Constructor
+
+
+

~Layer

++ virtual  ~Layer (void );
+Desstructor
+
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+
+ + + diff --git a/class_ewol__widget__List.html b/class_ewol__widget__List.html new file mode 100644 index 00000000..b88ee794 --- /dev/null +++ b/class_ewol__widget__List.html @@ -0,0 +1,215 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::List

Constructor and Destructor:

+
++                                         List                   (void );
+ virtual                                 ~List                  (void );
+
+

Synopsis:

+
++ virtual void                            calculateMinMaxSize    (void );
+         void                            setLabel               (std::string _newLabel);
+         void                            addOObject             (ewol::Compositing* _newObject,
                                                                  int32_t _pos);
+         void                            clearOObjectList       (void );
# virtual etk::Color<>                    getBasicBG             (void );
# virtual uint32_t                        getNuberOfColomn       (void );
# virtual bool                            getTitle               (int32_t _colomn,
                                                                  std::string & _myTitle,
                                                                  etk::Color<> & _fg,
                                                                  etk::Color<> & _bg);
# virtual uint32_t                        getNuberOfRaw          (void );
# virtual bool                            getElement             (int32_t _colomn,
                                                                  int32_t _raw,
                                                                  std::string & _myTextToWrite,
                                                                  etk::Color<> & _fg,
                                                                  etk::Color<> & _bg);
# virtual bool                            onItemEvent            (int32_t _IdInput,
                                                                  enum ewol::key::status _typeEvent,
                                                                  int32_t _colomn,
                                                                  int32_t _raw,
                                                                  float _x,
                                                                  float _y);
#         void                            setRawVisible          (int32_t _id);
# virtual void                            onGetFocus             (void );
# virtual void                            onLostFocus            (void );
# virtual void                            onDraw                 (void );
+ virtual void                            onRegenerateDisplay    (void );
+ virtual bool                            onEventInput           (const ewol::event::Input & _event);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::WidgetScrooled
                +--> ewol::widget::List
                       +--> ewol::widget::ListFileSystem
+

Detail:

+

List

++  List (void );
+ +
+
+
+

~List

++ virtual  ~List (void );
+ +
+
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

setLabel

++ void setLabel (std::string _newLabel);
+ +
+
+
+

addOObject

++ void addOObject (ewol::Compositing* _newObject,
                   int32_t _pos);
+ +
+
+
+

clearOObjectList

++ void clearOObjectList (void );
+ +
+
+
+

getBasicBG

+# virtual etk::Color<> getBasicBG (void );
+ +
+
+
+

getNuberOfColomn

+# virtual uint32_t getNuberOfColomn (void );
+ +
+
+
+

getTitle

+# virtual bool getTitle (int32_t _colomn,
                         std::string & _myTitle,
                         etk::Color<> & _fg,
                         etk::Color<> & _bg);
+ +
+
+
+

getNuberOfRaw

+# virtual uint32_t getNuberOfRaw (void );
+ +
+
+
+

getElement

+# virtual bool getElement (int32_t _colomn,
                           int32_t _raw,
                           std::string & _myTextToWrite,
                           etk::Color<> & _fg,
                           etk::Color<> & _bg);
+ +
+
+
+

onItemEvent

+# virtual bool onItemEvent (int32_t _IdInput,
                            enum ewol::key::status _typeEvent,
                            int32_t _colomn,
                            int32_t _raw,
                            float _x,
                            float _y);
+ +
+
+
+

setRawVisible

+# void setRawVisible (int32_t _id);
+set a raw visible in the main display
    + + +
    Parameter [input]:_id Id of the raw that might be visible.
    +
+ +
+
+

onGetFocus

+# virtual void onGetFocus (void );
+Event of the focus has been grep by the current widget
+
+
+

onLostFocus

+# virtual void onLostFocus (void );
+Event of the focus has been lost by the current widget
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+
+ + + diff --git a/class_ewol__widget__ListFileSystem.html b/class_ewol__widget__ListFileSystem.html new file mode 100644 index 00000000..1e3fe98c --- /dev/null +++ b/class_ewol__widget__ListFileSystem.html @@ -0,0 +1,230 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ListFileSystem

Constructor and Destructor:

+
++                                   ListFileSystem        (void );
+                                   ~ListFileSystem       (void );
+
+

Synopsis:

+
++         const char* const         eventFileSelect;
+         const char* const         eventFileValidate;
+         const char* const         eventFolderSelect;
+         const char* const         eventFolderValidate;
+ virtual etk::Color<>              getBasicBG            (void );
+         uint32_t                  getNuberOfColomn      (void );
+         bool                      getTitle              (int32_t _colomn,
                                                           std::string & _myTitle,
                                                           etk::Color<> & _fg,
                                                           etk::Color<> & _bg);
+         uint32_t                  getNuberOfRaw         (void );
+         bool                      getElement            (int32_t _colomn,
                                                           int32_t _raw,
                                                           std::string & _myTextToWrite,
                                                           etk::Color<> & _fg,
                                                           etk::Color<> & _bg);
+         bool                      onItemEvent           (int32_t _IdInput,
                                                           enum ewol::key::status _typeEvent,
                                                           int32_t _colomn,
                                                           int32_t _raw,
                                                           float _x,
                                                           float _y);
+         void                      setFolder             (std::string _newFolder);
+         std::string               getFolder             (void );
+         void                      setSelect             (std::string _data);
+         std::string               getSelect             (void );
+         void                      regenerateView        (void );
+         void                      setShowFiles          (bool _state);
+         void                      setShowFolder         (bool _state);
+         void                      setShowHiddenFiles    (bool _state);
+         void                      setShowTemporaryFiles (bool _state);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::WidgetScrooled
                +--> +ewol::widget::List
                       +--> ewol::widget::ListFileSystem
+

Detail:

+

eventFileSelect

++ const char* const eventFileSelect;
+ +
+
+
+

eventFileValidate

++ const char* const eventFileValidate;
+ +
+
+
+

eventFolderSelect

++ const char* const eventFolderSelect;
+ +
+
+
+

eventFolderValidate

++ const char* const eventFolderValidate;
+ +
+
+
+

ListFileSystem

++  ListFileSystem (void );
+ +
+
+
+

~ListFileSystem

++  ~ListFileSystem (void );
+ +
+
+
+

getBasicBG

++ virtual etk::Color<> getBasicBG (void );
+ +
+
+
+

getNuberOfColomn

++ uint32_t getNuberOfColomn (void );
+ +
+
+
+

getTitle

++ bool getTitle (int32_t _colomn,
                 std::string & _myTitle,
                 etk::Color<> & _fg,
                 etk::Color<> & _bg);
+ +
+
+
+

getNuberOfRaw

++ uint32_t getNuberOfRaw (void );
+ +
+
+
+

getElement

++ bool getElement (int32_t _colomn,
                   int32_t _raw,
                   std::string & _myTextToWrite,
                   etk::Color<> & _fg,
                   etk::Color<> & _bg);
+ +
+
+
+

onItemEvent

++ bool onItemEvent (int32_t _IdInput,
                    enum ewol::key::status _typeEvent,
                    int32_t _colomn,
                    int32_t _raw,
                    float _x,
                    float _y);
+ +
+
+
+

setFolder

++ void setFolder (std::string _newFolder);
+ +
+
+
+

getFolder

++ std::string getFolder (void );
+ +
+
+
+

setSelect

++ void setSelect (std::string _data);
+ +
+
+
+

getSelect

++ std::string getSelect (void );
+ +
+
+
+

regenerateView

++ void regenerateView (void );
+ +
+
+
+

setShowFiles

++ void setShowFiles (bool _state);
+ +
+
+
+

setShowFolder

++ void setShowFolder (bool _state);
+ +
+
+
+

setShowHiddenFiles

++ void setShowHiddenFiles (bool _state);
+ +
+
+
+

setShowTemporaryFiles

++ void setShowTemporaryFiles (bool _state);
+ +
+
+
+
+ + + diff --git a/class_ewol__widget__Manager.html b/class_ewol__widget__Manager.html new file mode 100644 index 00000000..6d33b005 --- /dev/null +++ b/class_ewol__widget__Manager.html @@ -0,0 +1,224 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Manager

Description:

+ +

+

Constructor and Destructor:

+
++                            Manager                (void );
+                            ~Manager               (void );
+
+

Synopsis:

+
++ typedefewol::Widget        *                      (*creator_tf)( void);
+ void                       rm                     (ewol::Widget* _newWidget);
+ void                       focusKeep              (ewol::Widget* _newWidget);
+ void                       focusSetDefault        (ewol::Widget* _newWidget);
+ void                       focusRelease           (void );
+ ewol::Widget*              focusGet               (void );
+ void                       focusRemoveIfRemove    (ewol::Widget* _newWidget);
+ void                       periodicCallAdd        (ewol::Widget* _pWidget);
+ void                       periodicCallRm         (ewol::Widget* _pWidget);
+ void                       periodicCall           (int64_t _localTime);
+ void                       periodicCallResume     (int64_t _localTime);
+ bool                       periodicCallHave       (void );
+ void                       markDrawingIsNeeded    (void );
+ bool                       isDrawingNeeded        (void );
+ void                       addWidgetCreator       (const std::string & _name,
                                                     creator_tf _pointer);
+ ewol::Widget*              create                 (const std::string & _name);
+ bool                       exist                  (const std::string & _name);
+ std::string                list                   (void );
+
+

Detail:

+

*

++ typedefewol::Widget * (*creator_tf)( void);
+ +
+
+
+

Manager

++  Manager (void );
+ +
+
+
+

~Manager

++  ~Manager (void );
+ +
+
+
+

rm

++ void rm (ewol::Widget* _newWidget);
+ +
+
+
+

focusKeep

++ void focusKeep (ewol::Widget* _newWidget);
+ +
+
+
+

focusSetDefault

++ void focusSetDefault (ewol::Widget* _newWidget);
+ +
+
+
+

focusRelease

++ void focusRelease (void );
+ +
+
+
+

focusGet

++ ewol::Widget* focusGet (void );
+ +
+
+
+

focusRemoveIfRemove

++ void focusRemoveIfRemove (ewol::Widget* _newWidget);
+ +
+
+
+

periodicCallAdd

++ void periodicCallAdd (ewol::Widget* _pWidget);
+ +
+
+
+

periodicCallRm

++ void periodicCallRm (ewol::Widget* _pWidget);
+ +
+
+
+

periodicCall

++ void periodicCall (int64_t _localTime);
+ +
+
+
+

periodicCallResume

++ void periodicCallResume (int64_t _localTime);
+ +
+
+
+

periodicCallHave

++ bool periodicCallHave (void );
+ +
+
+
+

markDrawingIsNeeded

++ void markDrawingIsNeeded (void );
+ +
+
+
+

isDrawingNeeded

++ bool isDrawingNeeded (void );
+ +
+
+
+

addWidgetCreator

++ void addWidgetCreator (const std::string & _name,
                         creator_tf _pointer);
+ +
+
+
+

create

++ ewol::Widget* create (const std::string & _name);
+ +
+
+
+

exist

++ bool exist (const std::string & _name);
+ +
+
+
+

list

++ std::string list (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__widget__Menu.html b/class_ewol__widget__Menu.html new file mode 100644 index 00000000..f9de25a3 --- /dev/null +++ b/class_ewol__widget__Menu.html @@ -0,0 +1,160 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Menu

Constructor and Destructor:

+
++                                                 Menu                (void );
+ virtual                                         ~Menu               (void );
+
+

Synopsis:

+
++         void                                    clear               (void );
+         int32_t                                 addTitle            (std::string _label,
                                                                       std::string _image,
                                                                       const char* _generateEvent,
                                                                       const std::string _message);
+         int32_t                                 add                 (int32_t parent,
                                                                       std::string _label,
                                                                       std::string _image,
                                                                       const char* _generateEvent,
                                                                       const std::string _message);
+         void                                    addSpacer           (void );
+ virtual void                                    onReceiveMessage    (const ewol::object::Message & _msg);
+ virtual void                                    onObjectRemove      (ewol::Object* _removeObject);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::ContainerN
                +--> +ewol::widget::Sizer
                       +--> ewol::widget::Menu
+

Detail:

+

Menu

++  Menu (void );
+ +
+
+
+

~Menu

++ virtual  ~Menu (void );
+ +
+
+
+

clear

++ void clear (void );
+ +
+
+
+

addTitle

++ int32_t addTitle (std::string _label,
                    std::string _image,
                    const char* _generateEvent,
                    const std::string _message);
+ +
+
+
+

add

++ int32_t add (int32_t parent,
               std::string _label,
               std::string _image,
               const char* _generateEvent,
               const std::string _message);
+ +
+
+
+

addSpacer

++ void addSpacer (void );
+ +
+
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+
+ + + diff --git a/class_ewol__widget__MenuElement.html b/class_ewol__widget__MenuElement.html new file mode 100644 index 00000000..bf4d09ea --- /dev/null +++ b/class_ewol__widget__MenuElement.html @@ -0,0 +1,152 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::MenuElement

Description:

+ +

+

Constructor and Destructor:

+
++               MenuElement     (void );
+
+

Synopsis:

+
++ int32_t       m_localId;
+ int32_t       m_parentId;
+ ewol::Object* m_widgetPointer;
+ std::string   m_label;
+ std::string   m_image;
+ const char*   m_generateEvent;
+ std::string   m_message;
+
+

Detail:

+

MenuElement

++  MenuElement (void );
+ +
+
+
+

m_localId

++ int32_t m_localId;
+ +
+
+
+

m_parentId

++ int32_t m_parentId;
+ +
+
+
+

m_widgetPointer

++ ewol::Object* m_widgetPointer;
+ +
+
+
+

m_label

++ std::string m_label;
+ +
+
+
+

m_image

++ std::string m_image;
+ +
+
+
+

m_generateEvent

++ const char* m_generateEvent;
+ +
+
+
+

m_message

++ std::string m_message;
+ +
+
+
+
+ + + diff --git a/class_ewol__widget__Parameter.html b/class_ewol__widget__Parameter.html new file mode 100644 index 00000000..b4a506d4 --- /dev/null +++ b/class_ewol__widget__Parameter.html @@ -0,0 +1,172 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Parameter

Constructor and Destructor:

+
++                                      Parameter        (void );
+                                      ~Parameter       (void );
+
+

Synopsis:

+
++         const char* const            eventClose;
+ virtual void                         onReceiveMessage (const ewol::object::Message & _msg);
+ virtual void                         onObjectRemove   (ewol::Object* _removeObject);
+         void                         setTitle         (std::string _label);
+         void                         menuAdd          (std::string _label,
                                                         std::string _image,
                                                         ewol::Widget* _associateWidget);
+         void                         menuAddGroup     (std::string _label);
+         void                         menuClear        (void );
+         void                         menuSeparator    (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::Container
                +--> +ewol::widget::PopUp
                       +--> ewol::widget::Parameter
+

Detail:

+

eventClose

++ const char* const eventClose;
+ +
+
+
+

Parameter

++  Parameter (void );
+ +
+
+
+

~Parameter

++  ~Parameter (void );
+ +
+
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

setTitle

++ void setTitle (std::string _label);
+ +
+
+
+

menuAdd

++ void menuAdd (std::string _label,
                std::string _image,
                ewol::Widget* _associateWidget);
+ +
+
+
+

menuAddGroup

++ void menuAddGroup (std::string _label);
+ +
+
+
+

menuClear

++ void menuClear (void );
+ +
+
+
+

menuSeparator

++ void menuSeparator (void );
+ +
+
+
+
+ + + diff --git a/class_ewol__widget__ParameterList.html b/class_ewol__widget__ParameterList.html new file mode 100644 index 00000000..a5d4ca5b --- /dev/null +++ b/class_ewol__widget__ParameterList.html @@ -0,0 +1,199 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ParameterList

Constructor and Destructor:

+
++                                               ParameterList          (void );
+ virtual                                       ~ParameterList         (void );
+
+

Synopsis:

+
++         const char* const                     eventSelect;
+         void                                  setLabel               (std::string _newLabel);
+         void                                  addOObject             (ewol::Compositing* _newObject,
                                                                        int32_t _pos);
+         void                                  clearOObjectList       (void );
+         void                                  menuAdd                (std::string & _label,
                                                                        int32_t _refId,
                                                                        std::string & _image);
+         void                                  menuAddGroup           (std::string & _label);
+         void                                  menuClear              (void );
+         void                                  menuSeparator          (void );
+ virtual void                                  onRegenerateDisplay    (void );
+ virtual bool                                  onEventInput           (const ewol::event::Input & _event);
+ virtual void                                  calculateMinMaxSize    (void );
# virtual void                                  onGetFocus             (void );
# virtual void                                  onLostFocus            (void );
# virtual void                                  onDraw                 (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::WidgetScrooled
                +--> ewol::widget::ParameterList
+

Detail:

+

eventSelect

++ const char* const eventSelect;
+ +
+
+
+

ParameterList

++  ParameterList (void );
+ +
+
+
+

~ParameterList

++ virtual  ~ParameterList (void );
+ +
+
+
+

setLabel

++ void setLabel (std::string _newLabel);
+ +
+
+
+

addOObject

++ void addOObject (ewol::Compositing* _newObject,
                   int32_t _pos);
+ +
+
+
+

clearOObjectList

++ void clearOObjectList (void );
+ +
+
+
+

menuAdd

++ void menuAdd (std::string & _label,
                int32_t _refId,
                std::string & _image);
+ +
+
+
+

menuAddGroup

++ void menuAddGroup (std::string & _label);
+ +
+
+
+

menuClear

++ void menuClear (void );
+ +
+
+
+

menuSeparator

++ void menuSeparator (void );
+ +
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onGetFocus

+# virtual void onGetFocus (void );
+Event of the focus has been grep by the current widget
+
+
+

onLostFocus

+# virtual void onLostFocus (void );
+Event of the focus has been lost by the current widget
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+
+ + + diff --git a/class_ewol__widget__PopUp.html b/class_ewol__widget__PopUp.html new file mode 100644 index 00000000..60aab6f3 --- /dev/null +++ b/class_ewol__widget__PopUp.html @@ -0,0 +1,292 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::PopUp

Constructor and Destructor:

+
++                                   PopUp                     (const std::string & _shaperName);
+ virtual                           ~PopUp                    (void );
+
+

Synopsis:

+
++         void                      init                      (ewol::widget::Manager & _widgetManager);
+         const char* const         configShaper;
+         const char* const         configRemoveOnExternClick;
+         const char* const         configAnimation;
+         const char* const         configLockExpand;
+         void                      setShaperName             (const std::string & _shaperName);
#         bvec2                     m_lockExpand;
+         void                      lockExpand                (const bvec2 & _lockExpand);
+         void                      setRemoveOnExternClick    (bool _state);
+         bool                      getRemoveOnExternClick    (void ) const;
# virtual void                      onDraw                    (void );
# virtual bool                      onSetConfig               (const ewol::object::Config & _conf);
# virtual bool                      onGetConfig               (const char* _config,
                                                               std::string & _result) const;
+ virtual void                      periodicCall              (const ewol::event::Time & _event);
+ virtual void                      systemDraw                (const ewol::DrawProperty & _displayProp);
+ virtual void                      onRegenerateDisplay       (void );
+ virtual void                      calculateSize             (const vec2 & _available);
+ virtual bool                      onEventInput              (const ewol::event::Input & _event);
+ virtual ewol::Widget*             getWidgetAtPos            (const vec2 & pos);
# virtual bool                      onStartAnnimation         (enum ewol::Widget::annimationMode _mode);
# virtual void                      onStopAnnimation          (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::Container
                +--> ewol::widget::PopUp
                       +--> ewol::widget::Parameter
                       +--> ewol::widget::FileChooser
                       +--> ewol::widget::StdPopUp
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

configShaper

++ const char* const configShaper;
+ +
+
+
+

configRemoveOnExternClick

++ const char* const configRemoveOnExternClick;
+ +
+
+
+

configAnimation

++ const char* const configAnimation;
+ +
+
+
+

configLockExpand

++ const char* const configLockExpand;
+ +
+
+
+

PopUp

++  PopUp (const std::string & _shaperName);
+Constructor
+ +
+
+

~PopUp

++ virtual  ~PopUp (void );
+Destructor
+
+
+

setShaperName

++ void setShaperName (const std::string & _shaperName);
+set the shaper name (use the contructer one this permit to not noad unused shaper)
+ +
+
+

m_lockExpand

+# bvec2 m_lockExpand;
+ +Lock the expend of the sub widget to this one == > this permit to limit bigger subWidget
+
+
+

lockExpand

++ void lockExpand (const bvec2 & _lockExpand);
+Limit the expend properties to the current widget (no contamination)
    + + +
    Parameter [input]:_lockExpend Lock mode of the expend properties
    +
+ +
+
+

setRemoveOnExternClick

++ void setRemoveOnExternClick (bool _state);
+Request the Auto-remove when the event input is set outside the widget
    + + +
    Parameter [input]:_state New status
    +
+ +
+
+

getRemoveOnExternClick

++ bool getRemoveOnExternClick (void ) const;
+get the status of the request the Auto-remove when the event input is set outside the widget.
    + +
    Return: the status of the removing
    +
+ +
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+

periodicCall

++ virtual void periodicCall (const ewol::event::Time & _event);
+periodic call of this widget
+ +
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _available);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onStartAnnimation

+# virtual bool onStartAnnimation (enum ewol::Widget::annimationMode _mode);
+Event when start the annimation.
+ +
+
+

onStopAnnimation

+# virtual void onStopAnnimation (void );
+Event when Stop the annimation.
+
+
+
+ + + diff --git a/class_ewol__widget__ProgressBar.html b/class_ewol__widget__ProgressBar.html new file mode 100644 index 00000000..cd30bbe1 --- /dev/null +++ b/class_ewol__widget__ProgressBar.html @@ -0,0 +1,200 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::ProgressBar

Constructor and Destructor:

+
++                                    ProgressBar         (void );
+ virtual                            ~ProgressBar        (void );
+
+

Synopsis:

+
++         void                       init                (ewol::widget::Manager & _widgetManager);
+         const char* const          configColorBg;
+         const char* const          configColorFgOn;
+         const char* const          configColorFgOff;
+         const char* const          configValue;
+         void                       setValue            (float _val);
+         float                      getValue            (void ) const;
+         void                       setColor            (etk::Color<> _newColor);
# virtual void                       onDraw              (void );
# virtual bool                       onSetConfig         (const ewol::object::Config & _conf);
# virtual bool                       onGetConfig         (const char* _config,
                                                          std::string & _result) const;
+ virtual void                       onRegenerateDisplay (void );
+ virtual void                       calculateMinMaxSize (void );
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::ProgressBar
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

configColorBg

++ const char* const configColorBg;
+ +
+
+
+

configColorFgOn

++ const char* const configColorFgOn;
+ +
+
+
+

configColorFgOff

++ const char* const configColorFgOff;
+ +
+
+
+

configValue

++ const char* const configValue;
+ +
+
+
+

ProgressBar

++  ProgressBar (void );
+ +
+
+
+

~ProgressBar

++ virtual  ~ProgressBar (void );
+ +
+
+
+

setValue

++ void setValue (float _val);
+ +
+
+
+

getValue

++ float getValue (void ) const;
+ +
+
+
+

setColor

++ void setColor (etk::Color<> _newColor);
+ +
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+
+ + + diff --git a/class_ewol__widget__Scroll.html b/class_ewol__widget__Scroll.html new file mode 100644 index 00000000..ed46fbb7 --- /dev/null +++ b/class_ewol__widget__Scroll.html @@ -0,0 +1,223 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Scroll

enum:

+ +

Constructor and Destructor:

+
++                                    Scroll              (void );
+ virtual                            ~Scroll             (void );
+
+

Synopsis:

+
++         const char* const          configLimit;
+         void                       init                (ewol::widget::Manager & _widgetManager);
#         vec2                       m_limit;
+         void                       setLimit            (const vec2 & _limit);
+         const vec2 &               getLimit            (void ) const;
+         void                       calculateMinMaxSize (void );
+ virtual void                       onRegenerateDisplay (void );
+ virtual bool                       onEventInput        (const ewol::event::Input & _event);
+ virtual void                       systemDraw          (const ewol::DrawProperty & _displayProp);
+ virtual ewol::Widget*              getWidgetAtPos      (const vec2 & _pos);
# virtual void                       onDraw              (void );
# virtual bool                       onSetConfig         (const ewol::object::Config & _conf);
# virtual bool                       onGetConfig         (const char* _config,
                                                          std::string & _result) const;
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::Container
                +--> ewol::widget::Scroll
+

Detail:

+

configLimit

++ const char* const configLimit;
+ +
+
+
+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

m_limit

+# vec2 m_limit;
+ +
+
+
+

Scroll

++  Scroll (void );
+ +
+
+
+

~Scroll

++ virtual  ~Scroll (void );
+ +
+
+
+

setLimit

++ void setLimit (const vec2 & _limit);
+set the limit of scrolling
Note: This permit to scoll element upper the end of the display
    + + +
    Parameter [input]:_limit scrolling limit [0..1] (represent a pourcent)
    +
+ +
+
+

getLimit

++ const vec2 & getLimit (void ) const;
+get the limit of scrolling
    + +
    Return: scrolling limit
    +
+ +
+
+

calculateMinMaxSize

++ void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onSetConfig

+# virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

+# virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+
+ + + diff --git a/class_ewol__widget__Sizer.html b/class_ewol__widget__Sizer.html new file mode 100644 index 00000000..1f65acca --- /dev/null +++ b/class_ewol__widget__Sizer.html @@ -0,0 +1,269 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Sizer

enum:

+ +

Constructor and Destructor:

+
++                                 Sizer               (enum displayMode _mode);
+ virtual                         ~Sizer              (void );
+
+

Synopsis:

+
++         void                    init                (ewol::widget::Manager & _widgetManager);
+         void                    setMode             (enum displayMode _mode);
+         enum displayMode        getMode             (void );
+         void                    setBorderSize       (const ewol::Dimension & _newBorderSize);
+         const ewol::Dimension & getBorderSize       (void );
+         void                    setAnimationMode    (enum animation _animation);
+         enum animation          getAnimationMode    (void );
+         void                    setAnimationTime    (float _time);
+         float                   getAnimationTime    (void );
+ virtual void                    calculateSize       (const vec2 & _availlable);
+ virtual void                    calculateMinMaxSize (void );
+ virtual bool                    loadXML             (exml::Element* _node);
+ virtual int32_t                 subWidgetAdd        (ewol::Widget* _newWidget);
+ virtual int32_t                 subWidgetAddStart   (ewol::Widget* _newWidget);
+ virtual void                    subWidgetRemove     (ewol::Widget* _newWidget);
+ virtual void                    subWidgetUnLink     (ewol::Widget* _newWidget);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::ContainerN
                +--> ewol::widget::Sizer
                       +--> ewol::widget::Menu
                       +--> ewol::widget::ColorChooser
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+Main call of recording the widget on the List of "widget named creator"
+
+
+

Sizer

++  Sizer (enum displayMode _mode);
+Constructor
    + + +
    Parameter [input]:_mode The mode to display the elements
    +
+ +
+
+

~Sizer

++ virtual  ~Sizer (void );
+Desstructor
+
+
+

setMode

++ void setMode (enum displayMode _mode);
+set the mode to display elements.
    + + +
    Parameter [input]:_mode The mode to display the elements.
    +
+ +
+
+

getMode

++ enum displayMode getMode (void );
+get the mode to display elements.
    + +
    Return: The current mode to display the elements.
    +
+ +
+
+

setBorderSize

++ void setBorderSize (const ewol::Dimension & _newBorderSize);
+set the current border size of the current element:
+ +
+
+

getBorderSize

++ const ewol::Dimension & getBorderSize (void );
+get the current border size of the current element:
+ +
+
+

setAnimationMode

++ void setAnimationMode (enum animation _animation);
+set an animation mode for the new element set in the Widget container.
    + + +
    Parameter [input]:_animation The new animation mode.
    +
+ +
+
+

getAnimationMode

++ enum animation getAnimationMode (void );
+get the current animation mode.
    + +
    Return: The animation mode.
    +
+ +
+
+

setAnimationTime

++ void setAnimationTime (float _time);
+set the time to produce animation.
    + + +
    Parameter [input]:_time The new animation time.
    +
+ +
+
+

getAnimationTime

++ float getAnimationTime (void );
+get the current animation time.
    + +
    Return: The time to produce the animation.
    +
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

loadXML

++ virtual bool loadXML (exml::Element* _node);
+load properties with an XML node.
+ +
+
+

subWidgetAdd

++ virtual int32_t subWidgetAdd (ewol::Widget* _newWidget);
+add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
+ +
+
+

subWidgetAddStart

++ virtual int32_t subWidgetAddStart (ewol::Widget* _newWidget);
+add at start position a Widget (note : This system use an inverted phylisophie (button to top, and left to right)
+ +
+
+

subWidgetRemove

++ virtual void subWidgetRemove (ewol::Widget* _newWidget);
+remove definitly a widget from the system and this layer.
+ +
+
+

subWidgetUnLink

++ virtual void subWidgetUnLink (ewol::Widget* _newWidget);
+Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...)
+ +
+
+
+ + + diff --git a/class_ewol__widget__Slider.html b/class_ewol__widget__Slider.html new file mode 100644 index 00000000..6baa2124 --- /dev/null +++ b/class_ewol__widget__Slider.html @@ -0,0 +1,219 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Slider

Constructor and Destructor:

+
++                                    Slider              (void );
+ virtual                            ~Slider             (void );
+
+

Synopsis:

+
++         const char* const          eventChange;
+         void                       init                (ewol::widget::Manager & _widgetManager);
+         void                       setValue            (int32_t _val);
+         int32_t                    getValue            (void );
+         void                       setMin              (int32_t _val);
+         void                       setMax              (int32_t _val);
+         void                       setColor            (etk::Color<> _newColor);
#         ewol::compositing::Drawing m_draw;
#         int32_t                    m_value;
#         int32_t                    m_min;
#         int32_t                    m_max;
#         etk::Color<>               m_textColorFg;
#         etk::Color<>               m_textColorBg;
+ virtual void                       onDraw              (void );
+ virtual void                       calculateMinMaxSize (void );
+ virtual void                       onRegenerateDisplay (void );
+ virtual bool                       onEventInput        (const ewol::event::Input & _event);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Slider
+

Detail:

+

eventChange

++ const char* const eventChange;
+ +
+
+
+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

Slider

++  Slider (void );
+ +
+
+
+

~Slider

++ virtual  ~Slider (void );
+ +
+
+
+

setValue

++ void setValue (int32_t _val);
+ +
+
+
+

getValue

++ int32_t getValue (void );
+ +
+
+
+

setMin

++ void setMin (int32_t _val);
+ +
+
+
+

setMax

++ void setMax (int32_t _val);
+ +
+
+
+

setColor

++ void setColor (etk::Color<> _newColor);
+ +
+
+
+

m_draw

+# ewol::compositing::Drawing m_draw;
+ +drawing tool.
+
+
+

m_value

+# int32_t m_value;
+ +
+
+
+

m_min

+# int32_t m_min;
+ +
+
+
+

m_max

+# int32_t m_max;
+ +
+
+
+

m_textColorFg

+# etk::Color<> m_textColorFg;
+ +Text color
+
+
+

m_textColorBg

+# etk::Color<> m_textColorBg;
+ +Background color
+
+
+

onDraw

++ virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

calculateMinMaxSize

++ virtual void calculateMinMaxSize (void );
+calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+
+ + + diff --git a/class_ewol__widget__Spacer.html b/class_ewol__widget__Spacer.html new file mode 100644 index 00000000..382ca349 --- /dev/null +++ b/class_ewol__widget__Spacer.html @@ -0,0 +1,183 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Spacer

Constructor and Destructor:

+
++                                    Spacer              (void );
+ virtual                            ~Spacer             (void );
+
+

Synopsis:

+
++         void                       init                (ewol::widget::Manager & _widgetManager);
+         const char* const          configColor;
#         etk::Color<>               m_color;
+         void                       setColor            (etk::Color<> _newColor);
+ virtual ewol::Widget*              getWidgetAtPos      (const vec2 & _pos);
+ virtual void                       onRegenerateDisplay (void );
+ virtual void                       onDraw              (void );
+ virtual bool                       onSetConfig         (const ewol::object::Config & _conf);
+ virtual bool                       onGetConfig         (const char* _config,
                                                          std::string & _result) const;
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Spacer
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

configColor

++ const char* const configColor;
+ +
+
+
+

Spacer

++  Spacer (void );
+Main constructer
+
+
+

~Spacer

++ virtual  ~Spacer (void );
+Main destructer
+
+
+

m_color

+# etk::Color<> m_color;
+ +Background color
+
+
+

setColor

++ void setColor (etk::Color<> _newColor);
+Spziby the background color (basicly transparent)
+ +
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onDraw

++ virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onSetConfig

++ virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

++ virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+
+ + + diff --git a/class_ewol__widget__StdPopUp.html b/class_ewol__widget__StdPopUp.html new file mode 100644 index 00000000..d048a5de --- /dev/null +++ b/class_ewol__widget__StdPopUp.html @@ -0,0 +1,182 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::StdPopUp

Constructor and Destructor:

+
++                               StdPopUp         (void );
+                               ~StdPopUp        (void );
+
+

Synopsis:

+
+#         ewol::widget::Label*  m_title;
+         void                  setTitle         (const std::string & _text);
#         ewol::widget::Label*  m_comment;
+         void                  setComment       (const std::string & _text);
#         ewol::widget::Sizer*  m_subBar;
+         ewol::widget::Button* addButton        (const std::string & _text,
                                                  bool _autoExit);
+ virtual void                  onObjectRemove   (ewol::Object* _removeObject);
+ virtual void                  onReceiveMessage (const ewol::object::Message & _msg);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::Container
                +--> +ewol::widget::PopUp
                       +--> ewol::widget::StdPopUp
+

Detail:

+

StdPopUp

++  StdPopUp (void );
+std-pop-up constructor.
+
+
+

~StdPopUp

++  ~StdPopUp (void );
+std-pop-up destructor.
+
+
+

m_title

+# ewol::widget::Label* m_title;
+ +Title Label widget
+
+
+

setTitle

++ void setTitle (const std::string & _text);
+Set the title string.
+ +
+
+

m_comment

+# ewol::widget::Label* m_comment;
+ +Comment label widget
+
+
+

setComment

++ void setComment (const std::string & _text);
+Set the commentary string.
+ +
+
+

m_subBar

+# ewol::widget::Sizer* m_subBar;
+ +subwidget bar containing all the button.
+
+
+

addButton

++ ewol::widget::Button* addButton (const std::string & _text,
                                   bool _autoExit);
+Add a buttom button.
+ +
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

onReceiveMessage

++ virtual void onReceiveMessage (const ewol::object::Message & _msg);
+Receive a message from an other Object with a specific eventId and data
+ +
+
+
+ + + diff --git a/class_ewol__widget__WSlider.html b/class_ewol__widget__WSlider.html new file mode 100644 index 00000000..a2644eb4 --- /dev/null +++ b/class_ewol__widget__WSlider.html @@ -0,0 +1,289 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::WSlider

enum:

+ +

Constructor and Destructor:

+
++                           WSlider                    (void );
+ virtual                   ~WSlider                   (void );
+
+

Synopsis:

+
++         void              init                       (ewol::widget::Manager & _widgetManager);
+         const char* const eventStartSlide;
+         const char* const eventStopSlide;
+         const char* const configMode;
#         void              subWidgetSelectSetVectorId (int32_t _id);
+         void              subWidgetSelectSet         (int32_t _id);
+         void              subWidgetSelectSet         (ewol::Widget* _widgetPointer);
+         void              subWidgetSelectSet         (const std::string & _widgetName);
+         void              setTransitionSpeed         (float _timeSecond);
+         float             getTransitionSpeed         (void );
+         void              setTransitionMode          (enum sladingMode _mode);
+         enum sladingMode  getTransitionMode          (void );
+ virtual void              calculateSize              (const vec2 & _availlable);
+ virtual void              systemDraw                 (const ewol::DrawProperty & _displayProp);
+ virtual void              onRegenerateDisplay        (void );
+ virtual ewol::Widget*     getWidgetAtPos             (const vec2 & _pos);
+ virtual void              periodicCall               (const ewol::event::Time & _event);
+ virtual bool              onSetConfig                (const ewol::object::Config & _conf);
+ virtual bool              onGetConfig                (const char* _config,
                                                        std::string & _result) const;
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> +ewol::widget::ContainerN
                +--> ewol::widget::WSlider
+

Detail:

+

init

++ void init (ewol::widget::Manager & _widgetManager);
+ +
+
+
+

eventStartSlide

++ const char* const eventStartSlide;
+ +
+
+
+

eventStopSlide

++ const char* const eventStopSlide;
+ +
+
+
+

configMode

++ const char* const configMode;
+ +
+
+
+

WSlider

++  WSlider (void );
+ +
+
+
+

~WSlider

++ virtual  ~WSlider (void );
+ +
+
+
+

subWidgetSelectSetVectorId

+# void subWidgetSelectSetVectorId (int32_t _id);
+Generate the move on the specific vector ID (This is not a public acces, because the vector can have some null pointer inside ...)
    + + +
    Parameter [input]:_id Id in the vector
    +
+ +
+
+

subWidgetSelectSet

++ void subWidgetSelectSet (int32_t _id);
+Select a new subwidget to display
    + + +
    Parameter [input]:_id Id of the subwidget requested
    +
+ +
+
+

subWidgetSelectSet

++ void subWidgetSelectSet (ewol::Widget* _widgetPointer);
+Select a new subwidget to display
+ +
+
+

subWidgetSelectSet

++ void subWidgetSelectSet (const std::string & _widgetName);
+Select a new subwidget to display
+ +
+
+

setTransitionSpeed

++ void setTransitionSpeed (float _timeSecond);
+set transition speed element.
    + + +
    Parameter [input]:_timeSecond number of second needed to do the transition.
    +
+ +
+
+

getTransitionSpeed

++ float getTransitionSpeed (void );
+get transition speed element.
    + +
    Return: number of second needed to do the transition.
    +
+ +
+
+

setTransitionMode

++ void setTransitionMode (enum sladingMode _mode);
+set a new mode of sliding element
    + + +
    Parameter [input]:_mode new display mode
    +
+ +
+
+

getTransitionMode

++ enum sladingMode getTransitionMode (void );
+get a new mode of sliding element
    + +
    Return: The current sliding mode
    +
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

periodicCall

++ virtual void periodicCall (const ewol::event::Time & _event);
+periodic call of this widget
+ +
+
+

onSetConfig

++ virtual bool onSetConfig (const ewol::object::Config & _conf);
+Configuration requested to the curent Object
+ +
+
+

onGetConfig

++ virtual bool onGetConfig (const char* _config,
                            std::string & _result) const;
+Receive a configuration message from an other element system or from the curent Object
+ +
+
+
+ + + diff --git a/class_ewol__widget__WidgetScrooled.html b/class_ewol__widget__WidgetScrooled.html new file mode 100644 index 00000000..fed08b16 --- /dev/null +++ b/class_ewol__widget__WidgetScrooled.html @@ -0,0 +1,219 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::WidgetScrooled

enum:

+ +

Constructor and Destructor:

+
++                                    WidgetScrooled              (void );
+ virtual                            ~WidgetScrooled             (void );
+
+

Synopsis:

+
+#         vec2                       m_originScrooled;
#         vec2                       m_maxSize;
#         float                      m_limitScrolling;
# virtual void                       onDraw                      (void );
+ virtual void                       onRegenerateDisplay         (void );
+ virtual bool                       onEventInput                (const ewol::event::Input & _event);
+ virtual void                       systemDraw                  (const ewol::DrawProperty & _displayProp);
#         void                       setScrollingSize            (float _nbPixel);
#         void                       scroolingMode               (enum scrollingMode _newMode);
#         void                       setMaxSize                  (const vec2 & _localSize);
#         void                       setScrollingPositionDynamic (vec2 _borderWidth,
                                                                  const vec2 & _currentPosition,
                                                                  bool _center);
#         void                       setLimitScrolling           (float _poucentageLimit);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::WidgetScrooled
                +--> ewol::widget::List
                +--> ewol::widget::ParameterList
+

Detail:

+

m_originScrooled

+# vec2 m_originScrooled;
+ +pixel distance from the origin of the display (Bottum left)
+
+
+

m_maxSize

+# vec2 m_maxSize;
+ +Maximum size of the Widget ==> to display scrollbar
+
+
+

m_limitScrolling

+# float m_limitScrolling;
+ +Mimit scrolling represent the propertion of the minimel scrolling activate (0.2 ==> 20% migt all time be visible) +mode of management of the scrooling
+
+
+

WidgetScrooled

++  WidgetScrooled (void );
+Scroll Widget main constructor to be herited from an other widget (this is not a stand-alone widget)
+
+
+

~WidgetScrooled

++ virtual  ~WidgetScrooled (void );
+Scroll widget destructor.
+
+
+

onDraw

+# virtual void onDraw (void );
+Common widget drawing function (called by the drawing thread [Android, X11, ...])
+
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onEventInput

++ virtual bool onEventInput (const ewol::event::Input & _event);
+Event on an input of this Widget (finger, mouse, stilet)
+ +
+
+

systemDraw

++ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

setScrollingSize

+# void setScrollingSize (float _nbPixel);
+For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled
    + + +
    Parameter [input]:_nbPixel number of pixel scrolling
    +
+ +
+
+

scroolingMode

+# void scroolingMode (enum scrollingMode _newMode);
+Specify the mode of scrolling for this windows
    + + +
    Parameter [input]:_newMode the selected mode for the scrolling...
    +
+ +
+
+

setMaxSize

+# void setMaxSize (const vec2 & _localSize);
+set the specific mawimum size of the widget
    + + +
    Parameter [input]:_localSize new Maximum size
    +
+ +
+
+

setScrollingPositionDynamic

+# void setScrollingPositionDynamic (vec2 _borderWidth,
                                    const vec2 & _currentPosition,
                                    bool _center);
+Request a specific position for the scrolling of the current windows.
    + + + + +
    Parameter [input]:_borderWidth size of the border that requested the element might not to be
    Parameter [input]:_currentPosition Position that is requested to view
    Parameter [input]:_center True if the position might be at the center of the widget
    +
+ +
+
+

setLimitScrolling

+# void setLimitScrolling (float _poucentageLimit);
+set the scrolling limit when arriving at he end of the widget
    + + +
    Parameter [input]:_poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end ...
    +
+ +
+
+
+ + + diff --git a/class_ewol__widget__Windows.html b/class_ewol__widget__Windows.html new file mode 100644 index 00000000..7b196b4f --- /dev/null +++ b/class_ewol__widget__Windows.html @@ -0,0 +1,315 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::Windows

enum:

+ +

Constructor and Destructor:

+
++                                    Windows                (void );
+ virtual                            ~Windows               (void );
+
+

Synopsis:

+
++         void                       sysDraw                (void );
+         void                       sysOnShow              (void );
+         void                       sysOnHide              (void );
+         void                       sysOnKill              (void );
+ virtual void                       onShow                 (void );
+ virtual void                       onHide                 (void );
+ virtual bool                       onKill                 (void );
+ virtual void                       onReduce               (void );
+ virtual void                       on                     (void );
+         void                       setDecorationDisable   (void );
+         void                       setDecorationEnable    (void );
+         void                       setSubWidget           (ewol::Widget* _widget);
+         void                       popUpWidgetPush        (ewol::Widget* _widget);
+         const etk::Color<float> &  getBackgroundColor     (void );
+         void                       setBackgroundColor     (const etk::Color<float> & _color);
# virtual void                       systemDraw             (const ewol::DrawProperty & _displayProp);
+ virtual void                       onRegenerateDisplay    (void );
+ virtual void                       onObjectRemove         (ewol::Object* _removeObject);
+ virtual void                       calculateSize          (const vec2 & _availlable);
+ virtual ewol::Widget*              getWidgetAtPos         (const vec2 & _pos);
+         void                       setTitle               (const std::string & _title);
+ virtual void                       createPopUpMessage     (enum popUpMessageType _type,
                                                             const std::string & _message);
+         void                       displayInfoMessage     (const std::string & _message);
+         void                       displayWarningMessage  (const std::string & _message);
+         void                       displayErrorMessage    (const std::string & _message);
+         void                       displayCriticalMessage (const std::string & _message);
+
+

Object Hierarchy:

+
++ewol::Object
  +--> +ewol::Widget
         +--> ewol::widget::Windows
+

Detail:

+

Windows

++  Windows (void );
+ +
+
+
+

~Windows

++ virtual  ~Windows (void );
+ +
+
+
+

sysDraw

++ void sysDraw (void );
+ +
+
+
+

sysOnShow

++ void sysOnShow (void );
+ +
+
+
+

sysOnHide

++ void sysOnHide (void );
+ +
+
+
+

sysOnKill

++ void sysOnKill (void );
+ +
+
+
+

onShow

++ virtual void onShow (void );
+ +
+
+
+

onHide

++ virtual void onHide (void );
+ +
+
+
+

onKill

++ virtual bool onKill (void );
+ +
+
+
+

onReduce

++ virtual void onReduce (void );
+ +
+
+
+

on

++ virtual void on (void );
+ +
+
+
+

setDecorationDisable

++ void setDecorationDisable (void );
+ +
+
+
+

setDecorationEnable

++ void setDecorationEnable (void );
+ +
+
+
+

setSubWidget

++ void setSubWidget (ewol::Widget* _widget);
+ +
+
+
+

popUpWidgetPush

++ void popUpWidgetPush (ewol::Widget* _widget);
+ +
+
+
+

getBackgroundColor

++ const etk::Color<float> & getBackgroundColor (void );
+get the background color.
+ +
+
+

setBackgroundColor

++ void setBackgroundColor (const etk::Color<float> & _color);
+set the background color.
+
+
+

systemDraw

+# virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) +This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

onRegenerateDisplay

++ virtual void onRegenerateDisplay (void );
+Event generated when a redraw is needed
+
+
+

onObjectRemove

++ virtual void onObjectRemove (ewol::Object* _removeObject);
+Inform object that an other object is removed ...
Note: : Sub classes must call this class
+ +
+
+

calculateSize

++ virtual void calculateSize (const vec2 & _availlable);
+Parent set the possible diplay size of the current widget whith his own possibilities + By default this save the widget available size in the widget size
Note: : INTERNAL EWOL SYSTEM
    + + +
    Parameter [input]:_available Available x&y pixel size
    +
+ +
+
+

getWidgetAtPos

++ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
+get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
+ +
+
+

setTitle

++ void setTitle (const std::string & _title);
+ +
+
+
+

createPopUpMessage

++ virtual void createPopUpMessage (enum popUpMessageType _type,
                                   const std::string & _message);
+Create a simple pop-up message on the screen for application error.
+ +
+
+

displayInfoMessage

++ void displayInfoMessage (const std::string & _message);
+Create a simple information message
+ +
+
+

displayWarningMessage

++ void displayWarningMessage (const std::string & _message);
+Create a simple warning message
+ +
+
+

displayErrorMessage

++ void displayErrorMessage (const std::string & _message);
+Create a simple error message
+ +
+
+

displayCriticalMessage

++ void displayCriticalMessage (const std::string & _message);
+Create a simple critical message
+ +
+
+
+ + + diff --git a/class_ewol__widget__elementPL.html b/class_ewol__widget__elementPL.html new file mode 100644 index 00000000..0e8eab84 --- /dev/null +++ b/class_ewol__widget__elementPL.html @@ -0,0 +1,142 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

class: ewol::widget::elementPL

Description:

+ +

+

Associated Namespace:

+

Constructor and Destructor:

+
++             elementPL  (std::string & _label,
                          int32_t _refId,
                          std::string & _image,
                          bool _isGroup);
+             ~elementPL (void );
+
+

Synopsis:

+
++ bool        m_group;
+ std::string m_label;
+ int32_t     m_refId;
+ std::string m_image;
+
+

Detail:

+

m_group

++ bool m_group;
+ +
+
+
+

m_label

++ std::string m_label;
+ +
+
+
+

m_refId

++ int32_t m_refId;
+ +
+
+
+

m_image

++ std::string m_image;
+ +
+
+
+

elementPL

++  elementPL (std::string & _label,
              int32_t _refId,
              std::string & _image,
              bool _isGroup);
+ +
+
+
+

~elementPL

++  ~elementPL (void );
+ +
+
+
+
+ + + diff --git a/enum_ewol__Dimension__distance.html b/enum_ewol__Dimension__distance.html new file mode 100644 index 00000000..5adba7dd --- /dev/null +++ b/enum_ewol__Dimension__distance.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::Dimension::distance

Description:

+ +

+

Value list

+ +

Detail:

+

Pourcent

+Pourcent   = 0
+
+

Pixel

+Pixel      = 1
+
+

Meter

+Meter      = 2
+
+

Centimeter

+Centimeter = 3
+
+

Millimeter

+Millimeter = 4
+
+

Kilometer

+Kilometer  = 5
+
+

Inch

+Inch       = 6
+
+

foot

+foot       = 7
+
+ + + diff --git a/enum_ewol__Widget__annimationMode.html b/enum_ewol__Widget__annimationMode.html new file mode 100644 index 00000000..5a54fc78 --- /dev/null +++ b/enum_ewol__Widget__annimationMode.html @@ -0,0 +1,115 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::Widget::annimationMode

Description:

+ +

+

Value list

+ +

Detail:

+

annimationModeEnableAdd

+annimationModeEnableAdd    = 0
+
+

annimationModeEnableRemove

+annimationModeEnableRemove = 1
+
+

annimationModeDisable

+annimationModeDisable      = 2
+
+ + + diff --git a/enum_ewol__compositing__Text__aligneMode.html b/enum_ewol__compositing__Text__aligneMode.html new file mode 100644 index 00000000..cd178891 --- /dev/null +++ b/enum_ewol__compositing__Text__aligneMode.html @@ -0,0 +1,125 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::compositing::Text::aligneMode

Description:

+ +

+

Value list

+ +

Detail:

+

alignDisable

+alignDisable = 0
+
+

alignRight

+alignRight   = 1
+
+

alignLeft

+alignLeft    = 2
+
+

alignCenter

+alignCenter  = 3
+
+

alignJustify

+alignJustify = 4
+
+ + + diff --git a/enum_ewol__context__clipBoard__clipboardListe.html b/enum_ewol__context__clipBoard__clipboardListe.html new file mode 100644 index 00000000..2224516f --- /dev/null +++ b/enum_ewol__context__clipBoard__clipboardListe.html @@ -0,0 +1,162 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::context::clipBoard::clipboardListe

Description:

+ +

+

Value list

+ +

Detail:

+

clipboard0

+clipboard0         = 0
+ +internal clipboard 0
+

clipboard1

+clipboard1         = 1
+ +internal clipboard 1
+

clipboard2

+clipboard2         = 2
+ +internal clipboard 2
+

clipboard3

+clipboard3         = 3
+ +internal clipboard 3
+

clipboard4

+clipboard4         = 4
+ +internal clipboard 4
+

clipboard5

+clipboard5         = 5
+ +internal clipboard 5
+

clipboard6

+clipboard6         = 6
+ +internal clipboard 6
+

clipboard7

+clipboard7         = 7
+ +internal clipboard 7
+

clipboard8

+clipboard8         = 8
+ +internal clipboard 8
+

clipboard9

+clipboard9         = 9
+ +internal clipboard 9
+

clipboardStd

+clipboardStd       = 10
+ +External clipboard represent the Copy/Cut/Past buffer
+

clipboardSelection

+clipboardSelection = 11
+ +External or internal clipboard depending on the OS, represent the middle button
+

clipboardCount

+clipboardCount     = 12
+ +Total number of clipboard
+ + + diff --git a/enum_ewol__context__cursorDisplay.html b/enum_ewol__context__cursorDisplay.html new file mode 100644 index 00000000..d30cbcb9 --- /dev/null +++ b/enum_ewol__context__cursorDisplay.html @@ -0,0 +1,184 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::context::cursorDisplay

Description:

+ +

+

Value list

+ +

Detail:

+

cursorArrow

+cursorArrow             = 0
+
+

cursorLeftArrow

+cursorLeftArrow         = 1
+
+

cursorInfo

+cursorInfo              = 2
+
+

cursorDestroy

+cursorDestroy           = 3
+
+

cursorHelp

+cursorHelp              = 4
+
+

cursorCycle

+cursorCycle             = 5
+
+

cursorSpray

+cursorSpray             = 6
+
+

cursorWait

+cursorWait              = 7
+
+

cursorText

+cursorText              = 8
+
+

cursorCrossHair

+cursorCrossHair         = 9
+
+

cursorSlideUpDown

+cursorSlideUpDown       = 10
+ +change the position (slide) vertical
+

cursorSlideLeftRight

+cursorSlideLeftRight    = 11
+ +change the position (slide) horizontal
+

cursorResizeUp

+cursorResizeUp          = 12
+
+

cursorResizeDown

+cursorResizeDown        = 13
+
+

cursorResizeLeft

+cursorResizeLeft        = 14
+
+

cursorResizeRight

+cursorResizeRight       = 15
+
+

cursorCornerTopLeft

+cursorCornerTopLeft     = 16
+
+

cursorCornerTopRight

+cursorCornerTopRight    = 17
+
+

cursorCornerButtomLeft

+cursorCornerButtomLeft  = 18
+
+

cursorCornerButtomRight

+cursorCornerButtomRight = 19
+
+

cursorNone

+cursorNone              = 20
+
+

cursorCount

+cursorCount             = 21
+
+ + + diff --git a/enum_ewol__font__mode.html b/enum_ewol__font__mode.html new file mode 100644 index 00000000..6a022cea --- /dev/null +++ b/enum_ewol__font__mode.html @@ -0,0 +1,117 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::font::mode

Value list

+ +

Detail:

+

Regular

+Regular    = 0
+
+

Italic

+Italic     = 1
+
+

Bold

+Bold       = 2
+
+

BoldItalic

+BoldItalic = 3
+
+ + + diff --git a/enum_ewol__gravity.html b/enum_ewol__gravity.html new file mode 100644 index 00000000..a4607e9e --- /dev/null +++ b/enum_ewol__gravity.html @@ -0,0 +1,133 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::gravity

Description:

+Gravity of the widget property

+

Value list

+ +

Detail:

+

gravityCenter

+gravityCenter      = 0x00
+ +gravity is in certer
+

gravityTopLeft

+gravityTopLeft     = 0x05
+
+

gravityTop

+gravityTop         = 0x01
+
+

gravityTopRight

+gravityTopRight    = 0x03
+
+

gravityRight

+gravityRight       = 0x02
+
+

gravityButtomRight

+gravityButtomRight = 0x06
+
+

gravityButtom

+gravityButtom      = 0x04
+
+

gravityButtomLeft

+gravityButtomLeft  = 0x0C
+
+

gravityLeft

+gravityLeft        = 0x08
+
+ + + diff --git a/enum_ewol__key__keyboard.html b/enum_ewol__key__keyboard.html new file mode 100644 index 00000000..cf2ac467 --- /dev/null +++ b/enum_ewol__key__keyboard.html @@ -0,0 +1,277 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::key::keyboard

Description:

+Keybord event or joystick event

+

Value list

+ +

Detail:

+

keyboardUnknow

+keyboardUnknow      = 0
+ +Unknown keyboard key
+

keyboardChar

+keyboardChar        = 1
+ +Char input is arrived ...
+

keyboardLeft

+keyboardLeft        = 2
+ +Left key <--
+

keyboardRight

+keyboardRight       = 3
+ +Right key -->
+

keyboardUp

+keyboardUp          = 4
+ +Up key ^
+

keyboardDown

+keyboardDown        = 5
+ +Down key \/
+

keyboardPageUp

+keyboardPageUp      = 6
+ +Page Up key
+

keyboardPageDown

+keyboardPageDown    = 7
+ +page down key
+

keyboardStart

+keyboardStart       = 8
+ +Start key
+

keyboardEnd

+keyboardEnd         = 9
+ +End key
+

keyboardPrint

+keyboardPrint       = 10
+ +print screen key.
+

keyboardStopDefil

+keyboardStopDefil   = 11
+ +Stop display key.
+

keyboardWait

+keyboardWait        = 12
+ +Wait key.
+

keyboardInsert

+keyboardInsert      = 13
+ +insert key.
+

keyboardF1

+keyboardF1          = 14
+ +F1 key.
+

keyboardF2

+keyboardF2          = 15
+ +F2 key.
+

keyboardF3

+keyboardF3          = 16
+ +F3 key.
+

keyboardF4

+keyboardF4          = 17
+ +F4 key.
+

keyboardF5

+keyboardF5          = 18
+ +F5 key.
+

keyboardF6

+keyboardF6          = 19
+ +F6 key.
+

keyboardF7

+keyboardF7          = 20
+ +F7 key.
+

keyboardF8

+keyboardF8          = 21
+ +F8 key.
+

keyboardF9

+keyboardF9          = 22
+ +F9 key.
+

keyboardF10

+keyboardF10         = 23
+ +F10 key.
+

keyboardF11

+keyboardF11         = 24
+ +F11 key.
+

keyboardF12

+keyboardF12         = 25
+ +F12 key.
+

keyboardCapLock

+keyboardCapLock     = 26
+ +Capital Letter Lock key.
+

keyboardShiftLeft

+keyboardShiftLeft   = 27
+ +Shift left key.
+

keyboardShiftRight

+keyboardShiftRight  = 28
+ +Shift right key.
+

keyboardCtrlLeft

+keyboardCtrlLeft    = 29
+ +Control left key.
+

keyboardCtrlRight

+keyboardCtrlRight   = 30
+ +Control right key.
+

keyboardMetaLeft

+keyboardMetaLeft    = 31
+ +Meta left key (apple key or windows key).
+

keyboardMetaRight

+keyboardMetaRight   = 32
+ +Meta right key (apple key or windows key).
+

keyboardAlt

+keyboardAlt         = 33
+ +Alt key.
+

keyboardAltGr

+keyboardAltGr       = 34
+ +Alt ground key.
+

keyboardContextMenu

+keyboardContextMenu = 35
+ +Contextual menu key.
+

keyboardNumLock

+keyboardNumLock     = 36
+ +Numerical Lock key.
+

keyboardCount

+keyboardCount       = 37
+ +number of posible key
+ + + diff --git a/enum_ewol__key__status.html b/enum_ewol__key__status.html new file mode 100644 index 00000000..15999cf9 --- /dev/null +++ b/enum_ewol__key__status.html @@ -0,0 +1,151 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::key::status

Description:

+Keybord event or joyestick event

+

Value list

+ +

Detail:

+

statusUnknow

+statusUnknow    = 0
+
+

statusDown

+statusDown      = 1
+
+

statusMove

+statusMove      = 2
+
+

statusSingle

+statusSingle    = 3
+
+

statusDouble

+statusDouble    = 4
+
+

statusTriple

+statusTriple    = 5
+
+

statusQuad

+statusQuad      = 6
+
+

statusQuinte

+statusQuinte    = 7
+
+

statusUp

+statusUp        = 8
+
+

statusEnter

+statusEnter     = 9
+
+

statusLeave

+statusLeave     = 10
+
+

statusAbort

+statusAbort     = 11
+
+

statusTransfert

+statusTransfert = 12
+
+

statusCount

+statusCount     = 13
+
+ + + diff --git a/enum_ewol__key__type.html b/enum_ewol__key__type.html new file mode 100644 index 00000000..b9937c99 --- /dev/null +++ b/enum_ewol__key__type.html @@ -0,0 +1,129 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::key::type

Description:

+type of input : Note that the keyboard is not prevent due to the fact that data is too different

+

Value list

+ +

Detail:

+

typeUnknow

+typeUnknow = 0
+ +Unknow input Type
+

typeMouse

+typeMouse  = 1
+ +Mouse type
+

typeFinger

+typeFinger = 2
+ +Finger type
+

typeStylet

+typeStylet = 3
+ +Stylet type
+

typeCount

+typeCount  = 4
+ +number of types
+ + + diff --git a/enum_ewol__openGL__openGlFlags.html b/enum_ewol__openGL__openGlFlags.html new file mode 100644 index 00000000..53405489 --- /dev/null +++ b/enum_ewol__openGL__openGlFlags.html @@ -0,0 +1,239 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::openGL::openGlFlags

Description:

+ +

+

Value list

+ +

Detail:

+

FLAG_BLEND

+FLAG_BLEND                         = <0
+ +If enabled, blend the computed fragment color values with the values in the color buffers. See glBlendFunc.
+

FLAG_CLIP_DISTANCE_I

+FLAG_CLIP_DISTANCE_I               = <1
+ +If enabled, clip geometry against user-defined half space i.
+

FLAG_COLOR_LOGIC_OP

+FLAG_COLOR_LOGIC_OP                = <2
+ +If enabled, apply the currently selected logical operation to the computed fragment color and color buffer values. See glLogicOp.
+

FLAG_CULL_FACE

+FLAG_CULL_FACE                     = <3
+ +If enabled, cull polygons based on their winding in window coordinates. See glCullFace.
+

FLAG_DEBUG_OUTPUT

+FLAG_DEBUG_OUTPUT                  = <4
+ +If enabled, debug messages are produced by a debug context. When disabled, the debug message log is silenced. Note that in a non-debug context, very few, if any messages might be produced, even when GL_DEBUG_OUTPUT is enabled.
+

FLAG_DEBUG_OUTPUT_SYNCHRONOUS

+FLAG_DEBUG_OUTPUT_SYNCHRONOUS      = <5
+ +If enabled, debug messages are produced synchronously by a debug context. If disabled, debug messages may be produced asynchronously. In particular, they may be delayed relative to the execution of GL commands, and the debug callback function may be called from a thread other than that in which the commands are executed. See glDebugMessageCallback.
+

FLAG_DEPTH_CLAMP

+FLAG_DEPTH_CLAMP                   = <6
+ +If enabled, the -wc≤zc≤wc plane equation is ignored by view volume clipping (effectively, there is no near or far plane clipping). See glDepthRange.
+

FLAG_DEPTH_TEST

+FLAG_DEPTH_TEST                    = <7
+ +If enabled, do depth comparisons and update the depth buffer. Note that even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. See glDepthFunc and glDepthRange.
+

FLAG_DITHER

+FLAG_DITHER                        = <8
+ +If enabled, dither color components or indices before they are written to the color buffer.
+

FLAG_FRAMEBUFFER_SRGB

+FLAG_FRAMEBUFFER_SRGB              = <9
+ +If enabled and the value of GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING for the framebuffer attachment corresponding to the destination buffer is GL_SRGB, the R, G, and B destination color values (after conversion from fixed-point to floating-point) are considered to be encoded for the sRGB color space and hence are linearized prior to their use in blending.
+

FLAG_LINE_SMOOTH

+FLAG_LINE_SMOOTH                   = <10
+ +If enabled, draw lines with correct filtering. Otherwise, draw aliased lines. See glLineWidth.
+

FLAG_MULTISAMPLE

+FLAG_MULTISAMPLE                   = <11
+ +If enabled, use multiple fragment samples in computing the final color of a pixel. See glSampleCoverage.
+

FLAG_POLYGON_OFFSET_FILL

+FLAG_POLYGON_OFFSET_FILL           = <12
+ +If enabled, and if the polygon is rendered in GL_FILL mode, an offset is added to depth values of a polygon's fragments before the depth comparison is performed. See glPolygonOffset.
+

FLAG_POLYGON_OFFSET_LINE

+FLAG_POLYGON_OFFSET_LINE           = <13
+ +If enabled, and if the polygon is rendered in GL_LINE mode, an offset is added to depth values of a polygon's fragments before the depth comparison is performed. See glPolygonOffset.
+

FLAG_POLYGON_OFFSET_POINT

+FLAG_POLYGON_OFFSET_POINT          = <14
+ +If enabled, an offset is added to depth values of a polygon's fragments before the depth comparison is performed, if the polygon is rendered in GL_POINT mode. See glPolygonOffset.
+

FLAG_POLYGON_SMOOTH

+FLAG_POLYGON_SMOOTH                = <15
+ +If enabled, draw polygons with proper filtering. Otherwise, draw aliased polygons. For correct antialiased polygons, an alpha buffer is needed and the polygons must be sorted front to back.
+

FLAG_PRIMITIVE_RESTART

+FLAG_PRIMITIVE_RESTART             = <16
+ +enables primitive restarting. If enabled, any one of the draw commands which transfers a set of generic attribute array elements to the GL will restart the primitive when the index of the vertex is equal to the primitive restart index. See glPrimitiveRestartIndex.
+

FLAG_PRIMITIVE_RESTART_FIXED_INDEX

+FLAG_PRIMITIVE_RESTART_FIXED_INDEX = <17
+ +enables primitive restarting with a fixed index. If enabled, any one of the draw commands which transfers a set of generic attribute array elements to the GL will restart the primitive when the index of the vertex is equal to the fixed primitive index for the specified index type. The fixed index is equal to 2n−1 where n is equal to 8 for GL_UNSIGNED_BYTE, 16 for GL_UNSIGNED_SHORT and 32 for GL_UNSIGNED_INT.
+

FLAG_SAMPLE_ALPHA_TO_COVERAGE

+FLAG_SAMPLE_ALPHA_TO_COVERAGE      = <18
+ +If enabled, compute a temporary coverage value where each bit is determined by the alpha value at the corresponding sample location. The temporary coverage value is then ANDed with the fragment coverage value.
+

FLAG_SAMPLE_ALPHA_TO_ONE

+FLAG_SAMPLE_ALPHA_TO_ONE           = <19
+ +If enabled, each sample alpha value is replaced by the maximum representable alpha value.
+

FLAG_SAMPLE_COVERAGE

+FLAG_SAMPLE_COVERAGE               = <20
+ +If enabled, the fragment's coverage is ANDed with the temporary coverage value. If GL_SAMPLE_COVERAGE_INVERT is set to GL_TRUE, invert the coverage value. See glSampleCoverage.
+

FLAG_SAMPLE_SHADING

+FLAG_SAMPLE_SHADING                = <21
+ +If enabled, the active fragment shader is run once for each covered sample, or at fraction of this rate as determined by the current value of GL_MIN_SAMPLE_SHADING_VALUE. See glMinSampleShading.
+

FLAG_SAMPLE_MASK

+FLAG_SAMPLE_MASK                   = <22
+ +If enabled, the sample coverage mask generated for a fragment during rasterization will be ANDed with the value of GL_SAMPLE_MASK_VALUE before shading occurs. See glSampleMaski.
+

FLAG_SCISSOR_TEST

+FLAG_SCISSOR_TEST                  = <23
+ +If enabled, discard fragments that are outside the scissor rectangle. See glScissor.
+

FLAG_STENCIL_TEST

+FLAG_STENCIL_TEST                  = <24
+ +If enabled, do stencil testing and update the stencil buffer. See glStencilFunc and glStencilOp. GL_TEXTURE_CUBE_MAP_SEAMLESS = 1<<0, //!< If enabled, cubemap textures are sampled such that when linearly sampling from the border between two adjacent faces, texels from both faces are used to generate the final sample value. When disabled, texels from only a single face are used to construct the final sample value.
+

FLAG_PROGRAM_POINT_SIZE

+FLAG_PROGRAM_POINT_SIZE            = <25
+ +If enabled and a vertex or geometry shader is active, then the derived point size is taken from the (potentially clipped) shader builtin gl_PointSize and clamped to the implementation-dependent point size range.
+

FLAG_TEXTURE_2D

+FLAG_TEXTURE_2D                    = <26
+ + +
+

FLAG_ALPHA_TEST

+FLAG_ALPHA_TEST                    = <27
+ + +
+

FLAG_FOG

+FLAG_FOG                           = <28
+ + +
+ + + diff --git a/enum_ewol__orientation.html b/enum_ewol__orientation.html new file mode 100644 index 00000000..1eda686b --- /dev/null +++ b/enum_ewol__orientation.html @@ -0,0 +1,112 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::orientation

Value list

+ +

Detail:

+

screenAuto

+screenAuto      = 0
+
+

screenLandscape

+screenLandscape = 1
+
+

screenPortrait

+screenPortrait  = 2
+
+ + + diff --git a/enum_ewol__widget__Button__buttonLock.html b/enum_ewol__widget__Button__buttonLock.html new file mode 100644 index 00000000..09054494 --- /dev/null +++ b/enum_ewol__widget__Button__buttonLock.html @@ -0,0 +1,124 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::Button::buttonLock

Description:

+ +

+

Value list

+ +

Detail:

+

lockNone

+lockNone         = 0
+ +normal status of the button
+

lockWhenPressed

+lockWhenPressed  = 1
+ +When the state is set in pressed, the status stay in this one
+

lockWhenReleased

+lockWhenReleased = 2
+ +When the state is set in not pressed, the status stay in this one
+

lockAccess

+lockAccess       = 3
+ +all event are trashed == > acctivity of the button is disable
+ + + diff --git a/enum_ewol__widget__Composer__composerMode.html b/enum_ewol__widget__Composer__composerMode.html new file mode 100644 index 00000000..7350d87a --- /dev/null +++ b/enum_ewol__widget__Composer__composerMode.html @@ -0,0 +1,115 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::Composer::composerMode

Description:

+ +

+

Value list

+ +

Detail:

+

None

+None   = 0
+
+

String

+String = 1
+
+

file

+file   = 2
+
+ + + diff --git a/enum_ewol__widget__ContextMenu__markPosition.html b/enum_ewol__widget__ContextMenu__markPosition.html new file mode 100644 index 00000000..bbf39a53 --- /dev/null +++ b/enum_ewol__widget__ContextMenu__markPosition.html @@ -0,0 +1,125 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::ContextMenu::markPosition

Description:

+ +

+

Value list

+ +

Detail:

+

markTop

+markTop    = 0
+
+

markRight

+markRight  = 1
+
+

markButtom

+markButtom = 2
+
+

markLeft

+markLeft   = 3
+
+

markNone

+markNone   = 4
+
+ + + diff --git a/enum_ewol__widget__Joystick__joystickMode.html b/enum_ewol__widget__Joystick__joystickMode.html new file mode 100644 index 00000000..d7f837bf --- /dev/null +++ b/enum_ewol__widget__Joystick__joystickMode.html @@ -0,0 +1,110 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::Joystick::joystickMode

Description:

+ +

+

Value list

+ +

Detail:

+

modeNormal

+modeNormal = 0
+
+

modeArrow

+modeArrow  = 1
+
+ + + diff --git a/enum_ewol__widget__Scroll__highSpeedMode.html b/enum_ewol__widget__Scroll__highSpeedMode.html new file mode 100644 index 00000000..be8a99bd --- /dev/null +++ b/enum_ewol__widget__Scroll__highSpeedMode.html @@ -0,0 +1,130 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::Scroll::highSpeedMode

Description:

+ +

+

Value list

+ +

Detail:

+

speedModeDisable

+speedModeDisable          = 0
+
+

speedModeInit

+speedModeInit             = 1
+
+

speedModeEnableFinger

+speedModeEnableFinger     = 2
+
+

speedModeEnableHorizontal

+speedModeEnableHorizontal = 3
+
+

speedModeEnableVertical

+speedModeEnableVertical   = 4
+
+

speedModeGrepEndEvent

+speedModeGrepEndEvent     = 5
+
+ + + diff --git a/enum_ewol__widget__Sizer__animation.html b/enum_ewol__widget__Sizer__animation.html new file mode 100644 index 00000000..0402c66c --- /dev/null +++ b/enum_ewol__widget__Sizer__animation.html @@ -0,0 +1,130 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::Sizer::animation

Description:

+ +

+

Value list

+ +

Detail:

+

animationNone

+animationNone   = 0
+ +No annimation
+

animationTop

+animationTop    = 1
+ +element came from the top
+

animationbuttom

+animationbuttom = 2
+ +element came from the buttom
+

animationLeft

+animationLeft   = 3
+ +element came from the Left
+

animationRight

+animationRight  = 4
+ +element came from the right
+ + + diff --git a/enum_ewol__widget__Sizer__displayMode.html b/enum_ewol__widget__Sizer__displayMode.html new file mode 100644 index 00000000..8060ccac --- /dev/null +++ b/enum_ewol__widget__Sizer__displayMode.html @@ -0,0 +1,112 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::Sizer::displayMode

Description:

+ +

+

Value list

+ +

Detail:

+

modeVert

+modeVert = 0
+ +Vertical mode
+

modeHori

+modeHori = 1
+ +Horizontal mode
+ + + diff --git a/enum_ewol__widget__WSlider__sladingMode.html b/enum_ewol__widget__WSlider__sladingMode.html new file mode 100644 index 00000000..b3ab42d3 --- /dev/null +++ b/enum_ewol__widget__WSlider__sladingMode.html @@ -0,0 +1,115 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::WSlider::sladingMode

Description:

+ +

+

Value list

+ +

Detail:

+

sladingTransitionVert

+sladingTransitionVert   = 0
+
+

sladingTransitionHori

+sladingTransitionHori   = 1
+
+

sladingTransition_count

+sladingTransition_count = 2
+
+ + + diff --git a/enum_ewol__widget__WidgetScrooled__scrollingMode.html b/enum_ewol__widget__WidgetScrooled__scrollingMode.html new file mode 100644 index 00000000..b65dfac0 --- /dev/null +++ b/enum_ewol__widget__WidgetScrooled__scrollingMode.html @@ -0,0 +1,118 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::WidgetScrooled::scrollingMode

Description:

+ +

+

Value list

+ +

Detail:

+

scroolModeNormal

+scroolModeNormal = 0
+ +No Zoom , can UP and down, left and right
+

scroolModeCenter

+scroolModeCenter = 1
+ +Zoom enable, no move left and right
+

scroolModeGame

+scroolModeGame   = 2
+ +Zoom enable, no move left and right
+ + + diff --git a/enum_ewol__widget__Windows__popUpMessageType.html b/enum_ewol__widget__Windows__popUpMessageType.html new file mode 100644 index 00000000..eef5a045 --- /dev/null +++ b/enum_ewol__widget__Windows__popUpMessageType.html @@ -0,0 +1,124 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

enum: ewol::widget::Windows::popUpMessageType

Description:

+ +

+

Value list

+ +

Detail:

+

messageTypeInfo

+messageTypeInfo     = 0
+ +information message pop-up
+

messageTypeWarning

+messageTypeWarning  = 1
+ +warning message pop-up
+

messageTypeError

+messageTypeError    = 2
+ +Error message pop-up
+

messageTypeCritical

+messageTypeCritical = 3
+ +Critical message pop-up
+ + + diff --git a/ewol__Compositing.html b/ewol__Compositing.html deleted file mode 100644 index dc429816..00000000 --- a/ewol__Compositing.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::Compositing

-
-

Constructor and Destructor:

-
-+        Compositing  (void);
+       ~Compositing  (void);
-

Synopsis:

-
-+  void  draw         (bool _disableDepthTest);
+  void  clear        (void);
+  void  resetMatrix  (void);
+  void  translate    (const vec3 & _vect);
+  void  rotate       (const vec3 & _vect,
                       float _angle);
+  void  scale        (const vec3 & _vect);
+  void  setMatrix    (const mat4 & _mat);
- - -

Object Hierarchy:

-
-ewol::Compositing
-    +--> ewol::compositing::Shaper
-    +--> ewol::compositing::Area
-    +--> ewol::compositing::Image
-    +--> ewol::compositing::Drawing
-    +--> ewol::compositing::Text
-
-
-

Detail:

-

ewol::Compositing ()

- -
-Compositing(void);
-
-generic constructor -

- -
-

ewol::~Compositing ()

- -
-~Compositing(void);
-
-Generic destructor -

- -
-

draw ()

- -
-void draw(bool _disableDepthTest);
-
-Virtal pure function that request the draw of all openGl elements -

- -
-

clear ()

- -
-void clear(void);
-
-clear alll tre registered element in the current element -

- -
-

resetMatrix ()

- -
-void resetMatrix(void);
-
-reset to the eye matrix the openGL mouving system -

- -
-

translate ()

- -
-void translate(const vec3 & _vect);
-
-translate the current display of this element -
-
- -
-

rotate ()

- -
-void rotate(const vec3 & _vect,
-            float _angle);
-
-rotate the curent display of this element -
-
- -
-

scale ()

- -
-void scale(const vec3 & _vect);
-
-scale the current diaplsy of this element -
-
- -
-

setMatrix ()

- -
-void setMatrix(const mat4 & _mat);
-
-set the transformation matrix -
-
- -
-
- - diff --git a/ewol__Context.html b/ewol__Context.html deleted file mode 100644 index 450a6cf1..00000000 --- a/ewol__Context.html +++ /dev/null @@ -1,707 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::Context

-
-

Constructor and Destructor:

-
-+                                Context                    (int32_t _argc,
                                                             const char * _argv);
+                               ~Context                    (void);
-

Synopsis:

-
-+  ewol::context::CommandLine &  getCmd                     (void);
+  ewol::context::ConfigFont &   getFontDefault             (void);
+  ewol::widget::Manager &       getWidgetManager           (void);
+  ewol::object::Manager &       getEObjectManager          (void);
+  ewol::resource::Manager &     getResourcesManager        (void);
+  void                          setArchiveDir              (int _mode,
                                                             const char * _str);
+  void                          OS_SetInputMotion          (int _pointerID,
                                                             const vec2 & _pos);
+  void                          OS_SetInputState           (int _pointerID,
                                                             bool _isDown,
                                                             const vec2 & _pos);
+  void                          OS_SetMouseMotion          (int _pointerID,
                                                             const vec2 & _pos);
+  void                          OS_SetMouseState           (int _pointerID,
                                                             bool _isDown,
                                                             const vec2 & _pos);
+  void                          OS_SetKeyboard             (ewol::key::Special & _special,
                                                             char32_t _myChar,
                                                             bool _isDown,
                                                             bool _isARepeateKey);
+  void                          OS_SetKeyboardMove         (ewol::key::Special & _special,
                                                             enum ewol::key::keyboard _move,
                                                             bool _isDown,
                                                             bool _isARepeateKey);
+  void                          OS_Suspend                 (void);
+  void                          OS_Resume                  (void);
+  void                          requestUpdateSize          (void);
+  bool                          OS_Draw                    (bool _displayEveryTime);
+  void                          onObjectRemove             (ewol::Object * _removeObject);
+  void                          resetIOEvent               (void);
+  void                          OS_OpenGlContextDestroy    (void);
+  void                          OS_Stop                    (void);
+  void                          stop                       (void);
+  void                          setWindows                 (ewol::widget::Windows * _windows);
+  ewol::widget::Windows *       getWindows                 (void);
+  const vec2 &                  getSize                    (void);
+  void                          OS_Resize                  (const vec2 & _size);
+  void                          setSize                    (const vec2 & _size);
+  void                          OS_Move                    (const vec2 & _pos);
+  void                          setPos                     (const vec2 & _pos);
+  void                          OS_Hide                    (void);
+  void                          hide                       (void);
+  void                          OS_Show                    (void);
+  void                          show                       (void);
+  void                          forceRedrawAll             (void);
+  void                          inputEventTransfertWidget  (ewol::Widget * _source,
                                                             ewol::Widget * _destination);
+  void                          inputEventGrabPointer      (ewol::Widget * _widget);
+  void                          inputEventUnGrabPointer    (void);
+  void                          keyboardShow               (void);
+  void                          keyboardHide               (void);
+  void                          clipBoardGet               (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+  void                          clipBoardSet               (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+  void                          OS_ClipBoardArrive         (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+  void                          setTitle                   (const std::string & _title);
+  void                          forceOrientation           (enum ewol::orientation _orientation);
+  void                          grabPointerEvents          (bool _isGrabbed,
                                                             const vec2 & _forcedPosition);
+  void                          setCursor                  (enum ewol::context::cursorDisplay _newCursor);
+  void                          setIcon                    (const std::string & _inputFile);
+  static int64_t                getTime                    (void);
+  static int                    main                       (int _argc,
                                                             const char * _argv);
#  void                          lockContext                (void);
#  void                          unLockContext              (void);
-  void                          processEvents              (void);
- - -

Detail:

-

getCmd ()

- -
-ewol::context::CommandLine & getCmd(void);
-
-
- -
-

getFontDefault ()

- -
-ewol::context::ConfigFont & getFontDefault(void);
-
-
- -
-

getWidgetManager ()

- -
-ewol::widget::Manager & getWidgetManager(void);
-
-
- -
-

getEObjectManager ()

- -
-ewol::object::Manager & getEObjectManager(void);
-
-
- -
-

getResourcesManager ()

- -
-ewol::resource::Manager & getResourcesManager(void);
-
-
- -
-

ewol::Context ()

- -
-Context(int32_t _argc,
-        const char * _argv);
-
-
- -
-

ewol::~Context ()

- -
-~Context(void);
-
-
- -
-

setArchiveDir ()

- -
-void setArchiveDir(int _mode,
-                   const char * _str);
-
-
- -
-

OS_SetInputMotion ()

- -
-void OS_SetInputMotion(int _pointerID,
-                       const vec2 & _pos);
-
-
- -
-

OS_SetInputState ()

- -
-void OS_SetInputState(int _pointerID,
-                      bool _isDown,
-                      const vec2 & _pos);
-
-
- -
-

OS_SetMouseMotion ()

- -
-void OS_SetMouseMotion(int _pointerID,
-                       const vec2 & _pos);
-
-
- -
-

OS_SetMouseState ()

- -
-void OS_SetMouseState(int _pointerID,
-                      bool _isDown,
-                      const vec2 & _pos);
-
-
- -
-

OS_SetKeyboard ()

- -
-void OS_SetKeyboard(ewol::key::Special & _special,
-                    char32_t _myChar,
-                    bool _isDown,
-                    bool _isARepeateKey);
-
-
- -
-

OS_SetKeyboardMove ()

- -
-void OS_SetKeyboardMove(ewol::key::Special & _special,
-                        enum ewol::key::keyboard _move,
-                        bool _isDown,
-                        bool _isARepeateKey);
-
-
- -
-

OS_Suspend ()

- -
-void OS_Suspend(void);
-
-The current context is suspended -

- -
-

OS_Resume ()

- -
-void OS_Resume(void);
-
-The current context is resumed -

- -
-

requestUpdateSize ()

- -
-void requestUpdateSize(void);
-
-
- -
-

OS_Draw ()

- -
-bool OS_Draw(bool _displayEveryTime);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-Inform object that an other object is removed ... -
Notes: : Sub classes must call this class -
-
- -
-

resetIOEvent ()

- -
-void resetIOEvent(void);
-
-reset event management for the IO like Input ou Mouse or keyborad -

- -
-

OS_OpenGlContextDestroy ()

- -
-void OS_OpenGlContextDestroy(void);
-
-The OS inform that the openGL constext has been destroy == > use to automaticly reload the texture and other thinks ... -

- -
-

OS_Stop ()

- -
-void OS_Stop(void);
-
-The OS Inform that the Window has been killed -

- -
-

stop ()

- -
-void stop(void);
-
-The application request that the Window will be killed -

- -
-

setWindows ()

- -
-void setWindows(ewol::widget::Windows * _windows);
-
-set the current windows to display : -
-
- -
-

getWindows ()

- -
-ewol::widget::Windows * getWindows(void);
-
-get the current windows that is displayed -
-
- -
-

getSize ()

- -
-const vec2 & getSize(void);
-
-get the current windows size -
-
- -
-

OS_Resize ()

- -
-void OS_Resize(const vec2 & _size);
-
-The OS inform that the current windows has change his size. -
-
- -
-

setSize ()

- -
-void setSize(const vec2 & _size);
-
-The application request a change of his curent size. -
-
- -
-

OS_Move ()

- -
-void OS_Move(const vec2 & _pos);
-
-The OS inform that the current windows has change his position. -
-
- -
-

setPos ()

- -
-void setPos(const vec2 & _pos);
-
-The Application request that the current windows will change his position. -
-
- -
-

OS_Hide ()

- -
-void OS_Hide(void);
-
-The OS inform that the Windows is now Hidden. -

- -
-

hide ()

- -
-void hide(void);
-
-The Application request that the Windows will be Hidden. -

- -
-

OS_Show ()

- -
-void OS_Show(void);
-
-The OS inform that the Windows is now visible. -

- -
-

show ()

- -
-void show(void);
-
-The Application request that the Windows will be visible. -

- -
-

forceRedrawAll ()

- -
-void forceRedrawAll(void);
-
-Redraw all the windows -

- -
-

inputEventTransfertWidget ()

- -
-void inputEventTransfertWidget(ewol::Widget * _source,
-                               ewol::Widget * _destination);
-
-This is to transfert the event from one widget to another one -
-
- -
-

inputEventGrabPointer ()

- -
-void inputEventGrabPointer(ewol::Widget * _widget);
-
-This fonction lock the pointer properties to move in relative instead of absolute -
-
- -
-

inputEventUnGrabPointer ()

- -
-void inputEventUnGrabPointer(void);
-
-This fonction un-lock the pointer properties to move in relative instead of absolute -

- -
-

keyboardShow ()

- -
-void keyboardShow(void);
-
-display the virtal keyboard (for touch system only) -

- -
-

keyboardHide ()

- -
-void keyboardHide(void);
-
-Hide the virtal keyboard (for touch system only) -

- -
-

clipBoardGet ()

- -
-void clipBoardGet(enum ewol::context::clipBoard::clipboardListe _clipboardID);
-
-Inform the Gui that we want to have a copy of the clipboard -
-
- -
-

clipBoardSet ()

- -
-void clipBoardSet(enum ewol::context::clipBoard::clipboardListe _clipboardID);
-
-Inform the Gui that we are the new owner of the clipboard -
-
- -
-

OS_ClipBoardArrive ()

- -
-void OS_ClipBoardArrive(enum ewol::context::clipBoard::clipboardListe _clipboardID);
-
-Call by the OS when a clipboard arrive to US (previously requested by a widget) -
-
- -
-

setTitle ()

- -
-void setTitle(const std::string & _title);
-
-set the new title of the windows -
-
- -
-

forceOrientation ()

- -
-void forceOrientation(enum ewol::orientation _orientation);
-
-force the screen orientation (availlable on portable elements ... -
-
- -
-

grabPointerEvents ()

- -
-void grabPointerEvents(bool _isGrabbed,
-                       const vec2 & _forcedPosition);
-
-get all the event from the X system -
-
- -
-

setCursor ()

- -
-void setCursor(enum ewol::context::cursorDisplay _newCursor);
-
-set the cursor display type. -
-
- -
-

setIcon ()

- -
-void setIcon(const std::string & _inputFile);
-
-set the Icon of the program -
-
- -
-

ewol::getTime ()

- -
-static int64_t getTime(void);
-
-get the curent time in micro-second -
Notes: : must be implemented in all system OS implementation -
-
- -
-

ewol::main ()

- -
-static int main(int _argc,
-                const char * _argv);
-
-This is the only one things the User might done in his main(); -
Notes: : must be implemented in all system OPS implementation -
Notes: To answare you before you ask the question, this is really simple: - Due to the fect that the current system is multiple-platform, you "main" - Does not exist in the android platform, then ewol call other start - and stop function, to permit to have only one code -
Notes: The main can not be in the ewol, due to the fact thet is an librairy -
-
- -
-

lockContext ()

- -
-void lockContext(void);
-
-set the curent interface. -
Notes: this lock the main mutex -

- -
-

unLockContext ()

- -
-void unLockContext(void);
-
-set the curent interface at NULL. -
Notes: this un-lock the main mutex -

- -
-

processEvents ()

- -
-void processEvents(void);
-
-Processing all the event arrived ... (commoly called in draw function) -

- -
-
- - diff --git a/ewol__Dimension.html b/ewol__Dimension.html deleted file mode 100644 index d646808d..00000000 --- a/ewol__Dimension.html +++ /dev/null @@ -1,453 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::Dimension

-
-

Constructor and Destructor:

-
-+                     Dimension            (void);
+                     Dimension            (const vec2 & _size,
                                            enum ewol::Dimension::distance _type);
+                     Dimension            (const std::string & _config);
+                     Dimension            (const char * _config);
+                    ~Dimension            (void);
-

Synopsis:

-
-+  void               string               (void);
+  vec2               get                  (enum distance _type);
+  void               set                  (const vec2 & _size,
                                            enum distance _type);
+  vec2               getPixel             (void);
+  vec2               getPourcent          (void);
+  vec2               getMeter             (void);
+  vec2               getCentimeter        (void);
+  vec2               getMillimeter        (void);
+  vec2               getKilometer         (void);
+  vec2               getInch              (void);
+  vec2               getFoot              (void);
+  const Dimension &  operator=            (const Dimension & _obj);
+  bool               operator==           (const Dimension & _obj);
+  bool               operator!=           (const Dimension & _obj);
+  static void        init                 (void);
+  static void        unInit               (void);
+  static void        setPixelRatio        (const vec2 & _ratio,
                                            enum ewol::Dimension::distance _type);
+  static void        setPixelWindowsSize  (const vec2 & _size);
+  static vec2        getWindowsSize       (enum ewol::Dimension::distance _type);
+  static float       getWindowsDiag       (enum ewol::Dimension::distance _type);
-  void               set                  (std::string _config);
- - -

Description:

-/** -* @brief in the dimention class we store the data as the more usefull unit (pixel) -* but one case need to be dynamic the %, then when requested in % the register the % value -*/

Detail:

-

ewol::Dimension ()

- -
-Dimension(void);
-
-Constructor (default :0,0 mode pixel) -

- -
-

ewol::Dimension ()

- -
-Dimension(const vec2 & _size,
-          enum ewol::Dimension::distance _type);
-
-Constructor -
-
- -
-

ewol::Dimension ()

- -
-Dimension(const std::string & _config);
-
-Constructor -
-
- -
-

ewol::Dimension ()

- -
-Dimension(const char * _config);
-
-Constructor -
-
- -
-

ewol::~Dimension ()

- -
-~Dimension(void);
-
-Destructor -

- -
-

string ()

- -
-void string(void);
-
-string cast : -

- -
-

get ()

- -
-vec2 get(enum distance _type);
-
-get the current dimention in requested type -
-
- -
-

set ()

- -
-void set(const vec2 & _size,
-         enum distance _type);
-
-set the current dimention in requested type -
-
- -
-

getPixel ()

- -
-vec2 getPixel(void);
-
-get the current dimention in pixel -
-
- -
-

getPourcent ()

- -
-vec2 getPourcent(void);
-
-get the current dimention in Pourcent -
-
- -
-

getMeter ()

- -
-vec2 getMeter(void);
-
-get the current dimention in Meter -
-
- -
-

getCentimeter ()

- -
-vec2 getCentimeter(void);
-
-get the current dimention in Centimeter -
-
- -
-

getMillimeter ()

- -
-vec2 getMillimeter(void);
-
-get the current dimention in Millimeter -
-
- -
-

getKilometer ()

- -
-vec2 getKilometer(void);
-
-get the current dimention in Kilometer -
-
- -
-

getInch ()

- -
-vec2 getInch(void);
-
-get the current dimention in Inch -
-
- -
-

getFoot ()

- -
-vec2 getFoot(void);
-
-get the current dimention in Foot -
-
- -
-

operator= ()

- -
-const Dimension & operator=(const Dimension & _obj);
-
-
- -
-

operator== ()

- -
-bool operator==(const Dimension & _obj);
-
-
- -
-

operator!= ()

- -
-bool operator!=(const Dimension & _obj);
-
-
- -
-

ewol::init ()

- -
-static void init(void);
-
-basic init -

- -
-

ewol::unInit ()

- -
-static void unInit(void);
-
-basic un-init -

- -
-

ewol::setPixelRatio ()

- -
-static void setPixelRatio(const vec2 & _ratio,
-                          enum ewol::Dimension::distance _type);
-
-set the Milimeter ratio for calculation -
-
- -
-

ewol::setPixelWindowsSize ()

- -
-static void setPixelWindowsSize(const vec2 & _size);
-
-set the current Windows size -
-
- -
-

ewol::getWindowsSize ()

- -
-static vec2 getWindowsSize(enum ewol::Dimension::distance _type);
-
-get the Windows size in the request unit -
-
- -
-

ewol::getWindowsDiag ()

- -
-static float getWindowsDiag(enum ewol::Dimension::distance _type);
-
-get the Windows diagonal size in the request unit -
-
- -
-

set ()

- -
-void set(std::string _config);
-
-set the current dimention in requested type -
-
- -
-
- - diff --git a/ewol__DrawProperty.html b/ewol__DrawProperty.html deleted file mode 100644 index 1840b8f1..00000000 --- a/ewol__DrawProperty.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::DrawProperty

-
-

Constructor and Destructor:

-
-
-

Synopsis:

-
-+  void  limit  (const vec2 & _origin,
                 const vec2 & _size);
- - -

Description:

-/** -* @not-in-doc -*/

Detail:

-

limit ()

- -
-void limit(const vec2 & _origin,
-           const vec2 & _size);
-
-
- -
-
- - diff --git a/ewol__EventShortCut.html b/ewol__EventShortCut.html deleted file mode 100644 index 7cf4cbf5..00000000 --- a/ewol__EventShortCut.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::EventShortCut

-
-

Constructor and Destructor:

-
-+        EventShortCut  (void);
+       ~EventShortCut  (void);
-

Synopsis:

-
-
- - -

Description:

-/** -* @not-in-doc -*/

Detail:

-

ewol::EventShortCut ()

- -
-EventShortCut(void);
-
-
- -
-

ewol::~EventShortCut ()

- -
-~EventShortCut(void);
-
-
- -
-
- - diff --git a/ewol__GlyphProperty.html b/ewol__GlyphProperty.html deleted file mode 100644 index 5ba7fdb3..00000000 --- a/ewol__GlyphProperty.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::GlyphProperty

-
-

Constructor and Destructor:

-
-+        GlyphProperty  (void);
-

Synopsis:

-
-+  float kerningGet     (const char32_t _charcode);
+  void  kerningAdd     (const char32_t _charcode,
                         float _value);
+  void  kerningClear   (void);
+  bool  exist          (void);
+  void  setNotExist    (void);
- - -

Description:

-/** -* @not-in-doc -*/

Detail:

-

ewol::GlyphProperty ()

- -
-GlyphProperty(void);
-
-
- -
-

kerningGet ()

- -
-float kerningGet(const char32_t _charcode);
-
-
- -
-

kerningAdd ()

- -
-void kerningAdd(const char32_t _charcode,
-                float _value);
-
-
- -
-

kerningClear ()

- -
-void kerningClear(void);
-
-
- -
-

exist ()

- -
-bool exist(void);
-
-get the status of the char, if it exist or not in the FONT -
-
- -
-

setNotExist ()

- -
-void setNotExist(void);
-
-set the element doen not exist !!! -

- -
-
- - diff --git a/ewol__Kerning.html b/ewol__Kerning.html deleted file mode 100644 index cce841c1..00000000 --- a/ewol__Kerning.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::Kerning

-
-

Constructor and Destructor:

-
-+        Kerning  (void);
+        Kerning  (const char32_t _charcode,
                   const float _value);
+       ~Kerning  (void);
-

Synopsis:

-
-
- - -

Description:

-/** -* @not-in-doc -* @brief Kerning properties of one specific Glyph with an other -* @note The "Kerning" is the methode to provide a better display for some string like -* the "VA" has 2 letter that overlap themself. This name Kerning -* -* Without Kerning : -* -* \ / /\ -* \ / / \ -* \ / / \ -* \ / /______\ -* \ / / \ -* \/ / \ -* v v a a -* -* With Kerning : -* -* \ / /\ -* \ / / \ -* \ / / \ -* \ / /______\ -* \ / / \ -* \/ / \ -* v a v a -* -*/

Detail:

-

ewol::Kerning ()

- -
-Kerning(void);
-
-Simple constructor that allow to allocate the std::vector element -

- -
-

ewol::Kerning ()

- -
-Kerning(const char32_t _charcode,
-        const float _value);
-
-Normal constructor -
-
- -
-

ewol::~Kerning ()

- -
-~Kerning(void);
-
-normal destructor -

- -
-
- - diff --git a/ewol__Object.html b/ewol__Object.html deleted file mode 100644 index b10f9e4d..00000000 --- a/ewol__Object.html +++ /dev/null @@ -1,629 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::Object

-
-

Constructor and Destructor:

-
-+                                                    Object              (void);
+                                                    Object              (const std::string & _name);
+                                                   ~Object              (void);
-

Synopsis:

-
-+  void                                              removeObject        (void);
+  const char * const                                getObjectType       (void);
+  std::string                                       getTypeDescription  (void);
+  bool                                              isTypeCompatible    (const std::string & _type);
+  bool                                              getStatic           (void);
+  int32_t                                           getId               (void);
+  void                                              registerOnEvent     (ewol::Object * _destinationObject,
                                                                          const char * _eventId,
                                                                          const char * _eventIdgenerated,
                                                                          const std::string & _overloadData);
+  void                                              unRegisterOnEvent   (ewol::Object * _destinationObject,
                                                                          const char * _eventId);
+  void                                              onObjectRemove      (ewol::Object * _removeObject);
+  void                                              onReceiveMessage    (const ewol::object::Message & _msg);
+  const std::vector &  getConfigList       (void);
+  bool                                              setConfig           (const ewol::object::Config & _conf);
+  bool                                              setConfig           (const std::string & _config,
                                                                          const std::string & _value);
+  bool                                              setConfigNamed      (const std::string & _objectName,
                                                                          const std::string & _config,
                                                                          const std::string & _value);
+  bool                                              setConfigNamed      (const std::string & _objectName,
                                                                          const ewol::object::Config & _conf);
+  std::string                                       getConfig           (const char * _config);
+  std::string                                       getConfig           (const std::string & _config);
+  const std::string &                               getName             (void);
+  void                                              setName             (const std::string & _name);
+  bool                                              loadXML             (exml::Element * _node);
+  bool                                              storeXML            (exml::Element * _node);
+  ewol::object::Manager &                           getObjectManager    (void);
+  ewol::object::MultiCast &                         getMultiCast        (void);
+  ewol::Context &                                   getContext          (void);
+  void                                              setStatusResource   (bool _val);
+  bool                                              getStatusResource   (void);
#  void                                              autoDestroy         (void);
#  void                                              addObjectType       (const char * _type);
#  void                                              addEventId          (const char * _generateEventId);
#  void                                              generateEventId     (const char * _generateEventId,
                                                                          const std::string & _data);
#  void                                              sendMultiCast       (const char * const _messageId,
                                                                          const std::string & _data);
#  void                                              registerMultiCast   (const char * const _messageId);
#  void                                              registerConfig      (const char * _config,
                                                                          const char * _type,
                                                                          const char * _control,
                                                                          const char * _description,
                                                                          const char * _default);
#  bool                                              onSetConfig         (const ewol::object::Config & _conf);
#  bool                                              onGetConfig         (const char * _config,
                                                                          std::string & _result);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-    +--> ewol::Resource
-
-
-

Description:

-//!< sometimes the user prefer to receive some specific data on an event (instead of the one sed by the widget)/** -* @brief Basic message classes for ewol system -* this class mermit at every Object to communicate between them. -*/

Detail:

-

ewol::Object ()

- -
-Object(void);
-
-Constructor. -

- -
-

ewol::Object ()

- -
-Object(const std::string & _name);
-
-Constructor. -
-
- -
-

ewol::~Object ()

- -
-~Object(void);
-
-Destructor -

- -
-

removeObject ()

- -
-void removeObject(void);
-
-Asynchronous removing the object -

- -
-

getObjectType ()

- -
-const char * const getObjectType(void);
-
-get the current Object type of the Object -
-
- -
-

getTypeDescription ()

- -
-std::string getTypeDescription(void);
-
-Get the herarchie of the Object type. -
-
- -
-

isTypeCompatible ()

- -
-bool isTypeCompatible(const std::string & _type);
-
-check if the element herited from a specific type -
-
- -
-

getStatic ()

- -
-bool getStatic(void);
-
-get the static status of the Object == > mark at true if the user set the object mark as static allocated element ==> not auto remove element -
-
- -
-

getId ()

- -
-int32_t getId(void);
-
-get the UniqueId of the Object -
-
- -
-

registerOnEvent ()

- -
-void registerOnEvent(ewol::Object * _destinationObject,
-                     const char * _eventId,
-                     const char * _eventIdgenerated,
-                     const std::string & _overloadData);
-
-Register an Object over an other to get event on the second... -
-
- -
-

unRegisterOnEvent ()

- -
-void unRegisterOnEvent(ewol::Object * _destinationObject,
-                       const char * _eventId);
-
-Un-Register an Object over an other. -
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-Inform object that an other object is removed ... -
Notes: : Sub classes must call this class -
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-Receive a message from an other Object with a specific eventId and data -
-
- -
-

getConfigList ()

- -
-const std::vector & getConfigList(void);
-
-get all the configuration list -
-
- -
-

setConfig ()

- -
-bool setConfig(const ewol::object::Config & _conf);
-
-Configuration requested to the curent Object (systrem mode) -
-
- -
-

setConfig ()

- -
-bool setConfig(const std::string & _config,
-               const std::string & _value);
-
-
- -
-

setConfigNamed ()

- -
-bool setConfigNamed(const std::string & _objectName,
-                    const std::string & _config,
-                    const std::string & _value);
-
-
- -
-

setConfigNamed ()

- -
-bool setConfigNamed(const std::string & _objectName,
-                    const ewol::object::Config & _conf);
-
-
- -
-

getConfig ()

- -
-std::string getConfig(const char * _config);
-
-Configuration get from the curent Object (systrem mode) -
-
- -
-

getConfig ()

- -
-std::string getConfig(const std::string & _config);
-
-
- -
-

getName ()

- -
-const std::string & getName(void);
-
-get the Object name -
-
- -
-

setName ()

- -
-void setName(const std::string & _name);
-
-get the Widget name -
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-load properties with an XML node. -
-
- -
-

storeXML ()

- -
-bool storeXML(exml::Element * _node);
-
-store properties in this XML node. -
-
- -
-

getObjectManager ()

- -
-ewol::object::Manager & getObjectManager(void);
-
- -
- -
-

getMultiCast ()

- -
-ewol::object::MultiCast & getMultiCast(void);
-
- -
- -
-

getContext ()

- -
-ewol::Context & getContext(void);
-
-get the curent the system inteface. -
-
- -
-

setStatusResource ()

- -
-void setStatusResource(bool _val);
-
-Declare this element as a resource (or singleton) this mean the element will -not be auto Remove at the end of the programm. It just notify that it is not removed. -
-
- -
-

getStatusResource ()

- -
-bool getStatusResource(void);
-
-Get the resource status of the element. -
-
- -
-

autoDestroy ()

- -
-void autoDestroy(void);
-
-Auto-destroy the object -

- -
-

addObjectType ()

- -
-void addObjectType(const char * _type);
-
-Add a type of the list of Object. -
-
- -
-

addEventId ()

- -
-void addEventId(const char * _generateEventId);
-
-add a specific event Id in the list to prevent wrong link on a Object -
-
- -
-

generateEventId ()

- -
-void generateEventId(const char * _generateEventId,
-                     const std::string & _data);
-
-generate event on all registered Object -
-
- -
-

sendMultiCast ()

- -
-void sendMultiCast(const char * const _messageId,
-                   const std::string & _data);
-
-generate Multicast event on all Object requested the event -
-
- -
-

registerMultiCast ()

- -
-void registerMultiCast(const char * const _messageId);
-
-Register of the arrival of a Multicast message -
-
- -
-

registerConfig ()

- -
-void registerConfig(const char * _config,
-                    const char * _type,
-                    const char * _control,
-                    const char * _description,
-                    const char * _default);
-
-the Object add a configuration capabilities -
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-Configuration requested to the curent Object -
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-Receive a configuration message from an other element system or from the curent Object -
-
- -
-
- - diff --git a/ewol__Resource.html b/ewol__Resource.html deleted file mode 100644 index f89bd307..00000000 --- a/ewol__Resource.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::Resource

-
-

Constructor and Destructor:

-
-+                                    Resource             (void);
+                                    Resource             (const std::string & _name);
+                                   ~Resource             (void);
-

Synopsis:

-
-+  void                              increment            (void);
+  bool                              decrement            (void);
+  int32_t                           getCounter           (void);
+  uint8_t                           getResourceLevel     (void);
+  void                              updateContext        (void);
+  void                              removeContext        (void);
+  void                              removeContextToLate  (void);
+  void                              reload               (void);
+  static ewol::resource::Manager &  getManager           (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::Shader
-        +--> ewol::resource::ConfigFile
-        +--> ewol::resource::Texture
-        +--> ewol::resource::Program
-        +--> ewol::resource::VirtualBufferObject
-        +--> ewol::resource::FontBase
-        +--> ewol::resource::Colored3DObject
-
-
-

Detail:

-

ewol::Resource ()

- -
-Resource(void);
-
-
- -
-

ewol::Resource ()

- -
-Resource(const std::string & _name);
-
-
- -
-

ewol::~Resource ()

- -
-~Resource(void);
-
-
- -
-

increment ()

- -
-void increment(void);
-
-
- -
-

decrement ()

- -
-bool decrement(void);
-
-
- -
-

getCounter ()

- -
-int32_t getCounter(void);
-
-
- -
-

getResourceLevel ()

- -
-uint8_t getResourceLevel(void);
-
-
- -
-

updateContext ()

- -
-void updateContext(void);
-
-
- -
-

removeContext ()

- -
-void removeContext(void);
-
-
- -
-

removeContextToLate ()

- -
-void removeContextToLate(void);
-
-
- -
-

reload ()

- -
-void reload(void);
-
-
- -
-

ewol::getManager ()

- -
-static ewol::resource::Manager & getManager(void);
-
-
- -
-
- - diff --git a/ewol__Widget.html b/ewol__Widget.html deleted file mode 100644 index 010e86ba..00000000 --- a/ewol__Widget.html +++ /dev/null @@ -1,1226 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::Widget

-
-

Constructor and Destructor:

-
-+                                     Widget                  (void);
+                                    ~Widget                  (void);
-

Synopsis:

-
-+  void                               setUpperWidget          (ewol::Widget * _upper);
+  void                               removeUpperWidget       (void);
+  ewol::Widget *                     getUpperWidget          (void);
+  vec2                               relativePosition        (const vec2 & _pos);
+  void                               calculateSize           (const vec2 & _available);
+  vec2                               getSize                 (void);
+  void                               calculateMinMaxSize     (void);
+  vec2                               getCalculateMinSize     (void);
+  vec2                               getCalculateMaxSize     (void);
+  void                               setOffset               (const vec2 & _newVal);
+  const vec2 &                       getOffset               (void);
+  void                               setZoom                 (float _newVal);
+  float                              getZoom                 (void);
+  void                               setOrigin               (const vec2 & _pos);
+  vec2                               getOrigin               (void);
+  void                               setMinSize              (const ewol::Dimension & _size);
+  void                               setNoMinSize            (void);
+  const ewol::Dimension &            getMinSize              (void);
+  void                               checkMinSize            (void);
+  void                               setMaxSize              (const ewol::Dimension & _size);
+  void                               setNoMaxSize            (void);
+  const ewol::Dimension &            getMaxSize              (void);
+  void                               checkMaxSize            (void);
+  void                               setExpand               (const bvec2 & _newExpand);
+  bvec2                              getExpand               (void);
+  bvec2                              canExpand               (void);
+  void                               setFill                 (const bvec2 & _newFill);
+  const bvec2 &                      getFill                 (void);
+  const bvec2 &                      canFill                 (void);
+  void                               hide                    (void);
+  void                               show                    (void);
+  bool                               isHide                  (void);
+  void                               setGravity              (enum ewol::gravity _gravity);
+  enum ewol::gravity                 getGravity              (void);
+  bool                               getFocus                (void);
+  bool                               canHaveFocus            (void);
+  bool                               setFocus                (void);
+  bool                               rmFocus                 (void);
+  void                               setCanHaveFocus         (bool _canFocusState);
+  void                               keepFocus               (void);
+  int32_t                            getMouseLimit           (void);
+  void                               setMouseLimit           (int32_t _numberState);
+  bool                               getKeyboardRepeate      (void);
+  int64_t                            systemGetCallDeltaTime  (void);
+  int64_t                            systemGetLastCallTime   (void);
+  void                               systemSetLastCallTime   (int64_t _time);
+  void                               periodicCall            (const ewol::event::Time & _event);
+  ewol::Widget *                     getWidgetAtPos          (const vec2 & _pos);
+  ewol::Widget *                     getWidgetNamed          (const std::string & _widgetName);
+  bool                               systemEventInput        (ewol::event::InputSystem & _event);
+  bool                               systemEventEntry        (ewol::event::EntrySystem & _event);
+  void                               onEventClipboard        (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+  bool                               onEventShortCut         (ewol::key::Special & _special,
                                                               char32_t _unicodeValue,
                                                               enum ewol::key::keyboard _kbMove,
                                                               bool _isDown);
+  void                               systemDraw              (const DrawProperty & _displayProp);
+  void                               onRegenerateDisplay     (void);
+  void                               grabCursor              (void);
+  void                               unGrabCursor            (void);
+  bool                               getGrabStatus           (void);
+  void                               setCursor               (enum ewol::context::cursorDisplay _newCursor);
+  enum ewol::context::cursorDisplay  getCursor               (void);
+  void                               onObjectRemove          (ewol::Object * _removeObject);
+  bool                               loadXML                 (exml::Element * _node);
+  void                               requestUpdateSize       (void);
+  ewol::widget::Manager &            getWidgetManager        (void);
+  ewol::widget::Windows *            getWindows              (void);
+  void                               setAnnimationType       (enum annimationMode _mode,
                                                               const std::string & _type);
+  void                               setAnnimationTime       (enum annimationMode _mode,
                                                               float _time);
+  bool                               startAnnimation         (enum annimationMode _mode);
+  bool                               stopAnnimation          (void);
#  void                               onGetFocus              (void);
#  void                               onLostFocus             (void);
#  void                               setKeyboardRepeate      (bool _state);
#  void                               showKeyboard            (void);
#  void                               hideKeyboard            (void);
#  void                               periodicCallDisable     (void);
#  void                               periodicCallEnable      (float _callInSecond);
#  bool                               onEventInput            (const ewol::event::Input & _event);
#  bool                               onEventEntry            (const ewol::event::Entry & _event);
#  void                               shortCutAdd             (const char * _descriptiveString,
                                                               const char * _generateEventId,
                                                               std::string _data,
                                                               bool _broadcast);
#  void                               shortCutClean           (void);
#  void                               markToRedraw            (void);
#  bool                               needRedraw              (void);
#  void                               onDraw                  (void);
#  bool                               onSetConfig             (const ewol::object::Config & _conf);
#  bool                               onGetConfig             (const char * _config,
                                                               std::string & _result);
#  void                               addAnnimationType       (enum annimationMode _mode,
                                                               const char * _type);
#  bool                               onStartAnnimation       (enum annimationMode _mode);
#  void                               onStopAnnimation        (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ProgressBar
-        +--> ewol::widget::ContainerN
-        +--> ewol::widget::Image
-        +--> ewol::widget::WidgetScrooled
-        +--> ewol::widget::Slider
-        +--> ewol::widget::ColorBar
-        +--> ewol::widget::Button
-        +--> ewol::widget::Spacer
-        +--> ewol::widget::Joystick
-        +--> ewol::widget::Label
-        +--> ewol::widget::Container
-        +--> ewol::widget::ButtonColor
-        +--> ewol::widget::Windows
-        +--> ewol::widget::CheckBox
-        +--> ewol::widget::Entry
-        +--> ewol::widget::Gird
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::Widget ()

- -
-Widget(void);
-
-Constructor of the widget classes -
-
- -
-

ewol::~Widget ()

- -
-~Widget(void);
-
-Destructor of the widget classes -

- -
-

setUpperWidget ()

- -
-void setUpperWidget(ewol::Widget * _upper);
-
-set the upper widget of this widget. -
-
- -
-

removeUpperWidget ()

- -
-void removeUpperWidget(void);
-
-remove the upper widget of this widget. -

- -
-

getUpperWidget ()

- -
-ewol::Widget * getUpperWidget(void);
-
-get the upper widget (father). -

- -
-

relativePosition ()

- -
-vec2 relativePosition(const vec2 & _pos);
-
-convert the absolute position in the local Position (Relative) -
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _available);
-
-Parent set the possible diplay size of the current widget whith his own possibilities - By default this save the widget available size in the widget size -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

getSize ()

- -
-vec2 getSize(void);
-
-get the widget size -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-calculate the minimum and maximum size (need to estimate expend properties of the widget) -
Notes: : INTERNAL EWOL SYSTEM -

- -
-

getCalculateMinSize ()

- -
-vec2 getCalculateMinSize(void);
-
-get the widget minimum size calculated -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

getCalculateMaxSize ()

- -
-vec2 getCalculateMaxSize(void);
-
-get the widget maximum size calculated -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

setOffset ()

- -
-void setOffset(const vec2 & _newVal);
-
-set the zoom property of the widget. -
-
- -
-

getOffset ()

- -
-const vec2 & getOffset(void);
-
-get the offset property of the widget. -
-
- -
-

setZoom ()

- -
-void setZoom(float _newVal);
-
-set the zoom property of the widget -
-
- -
-

getZoom ()

- -
-float getZoom(void);
-
-get the zoom property of the widget -
-
- -
-

setOrigin ()

- -
-void setOrigin(const vec2 & _pos);
-
-set origin at the widget (must be an parrent widget that set this parameter). -This represent the absolute origin in the program windows -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

getOrigin ()

- -
-vec2 getOrigin(void);
-
-get the origin (obsolute position in the windows) -
-
- -
-

setMinSize ()

- -
-void setMinSize(const ewol::Dimension & _size);
-
-User set the minimum size he want to set the display -
-
- -
-

setNoMinSize ()

- -
-void setNoMinSize(void);
-
-User set No minimum size. -

- -
-

getMinSize ()

- -
-const ewol::Dimension & getMinSize(void);
-
-get the current calculated min size -
-
- -
-

checkMinSize ()

- -
-void checkMinSize(void);
-
-Check if the current min size is compatible with the user minimum size - If it is not the user minimum size will overWrite the minimum size set. -
Notes: : INTERNAL EWOL SYSTEM -

- -
-

setMaxSize ()

- -
-void setMaxSize(const ewol::Dimension & _size);
-
-User set the maximum size he want to set the display -
-
- -
-

setNoMaxSize ()

- -
-void setNoMaxSize(void);
-
-User set No maximum size. -

- -
-

getMaxSize ()

- -
-const ewol::Dimension & getMaxSize(void);
-
-get the current maximum size -
-
- -
-

checkMaxSize ()

- -
-void checkMaxSize(void);
-
-Check if the current max size is compatible with the user maximum size - If it is not the user maximum size will overWrite the maximum size set. -
Notes: : INTERNAL EWOL SYSTEM -

- -
-

setExpand ()

- -
-void setExpand(const bvec2 & _newExpand);
-
-set the expend capabilities (x&y) -
-
- -
-

getExpand ()

- -
-bvec2 getExpand(void);
-
-get the expend capabilities (x&y) (set by the user) -
-
- -
-

canExpand ()

- -
-bvec2 canExpand(void);
-
-get the expend capabilities (x&y) -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

setFill ()

- -
-void setFill(const bvec2 & _newFill);
-
-set the x&y filling capacity -
-
- -
-

getFill ()

- -
-const bvec2 & getFill(void);
-
-set the x&y filling capacity set by the user -
-
- -
-

canFill ()

- -
-const bvec2 & canFill(void);
-
-get the filling capabilities x&y -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

hide ()

- -
-void hide(void);
-
-set the widget hidden -

- -
-

show ()

- -
-void show(void);
-
-set the widget visible -

- -
-

isHide ()

- -
-bool isHide(void);
-
-get the visibility of the widget -
-
- -
-

setGravity ()

- -
-void setGravity(enum ewol::gravity _gravity);
-
-set the widget gravity -
-
- -
-

getGravity ()

- -
-enum ewol::gravity getGravity(void);
-
-get the widget gravity -
-
- -
-

getFocus ()

- -
-bool getFocus(void);
-
-get the focus state of the widget -
-
- -
-

canHaveFocus ()

- -
-bool canHaveFocus(void);
-
-get the capability to have focus -
-
- -
-

setFocus ()

- -
-bool setFocus(void);
-
-set focus on this widget -
-
- -
-

rmFocus ()

- -
-bool rmFocus(void);
-
-remove the focus on this widget -
-
- -
-

setCanHaveFocus ()

- -
-void setCanHaveFocus(bool _canFocusState);
-
-set the capability to have the focus -
-
- -
-

keepFocus ()

- -
-void keepFocus(void);
-
-keep the focus on this widget == > this remove the previous focus on all other widget -

- -
-

getMouseLimit ()

- -
-int32_t getMouseLimit(void);
-
-get the number of mouse event supported -
-
- -
-

setMouseLimit ()

- -
-void setMouseLimit(int32_t _numberState);
-
-get the number of mouse event supported -
-
- -
-

getKeyboardRepeate ()

- -
-bool getKeyboardRepeate(void);
-
-get the keyboard repeating event supporting. -
-
- -
-

systemGetCallDeltaTime ()

- -
-int64_t systemGetCallDeltaTime(void);
-
-{SYSTEM} get a reference of the periodic call delta time -
-
- -
-

systemGetLastCallTime ()

- -
-int64_t systemGetLastCallTime(void);
-
-{SYSTEM} get a reference of the periodic call time -
-
- -
-

systemSetLastCallTime ()

- -
-void systemSetLastCallTime(int64_t _time);
-
-{SYSTEM} get a reference of the periodic call time -
-
- -
-

periodicCall ()

- -
-void periodicCall(const ewol::event::Time & _event);
-
-periodic call of this widget -
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-get the widget at the specific windows absolute position -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

getWidgetNamed ()

- -
-ewol::Widget * getWidgetNamed(const std::string & _widgetName);
-
-get the widget if it have this name or one of the subwidget with the same name -
-
- -
-

systemEventInput ()

- -
-bool systemEventInput(ewol::event::InputSystem & _event);
-
-{SYSTEM} system event input (only meta widget might overwrite this function). -
-
- -
-

systemEventEntry ()

- -
-bool systemEventEntry(ewol::event::EntrySystem & _event);
-
-{SYSTEM} Entry event (only meta widget might overwrite this function). -
-
- -
-

onEventClipboard ()

- -
-void onEventClipboard(enum ewol::context::clipBoard::clipboardListe _clipboardID);
-
-Event on a past event == > this event is asynchronous due to all system does not support direct getting datas -
Notes: : need to have focus ... -
-
- -
-

onEventShortCut ()

- -
-bool onEventShortCut(ewol::key::Special & _special,
-                     char32_t _unicodeValue,
-                     enum ewol::key::keyboard _kbMove,
-                     bool _isDown);
-
-Event on a short-cut of this Widget (in case of return false, the event on the keyevent will arrive in the function
Notes: To prevent some error when you get an event get it if it is down and Up ... == > like this it could not generate some ununderstanding error. -
-
- -
-

systemDraw ()

- -
-void systemDraw(const DrawProperty & _displayProp);
-
-{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) -This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget -
Notes: This function is virtual for the scrolled widget, and the more complicated openGl widget -
Notes: : INTERNAL EWOL SYSTEM -
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-Event generated when a redraw is needed -

- -
-

grabCursor ()

- -
-void grabCursor(void);
-
-Grab the cursor : This get all the mouvement of the mouse in PC mode, and generate an ofset instead of a position. -
Notes: : the generation of the offset is due to the fact the cursor position is forced at the center of the widget. -
Notes: This done nothing in "Finger" or "Stylet" mode. -

- -
-

unGrabCursor ()

- -
-void unGrabCursor(void);
-
-Un-Grab the cursor (default mode cursor offset) -

- -
-

getGrabStatus ()

- -
-bool getGrabStatus(void);
-
-get the grabbing status of the cursor. -
-
- -
-

setCursor ()

- -
-void setCursor(enum ewol::context::cursorDisplay _newCursor);
-
-set the cursor display type. -
-
- -
-

getCursor ()

- -
-enum ewol::context::cursorDisplay getCursor(void);
-
-get the currrent cursor. -
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-
- -
-

requestUpdateSize ()

- -
-void requestUpdateSize(void);
-
-need to be call When the size of the current widget have change == > this force the system to recalculate all the widget positions -

- -
-

getWidgetManager ()

- -
-ewol::widget::Manager & getWidgetManager(void);
-
-get the current Widget Manager -

- -
-

getWindows ()

- -
-ewol::widget::Windows * getWindows(void);
-
-get the curent Windows -

- -
-

setAnnimationType ()

- -
-void setAnnimationType(enum annimationMode _mode,
-                       const std::string & _type);
-
-set a annimation type. -
-
- -
-

setAnnimationTime ()

- -
-void setAnnimationTime(enum annimationMode _mode,
-                       float _time);
-
-set a annimation time to produce. -
-
- -
-

startAnnimation ()

- -
-bool startAnnimation(enum annimationMode _mode);
-
-Start the annimation. -
-
- -
-

stopAnnimation ()

- -
-bool stopAnnimation(void);
-
-Stop/Break the annimation. -
-
- -
-

onGetFocus ()

- -
-void onGetFocus(void);
-
-Event of the focus has been grep by the current widget -

- -
-

onLostFocus ()

- -
-void onLostFocus(void);
-
-Event of the focus has been lost by the current widget -

- -
-

setKeyboardRepeate ()

- -
-void setKeyboardRepeate(bool _state);
-
-set the keyboard repeating event supporting. -
-
- -
-

showKeyboard ()

- -
-void showKeyboard(void);
-
-display the virtual keyboard (if needed) -

- -
-

hideKeyboard ()

- -
-void hideKeyboard(void);
-
-Hide the virtual keyboard (if needed) -

- -
-

periodicCallDisable ()

- -
-void periodicCallDisable(void);
-
-disable the periodic call. -

- -
-

periodicCallEnable ()

- -
-void periodicCallEnable(float _callInSecond);
-
-disable the periodic call. -
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-Event on an input of this Widget (finger, mouse, stilet) -
-
- -
-

onEventEntry ()

- -
-bool onEventEntry(const ewol::event::Entry & _event);
-
-Entry event. - represent the physical event : - - Keyboard (key event and move event) - - Accelerometer - - Joystick -
-
- -
-

shortCutAdd ()

- -
-void shortCutAdd(const char * _descriptiveString,
-                 const char * _generateEventId,
-                 std::string _data,
-                 bool _broadcast);
-
-add a specific shortcut with his description -
-
- -
-

shortCutClean ()

- -
-void shortCutClean(void);
-
-remove all curent shortCut -

- -
-

markToRedraw ()

- -
-void markToRedraw(void);
-
-The widget mark itself that it need to regenerate the nest time. -

- -
-

needRedraw ()

- -
-bool needRedraw(void);
-
-get the need of the redrawing of the widget and reset it to false -
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-Common widget drawing function (called by the drawing thread [Android, X11, ...]) -

- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-

addAnnimationType ()

- -
-void addAnnimationType(enum annimationMode _mode,
-                       const char * _type);
-
-Add a annimation type capabilities of this widget. -
-
- -
-

onStartAnnimation ()

- -
-bool onStartAnnimation(enum annimationMode _mode);
-
-Event when start the annimation. -
-
- -
-

onStopAnnimation ()

- -
-void onStopAnnimation(void);
-
-Event when Stop the annimation. -

- -
-
- - diff --git a/ewol__compositing__Area.html b/ewol__compositing__Area.html deleted file mode 100644 index d0e212e6..00000000 --- a/ewol__compositing__Area.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::compositing::Area

-
-

Constructor and Destructor:

-
-+                  Area         (const ivec2 & _size);
+                 ~Area         (void);
-

Synopsis:

-
-+  void            draw         (bool _disableDepthTest);
+  void            clear        (void);
+  const vec3 &    getPos       (void);
+  void            setPos       (const vec3 & _pos);
+  void            setPos       (const vec2 & _pos);
+  void            setRelPos    (const vec3 & _pos);
+  void            setRelPos    (const vec2 & _pos);
+  void            print        (const ivec2 & _size);
+  egami::Image &  get          (void);
+  void            flush        (void);
-  void            loadProgram  (void);
- - -

Object Hierarchy:

-
-ewol::Compositing
-    +--> ewol::compositing::Area
-
-
-

Detail:

-

ewol::compositing::Area ()

- -
-Area(const ivec2 & _size);
-
-generic constructor -
-
- -
-

ewol::compositing::~Area ()

- -
-~Area(void);
-
-generic destructor -

- -
-

draw ()

- -
-void draw(bool _disableDepthTest);
-
-draw All the refistered text in the current element on openGL -

- -
-

clear ()

- -
-void clear(void);
-
-clear alll the registered element in the current element -

- -
-

getPos ()

- -
-const vec3 & getPos(void);
-
-get the current display position (sometime needed in the gui control) -
-
- -
-

setPos ()

- -
-void setPos(const vec3 & _pos);
-
-set position for the next text writen -
-
- -
-

setPos ()

- -
-void setPos(const vec2 & _pos);
-
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec3 & _pos);
-
-set relative position for the next text writen -
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec2 & _pos);
-
-
- -
-

print ()

- -
-void print(const ivec2 & _size);
-
-add a compleate of the image to display with the requested size -
-
- -
-

get ()

- -
-egami::Image & get(void);
-
-
- -
-

flush ()

- -
-void flush(void);
-
-
- -
-

loadProgram ()

- -
-void loadProgram(void);
-
-load the openGL program and get all the ID needed -

- -
-
- - diff --git a/ewol__compositing__Drawing.html b/ewol__compositing__Drawing.html deleted file mode 100644 index 85d222a6..00000000 --- a/ewol__compositing__Drawing.html +++ /dev/null @@ -1,517 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::compositing::Drawing

-
-

Constructor and Destructor:

-
-+                Drawing           (void);
+               ~Drawing           (void);
-

Synopsis:

-
-+  void          draw              (bool _disableDepthTest);
+  void          clear             (void);
+  const vec3 &  getPos            (void);
+  void          setPos            (const vec3 & _pos);
+  void          setPos            (const vec2 & _pos);
+  void          setRelPos         (const vec3 & _pos);
+  void          setRelPos         (const vec2 & _pos);
+  void          setColor          (const etk::Color<> & _color);
+  void          setColorBg        (const etk::Color<> & _color);
+  void          setClippingWidth  (const vec3 & _pos,
                                    const vec3 & _width);
+  void          setClippingWidth  (const vec2 & _pos,
                                    const vec2 & _width);
+  void          setClipping       (const vec3 & _pos,
                                    const vec3 & _posEnd);
+  void          setClipping       (const vec2 & _pos,
                                    const vec2 & _posEnd);
+  void          setClippingMode   (bool _newMode);
+  void          setThickness      (float _thickness);
+  void          addVertex         (void);
+  void          lineTo            (const vec3 & _dest);
+  void          lineTo            (const vec2 & _dest);
+  void          lineRel           (const vec3 & _vect);
+  void          lineRel           (const vec2 & _vect);
+  void          rectangle         (const vec3 & _dest);
+  void          rectangle         (const vec2 & _dest);
+  void          rectangleWidth    (const vec3 & _size);
+  void          rectangleWidth    (const vec2 & _size);
+  void          cube              (const vec3 & _dest);
+  void          circle            (float _radius,
                                    float _angleStart,
                                    float _angleStop);
-  void          loadProgram       (void);
-  void          unLoadProgram     (void);
-  void          generateTriangle  (void);
-  void          resetCount        (void);
-  void          internalSetColor  (const etk::Color<> & _color);
-  void          setPoint          (const vec3 & point);
- - -

Object Hierarchy:

-
-ewol::Compositing
-    +--> ewol::compositing::Drawing
-
-
-

Detail:

-

ewol::compositing::Drawing ()

- -
-Drawing(void);
-
-Basic constructor -

- -
-

ewol::compositing::~Drawing ()

- -
-~Drawing(void);
-
-Basic destructor -

- -
-

draw ()

- -
-void draw(bool _disableDepthTest);
-
-draw All the refistered text in the current element on openGL -

- -
-

clear ()

- -
-void clear(void);
-
-clear alll tre registered element in the current element -

- -
-

getPos ()

- -
-const vec3 & getPos(void);
-
-get the current display position (sometime needed in the gui control) -
-
- -
-

setPos ()

- -
-void setPos(const vec3 & _pos);
-
-set position for the next text writen -
-
- -
-

setPos ()

- -
-void setPos(const vec2 & _pos);
-
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec3 & _pos);
-
-set relative position for the next text writen -
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec2 & _pos);
-
-
- -
-

setColor ()

- -
-void setColor(const etk::Color<> & _color);
-
-set the Color of the current foreground font -
-
- -
-

setColorBg ()

- -
-void setColorBg(const etk::Color<> & _color);
-
-set the background color of the font (for selected Text (not the global BG)) -
-
- -
-

setClippingWidth ()

- -
-void setClippingWidth(const vec3 & _pos,
-                      const vec3 & _width);
-
-Request a clipping area for the text (next draw only) -
-
- -
-

setClippingWidth ()

- -
-void setClippingWidth(const vec2 & _pos,
-                      const vec2 & _width);
-
-
- -
-

setClipping ()

- -
-void setClipping(const vec3 & _pos,
-                 const vec3 & _posEnd);
-
-Request a clipping area for the text (next draw only) -
-
- -
-

setClipping ()

- -
-void setClipping(const vec2 & _pos,
-                 const vec2 & _posEnd);
-
-
- -
-

setClippingMode ()

- -
-void setClippingMode(bool _newMode);
-
-enable/Disable the clipping (without lose the current clipping position) -
_newMode The new status of the clipping -

- -
-

setThickness ()

- -
-void setThickness(float _thickness);
-
-Specify the line thickness for the next elements -
-
- -
-

addVertex ()

- -
-void addVertex(void);
-
-add a point reference at the current position (this is a vertex reference at the current position -

- -
-

lineTo ()

- -
-void lineTo(const vec3 & _dest);
-
-draw a line to a specific position -
-
- -
-

lineTo ()

- -
-void lineTo(const vec2 & _dest);
-
-
- -
-

lineRel ()

- -
-void lineRel(const vec3 & _vect);
-
-Relative drawing a line (spacial vector) -
-
- -
-

lineRel ()

- -
-void lineRel(const vec2 & _vect);
-
-
- -
-

rectangle ()

- -
-void rectangle(const vec3 & _dest);
-
-draw a 2D rectangle to the position requested. -
-
- -
-

rectangle ()

- -
-void rectangle(const vec2 & _dest);
-
-
- -
-

rectangleWidth ()

- -
-void rectangleWidth(const vec3 & _size);
-
-draw a 2D rectangle to the requested size. -
-
- -
-

rectangleWidth ()

- -
-void rectangleWidth(const vec2 & _size);
-
-
- -
-

cube ()

- -
-void cube(const vec3 & _dest);
-
-draw a 3D rectangle to the position requested. -
-
- -
-

circle ()

- -
-void circle(float _radius,
-            float _angleStart,
-            float _angleStop);
-
-draw a 2D circle with the specify rafdius parameter. -
-
- -
-

loadProgram ()

- -
-void loadProgram(void);
-
-load the openGL program and get all the ID needed -

- -
-

unLoadProgram ()

- -
-void unLoadProgram(void);
-
-Un-Load the openGL program and get all the ID needed -

- -
-

generateTriangle ()

- -
-void generateTriangle(void);
-
-Lunch the generation of triangle -

- -
-

resetCount ()

- -
-void resetCount(void);
-
-in case of some error the count can be reset -

- -
-

internalSetColor ()

- -
-void internalSetColor(const etk::Color<> & _color);
-
-set the Color of the current triangle drawing -
-
- -
-

setPoint ()

- -
-void setPoint(const vec3 & point);
-
-internal add of the specific point -
-
- -
-
- - diff --git a/ewol__compositing__Image.html b/ewol__compositing__Image.html deleted file mode 100644 index b6e938a0..00000000 --- a/ewol__compositing__Image.html +++ /dev/null @@ -1,428 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::compositing::Image

-
-

Constructor and Destructor:

-
-+                Image             (const std::string & _imageName);
+               ~Image             (void);
-

Synopsis:

-
-+  void          draw              (bool _disableDepthTest);
+  void          clear             (void);
+  const vec3 &  getPos            (void);
+  void          setPos            (const vec3 & _pos);
+  void          setPos            (const vec2 & _pos);
+  void          setRelPos         (const vec3 & _pos);
+  void          setRelPos         (const vec2 & _pos);
+  void          setColor          (const etk::Color<> & _color);
+  void          setClippingWidth  (const vec3 & _pos,
                                    vec3 _width);
+  void          setClippingWidth  (const vec2 & _pos,
                                    const vec2 & _width);
+  void          setClipping       (const vec3 & _pos,
                                    vec3 _posEnd);
+  void          setClipping       (const vec2 & _pos,
                                    const vec2 & _posEnd);
+  void          setClippingMode   (bool _newMode);
+  void          setAngle          (float _angleRad);
+  void          print             (const ivec2 & _size);
+  void          print             (const vec2 & _size);
+  void          printPart         (const vec2 & _size,
                                    const vec2 & _sourcePosStart,
                                    const vec2 & _sourcePosStop);
+  void          setSource         (const std::string & _newFile,
                                    int32_t _size);
+  void          setSource         (const std::string & _newFile,
                                    const vec2 & _size);
+  bool          hasSources        (void);
+  vec2          getRealSize       (void);
-  void          loadProgram       (void);
- - -

Object Hierarchy:

-
-ewol::Compositing
-    +--> ewol::compositing::Image
-        +--> ewol::compositing::Sprite
-
-
-

Detail:

-

ewol::compositing::Image ()

- -
-Image(const std::string & _imageName);
-
-generic constructor -
-
- -
-

ewol::compositing::~Image ()

- -
-~Image(void);
-
-generic destructor -

- -
-

draw ()

- -
-void draw(bool _disableDepthTest);
-
-draw All the refistered text in the current element on openGL -
-
- -
-

clear ()

- -
-void clear(void);
-
-clear alll tre registered element in the current element -

- -
-

getPos ()

- -
-const vec3 & getPos(void);
-
-get the current display position (sometime needed in the gui control) -
-
- -
-

setPos ()

- -
-void setPos(const vec3 & _pos);
-
-set position for the next text writen -
-
- -
-

setPos ()

- -
-void setPos(const vec2 & _pos);
-
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec3 & _pos);
-
-set relative position for the next text writen -
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec2 & _pos);
-
-
- -
-

setColor ()

- -
-void setColor(const etk::Color<> & _color);
-
-set the Color of the current foreground font -
-
- -
-

setClippingWidth ()

- -
-void setClippingWidth(const vec3 & _pos,
-                      vec3 _width);
-
-Request a clipping area for the text (next draw only) -
-
- -
-

setClippingWidth ()

- -
-void setClippingWidth(const vec2 & _pos,
-                      const vec2 & _width);
-
-
- -
-

setClipping ()

- -
-void setClipping(const vec3 & _pos,
-                 vec3 _posEnd);
-
-Request a clipping area for the text (next draw only) -
-
- -
-

setClipping ()

- -
-void setClipping(const vec2 & _pos,
-                 const vec2 & _posEnd);
-
-
- -
-

setClippingMode ()

- -
-void setClippingMode(bool _newMode);
-
-enable/Disable the clipping (without lose the current clipping position) -
_newMode The new status of the clipping -

- -
-

setAngle ()

- -
-void setAngle(float _angleRad);
-
-set a unique rotation of this element (not set in the rotate Generic system) -
-
- -
-

print ()

- -
-void print(const ivec2 & _size);
-
-add a compleate of the image to display with the requested size -
-
- -
-

print ()

- -
-void print(const vec2 & _size);
-
-
- -
-

printPart ()

- -
-void printPart(const vec2 & _size,
-               const vec2 & _sourcePosStart,
-               const vec2 & _sourcePosStop);
-
-add a part of the image to display with the requested size -
-
- -
-

setSource ()

- -
-void setSource(const std::string & _newFile,
-               int32_t _size);
-
-change the image Source == > can not be done to display 2 images at the same time ... -
-
- -
-

setSource ()

- -
-void setSource(const std::string & _newFile,
-               const vec2 & _size);
-
-
- -
-

hasSources ()

- -
-bool hasSources(void);
-
-Sometimes the user declare an image but not allocate the ressources all the time, this is to know it .. -
-
- -
-

getRealSize ()

- -
-vec2 getRealSize(void);
-
-get the source image registered size in the file (<0 when multiple size image) -
-
- -
-

loadProgram ()

- -
-void loadProgram(void);
-
-load the openGL program and get all the ID needed -

- -
-
- - diff --git a/ewol__compositing__Shaper.html b/ewol__compositing__Shaper.html deleted file mode 100644 index 20e8b4a9..00000000 --- a/ewol__compositing__Shaper.html +++ /dev/null @@ -1,390 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::compositing::Shaper

-
-

Constructor and Destructor:

-
-+                       Shaper                     (const std::string & _shaperName);
+                      ~Shaper                     (void);
-

Synopsis:

-
-+  void                 draw                       (bool _disableDepthTest);
+  void                 clear                      (void);
+  bool                 changeStatusIn             (int32_t _newStatusId);
+  int32_t              getCurrentDisplayedStatus  (void);
+  int32_t              getNextDisplayedStatus     (void);
+  float                getTransitionStatus        (void);
+  bool                 periodicCall               (const ewol::event::Time & _event);
+  void                 setOrigin                  (const vec2 & _newOri);
+  void                 setSize                    (const vec2 & _newSize);
+  void                 setInsideSize              (const vec2 & _newInsideSize);
+  void                 setInsidePos               (const vec2 & _newInsidePos);
+  vec2                 getPadding                 (void);
+  void                 setSource                  (const std::string & _newFile);
+  const std::string &  getSource                  (void);
+  bool                 hasSources                 (void);
-  void                 loadProgram                (void);
-  void                 unLoadProgram              (void);
-  void                 updateVertex               (void);
- - -

Object Hierarchy:

-
-ewol::Compositing
-    +--> ewol::compositing::Shaper
-
-
-

Description:

-/** -* @brief the Shaper system is a basic theme configuration for every widget, it corespond at a background display described by a pool of files -*/

Detail:

-

ewol::compositing::Shaper ()

- -
-Shaper(const std::string & _shaperName);
-
-generic constructor -
-
- -
-

ewol::compositing::~Shaper ()

- -
-~Shaper(void);
-
-generic destructor -

- -
-

draw ()

- -
-void draw(bool _disableDepthTest);
-
-draw All the refistered text in the current element on openGL -

- -
-

clear ()

- -
-void clear(void);
-
-clear alll tre registered element in the current element -

- -
-

changeStatusIn ()

- -
-bool changeStatusIn(int32_t _newStatusId);
-
-change the current status in an other -
-
- -
-

getCurrentDisplayedStatus ()

- -
-int32_t getCurrentDisplayedStatus(void);
-
-get the current displayed status of the shaper -
-
- -
-

getNextDisplayedStatus ()

- -
-int32_t getNextDisplayedStatus(void);
-
-get the next displayed status of the shaper -
-
- -
-

getTransitionStatus ()

- -
-float getTransitionStatus(void);
-
-get the current trasion status -
-
- -
-

periodicCall ()

- -
-bool periodicCall(const ewol::event::Time & _event);
-
-Same as the widfget periodic call (this is for change display) -
-
- -
-

setOrigin ()

- -
-void setOrigin(const vec2 & _newOri);
-
-set the widget origin (needed fot the display) -
-
- -
-

setSize ()

- -
-void setSize(const vec2 & _newSize);
-
-set the widget size (needed fot the display) -
-
- -
-

setInsideSize ()

- -
-void setInsideSize(const vec2 & _newInsideSize);
-
-set the internal widget size -
-
- -
-

setInsidePos ()

- -
-void setInsidePos(const vec2 & _newInsidePos);
-
-set the internal widget position -
-
- -
-

getPadding ()

- -
-vec2 getPadding(void);
-
-get the padding declared by the user in the config file -
-
- -
-

setSource ()

- -
-void setSource(const std::string & _newFile);
-
-change the shaper Source -
-
- -
-

getSource ()

- -
-const std::string & getSource(void);
-
-get the shaper file Source -
-
- -
-

hasSources ()

- -
-bool hasSources(void);
-
-Sometimes the user declare an image but not allocate the ressources all the time, this is to know it .. -
-
- -
-

loadProgram ()

- -
-void loadProgram(void);
-
-load the openGL program and get all the ID needed -

- -
-

unLoadProgram ()

- -
-void unLoadProgram(void);
-
-Un-Load the openGL program and get all the ID needed -

- -
-

updateVertex ()

- -
-void updateVertex(void);
-
-update the internal vertex table. -

- -
-
- - diff --git a/ewol__compositing__Sprite.html b/ewol__compositing__Sprite.html deleted file mode 100644 index 4ac93100..00000000 --- a/ewol__compositing__Sprite.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::compositing::Sprite

-
-

Constructor and Destructor:

-
-+        Sprite       (const std::string & _imageName,
                       const ivec2 & _nbSprite);
+       ~Sprite       ();
-

Synopsis:

-
-+  void  printSprite  (const ivec2 & _spriteID,
                       const vec2 & _size);
+  void  printSprite  (const ivec2 & _spriteID,
                       const vec3 & _size);
- - -

Object Hierarchy:

-
-ewol::Compositing
-    +--> ewol::compositing::Image
-        +--> ewol::compositing::Sprite
-
-
-

Detail:

-

ewol::compositing::Sprite ()

- -
-Sprite(const std::string & _imageName,
-       const ivec2 & _nbSprite);
-
-
- -
-

ewol::compositing::~Sprite ()

- -
-~Sprite();
-
-
- -
-

printSprite ()

- -
-void printSprite(const ivec2 & _spriteID,
-                 const vec2 & _size);
-
-
- -
-

printSprite ()

- -
-void printSprite(const ivec2 & _spriteID,
-                 const vec3 & _size);
-
-
- -
-
- - diff --git a/ewol__compositing__Text.html b/ewol__compositing__Text.html deleted file mode 100644 index bd11e42f..00000000 --- a/ewol__compositing__Text.html +++ /dev/null @@ -1,844 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::compositing::Text

-
-

Constructor and Destructor:

-
-+                                Text                    (const std::string & _fontName,
                                                          int32_t _fontSize);
+                               ~Text                    (void);
-

Synopsis:

-
-+  ewol::compositing::Drawing &  getDrawing              (void);
+  void                          translate               (const vec3 & _vect);
+  void                          rotate                  (const vec3 & _vect,
                                                          float _angle);
+  void                          scale                   (const vec3 & _vect);
+  void                          draw                    (bool _disableDepthTest);
+  void                          draw                    (const mat4 & _transformationMatrix,
                                                          bool _enableDepthTest);
+  void                          clear                   (void);
+  void                          reset                   (void);
+  const vec3 &                  getPos                  (void);
+  void                          setPos                  (const vec3 & _pos);
+  void                          setPos                  (const vec2 & _pos);
+  void                          setRelPos               (const vec3 & _pos);
+  void                          setRelPos               (const vec2 & _pos);
+  void                          setColor                (const etk::Color<> & _color);
+  void                          setColorBg              (const etk::Color<> & _color);
+  void                          setClippingWidth        (const vec3 & _pos,
                                                          const vec3 & _width);
+  void                          setClippingWidth        (const vec2 & _pos,
                                                          const vec2 & _width);
+  void                          setClipping             (const vec3 & _pos,
                                                          const vec3 & _posEnd);
+  void                          setClipping             (const vec2 & _pos,
                                                          const vec2 & _posEnd);
+  void                          setClippingMode         (bool _newMode);
+  void                          setFontSize             (int32_t _fontSize);
+  void                          setFontName             (const std::string & _fontName);
+  void                          setFont                 (std::string _fontName,
                                                          int32_t _fontSize);
+  void                          setFontMode             (enum ewol::font::mode _mode);
+  void                          setFontBold             (bool _status);
+  void                          setFontItalic           (bool _status);
+  void                          setKerningMode          (bool _newMode);
+  void                          setDistanceFieldMode    (bool _newMode);
+  void                          print                   (const std::string & _text);
+  void                          print                   (const std::u32string & _text);
+  void                          printDecorated          (const std::string & _text);
+  void                          printHTML               (const std::string & _text);
+  void                          print                   (const std::string & _text,
                                                          const std::vector & _decoration);
+  void                          print                   (const std::u32string & _text,
                                                          const std::vector & _decoration);
+  void                          print                   (const char32_t & _charcode);
+  void                          forceLineReturn         (void);
+  void                          setTextAlignement       (float _startTextpos,
                                                          float _stopTextPos,
                                                          enum ewol::compositing::Text::aligneMode _alignement);
+  void                          disableAlignement       (void);
+  vec3                          calculateSizeHTML       (const std::string & _text);
+  vec3                          calculateSizeDecorated  (const std::string & _text);
+  vec3                          calculateSize           (const std::string & _text);
+  vec3                          calculateSize           (const char32_t & _charcode);
+  void                          printCursor             (bool _isInsertMode,
                                                          float _cursorSize);
+  void                          disableCursor           (void);
+  void                          setCursorPos            (int32_t _cursorPos);
+  void                          setCursorSelection      (int32_t _cursorPos,
                                                          int32_t _selectionStartPos);
+  void                          setSelectionColor       (const etk::Color<> & _color);
+  void                          setCursorColor          (const etk::Color<> & _color);
-  void                          loadProgram             (void);
-  void                          parseHtmlNode           (exml::Element * _element);
-  bool                          extrapolateLastId       (const std::string & _text,
                                                          const int32_t _start,
                                                          int32_t & _stop,
                                                          int32_t & _space,
                                                          int32_t & _freeSpace);
-  bool                          extrapolateLastId       (const std::u32string & _text,
                                                          const int32_t _start,
                                                          int32_t & _stop,
                                                          int32_t & _space,
                                                          int32_t & _freeSpace);
-  void                          htmlAddData             (const std::string & _data);
-  void                          htmlFlush               (void);
- - -

Object Hierarchy:

-
-ewol::Compositing
-    +--> ewol::compositing::Text
-
-
-

Detail:

-

getDrawing ()

- -
-ewol::compositing::Drawing & getDrawing(void);
-
-
- -
-

ewol::compositing::Text ()

- -
-Text(const std::string & _fontName,
-     int32_t _fontSize);
-
-generic constructor -
-
- -
-

ewol::compositing::~Text ()

- -
-~Text(void);
-
-generic destructor -

- -
-

translate ()

- -
-void translate(const vec3 & _vect);
-
-
- -
-

rotate ()

- -
-void rotate(const vec3 & _vect,
-            float _angle);
-
-
- -
-

scale ()

- -
-void scale(const vec3 & _vect);
-
-
- -
-

draw ()

- -
-void draw(bool _disableDepthTest);
-
-draw All the refistered text in the current element on openGL -

- -
-

draw ()

- -
-void draw(const mat4 & _transformationMatrix,
-          bool _enableDepthTest);
-
-
- -
-

clear ()

- -
-void clear(void);
-
-clear all the registered element in the current element -

- -
-

reset ()

- -
-void reset(void);
-
-clear all the intermediate result detween 2 prints -

- -
-

getPos ()

- -
-const vec3 & getPos(void);
-
-get the current display position (sometime needed in the gui control) -
-
- -
-

setPos ()

- -
-void setPos(const vec3 & _pos);
-
-set position for the next text writen -
-
- -
-

setPos ()

- -
-void setPos(const vec2 & _pos);
-
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec3 & _pos);
-
-set relative position for the next text writen -
-
- -
-

setRelPos ()

- -
-void setRelPos(const vec2 & _pos);
-
-
- -
-

setColor ()

- -
-void setColor(const etk::Color<> & _color);
-
-set the Color of the current foreground font -
-
- -
-

setColorBg ()

- -
-void setColorBg(const etk::Color<> & _color);
-
-set the background color of the font (for selected Text (not the global BG)) -
-
- -
-

setClippingWidth ()

- -
-void setClippingWidth(const vec3 & _pos,
-                      const vec3 & _width);
-
-Request a clipping area for the text (next draw only) -
-
- -
-

setClippingWidth ()

- -
-void setClippingWidth(const vec2 & _pos,
-                      const vec2 & _width);
-
-
- -
-

setClipping ()

- -
-void setClipping(const vec3 & _pos,
-                 const vec3 & _posEnd);
-
-Request a clipping area for the text (next draw only) -
-
- -
-

setClipping ()

- -
-void setClipping(const vec2 & _pos,
-                 const vec2 & _posEnd);
-
-
- -
-

setClippingMode ()

- -
-void setClippingMode(bool _newMode);
-
-enable/Disable the clipping (without lose the current clipping position) -
_newMode The new status of the clipping -

- -
-

setFontSize ()

- -
-void setFontSize(int32_t _fontSize);
-
-Specify the font size (this reset the internal element of the current text (system requirement) -
-
- -
-

setFontName ()

- -
-void setFontName(const std::string & _fontName);
-
-Specify the font name (this reset the internal element of the current text (system requirement) -
-
- -
-

setFont ()

- -
-void setFont(std::string _fontName,
-             int32_t _fontSize);
-
-Specify the font property (this reset the internal element of the current text (system requirement) -
-
- -
-

setFontMode ()

- -
-void setFontMode(enum ewol::font::mode _mode);
-
-Specify the font mode for the next
-
- -
-

setFontBold ()

- -
-void setFontBold(bool _status);
-
-enable or disable the bold mode -
-
- -
-

setFontItalic ()

- -
-void setFontItalic(bool _status);
-
-enable or disable the italic mode -
-
- -
-

setKerningMode ()

- -
-void setKerningMode(bool _newMode);
-
-set the activation of the Kerning for the display (if it existed) -
-
- -
-

setDistanceFieldMode ()

- -
-void setDistanceFieldMode(bool _newMode);
-
-Request the distance field mode for this text display -
-
- -
-

print ()

- -
-void print(const std::string & _text);
-
-display a compleat string in the current element. -
-
- -
-

print ()

- -
-void print(const std::u32string & _text);
-
-
- -
-

printDecorated ()

- -
-void printDecorated(const std::string & _text);
-
-display a compleat string in the current element with the generic decoration specification. (basic html data) -
-	

-	



-	

-		text exemple in bold other text bold part boldItalic part an other thext
-		colored text bold color text bold italic text normal color text the end of the string

-		an an other thext
-	

-	



-	
-		plop 1
-	
-	



-	
-		plop 2
-	
-	



-	
-		Un exemple de text
-	
-
-
Notes: This is parsed with tiny xml, then be carfull that the XML is correct, and all balises are closed ... otherwite the display can not be done -
-
- -
-

printHTML ()

- -
-void printHTML(const std::string & _text);
-
-display a compleat string in the current element with the generic decoration specification. (basic html data) -
-	
-		
-			

-			



-			

-				text exemple in bold other text bold part boldItalic part an other thext
-				colored text bold color text bold italic text normal color text the end of the string

-				an an other thext
-			

-			



-			
-				plop 1
-			
-			



-			
-				plop 2
-			
-			



-			
-				Un exemple de text
-			
-		
-	
-
-
Notes: This is parsed with tiny xml, then be carfull that the XML is correct, and all balises are closed ... otherwite the display can not be done -
-
- -
-

print ()

- -
-void print(const std::string & _text,
-           const std::vector & _decoration);
-
-display a compleat string in the current element whith specific decorations (advence mode). -
-
- -
-

print ()

- -
-void print(const std::u32string & _text,
-           const std::vector & _decoration);
-
-
- -
-

print ()

- -
-void print(const char32_t & _charcode);
-
-display the current char in the current element (note that the kerning is availlable if the position is not changed) -
-
- -
-

forceLineReturn ()

- -
-void forceLineReturn(void);
-
-This generate the line return == > it return to the alignement position start and at the correct line position ==> it might be use to not know the line height -

- -
-

setTextAlignement ()

- -
-void setTextAlignement(float _startTextpos,
-                       float _stopTextPos,
-                       enum ewol::compositing::Text::aligneMode _alignement);
-
-This generate the possibility to generate the big text property -
Notes: The text align in center change of line every display done (even if it was just a char) -
-
- -
-

disableAlignement ()

- -
-void disableAlignement(void);
-
-disable the alignement system -

- -
-

calculateSizeHTML ()

- -
-vec3 calculateSizeHTML(const std::string & _text);
-
-calculate a theoric text size -
-
- -
-

calculateSizeDecorated ()

- -
-vec3 calculateSizeDecorated(const std::string & _text);
-
-calculate a theoric text size -
-
- -
-

calculateSize ()

- -
-vec3 calculateSize(const std::string & _text);
-
-calculate a theoric text size -
-
- -
-

calculateSize ()

- -
-vec3 calculateSize(const char32_t & _charcode);
-
-calculate a theoric charcode size -
-
- -
-

printCursor ()

- -
-void printCursor(bool _isInsertMode,
-                 float _cursorSize);
-
-draw a cursor at the specify position -
-
- -
-

disableCursor ()

- -
-void disableCursor(void);
-
-remove the cursor display -

- -
-

setCursorPos ()

- -
-void setCursorPos(int32_t _cursorPos);
-
-set a cursor at a specific position: -
-
- -
-

setCursorSelection ()

- -
-void setCursorSelection(int32_t _cursorPos,
-                        int32_t _selectionStartPos);
-
-set a cursor at a specific position with his associated selection: -
-
- -
-

setSelectionColor ()

- -
-void setSelectionColor(const etk::Color<> & _color);
-
-change the selection color -
-
- -
-

setCursorColor ()

- -
-void setCursorColor(const etk::Color<> & _color);
-
-change the cursor color -
-
- -
-

loadProgram ()

- -
-void loadProgram(void);
-
-load the openGL program and get all the ID needed -

- -
-

parseHtmlNode ()

- -
-void parseHtmlNode(exml::Element * _element);
-
-This parse a tinyXML node (void pointer to permit to hide tiny XML in include). -
-
- -
-

extrapolateLastId ()

- -
-bool extrapolateLastId(const std::string & _text,
-                       const int32_t _start,
-                       int32_t & _stop,
-                       int32_t & _space,
-                       int32_t & _freeSpace);
-
-calculate the element number that is the first out the alignement range - (start at the specify ID, and use start pos with current one) -
-
- -
-

extrapolateLastId ()

- -
-bool extrapolateLastId(const std::u32string & _text,
-                       const int32_t _start,
-                       int32_t & _stop,
-                       int32_t & _space,
-                       int32_t & _freeSpace);
-
-
- -
-

htmlAddData ()

- -
-void htmlAddData(const std::string & _data);
-
-add a line with the current m_htmlDecoTmp decoration -
-
- -
-

htmlFlush ()

- -
-void htmlFlush(void);
-
-draw the current line -

- -
-
- - diff --git a/ewol__compositing__TextDecoration.html b/ewol__compositing__TextDecoration.html deleted file mode 100644 index 8895afbf..00000000 --- a/ewol__compositing__TextDecoration.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::compositing::TextDecoration

-
-

Constructor and Destructor:

-
-+        TextDecoration  (void);
-

Synopsis:

-
-
- - -

Description:

-/** -* @brief This class represent the specific display for every char in the string ... -* @not-in-doc -*/

Detail:

-

ewol::compositing::TextDecoration ()

- -
-TextDecoration(void);
-
-
- -
-
- - diff --git a/ewol__context__CommandLine.html b/ewol__context__CommandLine.html deleted file mode 100644 index 3d9e0db2..00000000 --- a/ewol__context__CommandLine.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::context::CommandLine

-
-

Constructor and Destructor:

-
-
-

Synopsis:

-
-+  void                 parse  (int32_t _argc,
                                const char * _argv);
+  int32_t              size   (void);
+  const std::string &  get    (int32_t _id);
+  void                 add    (const std::string & _newElement);
+  void                 remove (int32_t _id);
- - -

Detail:

-

parse ()

- -
-void parse(int32_t _argc,
-           const char * _argv);
-
-Parse the command line parameters -

- -
-

size ()

- -
-int32_t size(void);
-
-get the number of element in the Command line -
-
- -
-

get ()

- -
-const std::string & get(int32_t _id);
-
-get an element with a specific ID -
-
- -
-

add ()

- -
-void add(const std::string & _newElement);
-
-add one element at the Command line -
-
- -
-

remove ()

- -
-void remove(int32_t _id);
-
-remove an element -
-
- -
-
- - diff --git a/ewol__context__ConfigFont.html b/ewol__context__ConfigFont.html deleted file mode 100644 index c6b1b5ff..00000000 --- a/ewol__context__ConfigFont.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::context::ConfigFont

-
-

Constructor and Destructor:

-
-+                       ConfigFont      (void);
+                      ~ConfigFont      (void);
-

Synopsis:

-
-+  void                 setFolder       (const std::string & _folder);
+  const std::string &  getFolder       (void);
+  void                 set             (const std::string & _fontName,
                                         int32_t _size);
+  const std::string &  getName         (void);
+  int32_t              getSize         (void);
+  void                 setUseExternal  (bool _val);
+  bool                 getUseExternal  (void);
- - -

Detail:

-

ewol::context::ConfigFont ()

- -
-ConfigFont(void);
-
-
- -
-

ewol::context::~ConfigFont ()

- -
-~ConfigFont(void);
-
-
- -
-

setFolder ()

- -
-void setFolder(const std::string & _folder);
-
-Specify the default font folder for the Ewol search system (only needed when embended font) -
-
- -
-

getFolder ()

- -
-const std::string & getFolder(void);
-
-get the default font folder. -
-
- -
-

set ()

- -
-void set(const std::string & _fontName,
-         int32_t _size);
-
-set the defaut font for all the widgets and basics display. -
-
- -
-

getName ()

- -
-const std::string & getName(void);
-
-get the current default font name -

- -
-

getSize ()

- -
-int32_t getSize(void);
-
-get the default font size. -
-
- -
-

setUseExternal ()

- -
-void setUseExternal(bool _val);
-
-set use of internal/external Font -
-
- -
-

getUseExternal ()

- -
-bool getUseExternal(void);
-
-get the use of internal/external Font -
-
- -
-
- - diff --git a/ewol__context__Fps.html b/ewol__context__Fps.html deleted file mode 100644 index a79ca21b..00000000 --- a/ewol__context__Fps.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::context::Fps

-
-

Constructor and Destructor:

-
-+        Fps               (const char * displayName,
                            bool displayFPS);
+       ~Fps               (void);
-

Synopsis:

-
-+  void  tic               (void);
+  void  toc               (bool displayTime);
+  void  incrementCounter  (void);
+  void  draw              (void);
- - -

Description:

-/** -* @brief This class is designed to count the number of frame per second in the main renderer system -* @not-in-doc -*/

Detail:

-

ewol::context::Fps ()

- -
-Fps(const char * displayName,
-    bool displayFPS);
-
-Constructor -

- -
-

ewol::context::~Fps ()

- -
-~Fps(void);
-
-Destructor -

- -
-

tic ()

- -
-void tic(void);
-
-this might be call every time a diplay start -

- -
-

toc ()

- -
-void toc(bool displayTime);
-
-this might be call every time a diplay stop, it do the display every second -
-
- -
-

incrementCounter ()

- -
-void incrementCounter(void);
-
-this might be call when a display is really done -

- -
-

draw ()

- -
-void draw(void);
-
-draw debug display ... -

- -
-
- - diff --git a/ewol__context__InputLimit.html b/ewol__context__InputLimit.html deleted file mode 100644 index 94cbe12a..00000000 --- a/ewol__context__InputLimit.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::context::InputLimit

-
-

Constructor and Destructor:

-
-
-

Synopsis:

-
-
- - -

Description:

-/** -* @brief internal structure -* @not-in-doc -*/

Detail:

-

- - diff --git a/ewol__context__InputManager.html b/ewol__context__InputManager.html deleted file mode 100644 index 24488b44..00000000 --- a/ewol__context__InputManager.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::context::InputManager

-
-

Constructor and Destructor:

-
-+           InputManager           (ewol::Context & _context);
+          ~InputManager           (void);
-

Synopsis:

-
-+  void     setDpi                 (int32_t newDPI);
+  void     motion                 (enum ewol::key::type _type,
                                    int _pointerID,
                                    vec2 _pos);
+  void     state                  (enum ewol::key::type _type,
                                    int _pointerID,
                                    bool _isDown,
                                    vec2 _pos);
+  void     onObjectRemove         (ewol::Object * _removeObject);
+  void     newLayerSet            (void);
+  void     transfertEvent         (ewol::Widget * _source,
                                    ewol::Widget * _destination);
+  void     grabPointer            (ewol::Widget * _widget);
+  void     unGrabPointer          (void);
-  void     calculateLimit         (void);
-  void     abortElement           (InputPoperty * _eventTable,
                                    int32_t _idInput,
                                    enum ewol::key::type _type);
-  void     cleanElement           (InputPoperty * _eventTable,
                                    int32_t _idInput);
-  bool     localEventInput        (enum ewol::key::type _type,
                                    ewol::Widget * _destWidget,
                                    int32_t _IdInput,
                                    enum ewol::key::status _typeEvent,
                                    vec2 _pos);
-  int32_t  localGetDestinationId  (enum ewol::key::type _type,
                                    ewol::Widget * _destWidget,
                                    int32_t _realInputId);
- - -

Detail:

-

ewol::context::InputManager ()

- -
-InputManager(ewol::Context & _context);
-
-
- -
-

ewol::context::~InputManager ()

- -
-~InputManager(void);
-
-
- -
-

setDpi ()

- -
-void setDpi(int32_t newDPI);
-
-
- -
-

motion ()

- -
-void motion(enum ewol::key::type _type,
-            int _pointerID,
-            vec2 _pos);
-
-
- -
-

state ()

- -
-void state(enum ewol::key::type _type,
-           int _pointerID,
-           bool _isDown,
-           vec2 _pos);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-Inform object that an other object is removed ... -
Notes: : Sub classes must call this class -
-
- -
-

newLayerSet ()

- -
-void newLayerSet(void);
-
-a new layer on the windows is set == > might remove all the property of the current element ... -

- -
-

transfertEvent ()

- -
-void transfertEvent(ewol::Widget * _source,
-                    ewol::Widget * _destination);
-
-This is to transfert the event from one widget to another one -
-
- -
-

grabPointer ()

- -
-void grabPointer(ewol::Widget * _widget);
-
-This fonction lock the pointer properties to move in relative instead of absolute -
-
- -
-

unGrabPointer ()

- -
-void unGrabPointer(void);
-
-This fonction un-lock the pointer properties to move in relative instead of absolute -

- -
-

calculateLimit ()

- -
-void calculateLimit(void);
-
-
- -
-

abortElement ()

- -
-void abortElement(InputPoperty * _eventTable,
-                  int32_t _idInput,
-                  enum ewol::key::type _type);
-
-
- -
-

cleanElement ()

- -
-void cleanElement(InputPoperty * _eventTable,
-                  int32_t _idInput);
-
-
- -
-

localEventInput ()

- -
-bool localEventInput(enum ewol::key::type _type,
-                     ewol::Widget * _destWidget,
-                     int32_t _IdInput,
-                     enum ewol::key::status _typeEvent,
-                     vec2 _pos);
-
-generate the event on the destinated widget. -
-
- -
-

localGetDestinationId ()

- -
-int32_t localGetDestinationId(enum ewol::key::type _type,
-                              ewol::Widget * _destWidget,
-                              int32_t _realInputId);
-
-convert the system event id in the correct EWOL id depending of the system management mode - This function find the next input id unused on the specifiic widget - == > on PC, the ID does not change (GUI is not the same) -
-
- -
-
- - diff --git a/ewol__context__InputPoperty.html b/ewol__context__InputPoperty.html deleted file mode 100644 index e784c69a..00000000 --- a/ewol__context__InputPoperty.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::context::InputPoperty

-
-

Constructor and Destructor:

-
-
-

Synopsis:

-
-
- - -

Description:

-/** -* @brief internal structure -* @not-in-doc -*/

Detail:

-

- - diff --git a/ewol__context__clipBoard__clipboardListe.html b/ewol__context__clipBoard__clipboardListe.html deleted file mode 100644 index 88907994..00000000 --- a/ewol__context__clipBoard__clipboardListe.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::context::clipBoard::clipboardListe

-
-Value :
- -
- - diff --git a/ewol__context__cursorDisplay.html b/ewol__context__cursorDisplay.html deleted file mode 100644 index ffcd827c..00000000 --- a/ewol__context__cursorDisplay.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::context::cursorDisplay

-
-Value :
- -
- - diff --git a/ewol__event__Entry.html b/ewol__event__Entry.html deleted file mode 100644 index 4dd88a29..00000000 --- a/ewol__event__Entry.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::event::Entry

-
-

Constructor and Destructor:

-
-+                                           Entry          (enum ewol::key::keyboard _type,
                                                            enum ewol::key::status _status,
                                                            ewol::key::Special _specialKey,
                                                            char32_t _char);
-

Synopsis:

-
-+  void                                     setType        (enum ewol::key::keyboard _type);
+  const enum ewol::key::keyboard &         getType        (void);
+  void                                     setStatus      (enum ewol::key::status _status);
+  const enum ewol::key::status &           getStatus      (void);
+  void                                     setSpecialKey  (const ewol::key::Special & _specialKey);
+  const ewol::key::Special &               getSpecialKey  (void);
+  void                                     setChar        (char32_t _char);
+  const char32_t &                         getChar        (void);
- - -

Detail:

-

ewol::event::Entry ()

- -
-Entry(enum ewol::key::keyboard _type,
-      enum ewol::key::status _status,
-      ewol::key::Special _specialKey,
-      char32_t _char);
-
-
- -
-

setType ()

- -
-void setType(enum ewol::key::keyboard _type);
-
-
- -
-

getType ()

- -
-const enum ewol::key::keyboard & getType(void);
-
-
- -
-

setStatus ()

- -
-void setStatus(enum ewol::key::status _status);
-
-
- -
-

getStatus ()

- -
-const enum ewol::key::status & getStatus(void);
-
-
- -
-

setSpecialKey ()

- -
-void setSpecialKey(const ewol::key::Special & _specialKey);
-
-
- -
-

getSpecialKey ()

- -
-const ewol::key::Special & getSpecialKey(void);
-
-
- -
-

setChar ()

- -
-void setChar(char32_t _char);
-
-
- -
-

getChar ()

- -
-const char32_t & getChar(void);
-
-
- -
-
- - diff --git a/ewol__event__EntrySystem.html b/ewol__event__EntrySystem.html deleted file mode 100644 index 52763368..00000000 --- a/ewol__event__EntrySystem.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::event::EntrySystem

-
-

Constructor and Destructor:

-
-+        EntrySystem  (enum ewol::key::keyboard _type,
                       enum ewol::key::status _status,
                       ewol::key::Special _specialKey,
                       char32_t _char);
-

Synopsis:

-
-
- - -

Detail:

-

ewol::event::EntrySystem ()

- -
-EntrySystem(enum ewol::key::keyboard _type,
-            enum ewol::key::status _status,
-            ewol::key::Special _specialKey,
-            char32_t _char);
-
-
- -
-
- - diff --git a/ewol__event__Input.html b/ewol__event__Input.html deleted file mode 100644 index a53b8396..00000000 --- a/ewol__event__Input.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::event::Input

-
-

Constructor and Destructor:

-
-+                                         Input      (enum ewol::key::type _type,
                                                      enum ewol::key::status _status,
                                                      uint8_t _id,
                                                      const vec2 & _pos);
-

Synopsis:

-
-+  void                                   setType    (enum ewol::key::type _type);
+  const enum ewol::key::type &           getType    (void);
+  void                                   setStatus  (enum ewol::key::status _status);
+  const enum ewol::key::status &         getStatus  (void);
+  void                                   setId      (uint8_t _id);
+  const uint8_t &                        getId      (void);
+  void                                   setPos     (const vec2 & _pos);
+  const vec2 &                           getPos     (void);
- - -

Detail:

-

ewol::event::Input ()

- -
-Input(enum ewol::key::type _type,
-      enum ewol::key::status _status,
-      uint8_t _id,
-      const vec2 & _pos);
-
-
- -
-

setType ()

- -
-void setType(enum ewol::key::type _type);
-
-
- -
-

getType ()

- -
-const enum ewol::key::type & getType(void);
-
-
- -
-

setStatus ()

- -
-void setStatus(enum ewol::key::status _status);
-
-
- -
-

getStatus ()

- -
-const enum ewol::key::status & getStatus(void);
-
-
- -
-

setId ()

- -
-void setId(uint8_t _id);
-
-
- -
-

getId ()

- -
-const uint8_t & getId(void);
-
-
- -
-

setPos ()

- -
-void setPos(const vec2 & _pos);
-
-
- -
-

getPos ()

- -
-const vec2 & getPos(void);
-
-
- -
-
- - diff --git a/ewol__event__InputSystem.html b/ewol__event__InputSystem.html deleted file mode 100644 index d3bdae96..00000000 --- a/ewol__event__InputSystem.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::event::InputSystem

-
-

Constructor and Destructor:

-
-+                         InputSystem    (enum ewol::key::type _type,
                                          enum ewol::key::status _status,
                                          uint8_t _id,
                                          const vec2 & _pos,
                                          ewol::Widget * _dest,
                                          int32_t _realIdEvent);
-

Synopsis:

-
-+  void                   setDestWidget  (ewol::Widget * _dest);
+  ewol::Widget *         getDestWidget  (void);
+  void                   setRealId      (int32_t _realIdEvent);
+  int32_t                getRealId      (void);
- - -

Detail:

-

ewol::event::InputSystem ()

- -
-InputSystem(enum ewol::key::type _type,
-            enum ewol::key::status _status,
-            uint8_t _id,
-            const vec2 & _pos,
-            ewol::Widget * _dest,
-            int32_t _realIdEvent);
-
-
- -
-

setDestWidget ()

- -
-void setDestWidget(ewol::Widget * _dest);
-
-
- -
-

getDestWidget ()

- -
-ewol::Widget * getDestWidget(void);
-
-
- -
-

setRealId ()

- -
-void setRealId(int32_t _realIdEvent);
-
-
- -
-

getRealId ()

- -
-int32_t getRealId(void);
-
-
- -
-
- - diff --git a/ewol__event__Time.html b/ewol__event__Time.html deleted file mode 100644 index f78c48c1..00000000 --- a/ewol__event__Time.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::event::Time

-
-

Constructor and Destructor:

-
-+                  Time               (int64_t _timeSystem,
                                       int64_t _timeUpAppl,
                                       float _timeDelta,
                                       float _timeDeltaCall);
-

Synopsis:

-
-+  void            setTime            (int64_t _timeSystem);
+  int64_t         getTime            (void);
+  void            setApplWakeUpTime  (int64_t _timeUpAppl);
+  int64_t         getApplWakeUpTime  (void);
+  int64_t         getApplUpTime      (void);
+  void            setDelta           (float _timeDelta);
+  float           getDelta           (void);
+  void            setDeltaCall       (float _timeDeltaCall);
+  float           getDeltaCall       (void);
- - -

Detail:

-

ewol::event::Time ()

- -
-Time(int64_t _timeSystem,
-     int64_t _timeUpAppl,
-     float _timeDelta,
-     float _timeDeltaCall);
-
-
- -
-

setTime ()

- -
-void setTime(int64_t _timeSystem);
-
-
- -
-

getTime ()

- -
-int64_t getTime(void);
-
-
- -
-

setApplWakeUpTime ()

- -
-void setApplWakeUpTime(int64_t _timeUpAppl);
-
-
- -
-

getApplWakeUpTime ()

- -
-int64_t getApplWakeUpTime(void);
-
-
- -
-

getApplUpTime ()

- -
-int64_t getApplUpTime(void);
-
-
- -
-

setDelta ()

- -
-void setDelta(float _timeDelta);
-
-
- -
-

getDelta ()

- -
-float getDelta(void);
-
-
- -
-

setDeltaCall ()

- -
-void setDeltaCall(float _timeDeltaCall);
-
-
- -
-

getDeltaCall ()

- -
-float getDeltaCall(void);
-
-
- -
-
- - diff --git a/ewol__font__mode.html b/ewol__font__mode.html deleted file mode 100644 index 0db433d4..00000000 --- a/ewol__font__mode.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::font::mode

-
-Value :
- -
- - diff --git a/ewol__gravity.html b/ewol__gravity.html deleted file mode 100644 index 574adac9..00000000 --- a/ewol__gravity.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::gravity

-
-Value :
- -
- - diff --git a/ewol__key__Special.html b/ewol__key__Special.html deleted file mode 100644 index eafb415c..00000000 --- a/ewol__key__Special.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::key::Special

-
-

Constructor and Destructor:

-
-+        Special      (void);
-

Synopsis:

-
-+  bool  getCapsLock  (void);
+  void  setCapsLock  (bool _value);
+  bool  getShift     (void);
+  void  setShift     (bool _value);
+  bool  getCtrl      (void);
+  void  setCtrl      (bool _value);
+  bool  getMeta      (void);
+  void  setMeta      (bool _value);
+  bool  getAlt       (void);
+  void  setAlt       (bool _value);
+  bool  getAltGr     (void);
+  void  setAltGr     (bool _value);
+  bool  getNumLock   (void);
+  void  setNumLock   (bool _value);
+  bool  getInsert    (void);
+  void  setInsert    (bool _value);
- - -

Description:

-/** -* @brief This class consider generic special keyborad key (insert, control, shift ...) -*/

Detail:

-

ewol::key::Special ()

- -
-Special(void);
-
-Main constructor -

- -
-

getCapsLock ()

- -
-bool getCapsLock(void);
-
-get the current CapLock Status -
-
- -
-

setCapsLock ()

- -
-void setCapsLock(bool _value);
-
-set the current CapLock Status -
-
- -
-

getShift ()

- -
-bool getShift(void);
-
-Get the current Shift key status -
-
- -
-

setShift ()

- -
-void setShift(bool _value);
-
-Set the current Shift key status -
-
- -
-

getCtrl ()

- -
-bool getCtrl(void);
-
-Get the Current Control key status -
-
- -
-

setCtrl ()

- -
-void setCtrl(bool _value);
-
-Set the Current Control key status -
-
- -
-

getMeta ()

- -
-bool getMeta(void);
-
-Get the current Meta key status (also named windows or apple key) -
-
- -
-

setMeta ()

- -
-void setMeta(bool _value);
-
-Set the current Meta key status (also named windows or apple key) -
-
- -
-

getAlt ()

- -
-bool getAlt(void);
-
-Get the current Alt key status -
-
- -
-

setAlt ()

- -
-void setAlt(bool _value);
-
-Set the current Alt key status -
-
- -
-

getAltGr ()

- -
-bool getAltGr(void);
-
-Get the current Alt-Gr key status -
-
- -
-

setAltGr ()

- -
-void setAltGr(bool _value);
-
-Set the current Alt-Gr key status -
-
- -
-

getNumLock ()

- -
-bool getNumLock(void);
-
-Get the current Ver-num key status -
-
- -
-

setNumLock ()

- -
-void setNumLock(bool _value);
-
-Set the current Ver-num key status -
-
- -
-

getInsert ()

- -
-bool getInsert(void);
-
-Get the current Intert key status -
-
- -
-

setInsert ()

- -
-void setInsert(bool _value);
-
-Set the current Intert key status -
-
- -
-
- - diff --git a/ewol__key__keyboard.html b/ewol__key__keyboard.html deleted file mode 100644 index af1bb258..00000000 --- a/ewol__key__keyboard.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::key::keyboard

-
-Value :
- -
- - diff --git a/ewol__key__status.html b/ewol__key__status.html deleted file mode 100644 index b1eb7dd2..00000000 --- a/ewol__key__status.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::key::status

-
-Value :
- -
- - diff --git a/ewol__key__type.html b/ewol__key__type.html deleted file mode 100644 index 5ba3e81d..00000000 --- a/ewol__key__type.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::key::type

-
-Value :
- -
- - diff --git a/ewol__object__Config.html b/ewol__object__Config.html deleted file mode 100644 index e7a77b0a..00000000 --- a/ewol__object__Config.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::object::Config

-
-

Constructor and Destructor:

-
-+                              Config     (const char * _config,
                                           const std::string & _data);
-

Synopsis:

-
-+  void                        setConfig  (const char * _config);
+  const char *                getConfig  (void);
+  void                        setData    (const std::string & _data);
+  const std::string &         getData    (void);
- - -

Detail:

-

ewol::object::Config ()

- -
-Config(const char * _config,
-       const std::string & _data);
-
-
- -
-

setConfig ()

- -
-void setConfig(const char * _config);
-
-
- -
-

getConfig ()

- -
-const char * getConfig(void);
-
-
- -
-

setData ()

- -
-void setData(const std::string & _data);
-
-
- -
-

getData ()

- -
-const std::string & getData(void);
-
-
- -
-
- - diff --git a/ewol__object__ConfigElement.html b/ewol__object__ConfigElement.html deleted file mode 100644 index 5da83192..00000000 --- a/ewol__object__ConfigElement.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::object::ConfigElement

-
-

Constructor and Destructor:

-
-+                       ConfigElement  (const char * _config,
                                        const char * _type,
                                        const char * _control,
                                        const char * _description,
                                        const char * _default);
-

Synopsis:

-
-+  const char *         getConfig      (void);
+  const char *         getType        (void);
+  const char *         getControl     (void);
+  const char *         getDescription (void);
+  const char *         getDefault     (void);
- - -

Detail:

-

ewol::object::ConfigElement ()

- -
-ConfigElement(const char * _config,
-              const char * _type,
-              const char * _control,
-              const char * _description,
-              const char * _default);
-
-
- -
-

getConfig ()

- -
-const char * getConfig(void);
-
-
- -
-

getType ()

- -
-const char * getType(void);
-
-
- -
-

getControl ()

- -
-const char * getControl(void);
-
-
- -
-

getDescription ()

- -
-const char * getDescription(void);
-
-
- -
-

getDefault ()

- -
-const char * getDefault(void);
-
-
- -
-
- - diff --git a/ewol__object__EventExtGen.html b/ewol__object__EventExtGen.html deleted file mode 100644 index bdc2569c..00000000 --- a/ewol__object__EventExtGen.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::object::EventExtGen

-
-

Constructor and Destructor:

-
-
-

Synopsis:

-
-
- - -

Description:

-/** -* local class for event generation -* @not-in-doc -*/

Detail:

-

- - diff --git a/ewol__object__Manager.html b/ewol__object__Manager.html deleted file mode 100644 index dcf02bb4..00000000 --- a/ewol__object__Manager.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::object::Manager

-
-

Constructor and Destructor:

-
-+                             Manager                   (void);
+                            ~Manager                   (void);
-

Synopsis:

-
-+  void                       unInit                    (void);
+  void                       add                       (ewol::Object * _object);
+  void                       rm                        (ewol::Object * _object);
+  int32_t                    getNumberObject           (void);
+  void                       autoRemove                (ewol::Object * _object);
+  void                       removeAllAutoRemove       (void);
+  ewol::Object *             get                       (const std::string & _name);
+  ewol::object::MultiCast &  multiCast                 (void);
-  void                       informOneObjectIsRemoved  (ewol::Object * _object);
- - -

Detail:

-

ewol::object::Manager ()

- -
-Manager(void);
-
-
- -
-

ewol::object::~Manager ()

- -
-~Manager(void);
-
-
- -
-

unInit ()

- -
-void unInit(void);
-
-remove all resources (un-init) out of the destructor (due to the system implementation) -

- -
-

add ()

- -
-void add(ewol::Object * _object);
-
-
- -
-

rm ()

- -
-void rm(ewol::Object * _object);
-
-
- -
-

getNumberObject ()

- -
-int32_t getNumberObject(void);
-
-
- -
-

autoRemove ()

- -
-void autoRemove(ewol::Object * _object);
-
-
- -
-

removeAllAutoRemove ()

- -
-void removeAllAutoRemove(void);
-
-
- -
-

get ()

- -
-ewol::Object * get(const std::string & _name);
-
-
- -
-

multiCast ()

- -
-ewol::object::MultiCast & multiCast(void);
-
-
- -
-

informOneObjectIsRemoved ()

- -
-void informOneObjectIsRemoved(ewol::Object * _object);
-
-
- -
-
- - diff --git a/ewol__object__Message.html b/ewol__object__Message.html deleted file mode 100644 index 622b77f4..00000000 --- a/ewol__object__Message.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::object::Message

-
-

Constructor and Destructor:

-
-+                              Message    (ewol::Object * _caller,
                                           const char * _message,
                                           const std::string & _data);
-

Synopsis:

-
-+  void                        setCaller  (ewol::Object * _caller);
+  ewol::Object *              getCaller  (void);
+  void                        setMessage (const char * _message);
+  const char *                getMessage (void);
+  void                        setData    (const std::string & _data);
+  const std::string &         getData    (void);
- - -

Detail:

-

ewol::object::Message ()

- -
-Message(ewol::Object * _caller,
-        const char * _message,
-        const std::string & _data);
-
-
- -
-

setCaller ()

- -
-void setCaller(ewol::Object * _caller);
-
-
- -
-

getCaller ()

- -
-ewol::Object * getCaller(void);
-
-
- -
-

setMessage ()

- -
-void setMessage(const char * _message);
-
-
- -
-

getMessage ()

- -
-const char * getMessage(void);
-
-
- -
-

setData ()

- -
-void setData(const std::string & _data);
-
-
- -
-

getData ()

- -
-const std::string & getData(void);
-
-
- -
-
- - diff --git a/ewol__object__MultiCast.html b/ewol__object__MultiCast.html deleted file mode 100644 index 6b4e3b25..00000000 --- a/ewol__object__MultiCast.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::object::MultiCast

-
-

Constructor and Destructor:

-
-+        MultiCast      (void);
+       ~MultiCast      (void);
-

Synopsis:

-
-+  void  anonymousSend  (const char * const _messageId,
                         const std::string & _data);
+  void  send           (ewol::Object * _object,
                         const char * const _message,
                         const std::string & _data);
+  void  rm             (ewol::Object * _object);
+  void  add            (ewol::Object * _object,
                         const char * const _message);
- - -

Detail:

-

ewol::object::MultiCast ()

- -
-MultiCast(void);
-
-
- -
-

ewol::object::~MultiCast ()

- -
-~MultiCast(void);
-
-
- -
-

anonymousSend ()

- -
-void anonymousSend(const char * const _messageId,
-                   const std::string & _data);
-
-
- -
-

send ()

- -
-void send(ewol::Object * _object,
-          const char * const _message,
-          const std::string & _data);
-
-
- -
-

rm ()

- -
-void rm(ewol::Object * _object);
-
-
- -
-

add ()

- -
-void add(ewol::Object * _object,
-         const char * const _message);
-
-
- -
-
- - diff --git a/ewol__object__MultiCast__MessageList.html b/ewol__object__MultiCast__MessageList.html deleted file mode 100644 index 1229d616..00000000 --- a/ewol__object__MultiCast__MessageList.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::object::MultiCast::MessageList

-
-

Constructor and Destructor:

-
-+        MessageList  (const char * _message,
                       ewol::Object * _object);
-

Synopsis:

-
-
- - -

Detail:

-

ewol::object::MultiCast::MessageList ()

- -
-MessageList(const char * _message,
-            ewol::Object * _object);
-
-
- -
-
- - diff --git a/ewol__openGL__openGlFlags.html b/ewol__openGL__openGlFlags.html deleted file mode 100644 index cb20e0fb..00000000 --- a/ewol__openGL__openGlFlags.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::openGL::openGlFlags

-
-Value :
- -
- - diff --git a/ewol__orientation.html b/ewol__orientation.html deleted file mode 100644 index e2a1a0d4..00000000 --- a/ewol__orientation.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Enum: ewol::orientation

-
-Value :
- -
- - diff --git a/ewol__resource__Colored3DObject.html b/ewol__resource__Colored3DObject.html deleted file mode 100644 index 8ea707be..00000000 --- a/ewol__resource__Colored3DObject.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::Colored3DObject

-
-

Constructor and Destructor:

-
-#                                            Colored3DObject  (void);
#                                           ~Colored3DObject  (void);
-

Synopsis:

-
-+  void                                      draw             (std::vector & _vertices,
                                                               const etk::Color<float> & _color,
                                                               bool _updateDepthBuffer,
                                                               bool _depthtest);
+  void                                      draw             (std::vector & _vertices,
                                                               const etk::Color<float> & _color,
                                                               mat4 & _transformationMatrix,
                                                               bool _updateDepthBuffer,
                                                               bool _depthtest);
+  void                                      drawLine         (std::vector & _vertices,
                                                               const etk::Color<float> & _color,
                                                               mat4 & _transformationMatrix,
                                                               bool _updateDepthBuffer,
                                                               bool _depthtest);
+  static ewol::resource::Colored3DObject *  keep             (void);
+  static void                               release          (ewol::resource::Colored3DObject * & _object);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::Colored3DObject
-
-
-

Detail:

-

draw ()

- -
-void draw(std::vector & _vertices,
-          const etk::Color<float> & _color,
-          bool _updateDepthBuffer,
-          bool _depthtest);
-
-
- -
-

draw ()

- -
-void draw(std::vector & _vertices,
-          const etk::Color<float> & _color,
-          mat4 & _transformationMatrix,
-          bool _updateDepthBuffer,
-          bool _depthtest);
-
-
- -
-

drawLine ()

- -
-void drawLine(std::vector & _vertices,
-              const etk::Color<float> & _color,
-              mat4 & _transformationMatrix,
-              bool _updateDepthBuffer,
-              bool _depthtest);
-
-
- -
-

ewol::resource::keep ()

- -
-static ewol::resource::Colored3DObject * keep(void);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::Colored3DObject * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::Colored3DObject ()

- -
-Colored3DObject(void);
-
-
- -
-

ewol::resource::~Colored3DObject ()

- -
-~Colored3DObject(void);
-
-
- -
-
- - diff --git a/ewol__resource__ConfigFile.html b/ewol__resource__ConfigFile.html deleted file mode 100644 index 665b9197..00000000 --- a/ewol__resource__ConfigFile.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::ConfigFile

-
-

Constructor and Destructor:

-
-#                                       ConfigFile  (const std::string & _filename);
#                                      ~ConfigFile  (void);
-

Synopsis:

-
-+  void                                 reload      (void);
+  int32_t                              request     (const std::string & _paramName);
+  int32_t                              getInteger  (int32_t _id);
+  float                                getFloat    (int32_t _id);
+  std::string &                        getString   (int32_t _id);
+  static ewol::resource::ConfigFile *  keep        (const std::string & _filename);
+  static void                          release     (ewol::resource::ConfigFile * & _object);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::ConfigFile
-
-
-

Detail:

-

reload ()

- -
-void reload(void);
-
-
- -
-

request ()

- -
-int32_t request(const std::string & _paramName);
-
-
- -
-

getInteger ()

- -
-int32_t getInteger(int32_t _id);
-
-
- -
-

getFloat ()

- -
-float getFloat(int32_t _id);
-
-
- -
-

getString ()

- -
-std::string & getString(int32_t _id);
-
-
- -
-

ewol::resource::keep ()

- -
-static ewol::resource::ConfigFile * keep(const std::string & _filename);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::ConfigFile * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::ConfigFile ()

- -
-ConfigFile(const std::string & _filename);
-
-
- -
-

ewol::resource::~ConfigFile ()

- -
-~ConfigFile(void);
-
-
- -
-
- - diff --git a/ewol__resource__FontBase.html b/ewol__resource__FontBase.html deleted file mode 100644 index 11f075b0..00000000 --- a/ewol__resource__FontBase.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::FontBase

-
-

Constructor and Destructor:

-
-+           FontBase          (const std::string & _fontName);
+          ~FontBase          (void);
-

Synopsis:

-
-+  bool     getGlyphProperty  (int32_t _fontSize,
                               ewol::GlyphProperty & _property);
+  bool     drawGlyph         (egami::Image & _imageOut,
                               int32_t _fontSize,
                               ivec2 _glyphPosition,
                               ewol::GlyphProperty & _property,
                               int8_t _posInImage);
+  vec2     getSize           (int32_t _fontSize,
                               const std::string & _unicodeString);
+  int32_t  getHeight         (int32_t _fontSize);
+  void     generateKerning   (int32_t _fontSize,
                               std::vector & _listGlyph);
+  void     display           (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::FontBase
-            +--> ewol::resource::FontFreeType
-
-
-

Detail:

-

ewol::resource::FontBase ()

- -
-FontBase(const std::string & _fontName);
-
-
- -
-

ewol::resource::~FontBase ()

- -
-~FontBase(void);
-
-
- -
-

getGlyphProperty ()

- -
-bool getGlyphProperty(int32_t _fontSize,
-                      ewol::GlyphProperty & _property);
-
-
- -
-

drawGlyph ()

- -
-bool drawGlyph(egami::Image & _imageOut,
-               int32_t _fontSize,
-               ivec2 _glyphPosition,
-               ewol::GlyphProperty & _property,
-               int8_t _posInImage);
-
-
- -
-

getSize ()

- -
-vec2 getSize(int32_t _fontSize,
-             const std::string & _unicodeString);
-
-
- -
-

getHeight ()

- -
-int32_t getHeight(int32_t _fontSize);
-
-
- -
-

generateKerning ()

- -
-void generateKerning(int32_t _fontSize,
-                     std::vector & _listGlyph);
-
-
- -
-

display ()

- -
-void display(void);
-
-
- -
-
- - diff --git a/ewol__resource__FontFreeType.html b/ewol__resource__FontFreeType.html deleted file mode 100644 index 27aaf20b..00000000 --- a/ewol__resource__FontFreeType.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::FontFreeType

-
-

Constructor and Destructor:

-
-#                                     FontFreeType      (const std::string & _fontName);
#                                    ~FontFreeType      (void);
-

Synopsis:

-
-+  bool                               getGlyphProperty  (int32_t _fontSize,
                                                         ewol::GlyphProperty & _property);
+  bool                               drawGlyph         (egami::Image & _imageOut,
                                                         int32_t _fontSize,
                                                         ivec2 _glyphPosition,
                                                         ewol::GlyphProperty & _property,
                                                         int8_t _posInImage);
+  vec2                               getSize           (int32_t _fontSize,
                                                         const std::string & _unicodeString);
+  int32_t                            getHeight         (int32_t _fontSize);
+  void                               generateKerning   (int32_t _fontSize,
                                                         std::vector & _listGlyph);
+  static ewol::resource::FontBase *  keep              (const std::string & _filename);
+  static void                        release           (ewol::resource::FontBase * & _object);
-  void                               display           (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::FontBase
-            +--> ewol::resource::FontFreeType
-
-
-

Detail:

-

getGlyphProperty ()

- -
-bool getGlyphProperty(int32_t _fontSize,
-                      ewol::GlyphProperty & _property);
-
-
- -
-

drawGlyph ()

- -
-bool drawGlyph(egami::Image & _imageOut,
-               int32_t _fontSize,
-               ivec2 _glyphPosition,
-               ewol::GlyphProperty & _property,
-               int8_t _posInImage);
-
-
- -
-

getSize ()

- -
-vec2 getSize(int32_t _fontSize,
-             const std::string & _unicodeString);
-
-
- -
-

getHeight ()

- -
-int32_t getHeight(int32_t _fontSize);
-
-
- -
-

generateKerning ()

- -
-void generateKerning(int32_t _fontSize,
-                     std::vector & _listGlyph);
-
-
- -
-

ewol::resource::keep ()

- -
-static ewol::resource::FontBase * keep(const std::string & _filename);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::FontBase * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::FontFreeType ()

- -
-FontFreeType(const std::string & _fontName);
-
-
- -
-

ewol::resource::~FontFreeType ()

- -
-~FontFreeType(void);
-
-
- -
-

display ()

- -
-void display(void);
-
-
- -
-
- - diff --git a/ewol__resource__Manager.html b/ewol__resource__Manager.html deleted file mode 100644 index 655ce31c..00000000 --- a/ewol__resource__Manager.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::Manager

-
-

Constructor and Destructor:

-
-+                    Manager                  (void);
+                   ~Manager                  (void);
-

Synopsis:

-
-+  void              unInit                   (void);
+  void              display                  (void);
+  void              reLoadResources          (void);
+  void              update                   (ewol::Resource * _object);
+  void              updateContext            (void);
+  void              contextHasBeenDestroyed  (void);
+  ewol::Resource *  localKeep                (const std::string & _filename);
+  void              localAdd                 (ewol::Resource * _object);
+  bool              release                  (ewol::Resource * & _object);
- - -

Detail:

-

ewol::resource::Manager ()

- -
-Manager(void);
-
-initialize the internal variable -

- -
-

ewol::resource::~Manager ()

- -
-~Manager(void);
-
-Uninitiamize the resource manager, free all resources previously requested -
Notes: when not free == > generate warning, because the segfault can appear after... -

- -
-

unInit ()

- -
-void unInit(void);
-
-remove all resources (un-init) out of the destructor (due to the system implementation) -

- -
-

display ()

- -
-void display(void);
-
-display in the log all the resources loaded ... -

- -
-

reLoadResources ()

- -
-void reLoadResources(void);
-
-Reload all resources from files, and send there in openGL card if needed. -
Notes: If file is reference at THEME:XXX:filename if the Theme change the file will reload the newOne -

- -
-

update ()

- -
-void update(ewol::Resource * _object);
-
-Call by the system to send all the needed data on the graphic card chen they change ... -
-
- -
-

updateContext ()

- -
-void updateContext(void);
-
-Call by the system chen the openGL Context has been unexpectially removed == > This reload all the texture, VBO and other .... -

- -
-

contextHasBeenDestroyed ()

- -
-void contextHasBeenDestroyed(void);
-
-This is to inform the resources manager that we have no more openGl context ... -

- -
-

localKeep ()

- -
-ewol::Resource * localKeep(const std::string & _filename);
-
-
- -
-

localAdd ()

- -
-void localAdd(ewol::Resource * _object);
-
-
- -
-

release ()

- -
-bool release(ewol::Resource * & _object);
-
-release a resources and free it if the Last release is call. -
-
- -
-
- - diff --git a/ewol__resource__Program.html b/ewol__resource__Program.html deleted file mode 100644 index 21e431ff..00000000 --- a/ewol__resource__Program.html +++ /dev/null @@ -1,694 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::Program

-
-

Constructor and Destructor:

-
-#                                    Program               (const std::string & filename);
#                                   ~Program               (void);
-

Synopsis:

-
-+  int32_t                           getAttribute          (std::string _elementName);
+  void                              sendAttribute         (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            void * _pointer,
                                                            int32_t _jumpBetweenSample);
+  void                              sendAttributePointer  (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            ewol::resource::VirtualBufferObject * _vbo,
                                                            int32_t _index,
                                                            int32_t _jumpBetweenSample,
                                                            int32_t _offset);
+  int32_t                           getUniform            (std::string _elementName);
+  void                              uniformMatrix4fv      (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            mat4 _pointer,
                                                            bool _transpose);
+  void                              uniform1f             (int32_t _idElem,
                                                            float _value1);
+  void                              uniform2f             (int32_t _idElem,
                                                            float _value1,
                                                            float _value2);
+  void                              uniform3f             (int32_t _idElem,
                                                            float _value1,
                                                            float _value2,
                                                            float _value3);
+  void                              uniform4f             (int32_t _idElem,
                                                            float _value1,
                                                            float _value2,
                                                            float _value3,
                                                            float _value4);
+  void                              uniform1i             (int32_t _idElem,
                                                            int32_t _value1);
+  void                              uniform2i             (int32_t _idElem,
                                                            int32_t _value1,
                                                            int32_t _value2);
+  void                              uniform3i             (int32_t _idElem,
                                                            int32_t _value1,
                                                            int32_t _value2,
                                                            int32_t _value3);
+  void                              uniform4i             (int32_t _idElem,
                                                            int32_t _value1,
                                                            int32_t _value2,
                                                            int32_t _value3,
                                                            int32_t _value4);
+  void                              uniform1fv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const float * _value);
+  void                              uniform2fv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const float * _value);
+  void                              uniform3fv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const float * _value);
+  void                              uniform4fv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const float * _value);
+  void                              uniform1iv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const int32_t * _value);
+  void                              uniform2iv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const int32_t * _value);
+  void                              uniform3iv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const int32_t * _value);
+  void                              uniform4iv            (int32_t _idElem,
                                                            int32_t _nbElement,
                                                            const int32_t * _value);
+  void                              uniform2              (int32_t _idElem,
                                                            const vec2 & _value);
+  void                              uniform3              (int32_t _idElem,
                                                            const vec3 & _value);
+  void                              uniform4              (int32_t _idElem,
                                                            const vec4 & _value);
+  void                              uniform2              (int32_t _idElem,
                                                            const ivec2 & _value);
+  void                              uniform3              (int32_t _idElem,
                                                            const ivec3 & _value);
+  void                              uniform4              (int32_t _idElem,
                                                            const ivec4 & _value);
+  void                              use                   (void);
+  void                              setTexture0           (int32_t _idElem,
                                                            GLint _textureOpenGlID);
+  void                              setTexture1           (int32_t _idElem,
                                                            GLint _textureOpenGlID);
+  void                              unUse                 (void);
+  void                              updateContext         (void);
+  void                              removeContext         (void);
+  void                              removeContextToLate   (void);
+  void                              reload                (void);
+  static ewol::resource::Program *  keep                  (const std::string & _filename);
+  static void                       release               (ewol::resource::Program * & _object);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::Program
-
-
-

Description:

-//!< if this element does not exist this is false/** -* @brief Program is a compilation of some fragment Shader and vertex Shader. This construct automaticly this assiciation -* The input file must have the form : "myFile.prog" -* The data is simple : -* 
-* # Comment line ... paid attention at the space at the end of lines, they are considered like a part of the file ...
-* # The folder is automaticly get from the program file basic folder
-* filename1.vert
-* filename2.frag
-* filename3.vert
-* filename4.frag
-*
-*/

Detail:

-

getAttribute ()

- -
-int32_t getAttribute(std::string _elementName);
-
-User request an attribute on this program. -
Notes: The attribute is send to the fragment shaders -
-
- -
-

sendAttribute ()

- -
-void sendAttribute(int32_t _idElem,
-                   int32_t _nbElement,
-                   void * _pointer,
-                   int32_t _jumpBetweenSample);
-
-Send attribute table to the spefified ID attribure (not send if does not really exist in the openGL program). -
-
- -
-

sendAttributePointer ()

- -
-void sendAttributePointer(int32_t _idElem,
-                          int32_t _nbElement,
-                          ewol::resource::VirtualBufferObject * _vbo,
-                          int32_t _index,
-                          int32_t _jumpBetweenSample,
-                          int32_t _offset);
-
-
- -
-

getUniform ()

- -
-int32_t getUniform(std::string _elementName);
-
-User request an Uniform on this program. -
Notes: uniform value is availlable for all the fragment shader in the program (only one value for all) -
-
- -
-

uniformMatrix4fv ()

- -
-void uniformMatrix4fv(int32_t _idElem,
-                      int32_t _nbElement,
-                      mat4 _pointer,
-                      bool _transpose);
-
-Send a uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform1f ()

- -
-void uniform1f(int32_t _idElem,
-               float _value1);
-
-Send 1 float uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform2f ()

- -
-void uniform2f(int32_t _idElem,
-               float _value1,
-               float _value2);
-
-Send 2 float uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform3f ()

- -
-void uniform3f(int32_t _idElem,
-               float _value1,
-               float _value2,
-               float _value3);
-
-Send 3 float uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform4f ()

- -
-void uniform4f(int32_t _idElem,
-               float _value1,
-               float _value2,
-               float _value3,
-               float _value4);
-
-Send 4 float uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform1i ()

- -
-void uniform1i(int32_t _idElem,
-               int32_t _value1);
-
-Send 1 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform2i ()

- -
-void uniform2i(int32_t _idElem,
-               int32_t _value1,
-               int32_t _value2);
-
-Send 2 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform3i ()

- -
-void uniform3i(int32_t _idElem,
-               int32_t _value1,
-               int32_t _value2,
-               int32_t _value3);
-
-Send 3 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform4i ()

- -
-void uniform4i(int32_t _idElem,
-               int32_t _value1,
-               int32_t _value2,
-               int32_t _value3,
-               int32_t _value4);
-
-Send 4 signed integer uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform1fv ()

- -
-void uniform1fv(int32_t _idElem,
-                int32_t _nbElement,
-                const float * _value);
-
-Send "vec1" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform2fv ()

- -
-void uniform2fv(int32_t _idElem,
-                int32_t _nbElement,
-                const float * _value);
-
-Send "vec2" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform3fv ()

- -
-void uniform3fv(int32_t _idElem,
-                int32_t _nbElement,
-                const float * _value);
-
-Send "vec3" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform4fv ()

- -
-void uniform4fv(int32_t _idElem,
-                int32_t _nbElement,
-                const float * _value);
-
-Send "vec4" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform1iv ()

- -
-void uniform1iv(int32_t _idElem,
-                int32_t _nbElement,
-                const int32_t * _value);
-
-Send "ivec1" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform2iv ()

- -
-void uniform2iv(int32_t _idElem,
-                int32_t _nbElement,
-                const int32_t * _value);
-
-Send "ivec2" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform3iv ()

- -
-void uniform3iv(int32_t _idElem,
-                int32_t _nbElement,
-                const int32_t * _value);
-
-Send "ivec3" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform4iv ()

- -
-void uniform4iv(int32_t _idElem,
-                int32_t _nbElement,
-                const int32_t * _value);
-
-Send "ivec4" uniform element to the spefified ID (not send if does not really exist in the openGL program) -
-
- -
-

uniform2 ()

- -
-void uniform2(int32_t _idElem,
-              const vec2 & _value);
-
-
- -
-

uniform3 ()

- -
-void uniform3(int32_t _idElem,
-              const vec3 & _value);
-
-
- -
-

uniform4 ()

- -
-void uniform4(int32_t _idElem,
-              const vec4 & _value);
-
-
- -
-

uniform2 ()

- -
-void uniform2(int32_t _idElem,
-              const ivec2 & _value);
-
-
- -
-

uniform3 ()

- -
-void uniform3(int32_t _idElem,
-              const ivec3 & _value);
-
-
- -
-

uniform4 ()

- -
-void uniform4(int32_t _idElem,
-              const ivec4 & _value);
-
-
- -
-

use ()

- -
-void use(void);
-
-Request the processing of this program -

- -
-

setTexture0 ()

- -
-void setTexture0(int32_t _idElem,
-                 GLint _textureOpenGlID);
-
-set the testure Id on the specify uniform element. -
-
- -
-

setTexture1 ()

- -
-void setTexture1(int32_t _idElem,
-                 GLint _textureOpenGlID);
-
-
- -
-

unUse ()

- -
-void unUse(void);
-
-Stop the processing of this program -

- -
-

updateContext ()

- -
-void updateContext(void);
-
-This load/reload the data in the opengl context, needed when removed previously. -

- -
-

removeContext ()

- -
-void removeContext(void);
-
-remove the data from the opengl context. -

- -
-

removeContextToLate ()

- -
-void removeContextToLate(void);
-
-Special android spec! It inform us that all context is removed and after notify us... -

- -
-

reload ()

- -
-void reload(void);
-
-Relode the shader from the file. used when a request of resouces reload is done. -
Notes: this is really usefull when we tested the new themes or shader developpements. -

- -
-

ewol::resource::keep ()

- -
-static ewol::resource::Program * keep(const std::string & _filename);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::Program * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::Program ()

- -
-Program(const std::string & filename);
-
-Contructor of an opengl Program. -
-
- -
-

ewol::resource::~Program ()

- -
-~Program(void);
-
-Destructor, remove the current Program. -

- -
-
- - diff --git a/ewol__resource__Shader.html b/ewol__resource__Shader.html deleted file mode 100644 index 2f02fa41..00000000 --- a/ewol__resource__Shader.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::Shader

-
-

Constructor and Destructor:

-
-#                                   Shader               (const std::string & _filename);
#                                  ~Shader               (void);
-

Synopsis:

-
-+  GLuint                           getGL_ID             (void);
+  GLenum                           getShaderType        (void);
+  void                             updateContext        (void);
+  void                             removeContext        (void);
+  void                             removeContextToLate  (void);
+  void                             reload               (void);
+  static ewol::resource::Shader *  keep                 (const std::string & _filename);
+  static void                      release              (ewol::resource::Shader * & _object);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::Shader
-
-
-

Description:

-/** -* @brief Shader is a specific resources for opengl, used only in @ref Program. This are components of the renderer pipe-line -*/

Detail:

-

getGL_ID ()

- -
-GLuint getGL_ID(void);
-
-get the opengl reference id of this shader. -
-
- -
-

getShaderType ()

- -
-GLenum getShaderType(void);
-
-get the opengl type of this shader. -
-
- -
-

updateContext ()

- -
-void updateContext(void);
-
-This load/reload the data in the opengl context, needed when removed previously. -

- -
-

removeContext ()

- -
-void removeContext(void);
-
-remove the data from the opengl context. -

- -
-

removeContextToLate ()

- -
-void removeContextToLate(void);
-
-Special android spec! It inform us that all context is removed and after notify us... -

- -
-

reload ()

- -
-void reload(void);
-
-Relode the shader from the file. used when a request of resouces reload is done. -
Notes: this is really usefull when we tested the new themes or shader developpements. -

- -
-

ewol::resource::keep ()

- -
-static ewol::resource::Shader * keep(const std::string & _filename);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::Shader * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::Shader ()

- -
-Shader(const std::string & _filename);
-
-Contructor of an opengl Shader -
-
- -
-

ewol::resource::~Shader ()

- -
-~Shader(void);
-
-Destructor, remove the current Shader -

- -
-
- - diff --git a/ewol__resource__SimpleConfigElement.html b/ewol__resource__SimpleConfigElement.html deleted file mode 100644 index da9fd641..00000000 --- a/ewol__resource__SimpleConfigElement.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::SimpleConfigElement

-
-

Constructor and Destructor:

-
-+                 SimpleConfigElement  (const std::string & _name);
+                ~SimpleConfigElement  (void);
-

Synopsis:

-
-+  void           parse                (const std::string & value);
+  int32_t        getInteger           (void);
+  float          getFloat             (void);
+  std::string &  getString            (void);
- - -

Description:

-/** -* @not-in-doc -*/

Detail:

-

ewol::resource::SimpleConfigElement ()

- -
-SimpleConfigElement(const std::string & _name);
-
-
- -
-

ewol::resource::~SimpleConfigElement ()

- -
-~SimpleConfigElement(void);
-
-
- -
-

parse ()

- -
-void parse(const std::string & value);
-
-
- -
-

getInteger ()

- -
-int32_t getInteger(void);
-
-
- -
-

getFloat ()

- -
-float getFloat(void);
-
-
- -
-

getString ()

- -
-std::string & getString(void);
-
-
- -
-
- - diff --git a/ewol__resource__Texture.html b/ewol__resource__Texture.html deleted file mode 100644 index 62f389ab..00000000 --- a/ewol__resource__Texture.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::Texture

-
-

Constructor and Destructor:

-
-#                                    Texture              (const std::string & _filename);
#                                    Texture              (void);
#                                   ~Texture              (void);
-

Synopsis:

-
-+  void                              updateContext        (void);
+  void                              removeContext        (void);
+  void                              removeContextToLate  (void);
+  GLuint                            getId                (void);
+  vec2                              getUsableSize        (void);
+  void                              setImageSize         (ivec2 newSize);
+  egami::Image &                    get                  (void);
+  void                              flush                (void);
+  static ewol::resource::Texture *  keep                 (void);
+  static void                       release              (ewol::resource::Texture * & _object);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::Texture
-            +--> ewol::resource::TextureFile
-            +--> ewol::resource::TexturedFont
-
-
-

Detail:

-

updateContext ()

- -
-void updateContext(void);
-
-
- -
-

removeContext ()

- -
-void removeContext(void);
-
-
- -
-

removeContextToLate ()

- -
-void removeContextToLate(void);
-
-
- -
-

getId ()

- -
-GLuint getId(void);
-
-
- -
-

getUsableSize ()

- -
-vec2 getUsableSize(void);
-
-
- -
-

setImageSize ()

- -
-void setImageSize(ivec2 newSize);
-
-
- -
-

get ()

- -
-egami::Image & get(void);
-
-
- -
-

flush ()

- -
-void flush(void);
-
-
- -
-

ewol::resource::keep ()

- -
-static ewol::resource::Texture * keep(void);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::Texture * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::Texture ()

- -
-Texture(const std::string & _filename);
-
-
- -
-

ewol::resource::Texture ()

- -
-Texture(void);
-
-
- -
-

ewol::resource::~Texture ()

- -
-~Texture(void);
-
-
- -
-
- - diff --git a/ewol__resource__TextureFile.html b/ewol__resource__TextureFile.html deleted file mode 100644 index 3ac44194..00000000 --- a/ewol__resource__TextureFile.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::TextureFile

-
-

Constructor and Destructor:

-
--                                        TextureFile  (const std::string & _genName);
-                                        TextureFile  (std::string _genName,
                                                       const std::string & _fileName,
                                                       const ivec2 & _size);
-                                       ~TextureFile  (void);
-

Synopsis:

-
-+  const vec2 &                          getRealSize  (void);
+  static ewol::resource::TextureFile *  keep         (const std::string & _filename,
                                                       ivec2 _size);
+  static void                           release      (ewol::resource::TextureFile * & _object);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::Texture
-            +--> ewol::resource::TextureFile
-
-
-

Detail:

-

getRealSize ()

- -
-const vec2 & getRealSize(void);
-
-
- -
-

ewol::resource::keep ()

- -
-static ewol::resource::TextureFile * keep(const std::string & _filename,
-                                          ivec2 _size);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::TextureFile * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::TextureFile ()

- -
-TextureFile(const std::string & _genName);
-
-
- -
-

ewol::resource::TextureFile ()

- -
-TextureFile(std::string _genName,
-            const std::string & _fileName,
-            const ivec2 & _size);
-
-
- -
-

ewol::resource::~TextureFile ()

- -
-~TextureFile(void);
-
-
- -
-
- - diff --git a/ewol__resource__TexturedFont.html b/ewol__resource__TexturedFont.html deleted file mode 100644 index f2f480f2..00000000 --- a/ewol__resource__TexturedFont.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::TexturedFont

-
-

Constructor and Destructor:

-
-#                                         TexturedFont     (const std::string & _fontName);
#                                        ~TexturedFont     (void);
-

Synopsis:

-
-+  int32_t                                getHeight        (const enum ewol::font::mode _displayMode);
+  int32_t                                getFontSize      (void);
+  int32_t                                getIndex         (char32_t _charcode,
                                                            const enum ewol::font::mode _displayMode);
+  ewol::GlyphProperty *                  getGlyphPointer  (const char32_t & _charcode,
                                                            const enum ewol::font::mode _displayMode);
+  static ewol::resource::TexturedFont *  keep             (const std::string & _filename);
+  static void                            release          (ewol::resource::TexturedFont * & _object);
-  bool                                   addGlyph         (const char32_t & _val);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::Texture
-            +--> ewol::resource::TexturedFont
-
-
-

Detail:

-

getHeight ()

- -
-int32_t getHeight(const enum ewol::font::mode _displayMode);
-
-get the display height of this font -
-
- -
-

getFontSize ()

- -
-int32_t getFontSize(void);
-
-get the font height (user friendly) -
-
- -
-

getIndex ()

- -
-int32_t getIndex(char32_t _charcode,
-                 const enum ewol::font::mode _displayMode);
-
-get the ID of a unicode charcode -
-
- -
-

getGlyphPointer ()

- -
-ewol::GlyphProperty * getGlyphPointer(const char32_t & _charcode,
-                                      const enum ewol::font::mode _displayMode);
-
-get the pointer on the coresponding glyph -
-
- -
-

ewol::resource::keep ()

- -
-static ewol::resource::TexturedFont * keep(const std::string & _filename);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::TexturedFont * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::TexturedFont ()

- -
-TexturedFont(const std::string & _fontName);
-
-
- -
-

ewol::resource::~TexturedFont ()

- -
-~TexturedFont(void);
-
-
- -
-

addGlyph ()

- -
-bool addGlyph(const char32_t & _val);
-
-add a glyph in a texture font. -
-
- -
-
- - diff --git a/ewol__resource__VirtualBufferObject.html b/ewol__resource__VirtualBufferObject.html deleted file mode 100644 index a6b29bde..00000000 --- a/ewol__resource__VirtualBufferObject.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::VirtualBufferObject

-
-

Constructor and Destructor:

-
-#                                                VirtualBufferObject  (int32_t _number);
#                                               ~VirtualBufferObject  (void);
-

Synopsis:

-
-+  GLuint                                        getGL_ID             (int32_t id);
+  std::vector<float> &                          getRefBuffer         (int32_t id);
+  void                                          pushOnBuffer         (int32_t id,
                                                                       const vec3 & data);
+  vec3                                          getOnBufferVec3      (int32_t id,
                                                                       int32_t elementID);
+  int32_t                                       sizeOnBufferVec3     (int32_t id);
+  void                                          pushOnBuffer         (int32_t id,
                                                                       const vec2 & data);
+  vec2                                          getOnBufferVec2      (int32_t id,
                                                                       int32_t elementID);
+  int32_t                                       sizeOnBufferVec2     (int32_t id);
+  void                                          retreiveData         (void);
+  void                                          flush                (void);
+  void                                          updateContext        (void);
+  void                                          removeContext        (void);
+  void                                          removeContextToLate  (void);
+  void                                          reload               (void);
+  static ewol::resource::VirtualBufferObject *  keep                 (int32_t _number);
+  static void                                   release              (ewol::resource::VirtualBufferObject * & _object);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Resource
-        +--> ewol::resource::VirtualBufferObject
-
-
-

Description:

-/** -* @brief VirtualBufferObject is a specific resources for opengl, this load the data directly in the graphic card ad keep these inside -*/

Detail:

-

getGL_ID ()

- -
-GLuint getGL_ID(int32_t id);
-
-get the real openGL ID. -
-
- -
-

getRefBuffer ()

- -
-std::vector<float> & getRefBuffer(int32_t id);
-
-get a reference on hte buffer data for this VBO. -
-
- -
-

pushOnBuffer ()

- -
-void pushOnBuffer(int32_t id,
-                  const vec3 & data);
-
-push data on a buffer with a custum type : -
-
- -
-

getOnBufferVec3 ()

- -
-vec3 getOnBufferVec3(int32_t id,
-                     int32_t elementID);
-
-
- -
-

sizeOnBufferVec3 ()

- -
-int32_t sizeOnBufferVec3(int32_t id);
-
-
- -
-

pushOnBuffer ()

- -
-void pushOnBuffer(int32_t id,
-                  const vec2 & data);
-
-push data on a buffer with a custum type : -
-
- -
-

getOnBufferVec2 ()

- -
-vec2 getOnBufferVec2(int32_t id,
-                     int32_t elementID);
-
-
- -
-

sizeOnBufferVec2 ()

- -
-int32_t sizeOnBufferVec2(int32_t id);
-
-
- -
-

retreiveData ()

- -
-void retreiveData(void);
-
-get the data from the graphic card. -

- -
-

flush ()

- -
-void flush(void);
-
-Send the data to the graphic card. -

- -
-

updateContext ()

- -
-void updateContext(void);
-
-This load/reload the data in the opengl context, needed when removed previously. -

- -
-

removeContext ()

- -
-void removeContext(void);
-
-remove the data from the opengl context. -

- -
-

removeContextToLate ()

- -
-void removeContextToLate(void);
-
-Special android spec! It inform us that all context is removed and after notify us... -

- -
-

reload ()

- -
-void reload(void);
-
-Relode the shader from the file. used when a request of resouces reload is done. -
Notes: this is really usefull when we tested the new themes or shader developpements. -

- -
-

ewol::resource::keep ()

- -
-static ewol::resource::VirtualBufferObject * keep(int32_t _number);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
-
- -
-

ewol::resource::release ()

- -
-static void release(ewol::resource::VirtualBufferObject * & _object);
-
-release the keeped resources -
-
- -
-

ewol::resource::VirtualBufferObject ()

- -
-VirtualBufferObject(int32_t _number);
-
-Constructor of this VBO. -
-
- -
-

ewol::resource::~VirtualBufferObject ()

- -
-~VirtualBufferObject(void);
-
-Destructor of this VBO. -

- -
-
- - diff --git a/ewol__resource__progAttributeElement.html b/ewol__resource__progAttributeElement.html deleted file mode 100644 index 1ed96e18..00000000 --- a/ewol__resource__progAttributeElement.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::resource::progAttributeElement

-
-

Constructor and Destructor:

-
-
-

Synopsis:

-
-
- - -

Description:

-/** -* @brief In a openGL program we need some data to communicate with them, we register all the name requested by the user in this structure: -* @note Register all requested element permit to abstract the fact that some element does not exist and remove control of existance from upper code. -* This is important to note when the Program is reloaded the elements availlable can change. -* @not-in-doc -*/

Detail:

-

- - diff --git a/ewol__widget__Button.html b/ewol__widget__Button.html deleted file mode 100644 index 0f784ff3..00000000 --- a/ewol__widget__Button.html +++ /dev/null @@ -1,435 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Button

-
-

Constructor and Destructor:

-
-+                  Button              (const std::string & _shaperName);
+                 ~Button              (void);
-

Synopsis:

-
-+  static void     init                (ewol::widget::Manager & _widgetManager);
+  void            setShaperName       (const std::string & _shaperName);
+  void            setSubWidget        (ewol::Widget * _subWidget);
+  void            setSubWidgetToggle  (ewol::Widget * _subWidget);
+  ewol::Widget *  getSubWidget        (void);
+  ewol::Widget *  getSubWidgetToggle  (void);
+  void            setValue            (bool _val);
+  bool            getValue            (void);
+  void            setLock             (enum buttonLock _lock);
+  void            setToggleMode       (bool _togg);
+  bool            getToggleMode       (void);
+  void            calculateMinMaxSize (void);
+  void            calculateSize       (const vec2 & _availlable);
+  void            onRegenerateDisplay (void);
+  void            systemDraw          (const ewol::DrawProperty & _displayProp);
+  bool            onEventInput        (const ewol::event::Input & _event);
+  bool            onEventEntry        (const ewol::event::Entry & _event);
+  bool            loadXML             (exml::Element * _node);
+  ewol::Widget *  getWidgetNamed      (const std::string & _widgetName);
#  void            onDraw              (void);
#  bool            onSetConfig         (const ewol::object::Config & _conf);
#  bool            onGetConfig         (const char * _config,
                                        std::string & _result);
-  void            changeStatusIn      (int32_t _newStatusId);
-  void            CheckStatus         (void);
-  void            periodicCall        (const ewol::event::Time & _event);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Button
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -* @brief a composed button is a button with an inside composed with the specify XML element == > this permit to generate standard element simple -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::Button ()

- -
-Button(const std::string & _shaperName);
-
-Constructor -
-
- -
-

ewol::widget::~Button ()

- -
-~Button(void);
-
-Destructor -

- -
-

setShaperName ()

- -
-void setShaperName(const std::string & _shaperName);
-
-set the shaper name (use the contructer one this permit to not noad unused shaper) -
-
- -
-

setSubWidget ()

- -
-void setSubWidget(ewol::Widget * _subWidget);
-
-Specify the current widget -
-
- -
-

setSubWidgetToggle ()

- -
-void setSubWidgetToggle(ewol::Widget * _subWidget);
-
-Specify the current widget -
-
- -
-

getSubWidget ()

- -
-ewol::Widget * getSubWidget(void);
-
-get the current displayed composition -
-
- -
-

getSubWidgetToggle ()

- -
-ewol::Widget * getSubWidgetToggle(void);
-
-get the current displayed composition -
-
- -
-

setValue ()

- -
-void setValue(bool _val);
-
-set the currentValue of the Button (pressed or not) -
Notes: Work only in toggle mode -
-
- -
-

getValue ()

- -
-bool getValue(void);
-
-get the current button value. -
-
- -
-

setLock ()

- -
-void setLock(enum buttonLock _lock);
-
-set the button lock state. -
-
- -
-

setToggleMode ()

- -
-void setToggleMode(bool _togg);
-
-change the toggle mode. -
-
- -
-

getToggleMode ()

- -
-bool getToggleMode(void);
-
-get the current toggle mode. -
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

onEventEntry ()

- -
-bool onEventEntry(const ewol::event::Entry & _event);
-
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-
- -
-

getWidgetNamed ()

- -
-ewol::Widget * getWidgetNamed(const std::string & _widgetName);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-

changeStatusIn ()

- -
-void changeStatusIn(int32_t _newStatusId);
-
-internal system to change the property of the current status -
-
- -
-

CheckStatus ()

- -
-void CheckStatus(void);
-
-update the status with the internal satte of the button ... -

- -
-

periodicCall ()

- -
-void periodicCall(const ewol::event::Time & _event);
-
-
- -
-
- - diff --git a/ewol__widget__ButtonColor.html b/ewol__widget__ButtonColor.html deleted file mode 100644 index 8002a264..00000000 --- a/ewol__widget__ButtonColor.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ButtonColor

-
-

Constructor and Destructor:

-
-+               ButtonColor          (etk::Color<> _baseColor,
                                      std::string _shaperName);
+              ~ButtonColor          (void);
-

Synopsis:

-
-+  static void  init                 (ewol::widget::Manager & _widgetManager);
+  void         setShaperName        (std::string _shaperName);
+  etk::Color<> getValue             (void);
+  void         setValue             (etk::Color<> _color);
+  void         calculateMinMaxSize  (void);
+  void         onRegenerateDisplay  (void);
+  bool         onEventInput         (const ewol::event::Input & _event);
+  void         onReceiveMessage     (const ewol::object::Message & _msg);
#  void         onDraw               (void);
-  void         changeStatusIn       (int32_t _newStatusId);
-  void         periodicCall         (const ewol::event::Time & _event);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ButtonColor
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::ButtonColor ()

- -
-ButtonColor(etk::Color<> _baseColor,
-            std::string _shaperName);
-
-Main constructor. -
-
- -
-

ewol::widget::~ButtonColor ()

- -
-~ButtonColor(void);
-
-Main destructor. -

- -
-

setShaperName ()

- -
-void setShaperName(std::string _shaperName);
-
-set the shaper name (use the contructer one this permit to not noad unused shaper). -
-
- -
-

getValue ()

- -
-etk::Color<> getValue(void);
-
-get the current color of the color selection widget -
-
- -
-

setValue ()

- -
-void setValue(etk::Color<> _color);
-
-Specify the current color. -
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

changeStatusIn ()

- -
-void changeStatusIn(int32_t _newStatusId);
-
-internal system to change the property of the current status -
-
- -
-

periodicCall ()

- -
-void periodicCall(const ewol::event::Time & _event);
-
-
- -
-
- - diff --git a/ewol__widget__CheckBox.html b/ewol__widget__CheckBox.html deleted file mode 100644 index 23d7cf7f..00000000 --- a/ewol__widget__CheckBox.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::CheckBox

-
-

Constructor and Destructor:

-
-+               CheckBox             (const std::string & newLabel);
+              ~CheckBox             (void);
-

Synopsis:

-
-+  static void  init                 (ewol::widget::Manager & _widgetManager);
+  void         setLabel             (std::string newLabel);
+  void         setValue             (bool val);
+  bool         getValue             (void);
+  void         calculateMinMaxSize  (void);
+  void         onRegenerateDisplay  (void);
+  bool         onEventInput         (const ewol::event::Input & _event);
+  bool         onEventEntry         (const ewol::event::Entry & _event);
#  void         onDraw               (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::CheckBox
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::CheckBox ()

- -
-CheckBox(const std::string & newLabel);
-
-
- -
-

ewol::widget::~CheckBox ()

- -
-~CheckBox(void);
-
-
- -
-

setLabel ()

- -
-void setLabel(std::string newLabel);
-
-
- -
-

setValue ()

- -
-void setValue(bool val);
-
-
- -
-

getValue ()

- -
-bool getValue(void);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

onEventEntry ()

- -
-bool onEventEntry(const ewol::event::Entry & _event);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-
- - diff --git a/ewol__widget__ColorBar.html b/ewol__widget__ColorBar.html deleted file mode 100644 index c888eaed..00000000 --- a/ewol__widget__ColorBar.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ColorBar

-
-

Constructor and Destructor:

-
-+                ColorBar             (void);
+               ~ColorBar             (void);
-

Synopsis:

-
-+  etk::Color<>  getCurrentColor      (void);
+  void          setCurrentColor      (etk::Color<> _newOne);
+  void          calculateMinMaxSize  (void);
+  void          onRegenerateDisplay  (void);
+  bool          onEventInput         (const ewol::event::Input & _event);
#  void          onDraw               (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ColorBar
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::ColorBar ()

- -
-ColorBar(void);
-
-
- -
-

ewol::widget::~ColorBar ()

- -
-~ColorBar(void);
-
-
- -
-

getCurrentColor ()

- -
-etk::Color<> getCurrentColor(void);
-
-
- -
-

setCurrentColor ()

- -
-void setCurrentColor(etk::Color<> _newOne);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-
- - diff --git a/ewol__widget__ColorChooser.html b/ewol__widget__ColorChooser.html deleted file mode 100644 index d99d4474..00000000 --- a/ewol__widget__ColorChooser.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ColorChooser

-
-

Constructor and Destructor:

-
-+                ColorChooser      (void);
+               ~ColorChooser      (void);
-

Synopsis:

-
-+  void          onReceiveMessage  (const ewol::object::Message & _msg);
+  void          onObjectRemove    (ewol::Object * _removeObject);
+  void          setColor          (etk::Color<> _newColor);
+  etk::Color<>  getColor          (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ContainerN
-            +--> ewol::widget::Sizer
-                +--> ewol::widget::ColorChooser
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::ColorChooser ()

- -
-ColorChooser(void);
-
-
- -
-

ewol::widget::~ColorChooser ()

- -
-~ColorChooser(void);
-
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

setColor ()

- -
-void setColor(etk::Color<> _newColor);
-
-
- -
-

getColor ()

- -
-etk::Color<> getColor(void);
-
-
- -
-
- - diff --git a/ewol__widget__Composer.html b/ewol__widget__Composer.html deleted file mode 100644 index d39d86e7..00000000 --- a/ewol__widget__Composer.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Composer

-
-

Constructor and Destructor:

-
-+        Composer                   (void);
+        Composer                   (enum composerMode _mode,
                                     const std::string & _data);
+       ~Composer                   (void);
-

Synopsis:

-
-+  bool  loadFromFile               (const std::string & _fileName);
+  bool  loadFromString             (const std::string & _composerXmlString);
+  void  registerOnEventNameWidget  (ewol::Object * _destinationObject,
                                     const std::string & _subWidgetName,
                                     const char * _eventId,
                                     const char * _eventIdgenerated,
                                     const std::string & _overloadData);
#  void  registerOnEventNameWidget  (const std::string & _subWidgetName,
                                     const char * _eventId,
                                     const char * _eventIdgenerated,
                                     const std::string & _overloadData);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::Composer
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -* @brief the composer widget is a widget that create a link on a string.file to parse the data and generate some widget tree -*/

Detail:

-

ewol::widget::Composer ()

- -
-Composer(void);
-
-Constructor -

- -
-

ewol::widget::Composer ()

- -
-Composer(enum composerMode _mode,
-         const std::string & _data);
-
-Constructor -
-
- -
-

ewol::widget::~Composer ()

- -
-~Composer(void);
-
-Destructor -

- -
-

loadFromFile ()

- -
-bool loadFromFile(const std::string & _fileName);
-
-load a composition with a file -
-
- -
-

loadFromString ()

- -
-bool loadFromString(const std::string & _composerXmlString);
-
-load a composition with a file -
-
- -
-

registerOnEventNameWidget ()

- -
-void registerOnEventNameWidget(ewol::Object * _destinationObject,
-                               const std::string & _subWidgetName,
-                               const char * _eventId,
-                               const char * _eventIdgenerated,
-                               const std::string & _overloadData);
-
-Register an Event an named widget.
Notes: : To used when NOT herited from this object. -
-
- -
-

registerOnEventNameWidget ()

- -
-void registerOnEventNameWidget(const std::string & _subWidgetName,
-                               const char * _eventId,
-                               const char * _eventIdgenerated,
-                               const std::string & _overloadData);
-
-Register an Event an named widget.
Notes: : To used when herited from this object. -
-
- -
-
- - diff --git a/ewol__widget__Container.html b/ewol__widget__Container.html deleted file mode 100644 index a7b5bccc..00000000 --- a/ewol__widget__Container.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Container

-
-

Constructor and Destructor:

-
-+                  Container               (ewol::Widget * _subElement);
+                 ~Container               (void);
-

Synopsis:

-
-+  ewol::Widget *  getSubWidget            (void);
+  void            setSubWidget            (ewol::Widget * _newWidget);
+  void            subWidgetRemove         (void);
+  void            subWidgetRemoveDelayed  (void);
+  void            systemDraw              (const ewol::DrawProperty & _displayProp);
+  void            onRegenerateDisplay     (void);
+  void            onObjectRemove          (ewol::Object * _removeObject);
+  void            calculateSize           (const vec2 & _availlable);
+  void            calculateMinMaxSize     (void);
+  ewol::Widget *  getWidgetAtPos          (const vec2 & _pos);
+  ewol::Widget *  getWidgetNamed          (const std::string & _widgetName);
+  bool            loadXML                 (exml::Element * _node);
+  void            setOffset               (const vec2 & _newVal);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::Composer
-            +--> ewol::widget::Scroll
-            +--> ewol::widget::PopUp
-            +--> ewol::widget::ContextMenu
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -* @brief the Cotainer widget is a widget that have an only one subWidget -*/

Detail:

-

ewol::widget::Container ()

- -
-Container(ewol::Widget * _subElement);
-
-Constructor -

- -
-

ewol::widget::~Container ()

- -
-~Container(void);
-
-Destructor -

- -
-

getSubWidget ()

- -
-ewol::Widget * getSubWidget(void);
-
-get the main node widget -
-
- -
-

setSubWidget ()

- -
-void setSubWidget(ewol::Widget * _newWidget);
-
-set the subWidget node widget. -
-
- -
-

subWidgetRemove ()

- -
-void subWidgetRemove(void);
-
-remove the subWidget node. -

- -
-

subWidgetRemoveDelayed ()

- -
-void subWidgetRemoveDelayed(void);
-
-remove the subWidget node (delayed to prevent remove in the callbback). -

- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-
- -
-

getWidgetNamed ()

- -
-ewol::Widget * getWidgetNamed(const std::string & _widgetName);
-
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-
- -
-

setOffset ()

- -
-void setOffset(const vec2 & _newVal);
-
-
- -
-
- - diff --git a/ewol__widget__ContainerN.html b/ewol__widget__ContainerN.html deleted file mode 100644 index 0b2d33fa..00000000 --- a/ewol__widget__ContainerN.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ContainerN

-
-

Constructor and Destructor:

-
-+                  ContainerN                 (void);
+                 ~ContainerN                 (void);
-

Synopsis:

-
-+  void            lockExpand                 (const bvec2 & _lockExpand);
+  bvec2           canExpand                  (void);
+  void            subWidgetRemoveAll         (void);
+  void            subWidgetRemoveAllDelayed  (void);
+  int32_t         subWidgetAdd               (ewol::Widget * _newWidget);
+  int32_t         subWidgetAddBack           (ewol::Widget * _newWidget);
+  int32_t         subWidgetAddEnd            (ewol::Widget * _newWidget);
+  int32_t         subWidgetAddStart          (ewol::Widget * _newWidget);
+  int32_t         subWidgetAddFront          (ewol::Widget * _newWidget);
+  void            subWidgetRemove            (ewol::Widget * _newWidget);
+  void            subWidgetUnLink            (ewol::Widget * _newWidget);
+  void            systemDraw                 (const ewol::DrawProperty & _displayProp);
+  void            onRegenerateDisplay        (void);
+  void            onObjectRemove             (ewol::Object * _removeObject);
+  void            calculateSize              (const vec2 & _availlable);
+  void            calculateMinMaxSize        (void);
+  ewol::Widget *  getWidgetAtPos             (const vec2 & _pos);
+  ewol::Widget *  getWidgetNamed             (const std::string & _widgetName);
+  bool            loadXML                    (exml::Element * _node);
+  void            setOffset                  (const vec2 & _newVal);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ContainerN
-            +--> ewol::widget::Layer
-            +--> ewol::widget::WSlider
-            +--> ewol::widget::Sizer
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -* @brief the Cotainer widget is a widget that have an only one subWidget -*/

Detail:

-

ewol::widget::ContainerN ()

- -
-ContainerN(void);
-
-Constructor -

- -
-

ewol::widget::~ContainerN ()

- -
-~ContainerN(void);
-
-Destructor -

- -
-

lockExpand ()

- -
-void lockExpand(const bvec2 & _lockExpand);
-
-Limit the expend properties to the current widget (no contamination) -
-
- -
-

canExpand ()

- -
-bvec2 canExpand(void);
-
-
- -
-

subWidgetRemoveAll ()

- -
-void subWidgetRemoveAll(void);
-
-remove all sub element from the widget. -

- -
-

subWidgetRemoveAllDelayed ()

- -
-void subWidgetRemoveAllDelayed(void);
-
-remove all sub element from the widget (delayed to prevent remove in the callbback). -

- -
-

subWidgetAdd ()

- -
-int32_t subWidgetAdd(ewol::Widget * _newWidget);
-
-add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) -
-
- -
-

subWidgetAddBack ()

- -
-int32_t subWidgetAddBack(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetAddEnd ()

- -
-int32_t subWidgetAddEnd(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetAddStart ()

- -
-int32_t subWidgetAddStart(ewol::Widget * _newWidget);
-
-add at start position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) -
-
- -
-

subWidgetAddFront ()

- -
-int32_t subWidgetAddFront(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetRemove ()

- -
-void subWidgetRemove(ewol::Widget * _newWidget);
-
-remove definitly a widget from the system and this layer. -
-
- -
-

subWidgetUnLink ()

- -
-void subWidgetUnLink(ewol::Widget * _newWidget);
-
-Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...) -
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-
- -
-

getWidgetNamed ()

- -
-ewol::Widget * getWidgetNamed(const std::string & _widgetName);
-
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-
- -
-

setOffset ()

- -
-void setOffset(const vec2 & _newVal);
-
-
- -
-
- - diff --git a/ewol__widget__ContextMenu.html b/ewol__widget__ContextMenu.html deleted file mode 100644 index 3232b780..00000000 --- a/ewol__widget__ContextMenu.html +++ /dev/null @@ -1,276 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ContextMenu

-
-

Constructor and Destructor:

-
-+                  ContextMenu          (const std::string & _shaperName);
+                 ~ContextMenu          (void);
-

Synopsis:

-
-+  static void     init                 (ewol::widget::Manager & _widgetManager);
+  void            setShaperName        (const std::string & _shaperName);
+  void            setPositionMark      (enum markPosition position,
                                         vec2 arrowPos);
+  void            onRegenerateDisplay  (void);
+  bool            onEventInput         (const ewol::event::Input & _event);
+  void            calculateSize        (const vec2 & availlable);
+  void            calculateMinMaxSize  (void);
+  ewol::Widget *  getWidgetAtPos       (const vec2 & pos);
#  void            onDraw               (void);
#  bool            onSetConfig          (const ewol::object::Config & _conf);
#  bool            onGetConfig          (const char * _config,
                                         std::string & _result);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::ContextMenu
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::ContextMenu ()

- -
-ContextMenu(const std::string & _shaperName);
-
-
- -
-

ewol::widget::~ContextMenu ()

- -
-~ContextMenu(void);
-
-
- -
-

setShaperName ()

- -
-void setShaperName(const std::string & _shaperName);
-
-set the shaper name (use the contructer one this permit to not noad unused shaper) -
-
- -
-

setPositionMark ()

- -
-void setPositionMark(enum markPosition position,
-                     vec2 arrowPos);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & availlable);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & pos);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-
- - diff --git a/ewol__widget__Entry.html b/ewol__widget__Entry.html deleted file mode 100644 index 4cd0519b..00000000 --- a/ewol__widget__Entry.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Entry

-
-

Constructor and Destructor:

-
-+                        Entry                     (std::string _newData);
+                       ~Entry                     (void);
-

Synopsis:

-
-+  static void           init                      (ewol::widget::Manager & _widgetManager);
+  void                  setValue                  (const std::string & _newData);
+  std::string           getValue                  (void);
+  void                  setMaxChar                (int32_t _nbMax);
+  int32_t               getMaxChar                (void);
+  void                  setRegExp                 (const std::string & _expression);
+  std::string           getRegExp                 (void);
+  void                  copySelectionToClipBoard  (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+  void                  removeSelected            (void);
+  void                  setColorText              (const etk::Color<> & _color);
+  const etk::Color<> &  getColorText              (void);
+  void                  setColorTextSelected      (const etk::Color<> & _color);
+  const etk::Color<> &  getColorTextSelected      (void);
+  void                  setEmptyText              (const std::string & _text);
+  const std::string &   getEmptyText              (void);
+  void                  onRegenerateDisplay       (void);
+  bool                  onEventInput              (const ewol::event::Input & _event);
+  bool                  onEventEntry              (const ewol::event::Entry & _event);
+  void                  onReceiveMessage          (const ewol::object::Message & _msg);
+  void                  onEventClipboard          (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+  void                  calculateMinMaxSize       (void);
#  void                  setInternalValue          (const std::string & _newData);
#  void                  markToUpdateTextPosition  (void);
#  void                  updateTextPosition        (void);
#  void                  updateCursorPosition      (const vec2 & _pos,
                                                    bool _Selection);
#  void                  onDraw                    (void);
#  void                  onGetFocus                (void);
#  void                  onLostFocus               (void);
#  void                  changeStatusIn            (int32_t _newStatusId);
#  void                  periodicCall              (const ewol::event::Time & _event);
#  bool                  onSetConfig               (const ewol::object::Config & _conf);
#  bool                  onGetConfig               (const char * _config,
                                                    std::string & _result);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Entry
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -* @brief Entry box display : -* -* ~~~~~~~~~~~~~~~~~~~~~~ -* ---------------------------------------------- -* | Editable Text | -* ---------------------------------------------- -* ~~~~~~~~~~~~~~~~~~~~~~ -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::Entry ()

- -
-Entry(std::string _newData);
-
-Contuctor -
-
- -
-

ewol::widget::~Entry ()

- -
-~Entry(void);
-
-Destuctor -

- -
-

setValue ()

- -
-void setValue(const std::string & _newData);
-
-set a new value on the entry. -
-
- -
-

getValue ()

- -
-std::string getValue(void);
-
-get the current value in the entry -
-
- -
-

setMaxChar ()

- -
-void setMaxChar(int32_t _nbMax);
-
-Limit the number of Unicode character in the entry -
-
- -
-

getMaxChar ()

- -
-int32_t getMaxChar(void);
-
-Limit the number of Unicode character in the entry -
-
- -
-

setRegExp ()

- -
-void setRegExp(const std::string & _expression);
-
-Limit the input entry at a regular expression... (by default it is "*") -
-
- -
-

getRegExp ()

- -
-std::string getRegExp(void);
-
-get the regualar expression limitation -
-
- -
-

copySelectionToClipBoard ()

- -
-void copySelectionToClipBoard(enum ewol::context::clipBoard::clipboardListe _clipboardID);
-
-Copy the selected data on the specify clipboard -
-
- -
-

removeSelected ()

- -
-void removeSelected(void);
-
-remove the selected area -
Notes: This request a regeneration of the display -

- -
-

setColorText ()

- -
-void setColorText(const etk::Color<> & _color);
-
-set text color. -
-
- -
-

getColorText ()

- -
-const etk::Color<> & getColorText(void);
-
-get the color for the text. -
-
- -
-

setColorTextSelected ()

- -
-void setColorTextSelected(const etk::Color<> & _color);
-
-set text backgroung color when selected. -
-
- -
-

getColorTextSelected ()

- -
-const etk::Color<> & getColorTextSelected(void);
-
-get the selected color for the text in selection mode. -
-
- -
-

setEmptyText ()

- -
-void setEmptyText(const std::string & _text);
-
-set The text displayed when nothing is in the entry. -
-
- -
-

getEmptyText ()

- -
-const std::string & getEmptyText(void);
-
-get The text displayed when nothing is in the entry. -
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

onEventEntry ()

- -
-bool onEventEntry(const ewol::event::Entry & _event);
-
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-
- -
-

onEventClipboard ()

- -
-void onEventClipboard(enum ewol::context::clipBoard::clipboardListe _clipboardID);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

setInternalValue ()

- -
-void setInternalValue(const std::string & _newData);
-
-internal check the value with RegExp checking -
-
- -
-

markToUpdateTextPosition ()

- -
-void markToUpdateTextPosition(void);
-
-informe the system thet the text change and the start position change -

- -
-

updateTextPosition ()

- -
-void updateTextPosition(void);
-
-update the display position start == > depending of the position of the Cursor and the size of the Data inside -

- -
-

updateCursorPosition ()

- -
-void updateCursorPosition(const vec2 & _pos,
-                          bool _Selection);
-
-change the cursor position with the curent position requested on the display -
Notes: The display is automaticly requested when change apear. -
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onGetFocus ()

- -
-void onGetFocus(void);
-
-
- -
-

onLostFocus ()

- -
-void onLostFocus(void);
-
-
- -
-

changeStatusIn ()

- -
-void changeStatusIn(int32_t _newStatusId);
-
-
- -
-

periodicCall ()

- -
-void periodicCall(const ewol::event::Time & _event);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-
- - diff --git a/ewol__widget__FileChooser.html b/ewol__widget__FileChooser.html deleted file mode 100644 index dd6788b5..00000000 --- a/ewol__widget__FileChooser.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::FileChooser

-
-

Constructor and Destructor:

-
-+               FileChooser           (void);
+              ~FileChooser           (void);
-

Synopsis:

-
-+  void         setTitle              (const std::string & _label);
+  void         setValidateLabel      (const std::string & _label);
+  void         setCancelLabel        (const std::string & _label);
+  void         setFolder             (const std::string & _folder);
+  void         setFileName           (const std::string & _filename);
+  std::string  getCompleateFileName  (void);
+  void         updateCurrentFolder   (void);
+  void         onReceiveMessage      (const ewol::object::Message & _msg);
+  void         onObjectRemove        (ewol::Object * _removeObject);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::PopUp
-                +--> ewol::widget::FileChooser
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::FileChooser ()

- -
-FileChooser(void);
-
-
- -
-

ewol::widget::~FileChooser ()

- -
-~FileChooser(void);
-
-
- -
-

setTitle ()

- -
-void setTitle(const std::string & _label);
-
-
- -
-

setValidateLabel ()

- -
-void setValidateLabel(const std::string & _label);
-
-
- -
-

setCancelLabel ()

- -
-void setCancelLabel(const std::string & _label);
-
-
- -
-

setFolder ()

- -
-void setFolder(const std::string & _folder);
-
-
- -
-

setFileName ()

- -
-void setFileName(const std::string & _filename);
-
-
- -
-

getCompleateFileName ()

- -
-std::string getCompleateFileName(void);
-
-
- -
-

updateCurrentFolder ()

- -
-void updateCurrentFolder(void);
-
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-
- - diff --git a/ewol__widget__Gird.html b/ewol__widget__Gird.html deleted file mode 100644 index 1b17c929..00000000 --- a/ewol__widget__Gird.html +++ /dev/null @@ -1,421 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Gird

-
-

Constructor and Destructor:

-
-+                 Gird                (int32_t _colNumber);
+                ~Gird                (void);
-

Synopsis:

-
-+  static void    init                (ewol::widget::Manager & _widgetManager);
+  void           setColNumber        (int32_t _colNumber);
+  void           setColSize          (int32_t _colId,
                                       int32_t _size);
+  void           setRowSize          (int32_t _size);
+  int32_t        getColSize          (int32_t _colId);
+  int32_t        getRowSize          (void);
+  void           setGravityButtom    (void);
+  void           setGravityTop       (void);
+  void           subWidgetRemoveAll  (void);
+  void           subWidgetAdd        (int32_t _colId,
                                       int32_t _rowId,
                                       ewol::Widget * _newWidget);
+  void           subWidgetRemove     (ewol::Widget * _newWidget);
+  void           subWidgetRemove     (int32_t _colId,
                                       int32_t _rowId);
+  void           subWidgetUnLink     (ewol::Widget * _newWidget);
+  void           subWidgetUnLink     (int32_t _colId,
                                       int32_t _rowId);
+  void           setBorderSize       (const ivec2 & _newBorderSize);
+  const ivec2 &  getBorderSize       (void);
+  void           systemDraw          (const ewol::DrawProperty & _displayProp);
+  void           onRegenerateDisplay (void);
+  ewol::Widget * getWidgetAtPos      (const vec2 & pos);
+  void           onObjectRemove      (ewol::Object * _removeObject);
+  void           calculateSize       (const vec2 & _availlable);
+  void           calculateMinMaxSize (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Gird
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::Gird ()

- -
-Gird(int32_t _colNumber);
-
-Constructor -

- -
-

ewol::widget::~Gird ()

- -
-~Gird(void);
-
-Desstructor -

- -
-

setColNumber ()

- -
-void setColNumber(int32_t _colNumber);
-
-set the number of colomn -
-
- -
-

setColSize ()

- -
-void setColSize(int32_t _colId,
-                int32_t _size);
-
-change a size view of a colomn. -
-
- -
-

setRowSize ()

- -
-void setRowSize(int32_t _size);
-
-change a size view of a line. -
-
- -
-

getColSize ()

- -
-int32_t getColSize(int32_t _colId);
-
-get the size view of a colomn. -
-
- -
-

getRowSize ()

- -
-int32_t getRowSize(void);
-
-get the size view of the lines. -
-
- -
-

setGravityButtom ()

- -
-void setGravityButtom(void);
-
-set the gravity of the widget on the Button (index 0 is on buttom) -

- -
-

setGravityTop ()

- -
-void setGravityTop(void);
-
-set the gravity of the widget on the Top (index 0 is on top) -

- -
-

subWidgetRemoveAll ()

- -
-void subWidgetRemoveAll(void);
-
-remove all sub element from the widget. -

- -
-

subWidgetAdd ()

- -
-void subWidgetAdd(int32_t _colId,
-                  int32_t _rowId,
-                  ewol::Widget * _newWidget);
-
-add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) -
-
- -
-

subWidgetRemove ()

- -
-void subWidgetRemove(ewol::Widget * _newWidget);
-
-remove definitly a widget from the system and this Gird. -
-
- -
-

subWidgetRemove ()

- -
-void subWidgetRemove(int32_t _colId,
-                     int32_t _rowId);
-
-remove definitly a widget from the system and this Gird. -
-
- -
-

subWidgetUnLink ()

- -
-void subWidgetUnLink(ewol::Widget * _newWidget);
-
-Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). -
-
- -
-

subWidgetUnLink ()

- -
-void subWidgetUnLink(int32_t _colId,
-                     int32_t _rowId);
-
-Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). -
-
- -
-

setBorderSize ()

- -
-void setBorderSize(const ivec2 & _newBorderSize);
-
-set the current border size of the current element: -
-
- -
-

getBorderSize ()

- -
-const ivec2 & getBorderSize(void);
-
-get the current border size of the current element: -
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & pos);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-
- - diff --git a/ewol__widget__Gird__GirdProperties.html b/ewol__widget__Gird__GirdProperties.html deleted file mode 100644 index 2b94843f..00000000 --- a/ewol__widget__Gird__GirdProperties.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Gird::GirdProperties

-
-

Constructor and Destructor:

-
-
-

Synopsis:

-
-
- - -

Detail:

-

- - diff --git a/ewol__widget__Image.html b/ewol__widget__Image.html deleted file mode 100644 index 7d5f616e..00000000 --- a/ewol__widget__Image.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Image

-
-

Constructor and Destructor:

-
-+                           Image                (const std::string & _file,
                                                  const ewol::Dimension & _border,
                                                  ewol::Dimension:: Millimeter));
+                          ~Image                (void);
-

Synopsis:

-
-+  static void              init                 (ewol::widget::Manager & _widgetManager);
+  void                     set                  (const std::string & _file,
                                                  const ewol::Dimension & _border);
+  void                     setFile              (const std::string & _file);
+  const std::string &      getFile              (void);
+  void                     setBorder            (const ewol::Dimension & _border);
+  const ewol::Dimension &  getBorder            (void);
+  void                     setImageSize         (const ewol::Dimension & _size);
+  const ewol::Dimension &  getImageSize         (void);
+  void                     setKeepRatio         (bool _keep);
+  bool                     getKeepRatio         (void);
+  void                     calculateMinMaxSize  (void);
+  void                     onRegenerateDisplay  (void);
+  bool                     onEventInput         (const ewol::event::Input & _event);
+  bool                     loadXML              (exml::Element * _node);
#  void                     onDraw               (void);
#  bool                     onSetConfig          (const ewol::object::Config & _conf);
#  bool                     onGetConfig          (const char * _config,
                                                  std::string & _result);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Image
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-Main call of recording the widget on the List of "widget named creator" -

- -
-

ewol::widget::Image ()

- -
-Image(const std::string & _file,
-      const ewol::Dimension & _border,
-      ewol::Dimension:: Millimeter));
-
- -

- -
-

ewol::widget::~Image ()

- -
-~Image(void);
-
- -

- -
-

set ()

- -
-void set(const std::string & _file,
-         const ewol::Dimension & _border);
-
-set All the configuration of the current image -
-
- -
-

setFile ()

- -
-void setFile(const std::string & _file);
-
-set the new filename -
-
- -
-

getFile ()

- -
-const std::string & getFile(void);
-
-get the file displayed -
-
- -
-

setBorder ()

- -
-void setBorder(const ewol::Dimension & _border);
-
-set tge Border size around the image -
-
- -
-

getBorder ()

- -
-const ewol::Dimension & getBorder(void);
-
-get the current border request at the image -
-
- -
-

setImageSize ()

- -
-void setImageSize(const ewol::Dimension & _size);
-
-set tge Border size around the image -
-
- -
-

getImageSize ()

- -
-const ewol::Dimension & getImageSize(void);
-
-get the current border request at the image -
-
- -
-

setKeepRatio ()

- -
-void setKeepRatio(bool _keep);
-
-set the current status of keeping ratio. -
-
- -
-

getKeepRatio ()

- -
-bool getKeepRatio(void);
-
-get the current status of keeping ratio. -
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-
- - diff --git a/ewol__widget__Joystick.html b/ewol__widget__Joystick.html deleted file mode 100644 index 5dafb1aa..00000000 --- a/ewol__widget__Joystick.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Joystick

-
-

Constructor and Destructor:

-
-+        Joystick             (void);
+       ~Joystick             (void);
-

Synopsis:

-
-+  void  setLockMode          (bool _lockWhenOut);
+  void  setDisplayMode       (enum joystickMode _newMode);
+  void  ratio                (float _newRatio);
+  void  background           (std::string _imageNameInData,
                               bool _display);
+  void  foreground           (std::string _imageNameInData);
+  void  getProperty          (float & _distance,
                               float & _angle);
+  void  calculateSize        (const vec2 & _availlable);
+  void  onRegenerateDisplay  (void);
+  bool  onEventInput         (const ewol::event::Input & _event);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Joystick
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::Joystick ()

- -
-Joystick(void);
-
-
- -
-

ewol::widget::~Joystick ()

- -
-~Joystick(void);
-
-
- -
-

setLockMode ()

- -
-void setLockMode(bool _lockWhenOut);
-
-
- -
-

setDisplayMode ()

- -
-void setDisplayMode(enum joystickMode _newMode);
-
-
- -
-

ratio ()

- -
-void ratio(float _newRatio);
-
-set the ratio of the widget joystick -
-
- -
-

background ()

- -
-void background(std::string _imageNameInData,
-                bool _display);
-
-set the Background of the widget joystick -
-
- -
-

foreground ()

- -
-void foreground(std::string _imageNameInData);
-
-set the Foreground of the widget joystick -
-
- -
-

getProperty ()

- -
-void getProperty(float & _distance,
-                 float & _angle);
-
-get the property of the joystick -
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-
- - diff --git a/ewol__widget__Label.html b/ewol__widget__Label.html deleted file mode 100644 index f75dde26..00000000 --- a/ewol__widget__Label.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Label

-
-

Constructor and Destructor:

-
-+                      Label                (std::string _newLabel);
+                     ~Label                (void);
-

Synopsis:

-
-+  static void         init                 (ewol::widget::Manager & _widgetManager);
+  void                setLabel             (const std::string & _newLabel);
+  void                setValue             (const std::string & _newLabel);
+  std::string         getLabel             (void);
+  std::string         getValue             (void);
+  void                calculateMinMaxSize  (void);
+  void                onRegenerateDisplay  (void);
+  bool                onEventInput         (const ewol::event::Input & _event);
+  bool                loadXML              (exml::Element * _node);
#  void                onDraw               (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Label
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-Main call of recording the widget on the List of "widget named creator" -

- -
-

ewol::widget::Label ()

- -
-Label(std::string _newLabel);
-
-Constructor -
-
- -
-

ewol::widget::~Label ()

- -
-~Label(void);
-
-destructor -

- -
-

setLabel ()

- -
-void setLabel(const std::string & _newLabel);
-
-change the label displayed -
-
- -
-

setValue ()

- -
-void setValue(const std::string & _newLabel);
-
-
- -
-

getLabel ()

- -
-std::string getLabel(void);
-
-get the current displayed label -
-
- -
-

getValue ()

- -
-std::string getValue(void);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-
- - diff --git a/ewol__widget__Layer.html b/ewol__widget__Layer.html deleted file mode 100644 index 7c3a3834..00000000 --- a/ewol__widget__Layer.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Layer

-
-

Constructor and Destructor:

-
-+                  Layer           (void);
+                 ~Layer           (void);
-

Synopsis:

-
-+  static void     init            (ewol::widget::Manager & _widgetManager);
+  ewol::Widget *  getWidgetAtPos  (const vec2 & _pos);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ContainerN
-            +--> ewol::widget::Layer
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-Main call of recording the widget on the List of "widget named creator" -

- -
-

ewol::widget::Layer ()

- -
-Layer(void);
-
-Constructor -

- -
-

ewol::widget::~Layer ()

- -
-~Layer(void);
-
-Desstructor -

- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-
- -
-
- - diff --git a/ewol__widget__List.html b/ewol__widget__List.html deleted file mode 100644 index ee22f976..00000000 --- a/ewol__widget__List.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::List

-
-

Constructor and Destructor:

-
-+                List                 (void);
+               ~List                 (void);
-

Synopsis:

-
-+  void          calculateMinMaxSize  (void);
+  void          setLabel             (std::string _newLabel);
+  void          addOObject           (ewol::Compositing * _newObject,
                                       int32_t _pos);
+  void          clearOObjectList     (void);
+  void          onRegenerateDisplay  (void);
+  bool          onEventInput         (const ewol::event::Input & _event);
#  etk::Color<>  getBasicBG           (void);
#  uint32_t      getNuberOfColomn     (void);
#  bool          getTitle             (int32_t _colomn,
                                       std::string & _myTitle,
                                       etk::Color<> & _fg,
                                       etk::Color<> & _bg);
#  uint32_t      getNuberOfRaw        (void);
#  bool          getElement           (int32_t _colomn,
                                       int32_t _raw,
                                       std::string & _myTextToWrite,
                                       etk::Color<> & _fg,
                                       etk::Color<> & _bg);
#  bool          onItemEvent          (int32_t _IdInput,
                                       enum ewol::key::status _typeEvent,
                                       int32_t _colomn,
                                       int32_t _raw,
                                       float _x,
                                       float _y);
#  void          setRawVisible        (int32_t _id);
#  void          onGetFocus           (void);
#  void          onLostFocus          (void);
#  void          onDraw               (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::WidgetScrooled
-            +--> ewol::widget::List
-                +--> ewol::widget::ListFileSystem
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::List ()

- -
-List(void);
-
-
- -
-

ewol::widget::~List ()

- -
-~List(void);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

setLabel ()

- -
-void setLabel(std::string _newLabel);
-
-
- -
-

addOObject ()

- -
-void addOObject(ewol::Compositing * _newObject,
-                int32_t _pos);
-
-
- -
-

clearOObjectList ()

- -
-void clearOObjectList(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

getBasicBG ()

- -
-etk::Color<> getBasicBG(void);
-
-
- -
-

getNuberOfColomn ()

- -
-uint32_t getNuberOfColomn(void);
-
-
- -
-

getTitle ()

- -
-bool getTitle(int32_t _colomn,
-              std::string & _myTitle,
-              etk::Color<> & _fg,
-              etk::Color<> & _bg);
-
-
- -
-

getNuberOfRaw ()

- -
-uint32_t getNuberOfRaw(void);
-
-
- -
-

getElement ()

- -
-bool getElement(int32_t _colomn,
-                int32_t _raw,
-                std::string & _myTextToWrite,
-                etk::Color<> & _fg,
-                etk::Color<> & _bg);
-
-
- -
-

onItemEvent ()

- -
-bool onItemEvent(int32_t _IdInput,
-                 enum ewol::key::status _typeEvent,
-                 int32_t _colomn,
-                 int32_t _raw,
-                 float _x,
-                 float _y);
-
-
- -
-

setRawVisible ()

- -
-void setRawVisible(int32_t _id);
-
-set a raw visible in the main display -
-
- -
-

onGetFocus ()

- -
-void onGetFocus(void);
-
-
- -
-

onLostFocus ()

- -
-void onLostFocus(void);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-
- - diff --git a/ewol__widget__ListFileSystem.html b/ewol__widget__ListFileSystem.html deleted file mode 100644 index 13f79e2c..00000000 --- a/ewol__widget__ListFileSystem.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ListFileSystem

-
-

Constructor and Destructor:

-
-+                ListFileSystem         (void);
+               ~ListFileSystem         (void);
-

Synopsis:

-
-+  etk::Color<>  getBasicBG             (void);
+  uint32_t      getNuberOfColomn       (void);
+  bool          getTitle               (int32_t _colomn,
                                         std::string & _myTitle,
                                         etk::Color<> & _fg,
                                         etk::Color<> & _bg);
+  uint32_t      getNuberOfRaw          (void);
+  bool          getElement             (int32_t _colomn,
                                         int32_t _raw,
                                         std::string & _myTextToWrite,
                                         etk::Color<> & _fg,
                                         etk::Color<> & _bg);
+  bool          onItemEvent            (int32_t _IdInput,
                                         enum ewol::key::status _typeEvent,
                                         int32_t _colomn,
                                         int32_t _raw,
                                         float _x,
                                         float _y);
+  void          setFolder              (std::string _newFolder);
+  std::string   getFolder              (void);
+  void          setSelect              (std::string _data);
+  std::string   getSelect              (void);
+  void          regenerateView         (void);
+  void          setShowFiles           (bool _state);
+  void          setShowFolder          (bool _state);
+  void          setShowHiddenFiles     (bool _state);
+  void          setShowTemporaryFiles  (bool _state);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::WidgetScrooled
-            +--> ewol::widget::List
-                +--> ewol::widget::ListFileSystem
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::ListFileSystem ()

- -
-ListFileSystem(void);
-
-
- -
-

ewol::widget::~ListFileSystem ()

- -
-~ListFileSystem(void);
-
-
- -
-

getBasicBG ()

- -
-etk::Color<> getBasicBG(void);
-
-
- -
-

getNuberOfColomn ()

- -
-uint32_t getNuberOfColomn(void);
-
-
- -
-

getTitle ()

- -
-bool getTitle(int32_t _colomn,
-              std::string & _myTitle,
-              etk::Color<> & _fg,
-              etk::Color<> & _bg);
-
-
- -
-

getNuberOfRaw ()

- -
-uint32_t getNuberOfRaw(void);
-
-
- -
-

getElement ()

- -
-bool getElement(int32_t _colomn,
-                int32_t _raw,
-                std::string & _myTextToWrite,
-                etk::Color<> & _fg,
-                etk::Color<> & _bg);
-
-
- -
-

onItemEvent ()

- -
-bool onItemEvent(int32_t _IdInput,
-                 enum ewol::key::status _typeEvent,
-                 int32_t _colomn,
-                 int32_t _raw,
-                 float _x,
-                 float _y);
-
-
- -
-

setFolder ()

- -
-void setFolder(std::string _newFolder);
-
-
- -
-

getFolder ()

- -
-std::string getFolder(void);
-
-
- -
-

setSelect ()

- -
-void setSelect(std::string _data);
-
-
- -
-

getSelect ()

- -
-std::string getSelect(void);
-
-
- -
-

regenerateView ()

- -
-void regenerateView(void);
-
-
- -
-

setShowFiles ()

- -
-void setShowFiles(bool _state);
-
-
- -
-

setShowFolder ()

- -
-void setShowFolder(bool _state);
-
-
- -
-

setShowHiddenFiles ()

- -
-void setShowHiddenFiles(bool _state);
-
-
- -
-

setShowTemporaryFiles ()

- -
-void setShowTemporaryFiles(bool _state);
-
-
- -
-
- - diff --git a/ewol__widget__Manager.html b/ewol__widget__Manager.html deleted file mode 100644 index ebcf8e5d..00000000 --- a/ewol__widget__Manager.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Manager

-
-

Constructor and Destructor:

-
-+                  Manager              (void);
+                 ~Manager              (void);
-

Synopsis:

-
-+  void            rm                   (ewol::Widget * _newWidget);
+  void            focusKeep            (ewol::Widget * _newWidget);
+  void            focusSetDefault      (ewol::Widget * _newWidget);
+  void            focusRelease         (void);
+  ewol::Widget *  focusGet             (void);
+  void            focusRemoveIfRemove  (ewol::Widget * _newWidget);
+  void            periodicCallAdd      (ewol::Widget * _pWidget);
+  void            periodicCallRm       (ewol::Widget * _pWidget);
+  void            periodicCall         (int64_t _localTime);
+  void            periodicCallResume   (int64_t _localTime);
+  bool            periodicCallHave     (void);
+  void            markDrawingIsNeeded  (void);
+  bool            isDrawingNeeded      (void);
+  void            addWidgetCreator     (const std::string & _name,
                                         creator_tf _pointer);
+  ewol::Widget *  create               (const std::string & _name);
+  bool            exist                (const std::string & _name);
+  std::string     list                 (void);
- - -

Detail:

-

ewol::widget::Manager ()

- -
-Manager(void);
-
-
- -
-

ewol::widget::~Manager ()

- -
-~Manager(void);
-
-
- -
-

rm ()

- -
-void rm(ewol::Widget * _newWidget);
-
-
- -
-

focusKeep ()

- -
-void focusKeep(ewol::Widget * _newWidget);
-
-
- -
-

focusSetDefault ()

- -
-void focusSetDefault(ewol::Widget * _newWidget);
-
-
- -
-

focusRelease ()

- -
-void focusRelease(void);
-
-
- -
-

focusGet ()

- -
-ewol::Widget * focusGet(void);
-
-
- -
-

focusRemoveIfRemove ()

- -
-void focusRemoveIfRemove(ewol::Widget * _newWidget);
-
-
- -
-

periodicCallAdd ()

- -
-void periodicCallAdd(ewol::Widget * _pWidget);
-
-
- -
-

periodicCallRm ()

- -
-void periodicCallRm(ewol::Widget * _pWidget);
-
-
- -
-

periodicCall ()

- -
-void periodicCall(int64_t _localTime);
-
-
- -
-

periodicCallResume ()

- -
-void periodicCallResume(int64_t _localTime);
-
-
- -
-

periodicCallHave ()

- -
-bool periodicCallHave(void);
-
-
- -
-

markDrawingIsNeeded ()

- -
-void markDrawingIsNeeded(void);
-
-
- -
-

isDrawingNeeded ()

- -
-bool isDrawingNeeded(void);
-
-
- -
-

addWidgetCreator ()

- -
-void addWidgetCreator(const std::string & _name,
-                      creator_tf _pointer);
-
-
- -
-

create ()

- -
-ewol::Widget * create(const std::string & _name);
-
-
- -
-

exist ()

- -
-bool exist(const std::string & _name);
-
-
- -
-

list ()

- -
-std::string list(void);
-
-
- -
-
- - diff --git a/ewol__widget__Menu.html b/ewol__widget__Menu.html deleted file mode 100644 index 8a45b617..00000000 --- a/ewol__widget__Menu.html +++ /dev/null @@ -1,270 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Menu

-
-

Constructor and Destructor:

-
-+           Menu                (void);
+          ~Menu                (void);
-

Synopsis:

-
-+  void     clear               (void);
+  int32_t  addTitle            (std::string _label,
                                 std::string _image,
                                 const char * _generateEvent,
                                 const std::string _message);
+  int32_t  add                 (int32_t parent,
                                 std::string _label,
                                 std::string _image,
                                 const char * _generateEvent,
                                 const std::string _message);
+  void     addSpacer           (void);
+  void     onReceiveMessage    (const ewol::object::Message & _msg);
+  void     onObjectRemove      (ewol::Object * _removeObject);
-  void     subWidgetRemoveAll  (void);
-  int32_t  subWidgetAdd        (ewol::Widget * _newWidget);
-  void     subWidgetRemove     (ewol::Widget * _newWidget);
-  void     subWidgetUnLink     (ewol::Widget * _newWidget);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ContainerN
-            +--> ewol::widget::Sizer
-                +--> ewol::widget::Menu
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::Menu ()

- -
-Menu(void);
-
-
- -
-

ewol::widget::~Menu ()

- -
-~Menu(void);
-
-
- -
-

clear ()

- -
-void clear(void);
-
-
- -
-

addTitle ()

- -
-int32_t addTitle(std::string _label,
-                 std::string _image,
-                 const char * _generateEvent,
-                 const std::string _message);
-
-
- -
-

add ()

- -
-int32_t add(int32_t parent,
-            std::string _label,
-            std::string _image,
-            const char * _generateEvent,
-            const std::string _message);
-
-
- -
-

addSpacer ()

- -
-void addSpacer(void);
-
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

subWidgetRemoveAll ()

- -
-void subWidgetRemoveAll(void);
-
-
- -
-

subWidgetAdd ()

- -
-int32_t subWidgetAdd(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetRemove ()

- -
-void subWidgetRemove(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetUnLink ()

- -
-void subWidgetUnLink(ewol::Widget * _newWidget);
-
-
- -
-
- - diff --git a/ewol__widget__MenuElement.html b/ewol__widget__MenuElement.html deleted file mode 100644 index 6eeb280a..00000000 --- a/ewol__widget__MenuElement.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::MenuElement

-
-

Constructor and Destructor:

-
-+        MenuElement  (void);
-

Synopsis:

-
-
- - -

Detail:

-

ewol::widget::MenuElement ()

- -
-MenuElement(void);
-
-
- -
-
- - diff --git a/ewol__widget__Parameter.html b/ewol__widget__Parameter.html deleted file mode 100644 index 15288953..00000000 --- a/ewol__widget__Parameter.html +++ /dev/null @@ -1,241 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Parameter

-
-

Constructor and Destructor:

-
-+        Parameter         (void);
+       ~Parameter         (void);
-

Synopsis:

-
-+  void  onReceiveMessage  (const ewol::object::Message & _msg);
+  void  onObjectRemove    (ewol::Object * _removeObject);
+  void  setTitle          (std::string _label);
+  void  menuAdd           (std::string _label,
                            std::string _image,
                            ewol::Widget * _associateWidget);
+  void  menuAddGroup      (std::string _label);
+  void  menuClear         (void);
+  void  menuSeparator     (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::PopUp
-                +--> ewol::widget::Parameter
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::Parameter ()

- -
-Parameter(void);
-
-
- -
-

ewol::widget::~Parameter ()

- -
-~Parameter(void);
-
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

setTitle ()

- -
-void setTitle(std::string _label);
-
-
- -
-

menuAdd ()

- -
-void menuAdd(std::string _label,
-             std::string _image,
-             ewol::Widget * _associateWidget);
-
-
- -
-

menuAddGroup ()

- -
-void menuAddGroup(std::string _label);
-
-
- -
-

menuClear ()

- -
-void menuClear(void);
-
-
- -
-

menuSeparator ()

- -
-void menuSeparator(void);
-
-
- -
-
- - diff --git a/ewol__widget__ParameterList.html b/ewol__widget__ParameterList.html deleted file mode 100644 index d0fd4754..00000000 --- a/ewol__widget__ParameterList.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ParameterList

-
-

Constructor and Destructor:

-
-+        ParameterList        (void);
+       ~ParameterList        (void);
-

Synopsis:

-
-+  void  setLabel             (std::string _newLabel);
+  void  addOObject           (ewol::Compositing * _newObject,
                               int32_t _pos);
+  void  clearOObjectList     (void);
+  void  menuAdd              (std::string & _label,
                               int32_t _refId,
                               std::string & _image);
+  void  menuAddGroup         (std::string & _label);
+  void  menuClear            (void);
+  void  menuSeparator        (void);
+  void  onRegenerateDisplay  (void);
+  bool  onEventInput         (const ewol::event::Input & _event);
+  void  calculateMinMaxSize  (void);
#  void  onGetFocus           (void);
#  void  onLostFocus          (void);
#  void  onDraw               (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::WidgetScrooled
-            +--> ewol::widget::ParameterList
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::ParameterList ()

- -
-ParameterList(void);
-
-
- -
-

ewol::widget::~ParameterList ()

- -
-~ParameterList(void);
-
-
- -
-

setLabel ()

- -
-void setLabel(std::string _newLabel);
-
-
- -
-

addOObject ()

- -
-void addOObject(ewol::Compositing * _newObject,
-                int32_t _pos);
-
-
- -
-

clearOObjectList ()

- -
-void clearOObjectList(void);
-
-
- -
-

menuAdd ()

- -
-void menuAdd(std::string & _label,
-             int32_t _refId,
-             std::string & _image);
-
-
- -
-

menuAddGroup ()

- -
-void menuAddGroup(std::string & _label);
-
-
- -
-

menuClear ()

- -
-void menuClear(void);
-
-
- -
-

menuSeparator ()

- -
-void menuSeparator(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onGetFocus ()

- -
-void onGetFocus(void);
-
-
- -
-

onLostFocus ()

- -
-void onLostFocus(void);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-
- - diff --git a/ewol__widget__PopUp.html b/ewol__widget__PopUp.html deleted file mode 100644 index 9d91eb1a..00000000 --- a/ewol__widget__PopUp.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::PopUp

-
-

Constructor and Destructor:

-
-+                  PopUp                   (const std::string & _shaperName);
+                 ~PopUp                   (void);
-

Synopsis:

-
-+  static void     init                    (ewol::widget::Manager & _widgetManager);
+  void            setShaperName           (const std::string & _shaperName);
+  void            lockExpand              (const bvec2 & _lockExpand);
+  void            setRemoveOnExternClick  (bool _state);
+  bool            getRemoveOnExternClick  (void);
+  void            periodicCall            (const ewol::event::Time & _event);
+  void            systemDraw              (const ewol::DrawProperty & _displayProp);
+  void            onRegenerateDisplay     (void);
+  void            calculateSize           (const vec2 & _available);
+  bool            onEventInput            (const ewol::event::Input & _event);
+  ewol::Widget *  getWidgetAtPos          (const vec2 & pos);
#  void            onDraw                  (void);
#  bool            onSetConfig             (const ewol::object::Config & _conf);
#  bool            onGetConfig             (const char * _config,
                                            std::string & _result);
#  bool            onStartAnnimation       (enum ewol::Widget::annimationMode _mode);
#  void            onStopAnnimation        (void);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::PopUp
-                +--> ewol::widget::StdPopUp
-                +--> ewol::widget::FileChooser
-                +--> ewol::widget::Parameter
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::PopUp ()

- -
-PopUp(const std::string & _shaperName);
-
-Constructor -
-
- -
-

ewol::widget::~PopUp ()

- -
-~PopUp(void);
-
-Destructor -

- -
-

setShaperName ()

- -
-void setShaperName(const std::string & _shaperName);
-
-set the shaper name (use the contructer one this permit to not noad unused shaper) -
-
- -
-

lockExpand ()

- -
-void lockExpand(const bvec2 & _lockExpand);
-
-Limit the expend properties to the current widget (no contamination) -
-
- -
-

setRemoveOnExternClick ()

- -
-void setRemoveOnExternClick(bool _state);
-
-Request the Auto-remove when the event input is set outside the widget -
-
- -
-

getRemoveOnExternClick ()

- -
-bool getRemoveOnExternClick(void);
-
-get the status of the request the Auto-remove when the event input is set outside the widget. -
-
- -
-

periodicCall ()

- -
-void periodicCall(const ewol::event::Time & _event);
-
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _available);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & pos);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-

onStartAnnimation ()

- -
-bool onStartAnnimation(enum ewol::Widget::annimationMode _mode);
-
-
- -
-

onStopAnnimation ()

- -
-void onStopAnnimation(void);
-
-
- -
-
- - diff --git a/ewol__widget__ProgressBar.html b/ewol__widget__ProgressBar.html deleted file mode 100644 index 385e2a02..00000000 --- a/ewol__widget__ProgressBar.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::ProgressBar

-
-

Constructor and Destructor:

-
-+               ProgressBar          (void);
+              ~ProgressBar          (void);
-

Synopsis:

-
-+  static void  init                 (ewol::widget::Manager & _widgetManager);
+  void         setValue             (float _val);
+  float        getValue             (void);
+  void         setColor             (etk::Color<> _newColor);
+  void         onRegenerateDisplay  (void);
+  void         calculateMinMaxSize  (void);
#  void         onDraw               (void);
#  bool         onSetConfig          (const ewol::object::Config & _conf);
#  bool         onGetConfig          (const char * _config,
                                      std::string & _result);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ProgressBar
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::ProgressBar ()

- -
-ProgressBar(void);
-
-
- -
-

ewol::widget::~ProgressBar ()

- -
-~ProgressBar(void);
-
-
- -
-

setValue ()

- -
-void setValue(float _val);
-
-
- -
-

getValue ()

- -
-float getValue(void);
-
-
- -
-

setColor ()

- -
-void setColor(etk::Color<> _newColor);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-
- - diff --git a/ewol__widget__Scroll.html b/ewol__widget__Scroll.html deleted file mode 100644 index 11cbc0bd..00000000 --- a/ewol__widget__Scroll.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Scroll

-
-

Constructor and Destructor:

-
-+                  Scroll               (void);
+                 ~Scroll               (void);
-

Synopsis:

-
-+  static void     init                 (ewol::widget::Manager & _widgetManager);
+  void            setLimit             (const vec2 & _limit);
+  const vec2 &    getLimit             (void);
+  void            calculateMinMaxSize  (void);
+  void            onRegenerateDisplay  (void);
+  bool            onEventInput         (const ewol::event::Input & _event);
+  void            systemDraw           (const ewol::DrawProperty & _displayProp);
+  ewol::Widget *  getWidgetAtPos       (const vec2 & _pos);
#  void            onDraw               (void);
#  bool            onSetConfig          (const ewol::object::Config & _conf);
#  bool            onGetConfig          (const char * _config,
                                         std::string & _result);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::Scroll
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::Scroll ()

- -
-Scroll(void);
-
-
- -
-

ewol::widget::~Scroll ()

- -
-~Scroll(void);
-
-
- -
-

setLimit ()

- -
-void setLimit(const vec2 & _limit);
-
-set the limit of scrolling -
Notes: This permit to scoll element upper the end of the display -
-
- -
-

getLimit ()

- -
-const vec2 & getLimit(void);
-
-get the limit of scrolling -
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-
- - diff --git a/ewol__widget__Sizer.html b/ewol__widget__Sizer.html deleted file mode 100644 index 219e7cb3..00000000 --- a/ewol__widget__Sizer.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Sizer

-
-

Constructor and Destructor:

-
-+                           Sizer                (enum displayMode _mode);
+                          ~Sizer                (void);
-

Synopsis:

-
-+  static void              init                 (ewol::widget::Manager & _widgetManager);
+  void                     setMode              (enum displayMode _mode);
+  void                     setBorderSize        (const ewol::Dimension & _newBorderSize);
+  const ewol::Dimension &  getBorderSize        (void);
+  void                     setAnimationMode     (enum animation _animation);
+  void                     setAnimationTime     (float _time);
+  float                    getAnimationTime     (void);
+  void                     calculateSize        (const vec2 & _availlable);
+  void                     calculateMinMaxSize  (void);
+  bool                     loadXML              (exml::Element * _node);
+  int32_t                  subWidgetAdd         (ewol::Widget * _newWidget);
+  int32_t                  subWidgetAddStart    (ewol::Widget * _newWidget);
+  void                     subWidgetRemove      (ewol::Widget * _newWidget);
+  void                     subWidgetUnLink      (ewol::Widget * _newWidget);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ContainerN
-            +--> ewol::widget::Sizer
-                +--> ewol::widget::ColorChooser
-                +--> ewol::widget::Menu
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-Main call of recording the widget on the List of "widget named creator" -

- -
-

ewol::widget::Sizer ()

- -
-Sizer(enum displayMode _mode);
-
-Constructor -
-
- -
-

ewol::widget::~Sizer ()

- -
-~Sizer(void);
-
-Desstructor -

- -
-

setMode ()

- -
-void setMode(enum displayMode _mode);
-
-set the mode to display elements. -
-
- -
-

setBorderSize ()

- -
-void setBorderSize(const ewol::Dimension & _newBorderSize);
-
-set the current border size of the current element: -
-
- -
-

getBorderSize ()

- -
-const ewol::Dimension & getBorderSize(void);
-
-get the current border size of the current element: -
-
- -
-

setAnimationMode ()

- -
-void setAnimationMode(enum animation _animation);
-
-set an animation mode for the new element set in the Widget container. -
-
- -
-

setAnimationTime ()

- -
-void setAnimationTime(float _time);
-
-set the time to produce animation. -
-
- -
-

getAnimationTime ()

- -
-float getAnimationTime(void);
-
-get the current animation time. -
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-
- -
-

subWidgetAdd ()

- -
-int32_t subWidgetAdd(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetAddStart ()

- -
-int32_t subWidgetAddStart(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetRemove ()

- -
-void subWidgetRemove(ewol::Widget * _newWidget);
-
-
- -
-

subWidgetUnLink ()

- -
-void subWidgetUnLink(ewol::Widget * _newWidget);
-
-
- -
-
- - diff --git a/ewol__widget__Slider.html b/ewol__widget__Slider.html deleted file mode 100644 index c9480326..00000000 --- a/ewol__widget__Slider.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Slider

-
-

Constructor and Destructor:

-
-+               Slider               (void);
+              ~Slider               (void);
-

Synopsis:

-
-+  static void  init                 (ewol::widget::Manager & _widgetManager);
+  void         setValue             (int32_t _val);
+  int32_t      getValue             (void);
+  void         setMin               (int32_t _val);
+  void         setMax               (int32_t _val);
+  void         setColor             (etk::Color<> _newColor);
+  void         onDraw               (void);
+  void         calculateMinMaxSize  (void);
+  void         onRegenerateDisplay  (void);
+  bool         onEventInput         (const ewol::event::Input & _event);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Slider
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::Slider ()

- -
-Slider(void);
-
-
- -
-

ewol::widget::~Slider ()

- -
-~Slider(void);
-
-
- -
-

setValue ()

- -
-void setValue(int32_t _val);
-
-
- -
-

getValue ()

- -
-int32_t getValue(void);
-
-
- -
-

setMin ()

- -
-void setMin(int32_t _val);
-
-
- -
-

setMax ()

- -
-void setMax(int32_t _val);
-
-
- -
-

setColor ()

- -
-void setColor(etk::Color<> _newColor);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

calculateMinMaxSize ()

- -
-void calculateMinMaxSize(void);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-
- - diff --git a/ewol__widget__Spacer.html b/ewol__widget__Spacer.html deleted file mode 100644 index 2d9f8a48..00000000 --- a/ewol__widget__Spacer.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Spacer

-
-

Constructor and Destructor:

-
-+                  Spacer               (void);
+                 ~Spacer               (void);
-

Synopsis:

-
-+  static void     init                 (ewol::widget::Manager & _widgetManager);
+  void            setColor             (etk::Color<> _newColor);
+  ewol::Widget *  getWidgetAtPos       (const vec2 & _pos);
+  void            onRegenerateDisplay  (void);
+  void            onDraw               (void);
+  bool            onSetConfig          (const ewol::object::Config & _conf);
+  bool            onGetConfig          (const char * _config,
                                         std::string & _result);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Spacer
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::Spacer ()

- -
-Spacer(void);
-
-Main constructer -

- -
-

ewol::widget::~Spacer ()

- -
-~Spacer(void);
-
-Main destructer -

- -
-

setColor ()

- -
-void setColor(etk::Color<> _newColor);
-
-Spziby the background color (basicly transparent) -
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-
- - diff --git a/ewol__widget__StdPopUp.html b/ewol__widget__StdPopUp.html deleted file mode 100644 index 1bb04960..00000000 --- a/ewol__widget__StdPopUp.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::StdPopUp

-
-

Constructor and Destructor:

-
-+                          StdPopUp          (void);
+                         ~StdPopUp          (void);
-

Synopsis:

-
-+  void                    setTitle          (const std::string & _text);
+  void                    setComment        (const std::string & _text);
+  ewol::widget::Button *  addButton         (const std::string & _text,
                                              bool _autoExit);
+  void                    onObjectRemove    (ewol::Object * _removeObject);
+  void                    onReceiveMessage  (const ewol::object::Message & _msg);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Container
-            +--> ewol::widget::PopUp
-                +--> ewol::widget::StdPopUp
-
-
-

Description:

-/** -* @brief The std pop up widget is a siple message widget to notify user of some simple things, like: -* -* [pre] -* +---------------------------------+---+---+---+ -* | Windows name... | _ | O | X | -* +---------------------------------+---+---+---+ -* | | -* | | -* | | -* | +-------------------+ | -* | | Erreur: | | -* | | | | -* | | Message to diplay | | -* | | to user | | -* | | | | -* | | Close | | -* | +-------------------+ | -* | | -* | | -* | | -* +---------------------------------------------+ -* [/pre] -*/

Detail:

-

ewol::widget::StdPopUp ()

- -
-StdPopUp(void);
-
-std-pop-up constructor. -

- -
-

ewol::widget::~StdPopUp ()

- -
-~StdPopUp(void);
-
-std-pop-up destructor. -

- -
-

setTitle ()

- -
-void setTitle(const std::string & _text);
-
-Set the title string. -
-
- -
-

setComment ()

- -
-void setComment(const std::string & _text);
-
-Set the commentary string. -
-
- -
-

addButton ()

- -
-ewol::widget::Button * addButton(const std::string & _text,
-                                 bool _autoExit);
-
-Add a buttom button. -
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::object::Message & _msg);
-
-
- -
-
- - diff --git a/ewol__widget__WSlider.html b/ewol__widget__WSlider.html deleted file mode 100644 index e516b9c7..00000000 --- a/ewol__widget__WSlider.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::WSlider

-
-

Constructor and Destructor:

-
-+                  WSlider                     (void);
+                 ~WSlider                     (void);
-

Synopsis:

-
-+  static void     init                        (ewol::widget::Manager & _widgetManager);
+  void            subWidgetSelectSet          (int32_t _id);
+  void            subWidgetSelectSet          (ewol::Widget * _widgetPointer);
+  void            subWidgetSelectSet          (const std::string & _widgetName);
+  void            setTransitionSpeed          (float _timeSecond);
+  float           getTransitionSpeed          (void);
+  void            setTransitionMode           (enum sladingMode _mode);
+  void            calculateSize               (const vec2 & _availlable);
+  void            systemDraw                  (const ewol::DrawProperty & _displayProp);
+  void            onRegenerateDisplay         (void);
+  ewol::Widget *  getWidgetAtPos              (const vec2 & _pos);
+  void            periodicCall                (const ewol::event::Time & _event);
+  bool            onSetConfig                 (const ewol::object::Config & _conf);
+  bool            onGetConfig                 (const char * _config,
                                                std::string & _result);
#  void            subWidgetSelectSetVectorId  (int32_t _id);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::ContainerN
-            +--> ewol::widget::WSlider
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::init ()

- -
-static void init(ewol::widget::Manager & _widgetManager);
-
-
- -
-

ewol::widget::WSlider ()

- -
-WSlider(void);
-
-
- -
-

ewol::widget::~WSlider ()

- -
-~WSlider(void);
-
-
- -
-

subWidgetSelectSet ()

- -
-void subWidgetSelectSet(int32_t _id);
-
-Select a new subwidget to display -
-
- -
-

subWidgetSelectSet ()

- -
-void subWidgetSelectSet(ewol::Widget * _widgetPointer);
-
-Select a new subwidget to display -
-
- -
-

subWidgetSelectSet ()

- -
-void subWidgetSelectSet(const std::string & _widgetName);
-
-Select a new subwidget to display -
-
- -
-

setTransitionSpeed ()

- -
-void setTransitionSpeed(float _timeSecond);
-
-set transition speed element. -
-
- -
-

getTransitionSpeed ()

- -
-float getTransitionSpeed(void);
-
-get transition speed element. -
-
- -
-

setTransitionMode ()

- -
-void setTransitionMode(enum sladingMode _mode);
-
-set a new mode of sliding element -
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-
- -
-

periodicCall ()

- -
-void periodicCall(const ewol::event::Time & _event);
-
-
- -
-

onSetConfig ()

- -
-bool onSetConfig(const ewol::object::Config & _conf);
-
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-
- -
-

subWidgetSelectSetVectorId ()

- -
-void subWidgetSelectSetVectorId(int32_t _id);
-
-Generate the move on the specific vector ID (This is not a public acces, because the vector can have some null pointer inside ...) -
-
- -
-
- - diff --git a/ewol__widget__WidgetScrooled.html b/ewol__widget__WidgetScrooled.html deleted file mode 100644 index a29f246f..00000000 --- a/ewol__widget__WidgetScrooled.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::WidgetScrooled

-
-

Constructor and Destructor:

-
-+        WidgetScrooled               (void);
+       ~WidgetScrooled               (void);
-

Synopsis:

-
-+  void  onRegenerateDisplay          (void);
+  bool  onEventInput                 (const ewol::event::Input & _event);
+  void  systemDraw                   (const ewol::DrawProperty & _displayProp);
#  void  onDraw                       (void);
#  void  setScrollingSize             (float _nbPixel);
#  void  scroolingMode                (enum scrollingMode _newMode);
#  void  setMaxSize                   (const vec2 & _localSize);
#  void  setScrollingPositionDynamic  (vec2 _borderWidth,
                                       const vec2 & _currentPosition,
                                       bool _center);
#  void  setLimitScrolling            (float _poucentageLimit);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::WidgetScrooled
-            +--> ewol::widget::List
-            +--> ewol::widget::ParameterList
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::WidgetScrooled ()

- -
-WidgetScrooled(void);
-
-Scroll Widget main constructor to be herited from an other widget (this is not a stand-alone widget) -

- -
-

ewol::widget::~WidgetScrooled ()

- -
-~WidgetScrooled(void);
-
-Scroll widget destructor. -

- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onEventInput ()

- -
-bool onEventInput(const ewol::event::Input & _event);
-
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-

onDraw ()

- -
-void onDraw(void);
-
-
- -
-

setScrollingSize ()

- -
-void setScrollingSize(float _nbPixel);
-
-For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled -
-
- -
-

scroolingMode ()

- -
-void scroolingMode(enum scrollingMode _newMode);
-
-Specify the mode of scrolling for this windows -
-
- -
-

setMaxSize ()

- -
-void setMaxSize(const vec2 & _localSize);
-
-set the specific mawimum size of the widget -
-
- -
-

setScrollingPositionDynamic ()

- -
-void setScrollingPositionDynamic(vec2 _borderWidth,
-                                 const vec2 & _currentPosition,
-                                 bool _center);
-
-Request a specific position for the scrolling of the current windows. -
-
- -
-

setLimitScrolling ()

- -
-void setLimitScrolling(float _poucentageLimit);
-
-set the scrolling limit when arriving at he end of the widget -
-
- -
-
- - diff --git a/ewol__widget__Windows.html b/ewol__widget__Windows.html deleted file mode 100644 index f46dc741..00000000 --- a/ewol__widget__Windows.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::Windows

-
-

Constructor and Destructor:

-
-+                             Windows                 (void);
+                            ~Windows                 (void);
-

Synopsis:

-
-+  void                       sysDraw                 (void);
+  void                       sysOnShow               (void);
+  void                       sysOnHide               (void);
+  void                       sysOnKill               (void);
+  void                       onShow                  (void);
+  void                       onHide                  (void);
+  bool                       onKill                  (void);
+  void                       onReduce                (void);
+  void                       on                      (void);
+  void                       setDecorationDisable    (void);
+  void                       setDecorationEnable     (void);
+  void                       setSubWidget            (ewol::Widget * _widget);
+  void                       popUpWidgetPush         (ewol::Widget * _widget);
+  const etk::Color<float> &  getBackgroundColor      (void);
+  void                       setBackgroundColor      (const etk::Color<float> & _color);
+  void                       onRegenerateDisplay     (void);
+  void                       onObjectRemove          (ewol::Object * _removeObject);
+  void                       calculateSize           (const vec2 & _availlable);
+  ewol::Widget *             getWidgetAtPos          (const vec2 & _pos);
+  void                       setTitle                (const std::string & _title);
+  void                       createPopUpMessage      (enum popUpMessageType _type,
                                                       const std::string & _message);
+  void                       displayInfoMessage      (const std::string & _message);
+  void                       displayWarningMessage   (const std::string & _message);
+  void                       displayErrorMessage     (const std::string & _message);
+  void                       displayCriticalMessage  (const std::string & _message);
#  void                       systemDraw              (const ewol::DrawProperty & _displayProp);
- - -

Object Hierarchy:

-
-ewol::Object
-    +--> ewol::Widget
-        +--> ewol::widget::Windows
-
-
-

Description:

-/** -* @ingroup ewolWidgetGroup -*/

Detail:

-

ewol::widget::Windows ()

- -
-Windows(void);
-
-
- -
-

ewol::widget::~Windows ()

- -
-~Windows(void);
-
-
- -
-

sysDraw ()

- -
-void sysDraw(void);
-
-
- -
-

sysOnShow ()

- -
-void sysOnShow(void);
-
-
- -
-

sysOnHide ()

- -
-void sysOnHide(void);
-
-
- -
-

sysOnKill ()

- -
-void sysOnKill(void);
-
-
- -
-

onShow ()

- -
-void onShow(void);
-
-
- -
-

onHide ()

- -
-void onHide(void);
-
-
- -
-

onKill ()

- -
-bool onKill(void);
-
-
- -
-

onReduce ()

- -
-void onReduce(void);
-
-
- -
-

on ()

- -
-void on(void);
-
-
- -
-

setDecorationDisable ()

- -
-void setDecorationDisable(void);
-
-
- -
-

setDecorationEnable ()

- -
-void setDecorationEnable(void);
-
-
- -
-

setSubWidget ()

- -
-void setSubWidget(ewol::Widget * _widget);
-
-
- -
-

popUpWidgetPush ()

- -
-void popUpWidgetPush(ewol::Widget * _widget);
-
-
- -
-

getBackgroundColor ()

- -
-const etk::Color<float> & getBackgroundColor(void);
-
-get the background color. -
-
- -
-

setBackgroundColor ()

- -
-void setBackgroundColor(const etk::Color<float> & _color);
-
-set the background color. -

- -
-

onRegenerateDisplay ()

- -
-void onRegenerateDisplay(void);
-
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::Object * _removeObject);
-
-
- -
-

calculateSize ()

- -
-void calculateSize(const vec2 & _availlable);
-
-
- -
-

getWidgetAtPos ()

- -
-ewol::Widget * getWidgetAtPos(const vec2 & _pos);
-
-
- -
-

setTitle ()

- -
-void setTitle(const std::string & _title);
-
-
- -
-

createPopUpMessage ()

- -
-void createPopUpMessage(enum popUpMessageType _type,
-                        const std::string & _message);
-
-Create a simple pop-up message on the screen for application error. -
-
- -
-

displayInfoMessage ()

- -
-void displayInfoMessage(const std::string & _message);
-
-Create a simple information message -
-
- -
-

displayWarningMessage ()

- -
-void displayWarningMessage(const std::string & _message);
-
-Create a simple warning message -
-
- -
-

displayErrorMessage ()

- -
-void displayErrorMessage(const std::string & _message);
-
-Create a simple error message -
-
- -
-

displayCriticalMessage ()

- -
-void displayCriticalMessage(const std::string & _message);
-
-Create a simple critical message -
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-
- - diff --git a/ewol__widget__elementPL.html b/ewol__widget__elementPL.html deleted file mode 100644 index 7d518eae..00000000 --- a/ewol__widget__elementPL.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - ewol Library - - - - -
-
-

ewol Library

- -
-
-
-

Class: ewol::widget::elementPL

-
-

Constructor and Destructor:

-
-+        elementPL  (std::string & _label,
                     int32_t _refId,
                     std::string & _image,
                     bool _isGroup);
+       ~elementPL  (void);
-

Synopsis:

-
-
- - -

Detail:

-

ewol::widget::elementPL ()

- -
-elementPL(std::string & _label,
-          int32_t _refId,
-          std::string & _image,
-          bool _isGroup);
-
-
- -
-

ewol::widget::~elementPL ()

- -
-~elementPL(void);
-
-
- -
-
- - diff --git a/index.html b/index.html index 2d01b54c..5fc52588 100644 --- a/index.html +++ b/index.html @@ -9,133 +9,73 @@
-

ewol Library

- +

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
@@ -151,10 +91,11 @@ EWOL is written in C++ and is not (for now) supported for other languages.

Are there any licensing restrictions?

EWOL is FREE software and all sub-library are FREE and staticly linkable !!!
That allow you to use it for every program you want, including those developing proprietary software, without any license fees or royalties.
-[note]The static support is important for some platform like IOs, and this limit the external library use at some license like : +
+Note:
The static support is important for some platform like IOs, and this limit the external library use at some license like :
 
  •  BSD*
  •  MIT
  •  APPACHE
  •  PNG
  •  ZLIB
This exclude the classical extern library with licence:
-
  •  L-GPL
  •  GPL
[/note]

-
 License (DSB) 

+
  •  L-GPL
  •  GPL

+

License (BSD)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
@@ -175,5 +116,13 @@ THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRA Global Documantation
Tutorials
+ diff --git a/library_ewol.html b/library_ewol.html new file mode 100644 index 00000000..1ec0e57a --- /dev/null +++ b/library_ewol.html @@ -0,0 +1,133 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

library: ewol

Description:

+ +

+

namespace:

+ +

Synopsis:

+
+  externconstchar* g_ewolLibName;
  bool             APP_Init      (ewol::Context & _context);
  void             APP_UnInit    (ewol::Context & _context);
  int              mm_main       (int argc,
                                  const char* argv);
  int              mm_run        (void );
+
+

Detail:

+

g_ewolLibName

+  externconstchar* g_ewolLibName;
+ +
+
+
+

APP_Init

+  bool APP_Init (ewol::Context & _context);
+ +
+
+
+

APP_UnInit

+  void APP_UnInit (ewol::Context & _context);
+ +
+
+
+

mm_main

+  int mm_main (int argc,
               const char* argv);
+ +
+
+
+

mm_run

+  int mm_run (void );
+ +
+
+
+
+ + + diff --git a/menu.css b/menu.css index 26ed3897..5b3f470e 100644 --- a/menu.css +++ b/menu.css @@ -1,146 +1,62 @@ /* CSS Document */ /*----------------MENU-----------------*/ -div#menu div{ - margin-top: 0px; - background: #6699FF; +div#menu { + border-left: 4px solid #8d2d0d; + border-bottom: 4px solid #8d2d0d; + padding-left: 4px; + padding-bottom: 4px; } -/* permet l'affichage du haut du menu*/ + div#menu h2{ color: #000000; - FONT-FAMILY: Arial; - FONT-SIZE: 9pt; text-align:left; margin: 0; padding: 3px; padding-left: 6px; - background: #1a62db; + background: #d44413; } div#menu h3{ margin: 0; padding: 6px; - background: #6699FF; + background: #d44413; } div#menu a{ color: #000000; - bgcolor=#6699FF; + bgcolor=#d44413; FONT-FAMILY: Arial; FONT-SIZE: 9pt; } div#menu li { - position: relative; list-style:none; - margin:0px; - border-bottom: 1px solid #0008ab; -} -div#menu li.sousmenu { - background: url(sous_menu.gif) 95% 50% no-repeat; -} -div#menu li:hover { - background: #0008ab; -} -div#menu li.sousmenu:hover { - background: #0008ab; -} -div#menu ul ul { - position: absolute; - top: 0px; + width:160px; + border-top: 1px solid #d44413; } -/*TAILLE PREMIERE COLONNE*/ -div#menu { - float: center; - width: 200px; - text-align:left; -} div#menu ul { + left: 30px; margin: 0; padding: 0; - width: 200px; - background: #6699FF; - border: 0px solid; -} -div#menu ul ul { - left: 199px; - display:none; - background: #FFFFFF; } + div#menu li a { - display: block; padding: 2px 0px 2px 4px; text-decoration: none; - width: 191px; - border-left: 3px solid #6699FF; -} -div#menu form { - border-left: 8px solid #6699FF; - background: #6699FF; - FONT-FAMILY: Arial; - margin:0px; - FONT-SIZE: 8pt; -} -div#menu texte { - border-left: 8px solid #6699FF; - FONT-FAMILY: Arial; - FONT-SIZE: 9pt; - font-weight:bold; - border-bottom: 1px solid #6699FF; + width:160px; + border-left: 4px solid #8d2d0d; } -/*TAILLE DEUXIEME COLONE*/ div#menu ul.niveau1 ul { - left: 200px; - height: 500px; - border: 1px solid #0008ab; + border-left: 20px solid #d44413; background: #1a62db; - /* - overflow:scroll; - overflow-y:auto; - overflow-x:hidden; - */ } div#menu ul.niveau1 li { - background: #6699FF; -} -div#menu ul.niveau1 li.sousmenu:hover ul.niveau2 { - width:219px; - display:block; + background: #b43a10; } - - -/*TAILLE TROISIEME COLONNE*/ -div#menu ul.niveau2 ul { - left: 219px; - height: 500px; -} -div#menu ul.niveau2 li a { - width: 200px; -} -div#menu ul.niveau2 li.sousmenu:hover ul.niveau3 { - width:10em; - display:block; -} - -/*TAILLE Quatrieme COLONNE*/ -div#menu ul.niveau3 ul { - left: 369px; - height: 500px; -} -div#menu ul.niveau3 li a { - width: 200px; -} -div#menu ul.niveau3 li.sousmenu:hover ul.niveau4 { - width:10em; - display:block; -} -/*TAILLE DEUXIEME COLONE BIS????*/ - -/*COULEUR DES BORDURES*/ div#menu li a:hover { - border-left-color: #000ADE; - background: #6699FF; + border-left-color: #ff3800; font-weight:bold; -} \ No newline at end of file +} diff --git a/namespace_MacOs.html b/namespace_MacOs.html new file mode 100644 index 00000000..5635b03e --- /dev/null +++ b/namespace_MacOs.html @@ -0,0 +1,142 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: MacOs

Description:

+ +

+

Associated Class:

+

Synopsis:

+
+  bool draw            (bool _displayEveryTime);
  void resize          (float _x,
                        float _y);
  void setMouseState   (int32_t _id,
                        bool _isDown,
                        float _x,
                        float _y);
  void setMouseMotion  (int32_t _id,
                        float _x,
                        float _y);
  void setKeyboard     (ewol::key::Special _keyboardMode,
                        int32_t _unichar,
                        bool _isDown,
                        bool _isAReapeateKey);
  void setKeyboardMove (ewol::key::Special & _keyboardMode,
                        enum ewol::key::keyboard _move,
                        bool _isDown);
+
+

Detail:

+

draw

+  bool draw (bool _displayEveryTime);
+ +
+
+
+

resize

+  void resize (float _x,
               float _y);
+The OS inform that the current windows has change his size.
    + + +
    Parameter [input]:_size new size of the windows.
    +
+ +
+
+

setMouseState

+  void setMouseState (int32_t _id,
                      bool _isDown,
                      float _x,
                      float _y);
+ +
+
+
+

setMouseMotion

+  void setMouseMotion (int32_t _id,
                       float _x,
                       float _y);
+ +
+
+
+

setKeyboard

+  void setKeyboard (ewol::key::Special _keyboardMode,
                    int32_t _unichar,
                    bool _isDown,
                    bool _isAReapeateKey);
+ +
+
+
+

setKeyboardMove

+  void setKeyboardMove (ewol::key::Special & _keyboardMode,
                        enum ewol::key::keyboard _move,
                        bool _isDown);
+ +
+
+
+
+ + + diff --git a/namespace_ewol.html b/namespace_ewol.html new file mode 100644 index 00000000..2e229898 --- /dev/null +++ b/namespace_ewol.html @@ -0,0 +1,240 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol

Description:

+ +

+

namespace:

+ +

class:

+ +

Synopsis:

+
+  int32_t            run                (int32_t _argc,
                                         const char* _argv);
  std::string        getVersion         (void );
  int64_t            getTime            (void );
  std::string        getCompilationMode (void );
  std::string        getBoardType       (void );
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         enum ewol::Dimension::distance _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const ewol::Dimension & _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const enum ewol::key::type _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const enum ewol::widget::WSlider::sladingMode _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const ewol::DrawProperty & _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const enum ewol::gravity _obj);
  std::string        gravityToString    (const enum ewol::gravity _obj);
  enum ewol::gravity stringToGravity    (const std::string & _obj);
  Context &          getContext         (void );
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const enum ewol::context::cursorDisplay _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const enum ewol::context::clipBoard::clipboardListe _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const ewol::object::Config & _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         const ewol::object::ConfigElement & _obj);
  etk::CCout &       operator <<        (etk::CCout & _os,
                                         enum ewol::font::mode _obj);
+
+

Detail:

+

run

+  int32_t run (int32_t _argc,
               const char* _argv);
+This is the only one things the User might done in his main();
Note: To answare you before you ask the question, this is really simple: + Due to the fect that the current system is multiple-platform, you "main" + Does not exist in the android platform, then ewol call other start + and stop function, to permit to have only one code
Note: The main can not be in the ewol, due to the fact thet is an librairy
    + + + +
    Parameter [input]:_argc Standard argc
    Parameter [input]:_argv Standard argv
    Return: normal error int for the application error management
    +
+ +
+
+

getVersion

+  std::string getVersion (void );
+get EWOL version
+ +
+
+

getTime

+  int64_t getTime (void );
+get current time in us...
Note: is implemented by the OS implementation cf renderer/X11/...
    + +
    Return: The current time
    +
+ +
+
+

getCompilationMode

+  std::string getCompilationMode (void );
+get compilation mode (release/debug)
+ +
+
+

getBoardType

+  std::string getBoardType (void );
+get the board type (Android/Linux/MacOs/...)
+ +
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            enum ewol::Dimension::distance _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::Dimension & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::key::type _obj);
+Debug operator To display the curent element in a Human redeable information
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::widget::WSlider::sladingMode _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::DrawProperty & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::gravity _obj);
+ +
+
+
+

gravityToString

+  std::string gravityToString (const enum ewol::gravity _obj);
+ +
+
+
+

stringToGravity

+  enum ewol::gravity stringToGravity (const std::string & _obj);
+ +
+
+
+

getContext

+  Context & getContext (void );
+From everyware in the program, we can get the context inteface.
    + +
    Return: current reference on the instance.
    +
+ +
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::context::cursorDisplay _obj);
+Debug operator To display the curent element in a Human readable information
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::context::clipBoard::clipboardListe _obj);
+Debug operator To display the curent element in a Human redeable information
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::object::Config & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::object::ConfigElement & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            enum ewol::font::mode _obj);
+ +
+
+
+
+ + + diff --git a/namespace_ewol__audio.html b/namespace_ewol__audio.html new file mode 100644 index 00000000..4b306a74 --- /dev/null +++ b/namespace_ewol__audio.html @@ -0,0 +1,133 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::audio

Description:

+ +

+

namespace:

+ +

Synopsis:

+
+  void    init              (void );
  void    unInit            (void );
  typedef void              (*AudioCallback)(int16_t*_bufferInterlace,int32_t_nbSample,int32_t _nbChannels);
  void    addCallbackOutput (AudioCallback _userCallback);
  void    getData           (int16_t* _bufferInterlace,
                             int32_t _nbSample,
                             int32_t _nbChannels);
+
+

Detail:

+

init

+  void init (void );
+ +
+
+
+

unInit

+  void unInit (void );
+ +
+
+
+

void

+  typedef void (*AudioCallback)(int16_t*_bufferInterlace,int32_t_nbSample,int32_t _nbChannels);
+ +
+
+
+

addCallbackOutput

+  void addCallbackOutput (AudioCallback _userCallback);
+ +
+
+
+

getData

+  void getData (int16_t* _bufferInterlace,
                int32_t _nbSample,
                int32_t _nbChannels);
+ +
+
+
+
+ + + diff --git a/namespace_ewol__audio__effects.html b/namespace_ewol__audio__effects.html new file mode 100644 index 00000000..2c8b0fbe --- /dev/null +++ b/namespace_ewol__audio__effects.html @@ -0,0 +1,148 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::audio::effects

Description:

+ +

+

Synopsis:

+
+  int32_t add       (std::string _file);
  void    rm        (int32_t _effectId);
  void    play      (int32_t _effectId,
                     float _xxx,
                     float _yyy);
  float   volumeGet (void );
  void    volumeSet (float _newVolume);
  bool    muteGet   (void );
  void    muteSet   (bool _newMute);
  void    getData   (int16_t* _bufferInterlace,
                     int32_t _nbSample,
                     int32_t _nbChannels);
+
+

Detail:

+

add

+  int32_t add (std::string _file);
+ +
+
+
+

rm

+  void rm (int32_t _effectId);
+ +
+
+
+

play

+  void play (int32_t _effectId,
             float _xxx,
             float _yyy);
+ +
+
+
+

volumeGet

+  float volumeGet (void );
+ +
+
+
+

volumeSet

+  void volumeSet (float _newVolume);
+ +
+
+
+

muteGet

+  bool muteGet (void );
+ +
+
+
+

muteSet

+  void muteSet (bool _newMute);
+ +
+
+
+

getData

+  void getData (int16_t* _bufferInterlace,
                int32_t _nbSample,
                int32_t _nbChannels);
+ +
+
+
+
+ + + diff --git a/namespace_ewol__audio__music.html b/namespace_ewol__audio__music.html new file mode 100644 index 00000000..8c539fcf --- /dev/null +++ b/namespace_ewol__audio__music.html @@ -0,0 +1,202 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::audio::music

Description:

+ +

+

Synopsis:

+
+  void  fading       (int32_t _timeMs);
  bool  listAdd      (std::string _file);
  bool  listRm       (std::string _file);
  bool  listClean    (void );
  bool  listPrevious (void );
  bool  listNext     (void );
  bool  listFirst    (void );
  bool  listLast     (void );
  bool  listPlay     (void );
  bool  listStop     (void );
  bool  play         (std::string _file);
  bool  stop         (void );
  float volumeGet    (void );
  void  volumeSet    (float _newVolume);
  bool  muteGet      (void );
  void  muteSet      (bool _newMute);
  void  getData      (int16_t* _bufferInterlace,
                      int32_t _nbSample,
                      int32_t _nbChannels);
+
+

Detail:

+

fading

+  void fading (int32_t _timeMs);
+ +
+
+
+

listAdd

+  bool listAdd (std::string _file);
+ +
+
+
+

listRm

+  bool listRm (std::string _file);
+ +
+
+
+

listClean

+  bool listClean (void );
+ +
+
+
+

listPrevious

+  bool listPrevious (void );
+ +
+
+
+

listNext

+  bool listNext (void );
+ +
+
+
+

listFirst

+  bool listFirst (void );
+ +
+
+
+

listLast

+  bool listLast (void );
+ +
+
+
+

listPlay

+  bool listPlay (void );
+ +
+
+
+

listStop

+  bool listStop (void );
+ +
+
+
+

play

+  bool play (std::string _file);
+ +
+
+
+

stop

+  bool stop (void );
+ +
+
+
+

volumeGet

+  float volumeGet (void );
+ +
+
+
+

volumeSet

+  void volumeSet (float _newVolume);
+ +
+
+
+

muteGet

+  bool muteGet (void );
+ +
+
+
+

muteSet

+  void muteSet (bool _newMute);
+ +
+
+
+

getData

+  void getData (int16_t* _bufferInterlace,
                int32_t _nbSample,
                int32_t _nbChannels);
+ +
+
+
+
+ + + diff --git a/namespace_ewol__audio__wav.html b/namespace_ewol__audio__wav.html new file mode 100644 index 00000000..76aa894e --- /dev/null +++ b/namespace_ewol__audio__wav.html @@ -0,0 +1,106 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::audio::wav

Description:

+ +

+

Synopsis:

+
+  int16_t* loadData (std::string filename,
                     int8_t nbChan,
                     int32_t frequency,
                     int32_t & nbSampleOut);
+
+

Detail:

+

loadData

+  int16_t* loadData (std::string filename,
                     int8_t nbChan,
                     int32_t frequency,
                     int32_t & nbSampleOut);
+ +
+
+
+
+ + + diff --git a/namespace_ewol__compositing.html b/namespace_ewol__compositing.html new file mode 100644 index 00000000..3db5e78a --- /dev/null +++ b/namespace_ewol__compositing.html @@ -0,0 +1,100 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::compositing

Description:

+ +

+

Associated Class:

+

class:

+ +
+ + + diff --git a/namespace_ewol__context.html b/namespace_ewol__context.html new file mode 100644 index 00000000..ab06a61b --- /dev/null +++ b/namespace_ewol__context.html @@ -0,0 +1,106 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::context

Description:

+ +

+

Associated Class:

+

namespace:

+ +

class:

+ +

enum:

+ +
+ + + diff --git a/namespace_ewol__context__clipBoard.html b/namespace_ewol__context__clipBoard.html new file mode 100644 index 00000000..e09cdf6f --- /dev/null +++ b/namespace_ewol__context__clipBoard.html @@ -0,0 +1,159 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::context::clipBoard

Description:

+ +

+

enum:

+ +

Synopsis:

+
+  void                set       (enum ewol::context::clipBoard::clipboardListe _clipboardID,
                                 const std::string & _data);
  void                request   (enum ewol::context::clipBoard::clipboardListe _clipboardID);
  void                setSystem (enum ewol::context::clipBoard::clipboardListe _clipboardID,
                                 const std::string & _data);
  const std::string & get       (enum ewol::context::clipBoard::clipboardListe _clipboardID);
  void                init      (void );
  void                unInit    (void );
+
+

Detail:

+

set

+  void set (enum ewol::context::clipBoard::clipboardListe _clipboardID,
            const std::string & _data);
+set the string data on a specific clipboard. The Gui system is notify that the clipboard "SELECTION" and "COPY" are change
+ +
+
+

request

+  void request (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+Call system to request the current clipboard.
Note: Due to some system that manage the clipboard request asynchronous (like X11) and ewol managing the system with only one thread, + we need the call the system to send us the buffer, this is really ambigous, but the widget (who has focus) receive the + notification of the arrival of this buffer id
+ +
+
+

setSystem

+  void setSystem (enum ewol::context::clipBoard::clipboardListe _clipboardID,
                  const std::string & _data);
+set the ewol internal buffer (no notification at the GUI). This fuction might be use by the + Gui abstraction to set the buffer we receive. The end user must not use it.
+ +
+
+

get

+  const std::string & get (enum ewol::context::clipBoard::clipboardListe _clipboardID);
+get the ewol internal buffer of the curent clipboard. The end user can use it when he receive the event in + the widget : @ref onEventClipboard == > we can nothe this function is the only one which permit it.
Note: if we call this fuction withoutcallin @ref ewol::context::clipBoard::Request, we only get the previous clipboard
+ +
+
+

init

+  void init (void );
+initialize the clipboard system (done by ewol)
+
+
+

unInit

+  void unInit (void );
+Un-Initialize the clipboard system (done by ewol)
+
+
+
+ + + diff --git a/namespace_ewol__event.html b/namespace_ewol__event.html new file mode 100644 index 00000000..c606b9b9 --- /dev/null +++ b/namespace_ewol__event.html @@ -0,0 +1,133 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::event

Description:

+ +

+

class:

+ +

Synopsis:

+
+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::Time & _obj);
  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::Entry & _obj);
  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::EntrySystem & _obj);
  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::Input & _obj);
  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::InputSystem & _obj);
+
+

Detail:

+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::Time & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::Entry & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::EntrySystem & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::Input & _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::event::InputSystem & _obj);
+ +
+
+
+
+ + + diff --git a/namespace_ewol__font.html b/namespace_ewol__font.html new file mode 100644 index 00000000..62017709 --- /dev/null +++ b/namespace_ewol__font.html @@ -0,0 +1,95 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::font

Description:

+ +

+
+ + + diff --git a/namespace_ewol__key.html b/namespace_ewol__key.html new file mode 100644 index 00000000..7f3ee3db --- /dev/null +++ b/namespace_ewol__key.html @@ -0,0 +1,122 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::key

Description:

+ +

+

class:

+ +

enum:

+ +

Synopsis:

+
+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::key::status _obj);
  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::key::Special _obj);
  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::key::keyboard _obj);
+
+

Detail:

+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::key::status _obj);
+Debug operator To display the curent element in a Human redeable information
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::key::Special _obj);
+ +
+
+
+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const enum ewol::key::keyboard _obj);
+Debug operator To display the curent element in a Human redeable information
+
+
+
+ + + diff --git a/namespace_ewol__object.html b/namespace_ewol__object.html new file mode 100644 index 00000000..610eefd6 --- /dev/null +++ b/namespace_ewol__object.html @@ -0,0 +1,111 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::object

Description:

+ +

+

Associated Class:

+

class:

+ +

Synopsis:

+
+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::object::Message & _obj);
+
+

Detail:

+

operator <<

+  etk::CCout & operator << (etk::CCout & _os,
                            const ewol::object::Message & _obj);
+ +
+
+
+
+ + + diff --git a/namespace_ewol__openGL.html b/namespace_ewol__openGL.html new file mode 100644 index 00000000..5cc866a1 --- /dev/null +++ b/namespace_ewol__openGL.html @@ -0,0 +1,264 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::openGL

Description:

+ +

+

enum:

+ +

Synopsis:

+
+  void         lock             (void );
  void         unLock           (void );
  void         setBasicMatrix   (const mat4 & _newOne);
  void         setMatrix        (const mat4 & _newOne);
  void         push             (void );
  void         pop              (void );
  const mat4 & getMatrix        (void );
  const mat4 & getCameraMatrix  (void );
  void         setCameraMatrix  (const mat4 & _newOne);
  void         finish           (void );
  void         flush            (void );
  void         swap             (void );
  void         enable           (enum openGlFlags _flagID);
  void         disable          (enum openGlFlags _flagID);
  void         updateAllFlags   (void );
  void         activeTexture    (uint32_t _flagID);
  void         desActiveTexture (uint32_t _flagID);
  void         drawArrays       (uint32_t _mode,
                                 int32_t _first,
                                 int32_t _count);
  void         drawElements     (uint32_t _mode,
                                 const std::vector<uint32_t> & _indices);
  void         drawElements16   (uint32_t _mode,
                                 const std::vector<uint16_t> & _indices);
  void         drawElements8    (uint32_t _mode,
                                 const std::vector<uint8_t> & _indices);
  void         useProgram       (int32_t _id);
+
+

Detail:

+

lock

+  void lock (void );
+Lock the openGL context for one user only == > better to keep flags and other things ...
+
+
+

unLock

+  void unLock (void );
+Un-lock the openGL context for an other user...
+
+
+

setBasicMatrix

+  void setBasicMatrix (const mat4 & _newOne);
+When you will done an opengl rendering, you might call this reset matrix first. It remove all the stach of the matrix pushed.
    + + +
    Parameter [input]:_newOne the default matrix that might be set for the graphic card for renderer. if too more pop will be done, this is the last that mmight survived
    +
+ +
+
+

setMatrix

+  void setMatrix (const mat4 & _newOne);
+this funtion configure the current use matrix for the renderer (call @ref Push before, and @ref Pop when no more needed).
Note: We did not use opengl standard system, due to the fact that is not supported in opengl ES-2
    + + +
    Parameter [input]:_newOne The new current matrix use for the render.
    +
+ +
+
+

push

+  void push (void );
+store current matrix in the matrix stack.
+
+
+

pop

+  void pop (void );
+remove the current matrix and get the last one from the matrix stack.
+
+
+

getMatrix

+  const mat4 & getMatrix (void );
+get a reference on the current matrix destinate to opengl renderer.
    + +
    Return: The requested matrix.
    +
+ +
+
+

getCameraMatrix

+  const mat4 & getCameraMatrix (void );
+get a reference on the current matrix camera destinate to opengl renderer.
    + +
    Return: The requested matrix.
    +
+ +
+
+

setCameraMatrix

+  void setCameraMatrix (const mat4 & _newOne);
+set a reference on the current camera to opengl renderer.
    + + +
    Parameter [input]:_newOne The requested matrix.
    +
+ +
+
+

finish

+  void finish (void );
+ +
+
+

flush

+  void flush (void );
+ +
+
+

swap

+  void swap (void );
+ +
+
+

enable

+  void enable (enum openGlFlags _flagID);
+enable a flag on the system
    + + +
    Parameter [input]:flagID The flag requested
    +
+ +
+
+

disable

+  void disable (enum openGlFlags _flagID);
+disable a flag on the system
    + + +
    Parameter [input]:flagID The flag requested
    +
+ +
+
+

updateAllFlags

+  void updateAllFlags (void );
+ +
+
+

activeTexture

+  void activeTexture (uint32_t _flagID);
+enable Texture on the system
    + + +
    Parameter [input]:flagID The flag requested
    +
+ +
+
+

desActiveTexture

+  void desActiveTexture (uint32_t _flagID);
+disable Texture on the system
    + + +
    Parameter [input]:flagID The flag requested
    +
+ +
+
+

drawArrays

+  void drawArrays (uint32_t _mode,
                   int32_t _first,
                   int32_t _count);
+draw a specific array == > this enable mode difference ...
+
+
+

drawElements

+  void drawElements (uint32_t _mode,
                     const std::vector<uint32_t> & _indices);
+ +
+
+
+

drawElements16

+  void drawElements16 (uint32_t _mode,
                       const std::vector<uint16_t> & _indices);
+ +
+
+
+

drawElements8

+  void drawElements8 (uint32_t _mode,
                      const std::vector<uint8_t> & _indices);
+ +
+
+
+

useProgram

+  void useProgram (int32_t _id);
+Use openGL program
+ +
+
+
+ + + diff --git a/namespace_ewol__portAudio.html b/namespace_ewol__portAudio.html new file mode 100644 index 00000000..7e2de9bb --- /dev/null +++ b/namespace_ewol__portAudio.html @@ -0,0 +1,112 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::portAudio

Description:

+ +

+

Synopsis:

+
+  void init   (void );
  void unInit (void );
+
+

Detail:

+

init

+  void init (void );
+ +
+
+
+

unInit

+  void unInit (void );
+ +
+
+
+
+ + + diff --git a/namespace_ewol__resource.html b/namespace_ewol__resource.html new file mode 100644 index 00000000..a17d77f7 --- /dev/null +++ b/namespace_ewol__resource.html @@ -0,0 +1,117 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::resource

Description:

+ +

+

Associated Class:

+

class:

+ +

Synopsis:

+
+  void freeTypeInit   (void );
  void freeTypeUnInit (void );
+
+

Detail:

+

freeTypeInit

+  void freeTypeInit (void );
+ +
+
+
+

freeTypeUnInit

+  void freeTypeUnInit (void );
+ +
+
+
+
+ + + diff --git a/namespace_ewol__widget.html b/namespace_ewol__widget.html new file mode 100644 index 00000000..755c2c1a --- /dev/null +++ b/namespace_ewol__widget.html @@ -0,0 +1,100 @@ + + + + + ewol Library + + + + +
+
+

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
+
+
+
+

namespace: ewol::widget

Description:

+ +

+

Associated Class:

+

class:

+ +
+ + + diff --git a/tutorial_000_Build.html b/tutorial_000_Build.html index 45eb2bec..bbad7779 100644 --- a/tutorial_000_Build.html +++ b/tutorial_000_Build.html @@ -9,133 +9,73 @@
-

ewol Library

- +

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
@@ -170,9 +110,10 @@ Download the software : # clone the exemple repository git clone git://github.com/HeeroYui/example.git
-[note] +
+Note:
 The full build tool documentation is availlable here : lutin
-[/note]

+

Common build instructions


Compile software in debug for the curent platform : 
@@ -206,5 +147,13 @@ To run an application you will find it directly on the out 'staging' tree :
 The workspace is a simple folder that contain all the modules ans sub module.
 It will create a tree like this :

 
  •  workspace
    •  ewol
      •  external (ewol external dependency sub-lib)
        •  agg
        •  bullet
        •  date
        •  egami
        •  ege
        •  ejson
        •  etk
        •  exml
        •  freetype
        •  glew
        •  lua
        •  ogg
        •  png
        •  portaudio
        •  z
      •  souces
        •  ewol
    •  example
+ diff --git a/tutorial_001_HelloWord.html b/tutorial_001_HelloWord.html index 00a400c0..d70bd47f 100644 --- a/tutorial_001_HelloWord.html +++ b/tutorial_001_HelloWord.html @@ -9,133 +9,73 @@
-

ewol Library

- +

ewol library

+

   [ sources ]

+

API:

+

Documentation:

+

Tutorials:

+

Associate libraries:

+
+
+
+
+
+
@@ -236,7 +176,8 @@ We can se in this example that the label have some other property like the font The label can have decorated text based on the html generic writing but it is composed with really simple set of balise. I will take a really long time to create a real html parser, the the availlable property is: -[note] The xml parser is a little strict on the case and end node, but it support to not have a main node.[/note]
+
+Note:
 The xml parser is a little strict on the case and end node, but it support to not have a main node.

The last step is to add the widget on the windows : 
@@ -273,5 +214,13 @@ In this function we just need to remove the windows and un-init all needed by th
 }
+