From 65d2cd695180ed8f62da2cafc1855fcac62bfbb9 Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Fri, 6 Dec 2013 16:19:25 +0100 Subject: [PATCH] [DEV] add first ewol real documentation --- base.css | 131 +++ eSystemMessage.html | 158 +++ ewol__Area.html | 277 +++++ ewol__Colored3DObject.html | 234 ++++ ewol__CommandLine.html | 201 ++++ ewol__Compositing.html | 247 ++++ ewol__ConfigFile.html | 240 ++++ ewol__ConfigFont.html | 242 ++++ ewol__Dimension.html | 371 ++++++ ewol__DrawProperty.html | 152 +++ ewol__Drawing.html | 505 ++++++++ ewol__EConfig.html | 184 +++ ewol__EConfigElement.html | 195 ++++ ewol__EMessage.html | 201 ++++ ewol__EMultiCast.html | 195 ++++ ewol__EMultiCast__MessageList.html | 152 +++ ewol__EObject.html | 617 ++++++++++ ewol__EObjectManager.html | 232 ++++ ewol__EventEntry.html | 218 ++++ ewol__EventEntrySystem.html | 154 +++ ewol__EventExtGen.html | 146 +++ ewol__EventInput.html | 218 ++++ ewol__EventInputSystem.html | 188 +++ ewol__EventShortCut.html | 159 +++ ewol__EventTime.html | 226 ++++ ewol__Face.html | 180 +++ ewol__FaceIndexing.html | 143 +++ ewol__FontBase.html | 230 ++++ ewol__FontFreeType.html | 248 ++++ ewol__Fps.html | 204 ++++ ewol__GlyphProperty.html | 197 ++++ ewol__Image.html | 416 +++++++ ewol__Kerning.html | 201 ++++ ewol__Light.html | 225 ++++ ewol__Material.html | 232 ++++ ewol__MaterialGlId.html | 160 +++ ewol__Mesh.html | 333 ++++++ ewol__PhysicsBox.html | 213 ++++ ewol__PhysicsCapsule.html | 221 ++++ ewol__PhysicsCone.html | 221 ++++ ewol__PhysicsConvexHull.html | 221 ++++ ewol__PhysicsCylinder.html | 213 ++++ ewol__PhysicsShape.html | 362 ++++++ ewol__PhysicsSphere.html | 213 ++++ ewol__Program.html | 694 +++++++++++ ewol__Resource.html | 253 ++++ ewol__ResourceManager.html | 249 ++++ ewol__Shader.html | 272 +++++ ewol__Shaper.html | 378 ++++++ ewol__SimpleConfigElement.html | 191 +++ ewol__SpecialKey.html | 248 ++++ ewol__SpecialKey__SpecialKey__union__.html | 143 +++ ewol__SpecialKey__union.html | 143 +++ ewol__Sprite.html | 185 +++ ewol__Text.html | 832 ++++++++++++++ ewol__TextDecoration.html | 154 +++ ewol__Texture.html | 273 +++++ ewol__TextureFile.html | 221 ++++ ewol__TexturedFont.html | 269 +++++ ewol__VirtualBufferObject.html | 354 ++++++ ewol__Widget.html | 1215 ++++++++++++++++++++ ewol__WidgetManager.html | 296 +++++ ewol__Windows.html | 404 +++++++ ewol__clipBoard__clipboardListe.html | 140 +++ ewol__cursorDisplay.html | 140 +++ ewol__eContext.html | 695 +++++++++++ ewol__eInput.html | 312 +++++ ewol__font__mode.html | 140 +++ ewol__gravity.html | 140 +++ ewol__keyEvent__keyboard.html | 140 +++ ewol__keyEvent__status.html | 140 +++ ewol__keyEvent__type.html | 140 +++ ewol__openGL__openGlFlags.html | 140 +++ ewol__orientation.html | 140 +++ ewol__progAttributeElement.html | 148 +++ images/bkg.png | Bin 4261 -> 0 bytes images/blacktocat.png | Bin 1266 -> 0 bytes index.html | 238 ++-- javascripts/main.js | 1 - params.json | 1 - stylesheets/pygment_trac.css | 68 -- stylesheets/stylesheet.css | 247 ---- widget__Button.html | 423 +++++++ widget__ButtonColor.html | 280 +++++ widget__CheckBox.html | 241 ++++ widget__ColorBar.html | 217 ++++ widget__ColorChooser.html | 203 ++++ widget__Composer.html | 253 ++++ widget__Container.html | 290 +++++ widget__ContainerN.html | 359 ++++++ widget__ContextMenu.html | 264 +++++ widget__Entry.html | 504 ++++++++ widget__FileChooser.html | 243 ++++ widget__Gird.html | 409 +++++++ widget__Gird__GirdProperties.html | 143 +++ widget__Image.html | 349 ++++++ widget__Joystick.html | 261 +++++ widget__Label.html | 263 +++++ widget__Layer.html | 189 +++ widget__List.html | 316 +++++ widget__ListFileSystem.html | 303 +++++ widget__Menu.html | 258 +++++ widget__MenuElement.html | 151 +++ widget__Mesh.html | 269 +++++ widget__Parameter.html | 229 ++++ widget__ParameterList.html | 277 +++++ widget__PopUp.html | 323 ++++++ widget__ProgressBar.html | 242 ++++ widget__Scroll.html | 268 +++++ widget__Sizer.html | 314 +++++ widget__Slider.html | 249 ++++ widget__Spacer.html | 232 ++++ widget__StdPopUp.html | 248 ++++ widget__WSlider.html | 307 +++++ widget__WidgetScrooled.html | 269 +++++ widget__elementPL.html | 162 +++ 116 files changed, 28906 insertions(+), 422 deletions(-) create mode 100644 base.css create mode 100644 eSystemMessage.html create mode 100644 ewol__Area.html create mode 100644 ewol__Colored3DObject.html create mode 100644 ewol__CommandLine.html create mode 100644 ewol__Compositing.html create mode 100644 ewol__ConfigFile.html create mode 100644 ewol__ConfigFont.html create mode 100644 ewol__Dimension.html create mode 100644 ewol__DrawProperty.html create mode 100644 ewol__Drawing.html create mode 100644 ewol__EConfig.html create mode 100644 ewol__EConfigElement.html create mode 100644 ewol__EMessage.html create mode 100644 ewol__EMultiCast.html create mode 100644 ewol__EMultiCast__MessageList.html create mode 100644 ewol__EObject.html create mode 100644 ewol__EObjectManager.html create mode 100644 ewol__EventEntry.html create mode 100644 ewol__EventEntrySystem.html create mode 100644 ewol__EventExtGen.html create mode 100644 ewol__EventInput.html create mode 100644 ewol__EventInputSystem.html create mode 100644 ewol__EventShortCut.html create mode 100644 ewol__EventTime.html create mode 100644 ewol__Face.html create mode 100644 ewol__FaceIndexing.html create mode 100644 ewol__FontBase.html create mode 100644 ewol__FontFreeType.html create mode 100644 ewol__Fps.html create mode 100644 ewol__GlyphProperty.html create mode 100644 ewol__Image.html create mode 100644 ewol__Kerning.html create mode 100644 ewol__Light.html create mode 100644 ewol__Material.html create mode 100644 ewol__MaterialGlId.html create mode 100644 ewol__Mesh.html create mode 100644 ewol__PhysicsBox.html create mode 100644 ewol__PhysicsCapsule.html create mode 100644 ewol__PhysicsCone.html create mode 100644 ewol__PhysicsConvexHull.html create mode 100644 ewol__PhysicsCylinder.html create mode 100644 ewol__PhysicsShape.html create mode 100644 ewol__PhysicsSphere.html create mode 100644 ewol__Program.html create mode 100644 ewol__Resource.html create mode 100644 ewol__ResourceManager.html create mode 100644 ewol__Shader.html create mode 100644 ewol__Shaper.html create mode 100644 ewol__SimpleConfigElement.html create mode 100644 ewol__SpecialKey.html create mode 100644 ewol__SpecialKey__SpecialKey__union__.html create mode 100644 ewol__SpecialKey__union.html create mode 100644 ewol__Sprite.html create mode 100644 ewol__Text.html create mode 100644 ewol__TextDecoration.html create mode 100644 ewol__Texture.html create mode 100644 ewol__TextureFile.html create mode 100644 ewol__TexturedFont.html create mode 100644 ewol__VirtualBufferObject.html create mode 100644 ewol__Widget.html create mode 100644 ewol__WidgetManager.html create mode 100644 ewol__Windows.html create mode 100644 ewol__clipBoard__clipboardListe.html create mode 100644 ewol__cursorDisplay.html create mode 100644 ewol__eContext.html create mode 100644 ewol__eInput.html create mode 100644 ewol__font__mode.html create mode 100644 ewol__gravity.html create mode 100644 ewol__keyEvent__keyboard.html create mode 100644 ewol__keyEvent__status.html create mode 100644 ewol__keyEvent__type.html create mode 100644 ewol__openGL__openGlFlags.html create mode 100644 ewol__orientation.html create mode 100644 ewol__progAttributeElement.html delete mode 100644 images/bkg.png delete mode 100644 images/blacktocat.png delete mode 100644 javascripts/main.js delete mode 100644 params.json delete mode 100644 stylesheets/pygment_trac.css delete mode 100644 stylesheets/stylesheet.css create mode 100644 widget__Button.html create mode 100644 widget__ButtonColor.html create mode 100644 widget__CheckBox.html create mode 100644 widget__ColorBar.html create mode 100644 widget__ColorChooser.html create mode 100644 widget__Composer.html create mode 100644 widget__Container.html create mode 100644 widget__ContainerN.html create mode 100644 widget__ContextMenu.html create mode 100644 widget__Entry.html create mode 100644 widget__FileChooser.html create mode 100644 widget__Gird.html create mode 100644 widget__Gird__GirdProperties.html create mode 100644 widget__Image.html create mode 100644 widget__Joystick.html create mode 100644 widget__Label.html create mode 100644 widget__Layer.html create mode 100644 widget__List.html create mode 100644 widget__ListFileSystem.html create mode 100644 widget__Menu.html create mode 100644 widget__MenuElement.html create mode 100644 widget__Mesh.html create mode 100644 widget__Parameter.html create mode 100644 widget__ParameterList.html create mode 100644 widget__PopUp.html create mode 100644 widget__ProgressBar.html create mode 100644 widget__Scroll.html create mode 100644 widget__Sizer.html create mode 100644 widget__Slider.html create mode 100644 widget__Spacer.html create mode 100644 widget__StdPopUp.html create mode 100644 widget__WSlider.html create mode 100644 widget__WidgetScrooled.html create mode 100644 widget__elementPL.html diff --git a/base.css b/base.css new file mode 100644 index 00000000..aa94d74e --- /dev/null +++ b/base.css @@ -0,0 +1,131 @@ + +html { + display: block; +} + +body { + font-family: 'Ubuntu',Tahoma,sans-serif; + padding-top: 40px; + padding-bottom: 40px; + font-size: 15px; + line-height: 150%; + margin: 0; + color: #333333; + background-color: #ffffff; + display: block; + margin-left: 250px; + margin-right: 50px; +}; + +.container{ + width:940px; + margin-right: auto; + margin-left: auto; + display: block; +}; + +.navbar { + z-index: 1; + overflow: visible; + color: #ffffff; + display: block; +} + +.navbar div { + display: block; + margin-left: 5px; + margin-right: 5px; +} + +.navbar-fixed-top { + width:210px; + display: block; + position: fixed; + padding-top: 0px; + top: 0; + height: 100%; + right: 0; + left: 0; + margin-bottom: 0; + background-color: #d44413; + border: 1px solid #c64012; + font-size: 15px; + font-weight: 200; + color: #ffffff; + text-shadow: 0 1px 0 #ce4213; + padding: 10px 20px 10px; + margin-left: -20px; + overflow:scroll; + overflow-x:hidden; +} +/* +.navbar ul { + font-size: 15px; +}; +*/ +h1, h2, h3, h4, h5, h6 { + display: block; + margin: 10px 0; + font-family: inherit; + font-weight: bold; + line-height: 1; + color: inherit; + text-rendering: optimizelegibility; +} + +p { + margin: 0 0 10px; + display: block; +} + +pre { + #margin-left: 20px; + display: block; + padding: 9.5px; + margin: 0 0 10px; + font-size: 13px; + line-height: 20px; + word-break: break-all; + word-wrap: break-word; + white-space: pre; + white-space: pre-wrap; + background-color: #f5f5f5; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.15); + border-radius: 4px; +} + + + +.code-function { + text-decoration:none; + color:#09857e; + font-weight:bold; +} + +.code-type { + text-decoration:none; + color:#376d0a; + font-weight:bold; +} + +.code-argument { + text-decoration:none; + color:#B80000; + font-weight:bold; +} + +.code-number { + text-decoration:none; + color:#007b00; +} + +.code-keyword { + text-decoration:none; + color:#215eb8; + font-weight:bold; +} +.code-storage-keyword { + text-decoration:none; + color:#466cb4; +} \ No newline at end of file diff --git a/eSystemMessage.html b/eSystemMessage.html new file mode 100644 index 00000000..5c104b79 --- /dev/null +++ b/eSystemMessage.html @@ -0,0 +1,158 @@ + + + + + ewol Library + + + + +
+

Class: eSystemMessage

+
+

Synopsis:

+
++        eSystemMessage  (void);
+ + +

Description:

+/** +* @author Edouard DUPIN +* +* @copyright 2011, Edouard DUPIN, all right reserved +* +* @license BSD v3 (see license file) +*/

Detail:

+

eSystemMessage ()

+ +
+eSystemMessage(void);
+
+
+ +
+
+ + diff --git a/ewol__Area.html b/ewol__Area.html new file mode 100644 index 00000000..d17b5d49 --- /dev/null +++ b/ewol__Area.html @@ -0,0 +1,277 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Area

+
+

Synopsis:

+
++                  Area         (const ivec2 & _size);
+ ~Area (void);
+ 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::Area
+
+
+

Detail:

+

ewol::Area ()

+ +
+Area(const ivec2 & _size);
+
+generic constructor +
+
+ +
+

ewol::~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__Colored3DObject.html b/ewol__Colored3DObject.html new file mode 100644 index 00000000..a9051bf1 --- /dev/null +++ b/ewol__Colored3DObject.html @@ -0,0 +1,234 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Colored3DObject

+
+

Synopsis:

+
++  const char *                    getType          (void);
+ 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::Colored3DObject * keep (void);
+ static void release (ewol::Colored3DObject * & _object);
# Colored3DObject (void);
# ~Colored3DObject (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::Colored3DObject
+
+
+

Detail:

+

getType ()

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

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::keep ()

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

ewol::release ()

+ +
+static void release(ewol::Colored3DObject * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::Colored3DObject ()

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

ewol::~Colored3DObject ()

+ +
+~Colored3DObject(void);
+
+
+ +
+
+ + diff --git a/ewol__CommandLine.html b/ewol__CommandLine.html new file mode 100644 index 00000000..5f32a179 --- /dev/null +++ b/ewol__CommandLine.html @@ -0,0 +1,201 @@ + + + + + ewol Library + + + + +
+

Class: ewol::CommandLine

+
+

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__Compositing.html b/ewol__Compositing.html new file mode 100644 index 00000000..e403f1a6 --- /dev/null +++ b/ewol__Compositing.html @@ -0,0 +1,247 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Compositing

+
+

Synopsis:

+
++        Compositing  (void);
+ ~Compositing (void);
+ 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::Shaper
+    +--> ewol::Drawing
+    +--> ewol::Text
+    +--> ewol::Image
+    +--> ewol::Area
+
+
+

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__ConfigFile.html b/ewol__ConfigFile.html new file mode 100644 index 00000000..67a955cc --- /dev/null +++ b/ewol__ConfigFile.html @@ -0,0 +1,240 @@ + + + + + ewol Library + + + + +
+

Class: ewol::ConfigFile

+
+

Synopsis:

+
++  const char *               getType     (void);
+ 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::ConfigFile * keep (const std::string & _filename);
+ static void release (ewol::ConfigFile * & _object);
# ConfigFile (const std::string & _filename);
# ~ConfigFile (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::ConfigFile
+
+
+

Detail:

+

getType ()

+ +
+const char * getType(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);
+
+
+ +
+

ewol::keep ()

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

ewol::release ()

+ +
+static void release(ewol::ConfigFile * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::ConfigFile ()

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

ewol::~ConfigFile ()

+ +
+~ConfigFile(void);
+
+
+ +
+
+ + diff --git a/ewol__ConfigFont.html b/ewol__ConfigFont.html new file mode 100644 index 00000000..cdb3332b --- /dev/null +++ b/ewol__ConfigFont.html @@ -0,0 +1,242 @@ + + + + + ewol Library + + + + +
+

Class: ewol::ConfigFont

+
+

Synopsis:

+
++                       ConfigFont      (void);
+ ~ConfigFont (void);
+ 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::ConfigFont ()

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

ewol::~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__Dimension.html b/ewol__Dimension.html new file mode 100644 index 00000000..796a0282 --- /dev/null +++ b/ewol__Dimension.html @@ -0,0 +1,371 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Dimension

+
+

Synopsis:

+
++                     Dimension      (void);
+ Dimension (const vec2 & _size,
enum ewol::Dimension::distance _type);
+ Dimension (const std::string & _config);
+ Dimension (const char * _config);
+ ~Dimension (void);
+ 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);
- 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);
+
+
+ +
+

set ()

+ +
+void set(std::string _config);
+
+set the current dimention in requested type +
+
+ +
+
+ + diff --git a/ewol__DrawProperty.html b/ewol__DrawProperty.html new file mode 100644 index 00000000..4c142784 --- /dev/null +++ b/ewol__DrawProperty.html @@ -0,0 +1,152 @@ + + + + + ewol Library + + + + +
+

Class: ewol::DrawProperty

+
+

Synopsis:

+
++  void  limit  (const vec2 & _origin,
const vec2 & _size);
+ + +

Detail:

+

limit ()

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

Class: ewol::Drawing

+
+

Synopsis:

+
++                Drawing           (void);
+ ~Drawing (void);
+ 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::Drawing
+
+
+

Detail:

+

ewol::Drawing ()

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

+ +
+

ewol::~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__EConfig.html b/ewol__EConfig.html new file mode 100644 index 00000000..91682bf9 --- /dev/null +++ b/ewol__EConfig.html @@ -0,0 +1,184 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EConfig

+
+

Synopsis:

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

Detail:

+

ewol::EConfig ()

+ +
+EConfig(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__EConfigElement.html b/ewol__EConfigElement.html new file mode 100644 index 00000000..9c6be745 --- /dev/null +++ b/ewol__EConfigElement.html @@ -0,0 +1,195 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EConfigElement

+
+

Synopsis:

+
++                       EConfigElement  (const char * _config,
const char * _type,
const char * _control,
const char * _description,
const char * _default);
+ const char * getConfig (void);
+ const char * getType (void);
+ const char * getControl (void);
+ const char * getDescription (void);
+ const char * getDefault (void);
+ + +

Detail:

+

ewol::EConfigElement ()

+ +
+EConfigElement(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__EMessage.html b/ewol__EMessage.html new file mode 100644 index 00000000..c4f112bb --- /dev/null +++ b/ewol__EMessage.html @@ -0,0 +1,201 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EMessage

+
+

Synopsis:

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

Detail:

+

ewol::EMessage ()

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

setCaller ()

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

getCaller ()

+ +
+ewol::EObject * 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__EMultiCast.html b/ewol__EMultiCast.html new file mode 100644 index 00000000..9938289e --- /dev/null +++ b/ewol__EMultiCast.html @@ -0,0 +1,195 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EMultiCast

+
+

Synopsis:

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

Detail:

+

ewol::EMultiCast ()

+ +
+EMultiCast();
+
+
+ +
+

ewol::~EMultiCast ()

+ +
+~EMultiCast(void);
+
+
+ +
+

anonymousSend ()

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

send ()

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

rm ()

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

add ()

+ +
+void add(ewol::EObject * _object,
+         const char * const _message);
+
+
+ +
+
+ + diff --git a/ewol__EMultiCast__MessageList.html b/ewol__EMultiCast__MessageList.html new file mode 100644 index 00000000..0cf40c5b --- /dev/null +++ b/ewol__EMultiCast__MessageList.html @@ -0,0 +1,152 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EMultiCast::MessageList

+
+

Synopsis:

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

Detail:

+

ewol::EMultiCast::MessageList ()

+ +
+MessageList(const char * _message,
+            ewol::EObject * _object);
+
+
+ +
+
+ + diff --git a/ewol__EObject.html b/ewol__EObject.html new file mode 100644 index 00000000..38aa8d58 --- /dev/null +++ b/ewol__EObject.html @@ -0,0 +1,617 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EObject

+
+

Synopsis:

+
++                                             EObject             (void);
+ EObject (const std::string & _name);
+ ~EObject (void);
+ 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::EObject * _destinationObject,
const char * _eventId,
const char * _eventIdgenerated,
const std::string & _overloadData);
+ void unRegisterOnEvent (ewol::EObject * _destinationObject,
const char * _eventId);
+ void onObjectRemove (ewol::EObject * _removeObject);
+ void onReceiveMessage (const ewol::EMessage & _msg);
+ const std::vector & getConfigList (void);
+ bool setConfig (const ewol::EConfig & _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::EConfig & _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::EObjectManager & getEObjectManager (void);
+ ewol::EMultiCast & getMultiCast (void);
+ eContext & 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::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> 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 EObject to communicate between them. +*/

Detail:

+

ewol::EObject ()

+ +
+EObject(void);
+
+Constructor. +

+ +
+

ewol::EObject ()

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

ewol::~EObject ()

+ +
+~EObject(void);
+
+Destructor +

+ +
+

removeObject ()

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

+ +
+

getObjectType ()

+ +
+const char * const getObjectType(void);
+
+get the current Object type of the EObject +
+
+ +
+

getTypeDescription ()

+ +
+std::string getTypeDescription(void);
+
+Get the herarchie of the EObject 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 EObject == > 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 EObject +
+
+ +
+

registerOnEvent ()

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

unRegisterOnEvent ()

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

onObjectRemove ()

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

onReceiveMessage ()

+ +
+void onReceiveMessage(const ewol::EMessage & _msg);
+
+Receive a message from an other EObject with a specific eventId and data +
+
+ +
+

getConfigList ()

+ +
+const std::vector & getConfigList(void);
+
+get all the configuration list +
+
+ +
+

setConfig ()

+ +
+bool setConfig(const ewol::EConfig & _conf);
+
+Configuration requested to the curent EObject (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::EConfig & _conf);
+
+
+ +
+

getConfig ()

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

getConfig ()

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

getName ()

+ +
+const std::string & getName(void);
+
+get the eObject 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. +
+
+ +
+

getEObjectManager ()

+ +
+ewol::EObjectManager & getEObjectManager(void);
+
+ +
+ +
+

getMultiCast ()

+ +
+ewol::EMultiCast & getMultiCast(void);
+
+ +
+ +
+

getContext ()

+ +
+eContext & 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 eObject. +
+
+ +
+

addEventId ()

+ +
+void addEventId(const char * _generateEventId);
+
+add a specific event Id in the list to prevent wrong link on a EObject +
+
+ +
+

generateEventId ()

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

sendMultiCast ()

+ +
+void sendMultiCast(const char * const _messageId,
+                   const std::string & _data);
+
+generate Multicast event on all EObject 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 EObject add a configuration capabilities +
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _conf);
+
+Configuration requested to the curent EObject +
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+Receive a configuration message from an other element system or from the curent EObject +
+
+ +
+
+ + diff --git a/ewol__EObjectManager.html b/ewol__EObjectManager.html new file mode 100644 index 00000000..458253a3 --- /dev/null +++ b/ewol__EObjectManager.html @@ -0,0 +1,232 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EObjectManager

+
+

Synopsis:

+
++                      EObjectManager            (void);
+ ~EObjectManager (void);
+ void unInit (void);
+ void add (ewol::EObject * _object);
+ void rm (ewol::EObject * _object);
+ int32_t getNumberObject (void);
+ void autoRemove (ewol::EObject * _object);
+ void removeAllAutoRemove (void);
+ ewol::EObject * get (const std::string & _name);
+ ewol::EMultiCast & multiCast (void);
- void informOneObjectIsRemoved (ewol::EObject * _object);
+ + +

Detail:

+

ewol::EObjectManager ()

+ +
+EObjectManager(void);
+
+
+ +
+

ewol::~EObjectManager ()

+ +
+~EObjectManager(void);
+
+
+ +
+

unInit ()

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

+ +
+

add ()

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

rm ()

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

getNumberObject ()

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

autoRemove ()

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

removeAllAutoRemove ()

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

get ()

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

multiCast ()

+ +
+ewol::EMultiCast & multiCast(void);
+
+
+ +
+

informOneObjectIsRemoved ()

+ +
+void informOneObjectIsRemoved(ewol::EObject * _object);
+
+
+ +
+
+ + diff --git a/ewol__EventEntry.html b/ewol__EventEntry.html new file mode 100644 index 00000000..eda334e8 --- /dev/null +++ b/ewol__EventEntry.html @@ -0,0 +1,218 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EventEntry

+
+

Synopsis:

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

Detail:

+

ewol::EventEntry ()

+ +
+EventEntry(enum ewol::keyEvent::keyboard _type,
+           enum ewol::keyEvent::status _status,
+           ewol::SpecialKey _specialKey,
+           char32_t _char);
+
+
+ +
+

setType ()

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

getType ()

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

setStatus ()

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

getStatus ()

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

setSpecialKey ()

+ +
+void setSpecialKey(const ewol::SpecialKey & _specialKey);
+
+
+ +
+

getSpecialKey ()

+ +
+const ewol::SpecialKey & getSpecialKey(void);
+
+
+ +
+

setChar ()

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

getChar ()

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

Class: ewol::EventEntrySystem

+
+

Synopsis:

+
++        EventEntrySystem  (enum ewol::keyEvent::keyboard _type,
enum ewol::keyEvent::status _status,
ewol::SpecialKey _specialKey,
char32_t _char);
+ + +

Detail:

+

ewol::EventEntrySystem ()

+ +
+EventEntrySystem(enum ewol::keyEvent::keyboard _type,
+                 enum ewol::keyEvent::status _status,
+                 ewol::SpecialKey _specialKey,
+                 char32_t _char);
+
+
+ +
+
+ + diff --git a/ewol__EventExtGen.html b/ewol__EventExtGen.html new file mode 100644 index 00000000..db333f3e --- /dev/null +++ b/ewol__EventExtGen.html @@ -0,0 +1,146 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EventExtGen

+
+

Synopsis:

+
+
+ + +

Description:

+/** +* local class for event generation +*/

Detail:

+

+ + diff --git a/ewol__EventInput.html b/ewol__EventInput.html new file mode 100644 index 00000000..372c9ef8 --- /dev/null +++ b/ewol__EventInput.html @@ -0,0 +1,218 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EventInput

+
+

Synopsis:

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

Detail:

+

ewol::EventInput ()

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

setType ()

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

getType ()

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

setStatus ()

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

getStatus ()

+ +
+const enum ewol::keyEvent::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__EventInputSystem.html b/ewol__EventInputSystem.html new file mode 100644 index 00000000..03104344 --- /dev/null +++ b/ewol__EventInputSystem.html @@ -0,0 +1,188 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EventInputSystem

+
+

Synopsis:

+
++                         EventInputSystem  (enum ewol::keyEvent::type _type,
enum ewol::keyEvent::status _status,
uint8_t _id,
const vec2 & _pos,
ewol::Widget * _dest,
int32_t _realIdEvent);
+ void setDestWidget (ewol::Widget * _dest);
+ ewol::Widget * getDestWidget (void);
+ void setRealId (int32_t _realIdEvent);
+ int32_t getRealId (void);
+ + +

Detail:

+

ewol::EventInputSystem ()

+ +
+EventInputSystem(enum ewol::keyEvent::type _type,
+                 enum ewol::keyEvent::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__EventShortCut.html b/ewol__EventShortCut.html new file mode 100644 index 00000000..f7784f21 --- /dev/null +++ b/ewol__EventShortCut.html @@ -0,0 +1,159 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EventShortCut

+
+

Synopsis:

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

Detail:

+

ewol::EventShortCut ()

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

ewol::~EventShortCut ()

+ +
+~EventShortCut(void);
+
+
+ +
+
+ + diff --git a/ewol__EventTime.html b/ewol__EventTime.html new file mode 100644 index 00000000..9f5f4e92 --- /dev/null +++ b/ewol__EventTime.html @@ -0,0 +1,226 @@ + + + + + ewol Library + + + + +
+

Class: ewol::EventTime

+
+

Synopsis:

+
++                  EventTime          (int64_t _timeSystem,
int64_t _timeUpAppl,
float _timeDelta,
float _timeDeltaCall);
+ 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::EventTime ()

+ +
+EventTime(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__Face.html b/ewol__Face.html new file mode 100644 index 00000000..ed030534 --- /dev/null +++ b/ewol__Face.html @@ -0,0 +1,180 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Face

+
+

Synopsis:

+
++        Face  (void);
+ Face (int32_t v1,
int32_t t1,
int32_t v2,
int32_t t2,
int32_t v3,
int32_t t3);
+ Face (int32_t v1,
int32_t t1,
int32_t n1,
int32_t v2,
int32_t t2,
int32_t n2,
int32_t v3,
int32_t t3,
int32_t n3);
+ + +

Detail:

+

ewol::Face ()

+ +
+Face(void);
+
+
+ +
+

ewol::Face ()

+ +
+Face(int32_t v1,
+     int32_t t1,
+     int32_t v2,
+     int32_t t2,
+     int32_t v3,
+     int32_t t3);
+
+
+ +
+

ewol::Face ()

+ +
+Face(int32_t v1,
+     int32_t t1,
+     int32_t n1,
+     int32_t v2,
+     int32_t t2,
+     int32_t n2,
+     int32_t v3,
+     int32_t t3,
+     int32_t n3);
+
+
+ +
+
+ + diff --git a/ewol__FaceIndexing.html b/ewol__FaceIndexing.html new file mode 100644 index 00000000..cca1bd9d --- /dev/null +++ b/ewol__FaceIndexing.html @@ -0,0 +1,143 @@ + + + + + ewol Library + + + + +
+

Class: ewol::FaceIndexing

+
+

Synopsis:

+
+
+ + +

Detail:

+

+ + diff --git a/ewol__FontBase.html b/ewol__FontBase.html new file mode 100644 index 00000000..24ce6ccf --- /dev/null +++ b/ewol__FontBase.html @@ -0,0 +1,230 @@ + + + + + ewol Library + + + + +
+

Class: ewol::FontBase

+
+

Synopsis:

+
++                FontBase          (const std::string & _fontName);
+ ~FontBase (void);
+ const char * getType (void);
+ 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::EObject
+    +--> ewol::Resource
+        +--> ewol::FontBase
+            +--> ewol::FontFreeType
+
+
+

Detail:

+

ewol::FontBase ()

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

ewol::~FontBase ()

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

getType ()

+ +
+const char * getType(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__FontFreeType.html b/ewol__FontFreeType.html new file mode 100644 index 00000000..b59726a9 --- /dev/null +++ b/ewol__FontFreeType.html @@ -0,0 +1,248 @@ + + + + + ewol Library + + + + +
+

Class: ewol::FontFreeType

+
+

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::FontBase * keep (const std::string & _filename);
+ static void release (ewol::FontBase * & _object);
# FontFreeType (const std::string & _fontName);
# ~FontFreeType (void);
- void display (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::FontBase
+            +--> ewol::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::keep ()

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

ewol::release ()

+ +
+static void release(ewol::FontBase * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::FontFreeType ()

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

ewol::~FontFreeType ()

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

display ()

+ +
+void display(void);
+
+
+ +
+
+ + diff --git a/ewol__Fps.html b/ewol__Fps.html new file mode 100644 index 00000000..c8475ad2 --- /dev/null +++ b/ewol__Fps.html @@ -0,0 +1,204 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Fps

+
+

Synopsis:

+
++        Fps               (const char * displayName,
bool displayFPS);
+ ~Fps (void);
+ 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 +*/

Detail:

+

ewol::Fps ()

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

+ +
+

ewol::~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__GlyphProperty.html b/ewol__GlyphProperty.html new file mode 100644 index 00000000..dc8d8e45 --- /dev/null +++ b/ewol__GlyphProperty.html @@ -0,0 +1,197 @@ + + + + + ewol Library + + + + +
+

Class: ewol::GlyphProperty

+
+

Synopsis:

+
++        GlyphProperty  (void);
+ float kerningGet (const char32_t _charcode);
+ void kerningAdd (const char32_t _charcode,
float _value);
+ void kerningClear (void);
+ bool exist (void);
+ void setNotExist (void);
+ + +

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__Image.html b/ewol__Image.html new file mode 100644 index 00000000..4cb7c371 --- /dev/null +++ b/ewol__Image.html @@ -0,0 +1,416 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Image

+
+

Synopsis:

+
++                Image             (const std::string & _imageName);
+ ~Image (void);
+ 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::Image
+        +--> ewol::Sprite
+
+
+

Detail:

+

ewol::Image ()

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

ewol::~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__Kerning.html b/ewol__Kerning.html new file mode 100644 index 00000000..31932303 --- /dev/null +++ b/ewol__Kerning.html @@ -0,0 +1,201 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Kerning

+
+

Synopsis:

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

Description:

+/** +* @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__Light.html b/ewol__Light.html new file mode 100644 index 00000000..cac807c0 --- /dev/null +++ b/ewol__Light.html @@ -0,0 +1,225 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Light

+
+

Synopsis:

+
++                       Light            (void);
+ ~Light (void);
+ void link (ewol::Program * _prog,
const std::string & _baseName);
+ void draw (ewol::Program * _prog);
+ void setDirection (const vec3 & val);
+ void setHalfPlane (const vec3 & val);
+ void setAmbientColor (const vec4 & val);
+ void setDiffuseColor (const vec4 & val);
+ void setSpecularColor (const vec4 & val);
+ friend etk::CCout & operator<< (etk::CCout & _os,
const ewol::Light & _obj);
+ + +

Detail:

+

ewol::Light ()

+ +
+Light(void);
+
+
+ +
+

ewol::~Light ()

+ +
+~Light(void);
+
+
+ +
+

link ()

+ +
+void link(ewol::Program * _prog,
+          const std::string & _baseName);
+
+
+ +
+

draw ()

+ +
+void draw(ewol::Program * _prog);
+
+
+ +
+

setDirection ()

+ +
+void setDirection(const vec3 & val);
+
+
+ +
+

setHalfPlane ()

+ +
+void setHalfPlane(const vec3 & val);
+
+
+ +
+

setAmbientColor ()

+ +
+void setAmbientColor(const vec4 & val);
+
+
+ +
+

setDiffuseColor ()

+ +
+void setDiffuseColor(const vec4 & val);
+
+
+ +
+

setSpecularColor ()

+ +
+void setSpecularColor(const vec4 & val);
+
+
+ +
+

operator<< ()

+ +
+friend etk::CCout & operator<<(etk::CCout & _os,
+                               const ewol::Light & _obj);
+
+
+ +
+
+ + diff --git a/ewol__Material.html b/ewol__Material.html new file mode 100644 index 00000000..656b8f85 --- /dev/null +++ b/ewol__Material.html @@ -0,0 +1,232 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Material

+
+

Synopsis:

+
++                  Material          (void);
+ ~Material (void);
+ void draw (ewol::Program * _prog,
const MaterialGlId & _glID);
+ void setAmbientFactor (const vec4 & _val);
+ void setDiffuseFactor (const vec4 & _val);
+ void setSpecularFactor (const vec4 & _val);
+ void setShininess (float _val);
+ void setTexture0 (const std::string & _filename);
+ void setImageSize (const ivec2 & _newSize);
+ egami::Image * get (void);
+ void flush (void);
+ + +

Detail:

+

ewol::Material ()

+ +
+Material(void);
+
+
+ +
+

ewol::~Material ()

+ +
+~Material(void);
+
+
+ +
+

draw ()

+ +
+void draw(ewol::Program * _prog,
+          const MaterialGlId & _glID);
+
+
+ +
+

setAmbientFactor ()

+ +
+void setAmbientFactor(const vec4 & _val);
+
+
+ +
+

setDiffuseFactor ()

+ +
+void setDiffuseFactor(const vec4 & _val);
+
+
+ +
+

setSpecularFactor ()

+ +
+void setSpecularFactor(const vec4 & _val);
+
+
+ +
+

setShininess ()

+ +
+void setShininess(float _val);
+
+
+ +
+

setTexture0 ()

+ +
+void setTexture0(const std::string & _filename);
+
+
+ +
+

setImageSize ()

+ +
+void setImageSize(const ivec2 & _newSize);
+
+
+ +
+

get ()

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

flush ()

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

Class: ewol::MaterialGlId

+
+

Synopsis:

+
++        MaterialGlId  (void);
+ void link (ewol::Program * _prog,
const std::string & _baseName);
+ + +

Detail:

+

ewol::MaterialGlId ()

+ +
+MaterialGlId(void);
+
+
+ +
+

link ()

+ +
+void link(ewol::Program * _prog,
+          const std::string & _baseName);
+
+
+ +
+
+ + diff --git a/ewol__Mesh.html b/ewol__Mesh.html new file mode 100644 index 00000000..20ac8790 --- /dev/null +++ b/ewol__Mesh.html @@ -0,0 +1,333 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Mesh

+
+

Synopsis:

+
++  const char *                               getType                (void);
+ void draw (mat4 & _positionMatrix,
bool _enableDepthTest,
bool _enableDepthUpdate);
+ void generateVBO (void);
+ void createViewBox (const std::string & _materialName,
float _size);
+ void addMaterial (const std::string & _name,
ewol::Material * _data);
+ void setCheckNormal (bool _status);
+ bool getCheckNormal (void);
+ const std::vector & getPhysicalProperties (void);
+ void setShape (void * _shape);
+ void * getShape (void);
+ void setFreeShapeFunction (void(*_functionFreeShape)(void*_pointer));
+ static ewol::Mesh * keep (const std::string & _meshname);
+ static void release (ewol::Mesh * & _object);
# Mesh (const std::string & _fileName,
const std::string & _shaderName);
# ~Mesh (void);
- void calculateNormaleFace (void);
- void calculateNormaleEdge (void);
- bool loadOBJ (const std::string & _fileName);
- bool loadEMF (const std::string & _fileName);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::Mesh
+
+
+

Detail:

+

getType ()

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

draw ()

+ +
+void draw(mat4 & _positionMatrix,
+          bool _enableDepthTest,
+          bool _enableDepthUpdate);
+
+
+ +
+

generateVBO ()

+ +
+void generateVBO(void);
+
+
+ +
+

createViewBox ()

+ +
+void createViewBox(const std::string & _materialName,
+                   float _size);
+
+
+ +
+

addMaterial ()

+ +
+void addMaterial(const std::string & _name,
+                 ewol::Material * _data);
+
+
+ +
+

setCheckNormal ()

+ +
+void setCheckNormal(bool _status);
+
+set the check of normal position befor sending it to the openGl card +
+
+ +
+

getCheckNormal ()

+ +
+bool getCheckNormal(void);
+
+get the check value of normal position befor sending it to the openGl card +
+
+ +
+

getPhysicalProperties ()

+ +
+const std::vector & getPhysicalProperties(void);
+
+
+ +
+

setShape ()

+ +
+void setShape(void * _shape);
+
+set the shape pointer (no type == > user might know it ...) +
+
+ +
+

getShape ()

+ +
+void * getShape(void);
+
+get the pointer on the shame (no type) +
+
+ +
+

setFreeShapeFunction ()

+ +
+void setFreeShapeFunction(void(*_functionFreeShape)(void*_pointer));
+
+
+ +
+

ewol::keep ()

+ +
+static ewol::Mesh * keep(const std::string & _meshname);
+
+keep the resource pointer. +
Notes: Never free this pointer by your own... +
+
+ +
+

ewol::release ()

+ +
+static void release(ewol::Mesh * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::Mesh ()

+ +
+Mesh(const std::string & _fileName,
+     const std::string & _shaderName);
+
+
+ +
+

ewol::~Mesh ()

+ +
+~Mesh(void);
+
+
+ +
+

calculateNormaleFace ()

+ +
+void calculateNormaleFace(void);
+
+
+ +
+

calculateNormaleEdge ()

+ +
+void calculateNormaleEdge(void);
+
+
+ +
+

loadOBJ ()

+ +
+bool loadOBJ(const std::string & _fileName);
+
+
+ +
+

loadEMF ()

+ +
+bool loadEMF(const std::string & _fileName);
+
+
+ +
+
+ + diff --git a/ewol__PhysicsBox.html b/ewol__PhysicsBox.html new file mode 100644 index 00000000..3943f887 --- /dev/null +++ b/ewol__PhysicsBox.html @@ -0,0 +1,213 @@ + + + + + ewol Library + + + + +
+

Class: ewol::PhysicsBox

+
+

Synopsis:

+
++                      PhysicsBox  (void);
+ ~PhysicsBox (void);
+ bool parse (const char * _line);
+ void display (void);
+ enum type getType (void);
+ const vec3 & getSize (void);
+ const PhysicsBox * toBox (void);
+ PhysicsBox * toBox (void);
+ + +

Object Hierarchy:

+
+ewol::PhysicsShape
+    +--> ewol::PhysicsBox
+
+
+

Detail:

+

ewol::PhysicsBox ()

+ +
+PhysicsBox(void);
+
+
+ +
+

ewol::~PhysicsBox ()

+ +
+~PhysicsBox(void);
+
+
+ +
+

parse ()

+ +
+bool parse(const char * _line);
+
+
+ +
+

display ()

+ +
+void display(void);
+
+
+ +
+

getType ()

+ +
+enum type getType(void);
+
+
+ +
+

getSize ()

+ +
+const vec3 & getSize(void);
+
+
+ +
+

toBox ()

+ +
+const PhysicsBox * toBox(void);
+
+
+ +
+

toBox ()

+ +
+PhysicsBox * toBox(void);
+
+
+ +
+
+ + diff --git a/ewol__PhysicsCapsule.html b/ewol__PhysicsCapsule.html new file mode 100644 index 00000000..7882e11d --- /dev/null +++ b/ewol__PhysicsCapsule.html @@ -0,0 +1,221 @@ + + + + + ewol Library + + + + +
+

Class: ewol::PhysicsCapsule

+
+

Synopsis:

+
++                          PhysicsCapsule  (void);
+ ~PhysicsCapsule (void);
+ bool parse (const char * _line);
+ void display (void);
+ enum type getType (void);
+ float getRadius (void);
+ float getHeight (void);
+ const PhysicsCapsule * toCapsule (void);
+ PhysicsCapsule * toCapsule (void);
+ + +

Object Hierarchy:

+
+ewol::PhysicsShape
+    +--> ewol::PhysicsCapsule
+
+
+

Detail:

+

ewol::PhysicsCapsule ()

+ +
+PhysicsCapsule(void);
+
+
+ +
+

ewol::~PhysicsCapsule ()

+ +
+~PhysicsCapsule(void);
+
+
+ +
+

parse ()

+ +
+bool parse(const char * _line);
+
+
+ +
+

display ()

+ +
+void display(void);
+
+
+ +
+

getType ()

+ +
+enum type getType(void);
+
+
+ +
+

getRadius ()

+ +
+float getRadius(void);
+
+
+ +
+

getHeight ()

+ +
+float getHeight(void);
+
+
+ +
+

toCapsule ()

+ +
+const PhysicsCapsule * toCapsule(void);
+
+
+ +
+

toCapsule ()

+ +
+PhysicsCapsule * toCapsule(void);
+
+
+ +
+
+ + diff --git a/ewol__PhysicsCone.html b/ewol__PhysicsCone.html new file mode 100644 index 00000000..db6a87c5 --- /dev/null +++ b/ewol__PhysicsCone.html @@ -0,0 +1,221 @@ + + + + + ewol Library + + + + +
+

Class: ewol::PhysicsCone

+
+

Synopsis:

+
++                       PhysicsCone  (void);
+ ~PhysicsCone (void);
+ bool parse (const char * _line);
+ void display (void);
+ enum type getType (void);
+ float getRadius (void);
+ float getHeight (void);
+ const PhysicsCone * toCone (void);
+ PhysicsCone * toCone (void);
+ + +

Object Hierarchy:

+
+ewol::PhysicsShape
+    +--> ewol::PhysicsCone
+
+
+

Detail:

+

ewol::PhysicsCone ()

+ +
+PhysicsCone(void);
+
+
+ +
+

ewol::~PhysicsCone ()

+ +
+~PhysicsCone(void);
+
+
+ +
+

parse ()

+ +
+bool parse(const char * _line);
+
+
+ +
+

display ()

+ +
+void display(void);
+
+
+ +
+

getType ()

+ +
+enum type getType(void);
+
+
+ +
+

getRadius ()

+ +
+float getRadius(void);
+
+
+ +
+

getHeight ()

+ +
+float getHeight(void);
+
+
+ +
+

toCone ()

+ +
+const PhysicsCone * toCone(void);
+
+
+ +
+

toCone ()

+ +
+PhysicsCone * toCone(void);
+
+
+ +
+
+ + diff --git a/ewol__PhysicsConvexHull.html b/ewol__PhysicsConvexHull.html new file mode 100644 index 00000000..81c37a81 --- /dev/null +++ b/ewol__PhysicsConvexHull.html @@ -0,0 +1,221 @@ + + + + + ewol Library + + + + +
+

Class: ewol::PhysicsConvexHull

+
+

Synopsis:

+
++                             PhysicsConvexHull  (void);
+ ~PhysicsConvexHull (void);
+ bool parse (const char * _line);
+ void display (void);
+ enum type getType (void);
+ vec3 getScale (void);
+ const std::vector & getPointList (void);
+ const PhysicsConvexHull * toConvexHull (void);
+ PhysicsConvexHull * toConvexHull (void);
+ + +

Object Hierarchy:

+
+ewol::PhysicsShape
+    +--> ewol::PhysicsConvexHull
+
+
+

Detail:

+

ewol::PhysicsConvexHull ()

+ +
+PhysicsConvexHull(void);
+
+
+ +
+

ewol::~PhysicsConvexHull ()

+ +
+~PhysicsConvexHull(void);
+
+
+ +
+

parse ()

+ +
+bool parse(const char * _line);
+
+
+ +
+

display ()

+ +
+void display(void);
+
+
+ +
+

getType ()

+ +
+enum type getType(void);
+
+
+ +
+

getScale ()

+ +
+vec3 getScale(void);
+
+
+ +
+

getPointList ()

+ +
+const std::vector & getPointList(void);
+
+
+ +
+

toConvexHull ()

+ +
+const PhysicsConvexHull * toConvexHull(void);
+
+
+ +
+

toConvexHull ()

+ +
+PhysicsConvexHull * toConvexHull(void);
+
+
+ +
+
+ + diff --git a/ewol__PhysicsCylinder.html b/ewol__PhysicsCylinder.html new file mode 100644 index 00000000..c9fc9855 --- /dev/null +++ b/ewol__PhysicsCylinder.html @@ -0,0 +1,213 @@ + + + + + ewol Library + + + + +
+

Class: ewol::PhysicsCylinder

+
+

Synopsis:

+
++                           PhysicsCylinder  (void);
+ ~PhysicsCylinder (void);
+ bool parse (const char * _line);
+ void display (void);
+ enum type getType (void);
+ vec3 getSize (void);
+ const PhysicsCylinder * toCylinder (void);
+ PhysicsCylinder * toCylinder (void);
+ + +

Object Hierarchy:

+
+ewol::PhysicsShape
+    +--> ewol::PhysicsCylinder
+
+
+

Detail:

+

ewol::PhysicsCylinder ()

+ +
+PhysicsCylinder(void);
+
+
+ +
+

ewol::~PhysicsCylinder ()

+ +
+~PhysicsCylinder(void);
+
+
+ +
+

parse ()

+ +
+bool parse(const char * _line);
+
+
+ +
+

display ()

+ +
+void display(void);
+
+
+ +
+

getType ()

+ +
+enum type getType(void);
+
+
+ +
+

getSize ()

+ +
+vec3 getSize(void);
+
+
+ +
+

toCylinder ()

+ +
+const PhysicsCylinder * toCylinder(void);
+
+
+ +
+

toCylinder ()

+ +
+PhysicsCylinder * toCylinder(void);
+
+
+ +
+
+ + diff --git a/ewol__PhysicsShape.html b/ewol__PhysicsShape.html new file mode 100644 index 00000000..ecadc77f --- /dev/null +++ b/ewol__PhysicsShape.html @@ -0,0 +1,362 @@ + + + + + ewol Library + + + + +
+

Class: ewol::PhysicsShape

+
+

Synopsis:

+
++  static PhysicsShape *      create        (const std::string & _name);
+ PhysicsShape (void);
+ ~PhysicsShape (void);
+ enum type getType (void);
+ bool parse (const char * _line);
+ void display (void);
+ const vec4 & getQuaternion (void);
+ const vec3 & getOrigin (void);
+ bool isBox (void);
+ bool isCylinder (void);
+ bool isCapsule (void);
+ bool isCone (void);
+ bool isConvexHull (void);
+ bool isSphere (void);
+ const PhysicsBox * toBox (void);
+ PhysicsBox * toBox (void);
+ const PhysicsCylinder * toCylinder (void);
+ PhysicsCylinder * toCylinder (void);
+ const PhysicsCapsule * toCapsule (void);
+ PhysicsCapsule * toCapsule (void);
+ const PhysicsCone * toCone (void);
+ PhysicsCone * toCone (void);
+ const PhysicsConvexHull * toConvexHull (void);
+ PhysicsConvexHull * toConvexHull (void);
+ const PhysicsSphere * toSphere (void);
+ PhysicsSphere * toSphere (void);
+ + +

Object Hierarchy:

+
+ewol::PhysicsShape
+    +--> ewol::PhysicsBox
+    +--> ewol::PhysicsCone
+    +--> ewol::PhysicsCapsule
+    +--> ewol::PhysicsConvexHull
+    +--> ewol::PhysicsSphere
+    +--> ewol::PhysicsCylinder
+
+
+

Detail:

+

ewol::create ()

+ +
+static PhysicsShape * create(const std::string & _name);
+
+
+ +
+

ewol::PhysicsShape ()

+ +
+PhysicsShape(void);
+
+
+ +
+

ewol::~PhysicsShape ()

+ +
+~PhysicsShape(void);
+
+
+ +
+

getType ()

+ +
+enum type getType(void);
+
+
+ +
+

parse ()

+ +
+bool parse(const char * _line);
+
+
+ +
+

display ()

+ +
+void display(void);
+
+
+ +
+

getQuaternion ()

+ +
+const vec4 & getQuaternion(void);
+
+
+ +
+

getOrigin ()

+ +
+const vec3 & getOrigin(void);
+
+
+ +
+

isBox ()

+ +
+bool isBox(void);
+
+
+ +
+

isCylinder ()

+ +
+bool isCylinder(void);
+
+
+ +
+

isCapsule ()

+ +
+bool isCapsule(void);
+
+
+ +
+

isCone ()

+ +
+bool isCone(void);
+
+
+ +
+

isConvexHull ()

+ +
+bool isConvexHull(void);
+
+
+ +
+

isSphere ()

+ +
+bool isSphere(void);
+
+
+ +
+

toBox ()

+ +
+const PhysicsBox * toBox(void);
+
+
+ +
+

toBox ()

+ +
+PhysicsBox * toBox(void);
+
+
+ +
+

toCylinder ()

+ +
+const PhysicsCylinder * toCylinder(void);
+
+
+ +
+

toCylinder ()

+ +
+PhysicsCylinder * toCylinder(void);
+
+
+ +
+

toCapsule ()

+ +
+const PhysicsCapsule * toCapsule(void);
+
+
+ +
+

toCapsule ()

+ +
+PhysicsCapsule * toCapsule(void);
+
+
+ +
+

toCone ()

+ +
+const PhysicsCone * toCone(void);
+
+
+ +
+

toCone ()

+ +
+PhysicsCone * toCone(void);
+
+
+ +
+

toConvexHull ()

+ +
+const PhysicsConvexHull * toConvexHull(void);
+
+
+ +
+

toConvexHull ()

+ +
+PhysicsConvexHull * toConvexHull(void);
+
+
+ +
+

toSphere ()

+ +
+const PhysicsSphere * toSphere(void);
+
+
+ +
+

toSphere ()

+ +
+PhysicsSphere * toSphere(void);
+
+
+ +
+
+ + diff --git a/ewol__PhysicsSphere.html b/ewol__PhysicsSphere.html new file mode 100644 index 00000000..e0726909 --- /dev/null +++ b/ewol__PhysicsSphere.html @@ -0,0 +1,213 @@ + + + + + ewol Library + + + + +
+

Class: ewol::PhysicsSphere

+
+

Synopsis:

+
++                         PhysicsSphere  (void);
+ ~PhysicsSphere (void);
+ bool parse (const char * _line);
+ void display (void);
+ enum type getType (void);
+ float getRadius (void);
- const PhysicsSphere * toSphere (void);
- PhysicsSphere * toSphere (void);
+ + +

Object Hierarchy:

+
+ewol::PhysicsShape
+    +--> ewol::PhysicsSphere
+
+
+

Detail:

+

ewol::PhysicsSphere ()

+ +
+PhysicsSphere(void);
+
+
+ +
+

ewol::~PhysicsSphere ()

+ +
+~PhysicsSphere(void);
+
+
+ +
+

parse ()

+ +
+bool parse(const char * _line);
+
+
+ +
+

display ()

+ +
+void display(void);
+
+
+ +
+

getType ()

+ +
+enum type getType(void);
+
+
+ +
+

getRadius ()

+ +
+float getRadius(void);
+
+
+ +
+

toSphere ()

+ +
+const PhysicsSphere * toSphere(void);
+
+
+ +
+

toSphere ()

+ +
+PhysicsSphere * toSphere(void);
+
+
+ +
+
+ + diff --git a/ewol__Program.html b/ewol__Program.html new file mode 100644 index 00000000..260e594c --- /dev/null +++ b/ewol__Program.html @@ -0,0 +1,694 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Program

+
+

Synopsis:

+
++  const char *            getType               (void);
+ 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::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::Program * keep (const std::string & _filename);
+ static void release (ewol::Program * & _object);
# Program (const std::string & filename);
# ~Program (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::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:

+

getType ()

+ +
+const char * getType(void);
+
+Generic function that get the resouces name of his type. +
+
+ +
+

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::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::keep ()

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

ewol::release ()

+ +
+static void release(ewol::Program * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::Program ()

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

ewol::~Program ()

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

+ +
+
+ + diff --git a/ewol__Resource.html b/ewol__Resource.html new file mode 100644 index 00000000..e071005d --- /dev/null +++ b/ewol__Resource.html @@ -0,0 +1,253 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Resource

+
+

Synopsis:

+
++                                  Resource             (void);
+ Resource (const std::string & _name);
+ ~Resource (void);
+ 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::ResourceManager & getManager (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::FontBase
+        +--> ewol::VirtualBufferObject
+        +--> ewol::Shader
+        +--> ewol::Mesh
+        +--> ewol::Program
+        +--> ewol::Colored3DObject
+        +--> ewol::Texture
+        +--> ewol::ConfigFile
+
+
+

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::ResourceManager & getManager(void);
+
+
+ +
+
+ + diff --git a/ewol__ResourceManager.html b/ewol__ResourceManager.html new file mode 100644 index 00000000..2a393dd6 --- /dev/null +++ b/ewol__ResourceManager.html @@ -0,0 +1,249 @@ + + + + + ewol Library + + + + +
+

Class: ewol::ResourceManager

+
+

Synopsis:

+
++                    ResourceManager          (void);
+ ~ResourceManager (void);
+ 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::ResourceManager ()

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

+ +
+

ewol::~ResourceManager ()

+ +
+~ResourceManager(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__Shader.html b/ewol__Shader.html new file mode 100644 index 00000000..636ea4a4 --- /dev/null +++ b/ewol__Shader.html @@ -0,0 +1,272 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Shader

+
+

Synopsis:

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

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::Shader
+
+
+

Description:

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

Detail:

+

getType ()

+ +
+const char * getType(void);
+
+Generic function that get the resouces name of his type. +
+
+ +
+

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::keep ()

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

ewol::release ()

+ +
+static void release(ewol::Shader * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::Shader ()

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

ewol::~Shader ()

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

+ +
+
+ + diff --git a/ewol__Shaper.html b/ewol__Shaper.html new file mode 100644 index 00000000..1f82bd7d --- /dev/null +++ b/ewol__Shaper.html @@ -0,0 +1,378 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Shaper

+
+

Synopsis:

+
++                       Shaper                     (const std::string & _shaperName);
+ ~Shaper (void);
+ 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::EventTime & _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::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::Shaper ()

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

ewol::~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::EventTime & _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__SimpleConfigElement.html b/ewol__SimpleConfigElement.html new file mode 100644 index 00000000..12a45717 --- /dev/null +++ b/ewol__SimpleConfigElement.html @@ -0,0 +1,191 @@ + + + + + ewol Library + + + + +
+

Class: ewol::SimpleConfigElement

+
+

Synopsis:

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

Detail:

+

ewol::SimpleConfigElement ()

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

ewol::~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__SpecialKey.html b/ewol__SpecialKey.html new file mode 100644 index 00000000..f9c8a562 --- /dev/null +++ b/ewol__SpecialKey.html @@ -0,0 +1,248 @@ + + + + + ewol Library + + + + +
+

Class: ewol::SpecialKey

+
+

Synopsis:

+
++        SpecialKey     (void);
+ bool isSetCapsLock (void);
+ bool isSetShift (void);
+ bool isSetCtrl (void);
+ bool isSetMeta (void);
+ bool isSetAlt (void);
+ bool isSetAltGr (void);
+ bool isSetNumLock (void);
+ bool isSetInsert (void);
+ + +

Detail:

+

ewol::SpecialKey ()

+ +
+SpecialKey(void);
+
+Main constructor +

+ +
+

isSetCapsLock ()

+ +
+bool isSetCapsLock(void);
+
+get the current CapLock Status +
+
+ +
+

isSetShift ()

+ +
+bool isSetShift(void);
+
+get the current Shift key status +
+
+ +
+

isSetCtrl ()

+ +
+bool isSetCtrl(void);
+
+get the Current Control key status +
+
+ +
+

isSetMeta ()

+ +
+bool isSetMeta(void);
+
+get the current Meta key status (also named windows or apple key) +
+
+ +
+

isSetAlt ()

+ +
+bool isSetAlt(void);
+
+get the current Alt key status +
+
+ +
+

isSetAltGr ()

+ +
+bool isSetAltGr(void);
+
+get the current Alt-Gr key status +
+
+ +
+

isSetNumLock ()

+ +
+bool isSetNumLock(void);
+
+get the current Ver-num key status +
+
+ +
+

isSetInsert ()

+ +
+bool isSetInsert(void);
+
+get the current Intert key status +
+
+ +
+
+ + diff --git a/ewol__SpecialKey__SpecialKey__union__.html b/ewol__SpecialKey__SpecialKey__union__.html new file mode 100644 index 00000000..031a79ee --- /dev/null +++ b/ewol__SpecialKey__SpecialKey__union__.html @@ -0,0 +1,143 @@ + + + + + ewol Library + + + + +
+

Class: ewol::SpecialKey::SpecialKey::union ::

+
+

Synopsis:

+
+
+ + +

Detail:

+

+ + diff --git a/ewol__SpecialKey__union.html b/ewol__SpecialKey__union.html new file mode 100644 index 00000000..0f6ac625 --- /dev/null +++ b/ewol__SpecialKey__union.html @@ -0,0 +1,143 @@ + + + + + ewol Library + + + + +
+

Class: ewol::SpecialKey::union

+
+

Synopsis:

+
+
+ + +

Detail:

+

+ + diff --git a/ewol__Sprite.html b/ewol__Sprite.html new file mode 100644 index 00000000..b863986e --- /dev/null +++ b/ewol__Sprite.html @@ -0,0 +1,185 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Sprite

+
+

Synopsis:

+
++        Sprite       (const std::string & _imageName,
const ivec2 & _nbSprite);
+ ~Sprite ();
+ void printSprite (const ivec2 & _spriteID,
const vec2 & _size);
+ void printSprite (const ivec2 & _spriteID,
const vec3 & _size);
+ + +

Object Hierarchy:

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

Detail:

+

ewol::Sprite ()

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

ewol::~Sprite ()

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

printSprite ()

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

printSprite ()

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

Class: ewol::Text

+
+

Synopsis:

+
++  ewol::Drawing &  getDrawing              (void);
+ Text (const std::string & _fontName,
int32_t _fontSize);
+ ~Text (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::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::Text
+
+
+

Detail:

+

getDrawing ()

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

ewol::Text ()

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

ewol::~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::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__TextDecoration.html b/ewol__TextDecoration.html new file mode 100644 index 00000000..3644f297 --- /dev/null +++ b/ewol__TextDecoration.html @@ -0,0 +1,154 @@ + + + + + ewol Library + + + + +
+

Class: ewol::TextDecoration

+
+

Synopsis:

+
++        TextDecoration  (void);
+ + +

Description:

+/** +* @brief This class represent the specific display for every char in the string ... +*/

Detail:

+

ewol::TextDecoration ()

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

Class: ewol::Texture

+
+

Synopsis:

+
++  void                   updateContext        (void);
+ void removeContext (void);
+ void removeContextToLate (void);
+ GLuint getId (void);
+ vec2 getUsableSize (void);
+ const char * getType (void);
+ void setImageSize (ivec2 newSize);
+ egami::Image & get (void);
+ void flush (void);
+ static ewol::Texture * keep (void);
+ static void release (ewol::Texture * & _object);
# Texture (const std::string & _filename);
# Texture (void);
# ~Texture (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::Texture
+            +--> ewol::TextureFile
+            +--> ewol::TexturedFont
+
+
+

Detail:

+

updateContext ()

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

removeContext ()

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

removeContextToLate ()

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

getId ()

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

getUsableSize ()

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

getType ()

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

setImageSize ()

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

get ()

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

flush ()

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

ewol::keep ()

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

ewol::release ()

+ +
+static void release(ewol::Texture * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::Texture ()

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

ewol::Texture ()

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

ewol::~Texture ()

+ +
+~Texture(void);
+
+
+ +
+
+ + diff --git a/ewol__TextureFile.html b/ewol__TextureFile.html new file mode 100644 index 00000000..0750dedc --- /dev/null +++ b/ewol__TextureFile.html @@ -0,0 +1,221 @@ + + + + + ewol Library + + + + +
+

Class: ewol::TextureFile

+
+

Synopsis:

+
++  const char *                getType      (void);
+ const vec2 & getRealSize (void);
+ static ewol::TextureFile * keep (const std::string & _filename,
ivec2 _size);
+ static void release (ewol::TextureFile * & _object);
- TextureFile (const std::string & _genName);
- TextureFile (std::string _genName,
const std::string & _fileName,
const ivec2 & _size);
- ~TextureFile (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::Texture
+            +--> ewol::TextureFile
+
+
+

Detail:

+

getType ()

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

getRealSize ()

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

ewol::keep ()

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

ewol::release ()

+ +
+static void release(ewol::TextureFile * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::TextureFile ()

+ +
+TextureFile(const std::string & _genName);
+
+
+ +
+

ewol::TextureFile ()

+ +
+TextureFile(std::string _genName,
+            const std::string & _fileName,
+            const ivec2 & _size);
+
+
+ +
+

ewol::~TextureFile ()

+ +
+~TextureFile(void);
+
+
+ +
+
+ + diff --git a/ewol__TexturedFont.html b/ewol__TexturedFont.html new file mode 100644 index 00000000..7ac0f52d --- /dev/null +++ b/ewol__TexturedFont.html @@ -0,0 +1,269 @@ + + + + + ewol Library + + + + +
+

Class: ewol::TexturedFont

+
+

Synopsis:

+
++  const char *                 getType          (void);
+ 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::TexturedFont * keep (const std::string & _filename);
+ static void release (ewol::TexturedFont * & _object);
# TexturedFont (const std::string & _fontName);
# ~TexturedFont (void);
- bool addGlyph (const char32_t & _val);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::Texture
+            +--> ewol::TexturedFont
+
+
+

Detail:

+

getType ()

+ +
+const char * getType(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) +
+
+ +
+

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::keep ()

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

ewol::release ()

+ +
+static void release(ewol::TexturedFont * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::TexturedFont ()

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

ewol::~TexturedFont ()

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

addGlyph ()

+ +
+bool addGlyph(const char32_t & _val);
+
+add a glyph in a texture font. +
+
+ +
+
+ + diff --git a/ewol__VirtualBufferObject.html b/ewol__VirtualBufferObject.html new file mode 100644 index 00000000..ff9dfa05 --- /dev/null +++ b/ewol__VirtualBufferObject.html @@ -0,0 +1,354 @@ + + + + + ewol Library + + + + +
+

Class: ewol::VirtualBufferObject

+
+

Synopsis:

+
++  const char *                        getType              (void);
+ 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::VirtualBufferObject * keep (int32_t _number);
+ static void release (ewol::VirtualBufferObject * & _object);
# VirtualBufferObject (int32_t _number);
# ~VirtualBufferObject (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Resource
+        +--> ewol::VirtualBufferObject
+
+
+

Description:

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

Detail:

+

getType ()

+ +
+const char * getType(void);
+
+Generic function that get the resouces name of his type. +
+
+ +
+

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::keep ()

+ +
+static ewol::VirtualBufferObject * keep(int32_t _number);
+
+keep the resource pointer. +
Notes: Never free this pointer by your own... +
+
+ +
+

ewol::release ()

+ +
+static void release(ewol::VirtualBufferObject * & _object);
+
+release the keeped resources +
+
+ +
+

ewol::VirtualBufferObject ()

+ +
+VirtualBufferObject(int32_t _number);
+
+Constructor of this VBO. +
+
+ +
+

ewol::~VirtualBufferObject ()

+ +
+~VirtualBufferObject(void);
+
+Destructor of this VBO. +

+ +
+
+ + diff --git a/ewol__Widget.html b/ewol__Widget.html new file mode 100644 index 00000000..6aaa3489 --- /dev/null +++ b/ewol__Widget.html @@ -0,0 +1,1215 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Widget

+
+

Synopsis:

+
++                           Widget                  (void);
+ ~Widget (void);
+ 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::EventTime & _event);
+ ewol::Widget * getWidgetAtPos (const vec2 & _pos);
+ ewol::Widget * getWidgetNamed (const std::string & _widgetName);
+ bool systemEventInput (ewol::EventInputSystem & _event);
+ bool systemEventEntry (ewol::EventEntrySystem & _event);
+ void onEventClipboard (enum ewol::clipBoard::clipboardListe _clipboardID);
+ bool onEventShortCut (ewol::SpecialKey & _special,
char32_t _unicodeValue,
enum ewol::keyEvent::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::cursorDisplay _newCursor);
+ enum ewol::cursorDisplay getCursor (void);
+ void onObjectRemove (ewol::EObject * _removeObject);
+ bool loadXML (exml::Element * _node);
+ void requestUpdateSize (void);
+ ewol::WidgetManager & getWidgetManager (void);
+ ewol::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::EventInput & _event);
# bool onEventEntry (const ewol::EventEntry & _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::EConfig & _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::EObject
+    +--> ewol::Widget
+        +--> widget::Spacer
+        +--> widget::ContainerN
+        +--> widget::ProgressBar
+        +--> widget::Slider
+        +--> widget::Entry
+        +--> widget::Joystick
+        +--> widget::Container
+        +--> ewol::Windows
+        +--> widget::ColorBar
+        +--> widget::ButtonColor
+        +--> widget::Label
+        +--> widget::Mesh
+        +--> widget::Button
+        +--> widget::WidgetScrooled
+        +--> widget::Image
+        +--> widget::Gird
+        +--> widget::CheckBox
+
+
+

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::EventTime & _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::EventInputSystem & _event);
+
+{SYSTEM} system event input (only meta widget might overwrite this function). +
+
+ +
+

systemEventEntry ()

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

onEventClipboard ()

+ +
+void onEventClipboard(enum ewol::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::SpecialKey & _special,
+                     char32_t _unicodeValue,
+                     enum ewol::keyEvent::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::cursorDisplay _newCursor);
+
+set the cursor display type. +
+
+ +
+

getCursor ()

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

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _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::WidgetManager & getWidgetManager(void);
+
+get the current Widget Manager +

+ +
+

getWindows ()

+ +
+ewol::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::EventInput & _event);
+
+Event on an input of this Widget (finger, mouse, stilet) +
+
+ +
+

onEventEntry ()

+ +
+bool onEventEntry(const ewol::EventEntry & _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::EConfig & _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__WidgetManager.html b/ewol__WidgetManager.html new file mode 100644 index 00000000..fb5d885e --- /dev/null +++ b/ewol__WidgetManager.html @@ -0,0 +1,296 @@ + + + + + ewol Library + + + + +
+

Class: ewol::WidgetManager

+
+

Synopsis:

+
++                  WidgetManager        (void);
+ ~WidgetManager (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:

+

ewol::WidgetManager ()

+ +
+WidgetManager(void);
+
+
+ +
+

ewol::~WidgetManager ()

+ +
+~WidgetManager(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__Windows.html b/ewol__Windows.html new file mode 100644 index 00000000..031c190e --- /dev/null +++ b/ewol__Windows.html @@ -0,0 +1,404 @@ + + + + + ewol Library + + + + +
+

Class: ewol::Windows

+
+

Synopsis:

+
++                             Windows                 (void);
+ ~Windows (void);
+ 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::EObject * _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::EObject
+    +--> ewol::Widget
+        +--> ewol::Windows
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

ewol::Windows ()

+ +
+Windows(void);
+
+
+ +
+

ewol::~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::EObject * _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__clipBoard__clipboardListe.html b/ewol__clipBoard__clipboardListe.html new file mode 100644 index 00000000..8cf9fda8 --- /dev/null +++ b/ewol__clipBoard__clipboardListe.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::clipBoard::clipboardListe

+
+Value :
+ +
+ + diff --git a/ewol__cursorDisplay.html b/ewol__cursorDisplay.html new file mode 100644 index 00000000..65b5e672 --- /dev/null +++ b/ewol__cursorDisplay.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::cursorDisplay

+
+Value :
+ +
+ + diff --git a/ewol__eContext.html b/ewol__eContext.html new file mode 100644 index 00000000..8df693db --- /dev/null +++ b/ewol__eContext.html @@ -0,0 +1,695 @@ + + + + + ewol Library + + + + +
+

Class: ewol::eContext

+
+

Synopsis:

+
++  ewol::CommandLine &      getCmd                     (void);
+ ewol::ConfigFont & getFontDefault (void);
+ ewol::WidgetManager & getWidgetManager (void);
+ ewol::EObjectManager & getEObjectManager (void);
+ ewol::ResourceManager & getResourcesManager (void);
+ eContext (int32_t _argc,
const char * _argv);
+ ~eContext (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::SpecialKey & _special,
char32_t _myChar,
bool _isDown,
bool _isARepeateKey);
+ void OS_SetKeyboardMove (ewol::SpecialKey & _special,
enum ewol::keyEvent::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::EObject * _removeObject);
+ void resetIOEvent (void);
+ void OS_OpenGlContextDestroy (void);
+ void OS_Stop (void);
+ void stop (void);
+ void setWindows (ewol::Windows * _windows);
+ ewol::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::clipBoard::clipboardListe _clipboardID);
+ void clipBoardSet (enum ewol::clipBoard::clipboardListe _clipboardID);
+ void OS_ClipBoardArrive (enum ewol::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::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::CommandLine & getCmd(void);
+
+
+ +
+

getFontDefault ()

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

getWidgetManager ()

+ +
+ewol::WidgetManager & getWidgetManager(void);
+
+
+ +
+

getEObjectManager ()

+ +
+ewol::EObjectManager & getEObjectManager(void);
+
+
+ +
+

getResourcesManager ()

+ +
+ewol::ResourceManager & getResourcesManager(void);
+
+
+ +
+

ewol::eContext ()

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

ewol::~eContext ()

+ +
+~eContext(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::SpecialKey & _special,
+                    char32_t _myChar,
+                    bool _isDown,
+                    bool _isARepeateKey);
+
+
+ +
+

OS_SetKeyboardMove ()

+ +
+void OS_SetKeyboardMove(ewol::SpecialKey & _special,
+                        enum ewol::keyEvent::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::EObject * _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::Windows * _windows);
+
+set the current windows to display : +
+
+ +
+

getWindows ()

+ +
+ewol::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::clipBoard::clipboardListe _clipboardID);
+
+Inform the Gui that we want to have a copy of the clipboard +
+
+ +
+

clipBoardSet ()

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

OS_ClipBoardArrive ()

+ +
+void OS_ClipBoardArrive(enum ewol::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::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__eInput.html b/ewol__eInput.html new file mode 100644 index 00000000..5ed6566a --- /dev/null +++ b/ewol__eInput.html @@ -0,0 +1,312 @@ + + + + + ewol Library + + + + +
+

Class: ewol::eInput

+
+

Synopsis:

+
++           eInput                 (ewol::eContext & _context);
+ ~eInput (void);
+ void setDpi (int32_t newDPI);
+ void motion (enum ewol::keyEvent::type _type,
int _pointerID,
vec2 _pos);
+ void state (enum ewol::keyEvent::type _type,
int _pointerID,
bool _isDown,
vec2 _pos);
+ void onObjectRemove (ewol::EObject * _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_ts * _eventTable,
int32_t _idInput,
enum ewol::keyEvent::type _type);
- void cleanElement (InputPoperty_ts * _eventTable,
int32_t _idInput);
- bool localEventInput (enum ewol::keyEvent::type _type,
ewol::Widget * _destWidget,
int32_t _IdInput,
enum ewol::keyEvent::status _typeEvent,
vec2 _pos);
- int32_t localGetDestinationId (enum ewol::keyEvent::type _type,
ewol::Widget * _destWidget,
int32_t _realInputId);
+ + +

Detail:

+

ewol::eInput ()

+ +
+eInput(ewol::eContext & _context);
+
+
+ +
+

ewol::~eInput ()

+ +
+~eInput(void);
+
+
+ +
+

setDpi ()

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

motion ()

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

state ()

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

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _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_ts * _eventTable,
+                  int32_t _idInput,
+                  enum ewol::keyEvent::type _type);
+
+
+ +
+

cleanElement ()

+ +
+void cleanElement(InputPoperty_ts * _eventTable,
+                  int32_t _idInput);
+
+
+ +
+

localEventInput ()

+ +
+bool localEventInput(enum ewol::keyEvent::type _type,
+                     ewol::Widget * _destWidget,
+                     int32_t _IdInput,
+                     enum ewol::keyEvent::status _typeEvent,
+                     vec2 _pos);
+
+generate the event on the destinated widget. +
+
+ +
+

localGetDestinationId ()

+ +
+int32_t localGetDestinationId(enum ewol::keyEvent::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__font__mode.html b/ewol__font__mode.html new file mode 100644 index 00000000..f53d3cc8 --- /dev/null +++ b/ewol__font__mode.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::font::mode

+
+Value :
+ +
+ + diff --git a/ewol__gravity.html b/ewol__gravity.html new file mode 100644 index 00000000..d2870239 --- /dev/null +++ b/ewol__gravity.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::gravity

+
+Value :
+ +
+ + diff --git a/ewol__keyEvent__keyboard.html b/ewol__keyEvent__keyboard.html new file mode 100644 index 00000000..e7e53742 --- /dev/null +++ b/ewol__keyEvent__keyboard.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::keyEvent::keyboard

+
+Value :
+ +
+ + diff --git a/ewol__keyEvent__status.html b/ewol__keyEvent__status.html new file mode 100644 index 00000000..2b12ada3 --- /dev/null +++ b/ewol__keyEvent__status.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::keyEvent::status

+
+Value :
+ +
+ + diff --git a/ewol__keyEvent__type.html b/ewol__keyEvent__type.html new file mode 100644 index 00000000..2ee93ef9 --- /dev/null +++ b/ewol__keyEvent__type.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::keyEvent::type

+
+Value :
+ +
+ + diff --git a/ewol__openGL__openGlFlags.html b/ewol__openGL__openGlFlags.html new file mode 100644 index 00000000..f3c33328 --- /dev/null +++ b/ewol__openGL__openGlFlags.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::openGL::openGlFlags

+
+Value :
+ +
+ + diff --git a/ewol__orientation.html b/ewol__orientation.html new file mode 100644 index 00000000..495e80f9 --- /dev/null +++ b/ewol__orientation.html @@ -0,0 +1,140 @@ + + + + + ewol Library + + + + +
+

Enum: ewol::orientation

+
+Value :
+ +
+ + diff --git a/ewol__progAttributeElement.html b/ewol__progAttributeElement.html new file mode 100644 index 00000000..80dcf8ee --- /dev/null +++ b/ewol__progAttributeElement.html @@ -0,0 +1,148 @@ + + + + + ewol Library + + + + +
+

Class: ewol::progAttributeElement

+
+

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. +*/

Detail:

+

+ + diff --git a/images/bkg.png b/images/bkg.png deleted file mode 100644 index fcebb5b22999adb792afee1f74bcf4af91db8441..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4261 zcmai24OG(S8mBsUyM3)~ZEIE-v#qwa1Vm(_WaZcF4$Tzl!!$x9YVt?^Am9ho*2lIQ zTie~ak)qq&rWX>8T6nEuDuzAQq;*m$U_enEjIf_wTdeFYT{JoQD5|@shXlvVcOKfW~DY zHWUE68K|@(8k4bwK`Rgy8yWEk#GD9L_Ez3j^7}+OP!vh??}-!^abRx*B0fRLq0#p- zc&ObBCW}pqaOzqkP^+4>M6iip9W9{ohX*|-IT#4SlFk8;5lDPj+g$04H80)Ze>fQtmU zOf)t&Hr5{_DrzmfV=X9R^Jv1gY;a{DLJ|X{b6Ff73t*%C5ox;tK93XuBb_-y5$ADO zHu$JaaKX?*8V8My#Q2XC*hnUa-da@jcsIz~!gzxBse!?45r=`^!TNt2HYP=5@QE9vlA}}JO%C`b0d#&5gUt*07CiBd4(jWt zLJWhZKp#6>gL!$$qVD|Wzk7)}V zkBQGx@@9q_1yr6q017Ty@?&EzVH&nI8Gv!-^x=W~}{IQz$!k{zA98=Ti? z9cVfF`8lawJL&Vf$95Qs%Nvf1vh7mQMX#$ul8xKfXp?90UsgyjF)tIRCdvlh?KrbH zv$~{=QZbg@;?kDY?!_;sOnP!E$WC_y*L!11kJ$Bv5P=FueEclp=B)kG%NZ+7YOGoP zR-EH7=(Ixzm4*4r!U~*|*f}&ewbAzZg$rV7yy&TpH)pNSQqOg{CC4>}G40e2em2s* zKCkIZr2DpNqSZ@AS6r{w4k}39fVJzZXAy0G=<@V(rsuz5bVoeL zq+fMF{HYOh*>$N+ro3`@%}CQfL>5o_WPYe}`@$iaZYz~6GhYY36SpGGi3vX>Q!if_ zW9q{cdi5&xHzBM2OL>Yxeo@({8F}vGo)?H9zB*<}?_KK~<>Ca;lrUut0s0QfGvOOQ zX|CGP-t&oefY|ZSCUqIdWgV^RD9OM76AmFBk^+y@7AoJF~M91Md>YK-Oz2RcP>?)IpVnVhM_99yGk?`*T+XD zwBp#*t06#hT90_d;P)Bbq_WluNSRZ6dv$X^6I1e|_Ex>3C+}~eO6?xaH@&~Jr03}Q z0ll4KqB|?}$cD=Fj)(0>75P8jfk6WSLIxx#!0NJlW3XW4xh2*vK>a`=aGXCgp^dBC zWbsw8pkoUCTuEOjesHP=HT~O?9Z4p1!un#t@AR82drx@}=8y;C3Sro$7oR@K z@IaRLzRu~|mYn_qwVlpXQ4GdGlX91Qv1*s4X`3a?xBTl+6gjVY8?3u26I5R*7URK1 zE=Ac&mvpCFg3I5*AIz?JhVVgKZ%aQcCA1(@d7`&1KFgm|=7IU)9eu`jukwd}^DxEQ zG;~TIDm9)ab}d=d-5BROfvdYfco-jDRg|~dWgdF4?0Ij6Qg{#XJ0ZZVfM`CND7eoe z%RgC$+LKp`BM6{vjBl?JHK}!kDD{<2amH)l>0X#6e?t7&y3fzGT8is#^2aMbRTCk; zJ(sUXP5}^>+6yzxOEHYVr)^ywMD4BNP?p-pCJgbFKiOU??lf*qwM^j7+rsdqkb`_< zu8XfLVd}?QOz?^->D^mk<}$@nMGhUVuWEj*zsW&W*LTpG#BI`{j3U;d25*I>wQU<%>f=gRb zoB3nzuQZE1VsAI0q9Fu1XeEnWrw61}#&RdiUgeSC)MCg}l56y>n~zJy4~!oRrSk?+ z^|z_7X!7ri<33}WCtfkPM{XaK)*O=Vv)t7yh&CgA{MMuALtvt3t{B)Nx2!U`E3tjf z`teF@drzmAWoULxts_H3G-*w!78UQbn(XfG6=khyzw@p2!)9aEeaHEud<#kD>9RSO zv4-4-Lmar@`!;{Jr^WQv-8GcOR=etVt>w3~j-~BA%P8I!s&Ds3L;i|4t7Purz>$NZ zLdX8z;(M{+ihDk&gD&7dmuocXNUmXK-XYTv4@Mt2?u>v1tjpHoom4}Y)wInK=54oY zKa}v{yU`|fgO;#gLyBgiBOG!z#3@XkTfXu8c}+PK=2_c1mzO*scsQco@tHBs5OfZs z$8NNh_v)za2hh3d!{9GC=2^!u6$x6F3k_b)0HLi@ubw9%xBZ3Ommvims*{jB*0zSC zJ49_LfLb#7dYNlHqdQGMY}V}ji|0&vzYZYi^bR?WnGau-m&DBM#vB>^$Z&(5&gG#x zJ`xV$h>ipCjn@`3+01KQ+utac5>+Ws#n+nJvi`lWegz$?!qujlbLb{{(_)p_l1Z+( zdM>W^kZsfPn#(4ql5bnklzKaaX49VdUT_o$9aG z(}gb@7Cr`Hs63vrG-d~*-Ew3l)s6YthL%Ht*{ ze%1=aHvnw3uQBA!TwFcao}XkUs49=`tQ%O)vYY}elzL*VuTX(=8u_V>j)}r>S4Uh~ zh>GVehE`=Smd4(neDmas=pLEo)|t(XUs77pn;QoN(54u9Jv>@Lm8^V);kZT#8jv3` z&GiE#r51T-G5W5_uCs-YQIy9$Bn^A%)S!H7$u7ib&EeDgKaH>T|KlJnIXy|Wao30c E2cLQQbpQYW diff --git a/images/blacktocat.png b/images/blacktocat.png deleted file mode 100644 index 273d5710a2e0968d77584ad073e4a089fbfd7e68..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1266 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`k|nMYCBgY=CFO}lsSJ)O`AMk? zp1FzXsX?iUDV2pMQ*9U+nA0*tB1$5BeXNr6bM+EIYV;~{3xK*A7;Nk-3KEmEQ%e+* zQqwc@Y?a>c-mj#PnPRIHZt82`Ti~3Uk?B!Ylp0*+7m{3+ootz+WN)WnQ(*-(AUCxn zQK2F?C$HG5!d3}vt`(3C64qBz04piUwpD^SD#ABF!8yMuRl!uxKsVXI%s|1+P|wiV z#N6CmN5ROz&_Lh7NZ-&%*U;R`*vQJjKmiJrfVLH-q*(>IxIyg#@@$ndN=gc>^!3Zj z%k|2Q_413-^$jg8EkR}&8R-I5=oVMzl_XZ^<`pZ$OmImpPA){ffi_eM3D1{oGuTzrd=COM+4n&cLd=IHa;5RX-@T zIKQ+g85kdF$}r8qu)}W=NFmTQR{lkqz(`5Vami0E%}vcK@pQ3O0?O#6WTsdd7+V+^ z8k(CJm>U_GSr{5xm>asenYlPSS~yx7IT;(l%)qAC#mvab6&Utr2Bs#4hOUN|=4MVV zCI+U?PDZXKZWgXEy`Fi+C5d^-sW5vpf%Zc6n&H)JD;QCfH z^og8&1M`mKzE)l;d=qjrb~vvJSy|Mouyo1dg^ni6?thVCs0yAf`Q@5aq}s+K9`V=C z{rP`=v-NB<-^nFOYBRV_`Rx;uVYQy^)9a}ALqMd-xJi4fVcRLrrgF#H^(z_`gmYNg z8`ZC~^QU(&GySnBKw|Qotw~8oCN7?p;&T4i?d&@L$Gl%$8&-dv`S`$=`T36X{>ZDw zT=kLd?0S^caPZI_ua^-qKl~;=EWB<}?CV->TJO$Qp2Pd-+ - - - - - - - - - Ewol by HeeroYui - - - - -
-
-

Ewol

-

(BSD v3) OpenGL widget abstraction for application and game (Linux/Android/Windows TODO: Mac/IPhone/Bada)

- -
- Download as .zip - Download as .tar.gz - View on GitHub -
-
-
- -
-
-

-Ewol

- -

Ewol (Edn Widget OpenGl Layer) is a FREE software.

- -

-Instructions

- -

download the software :

- -
git clone git://github.com/HeeroYui/ewol.git
-cd ewol
-git submodule init
-git submodule update
-
- -

Compile software and install :

- -
For this you might use a project that create binaries or something else ...
-Show http://github.com/HeeroYui/edn project
-
- -

-Dependency packages

- -
sudo apt-get install g++ libgl1-mesa-dev zlib1g-dev libasound2-dev
-# if you want to compile with clang :
-sudo apt-get install clang
-# For andoid compilation (jdk 7 does not work...)
-sudo apt-get install javacc openjdk-6-jdk
-# if you want to compile for windows :
-sudo apt-get install mingw32
-# on 64 bits processor for compatibility
-sudo apt-get install ia32-libs
-
- -

-Copyright (c)

- -

2011, Edouard DUPIN

- -

-License (DSB)

- -

Note : only for etk and EWOL

- -

Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions -are met:

- -
    -
  1. Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer.

  2. -
  3. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution.

  4. -
  5. The name of the author may not be used to endorse or promote - products derived from this software without specific prior - written permission.

  6. -

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR -IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, -INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, -STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING -IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE.

-
-
- - - - \ No newline at end of file + + + ewol Library + + + + +
+

ewol


TODO : Main page ...

+ + diff --git a/javascripts/main.js b/javascripts/main.js deleted file mode 100644 index d8135d37..00000000 --- a/javascripts/main.js +++ /dev/null @@ -1 +0,0 @@ -console.log('This would be the main JS file.'); diff --git a/params.json b/params.json deleted file mode 100644 index bea6f296..00000000 --- a/params.json +++ /dev/null @@ -1 +0,0 @@ -{"name":"Ewol","tagline":"(BSD v3) OpenGL widget abstraction for application and game (Linux/Android/Windows TODO: Mac/IPhone/Bada) ","body":"Ewol\r\n====\r\n\r\n`Ewol` (Edn Widget OpenGl Layer) is a FREE software.\r\n\r\nInstructions\r\n============\r\n\r\ndownload the software :\r\n\r\n\tgit clone git://github.com/HeeroYui/ewol.git\r\n\tcd ewol\r\n\tgit submodule init\r\n\tgit submodule update\r\n\r\nCompile software and install :\r\n\r\n\tFor this you might use a project that create binaries or something else ...\r\n\tShow http://github.com/HeeroYui/edn project\r\n\r\nDependency packages\r\n===================\r\n\r\n\tsudo apt-get install g++ libgl1-mesa-dev zlib1g-dev libasound2-dev\r\n\t# if you want to compile with clang :\r\n\tsudo apt-get install clang\r\n\t# For andoid compilation (jdk 7 does not work...)\r\n\tsudo apt-get install javacc openjdk-6-jdk\r\n\t# if you want to compile for windows :\r\n\tsudo apt-get install mingw32\r\n\t# on 64 bits processor for compatibility\r\n\tsudo apt-get install ia32-libs\r\n\r\nCopyright (c)\r\n=============\r\n\r\n2011, Edouard DUPIN\r\n\r\nLicense (DSB)\r\n=============\r\n\r\nNote : only for etk and EWOL\r\n\r\nRedistribution and use in source and binary forms, with or without\r\nmodification, are permitted provided that the following conditions\r\nare met:\r\n\r\n 1. Redistributions of source code must retain the above copyright\r\n notice, this list of conditions and the following disclaimer.\r\n\r\n 2. Redistributions in binary form must reproduce the above copyright\r\n notice, this list of conditions and the following disclaimer in\r\n the documentation and/or other materials provided with the\r\n distribution.\r\n\r\n 3. The name of the author may not be used to endorse or promote\r\n products derived from this software without specific prior\r\n written permission.\r\n\r\nTHIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r\nIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r\nARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,\r\nINDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r\nHOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r\nSTRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r\nIN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r\nPOSSIBILITY OF SUCH DAMAGE.\r\n\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file diff --git a/stylesheets/pygment_trac.css b/stylesheets/pygment_trac.css deleted file mode 100644 index d1df6a21..00000000 --- a/stylesheets/pygment_trac.css +++ /dev/null @@ -1,68 +0,0 @@ -.highlight .c { color: #999988; font-style: italic } /* Comment */ -.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -.highlight .k { font-weight: bold } /* Keyword */ -.highlight .o { font-weight: bold } /* Operator */ -.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */ -.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ -.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #aa0000 } /* Generic.Error */ -.highlight .gh { color: #999999 } /* Generic.Heading */ -.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ -.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */ -.highlight .go { color: #888888 } /* Generic.Output */ -.highlight .gp { color: #555555 } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */ -.highlight .gt { color: #aa0000 } /* Generic.Traceback */ -.highlight .kc { font-weight: bold } /* Keyword.Constant */ -.highlight .kd { font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ -.highlight .m { color: #009999 } /* Literal.Number */ -.highlight .s { color: #d14 } /* Literal.String */ -.highlight .na { color: #008080 } /* Name.Attribute */ -.highlight .nb { color: #0086B3 } /* Name.Builtin */ -.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ -.highlight .no { color: #008080 } /* Name.Constant */ -.highlight .ni { color: #800080 } /* Name.Entity */ -.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ -.highlight .nn { color: #555555 } /* Name.Namespace */ -.highlight .nt { color: #CBDFFF } /* Name.Tag */ -.highlight .nv { color: #008080 } /* Name.Variable */ -.highlight .ow { font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mf { color: #009999 } /* Literal.Number.Float */ -.highlight .mh { color: #009999 } /* Literal.Number.Hex */ -.highlight .mi { color: #009999 } /* Literal.Number.Integer */ -.highlight .mo { color: #009999 } /* Literal.Number.Oct */ -.highlight .sb { color: #d14 } /* Literal.String.Backtick */ -.highlight .sc { color: #d14 } /* Literal.String.Char */ -.highlight .sd { color: #d14 } /* Literal.String.Doc */ -.highlight .s2 { color: #d14 } /* Literal.String.Double */ -.highlight .se { color: #d14 } /* Literal.String.Escape */ -.highlight .sh { color: #d14 } /* Literal.String.Heredoc */ -.highlight .si { color: #d14 } /* Literal.String.Interpol */ -.highlight .sx { color: #d14 } /* Literal.String.Other */ -.highlight .sr { color: #009926 } /* Literal.String.Regex */ -.highlight .s1 { color: #d14 } /* Literal.String.Single */ -.highlight .ss { color: #990073 } /* Literal.String.Symbol */ -.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ -.highlight .vc { color: #008080 } /* Name.Variable.Class */ -.highlight .vg { color: #008080 } /* Name.Variable.Global */ -.highlight .vi { color: #008080 } /* Name.Variable.Instance */ -.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */ - -.type-csharp .highlight .k { color: #0000FF } -.type-csharp .highlight .kt { color: #0000FF } -.type-csharp .highlight .nf { color: #000000; font-weight: normal } -.type-csharp .highlight .nc { color: #2B91AF } -.type-csharp .highlight .nn { color: #000000 } -.type-csharp .highlight .s { color: #A31515 } -.type-csharp .highlight .sc { color: #A31515 } diff --git a/stylesheets/stylesheet.css b/stylesheets/stylesheet.css deleted file mode 100644 index a54a6397..00000000 --- a/stylesheets/stylesheet.css +++ /dev/null @@ -1,247 +0,0 @@ -body { - margin: 0; - padding: 0; - background: #151515 url("../images/bkg.png") 0 0; - color: #eaeaea; - font: 16px; - line-height: 1.5; - font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; -} - -/* General & 'Reset' Stuff */ - -.container { - width: 90%; - max-width: 600px; - margin: 0 auto; -} - -section { - display: block; - margin: 0 0 20px 0; -} - -h1, h2, h3, h4, h5, h6 { - margin: 0 0 20px; -} - -li { - line-height: 1.4 ; -} - -/* Header,
- header - container - h1 - project name - h2 - project description -*/ - -header { - background: rgba(0, 0, 0, 0.1); - width: 100%; - border-bottom: 1px dashed #b5e853; - padding: 20px 0; - margin: 0 0 40px 0; -} - -header h1 { - font-size: 30px; - line-height: 1.5; - margin: 0 0 0 -40px; - font-weight: bold; - font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; - color: #b5e853; - text-shadow: 0 1px 1px rgba(0, 0, 0, 0.1), - 0 0 5px rgba(181, 232, 83, 0.1), - 0 0 10px rgba(181, 232, 83, 0.1); - letter-spacing: -1px; - -webkit-font-smoothing: antialiased; -} - -header h1:before { - content: "./ "; - font-size: 24px; -} - -header h2 { - font-size: 18px; - font-weight: 300; - color: #666; -} - -#downloads .btn { - display: inline-block; - text-align: center; - margin: 0; -} - -/* Main Content -*/ - -#main_content { - width: 100%; - -webkit-font-smoothing: antialiased; -} -section img { - max-width: 100% -} - -h1, h2, h3, h4, h5, h6 { - font-weight: normal; - font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; - color: #b5e853; - letter-spacing: -0.03em; - text-shadow: 0 1px 1px rgba(0, 0, 0, 0.1), - 0 0 5px rgba(181, 232, 83, 0.1), - 0 0 10px rgba(181, 232, 83, 0.1); -} - -#main_content h1 { - font-size: 30px; -} - -#main_content h2 { - font-size: 24px; -} - -#main_content h3 { - font-size: 18px; -} - -#main_content h4 { - font-size: 14px; -} - -#main_content h5 { - font-size: 12px; - text-transform: uppercase; - margin: 0 0 5px 0; -} - -#main_content h6 { - font-size: 12px; - text-transform: uppercase; - color: #999; - margin: 0 0 5px 0; -} - -dt { - font-style: italic; - font-weight: bold; -} - -ul li { - list-style: none; -} - -ul li:before { - content: ">>"; - font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; - font-size: 13px; - color: #b5e853; - margin-left: -37px; - margin-right: 21px; - line-height: 16px; -} - -blockquote { - color: #aaa; - padding-left: 10px; - border-left: 1px dotted #666; -} - -pre { - background: rgba(0, 0, 0, 0.9); - border: 1px solid rgba(255, 255, 255, 0.15); - padding: 10px; - font-size: 14px; - color: #b5e853; - border-radius: 2px; - -moz-border-radius: 2px; - -webkit-border-radius: 2px; - text-wrap: normal; - overflow: auto; - overflow-y: hidden; -} - -table { - width: 100%; - margin: 0 0 20px 0; -} - -th { - text-align: left; - border-bottom: 1px dashed #b5e853; - padding: 5px 10px; -} - -td { - padding: 5px 10px; -} - -hr { - height: 0; - border: 0; - border-bottom: 1px dashed #b5e853; - color: #b5e853; -} - -/* Buttons -*/ - -.btn { - display: inline-block; - background: -webkit-linear-gradient(top, rgba(40, 40, 40, 0.3), rgba(35, 35, 35, 0.3) 50%, rgba(10, 10, 10, 0.3) 50%, rgba(0, 0, 0, 0.3)); - padding: 8px 18px; - border-radius: 50px; - border: 2px solid rgba(0, 0, 0, 0.7); - border-bottom: 2px solid rgba(0, 0, 0, 0.7); - border-top: 2px solid rgba(0, 0, 0, 1); - color: rgba(255, 255, 255, 0.8); - font-family: Helvetica, Arial, sans-serif; - font-weight: bold; - font-size: 13px; - text-decoration: none; - text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.75); - box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.05); -} - -.btn:hover { - background: -webkit-linear-gradient(top, rgba(40, 40, 40, 0.6), rgba(35, 35, 35, 0.6) 50%, rgba(10, 10, 10, 0.8) 50%, rgba(0, 0, 0, 0.8)); -} - -.btn .icon { - display: inline-block; - width: 16px; - height: 16px; - margin: 1px 8px 0 0; - float: left; -} - -.btn-github .icon { - opacity: 0.6; - background: url("../images/blacktocat.png") 0 0 no-repeat; -} - -/* Links - a, a:hover, a:visited -*/ - -a { - color: #63c0f5; - text-shadow: 0 0 5px rgba(104, 182, 255, 0.5); -} - -/* Clearfix */ - -.cf:before, .cf:after { - content:""; - display:table; -} - -.cf:after { - clear:both; -} - -.cf { - zoom:1; -} \ No newline at end of file diff --git a/widget__Button.html b/widget__Button.html new file mode 100644 index 00000000..4b8d6ddd --- /dev/null +++ b/widget__Button.html @@ -0,0 +1,423 @@ + + + + + ewol Library + + + + +
+

Class: widget::Button

+
+

Synopsis:

+
++  static void     init                (ewol::WidgetManager & _widgetManager);
+ Button (const std::string & _shaperName);
+ ~Button (void);
+ 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::EventInput & _event);
+ bool onEventEntry (const ewol::EventEntry & _event);
+ bool loadXML (exml::Element * _node);
+ ewol::Widget * getWidgetNamed (const std::string & _widgetName);
# void onDraw (void);
# bool onSetConfig (const ewol::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
- void changeStatusIn (int32_t _newStatusId);
- void CheckStatus (void);
- void periodicCall (const ewol::EventTime & _event);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> 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:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::Button ()

+ +
+Button(const std::string & _shaperName);
+
+Constructor +
    +Parameter [input]: _shaperName Shaper file properties +
+
+ +
+

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) +
    +Parameter [input]: _shaperName The new shaper filename +
+
+ +
+

setSubWidget ()

+ +
+void setSubWidget(ewol::Widget * _subWidget);
+
+Specify the current widget +
    +Parameter [input]: _subWidget Widget to add normal +
+
+ +
+

setSubWidgetToggle ()

+ +
+void setSubWidgetToggle(ewol::Widget * _subWidget);
+
+Specify the current widget +
    +Parameter [input]: _subWidget Widget to add Toggle +
+
+ +
+

getSubWidget ()

+ +
+ewol::Widget * getSubWidget(void);
+
+get the current displayed composition +
    +Return: The base widget +
+
+ +
+

getSubWidgetToggle ()

+ +
+ewol::Widget * getSubWidgetToggle(void);
+
+get the current displayed composition +
    +Return: The toggle widget +
+
+ +
+

setValue ()

+ +
+void setValue(bool _val);
+
+set the currentValue of the Button (pressed or not) +
Notes: Work only in toggle mode +
    +Parameter [input]: _val New value of the button +
+
+ +
+

getValue ()

+ +
+bool getValue(void);
+
+get the current button value. +
    +Return: True : The button is pressed. +
    Return: 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 +
+
+ +
+

setToggleMode ()

+ +
+void setToggleMode(bool _togg);
+
+change the toggle mode. +
    +Parameter [input]: _togg New toggle mode +
+
+ +
+

getToggleMode ()

+ +
+bool getToggleMode(void);
+
+get the current toggle mode. +
    +Return: 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::EventInput & _event);
+
+
+ +
+

onEventEntry ()

+ +
+bool onEventEntry(const ewol::EventEntry & _event);
+
+
+ +
+

loadXML ()

+ +
+bool loadXML(exml::Element * _node);
+
+
+ +
+

getWidgetNamed ()

+ +
+ewol::Widget * getWidgetNamed(const std::string & _widgetName);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _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 +
    +Parameter [input]: _newStatusId new state +
+
+ +
+

CheckStatus ()

+ +
+void CheckStatus(void);
+
+update the status with the internal satte of the button ... +

+ +
+

periodicCall ()

+ +
+void periodicCall(const ewol::EventTime & _event);
+
+
+ +
+
+ + diff --git a/widget__ButtonColor.html b/widget__ButtonColor.html new file mode 100644 index 00000000..8be9be11 --- /dev/null +++ b/widget__ButtonColor.html @@ -0,0 +1,280 @@ + + + + + ewol Library + + + + +
+

Class: widget::ButtonColor

+
+

Synopsis:

+
++  static void  init                 (ewol::WidgetManager & _widgetManager);
+ ButtonColor (etk::Color<> _baseColor,
std::string _shaperName);
+ ~ButtonColor (void);
+ void setShaperName (std::string _shaperName);
+ etk::Color<> getValue (void);
+ void setValue (etk::Color<> _color);
+ void calculateMinMaxSize (void);
+ void onRegenerateDisplay (void);
+ bool onEventInput (const ewol::EventInput & _event);
+ void onReceiveMessage (const ewol::EMessage & _msg);
# void onDraw (void);
- void changeStatusIn (int32_t _newStatusId);
- void periodicCall (const ewol::EventTime & _event);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::ButtonColor
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::ButtonColor ()

+ +
+ButtonColor(etk::Color<> _baseColor,
+            std::string _shaperName);
+
+Main constructor. +
    +Parameter [input]: _baseColor basic displayed color. +
    Parameter [input]: _shaperName The new shaper filename. +
+
+ +
+

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). +
    +Parameter [input]: _shaperName The new shaper filename. +
+
+ +
+

getValue ()

+ +
+etk::Color<> getValue(void);
+
+get the current color of the color selection widget +
    +Return: The current color +
+
+ +
+

setValue ()

+ +
+void setValue(etk::Color<> _color);
+
+Specify the current color. +
    +Parameter [input]: _color The new display color. +
+
+ +
+

calculateMinMaxSize ()

+ +
+void calculateMinMaxSize(void);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+

onReceiveMessage ()

+ +
+void onReceiveMessage(const ewol::EMessage & _msg);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

changeStatusIn ()

+ +
+void changeStatusIn(int32_t _newStatusId);
+
+internal system to change the property of the current status +
    +Parameter [input]: _newStatusId new state +
+
+ +
+

periodicCall ()

+ +
+void periodicCall(const ewol::EventTime & _event);
+
+
+ +
+
+ + diff --git a/widget__CheckBox.html b/widget__CheckBox.html new file mode 100644 index 00000000..5cd67e1b --- /dev/null +++ b/widget__CheckBox.html @@ -0,0 +1,241 @@ + + + + + ewol Library + + + + +
+

Class: widget::CheckBox

+
+

Synopsis:

+
++  static void  init                 (ewol::WidgetManager & _widgetManager);
+ CheckBox (const std::string & newLabel);
+ ~CheckBox (void);
+ void setLabel (std::string newLabel);
+ void setValue (bool val);
+ bool getValue (void);
+ void calculateMinMaxSize (void);
+ void onRegenerateDisplay (void);
+ bool onEventInput (const ewol::EventInput & _event);
+ bool onEventEntry (const ewol::EventEntry & _event);
# void onDraw (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::CheckBox
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::CheckBox ()

+ +
+CheckBox(const std::string & newLabel);
+
+
+ +
+

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::EventInput & _event);
+
+
+ +
+

onEventEntry ()

+ +
+bool onEventEntry(const ewol::EventEntry & _event);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+
+ + diff --git a/widget__ColorBar.html b/widget__ColorBar.html new file mode 100644 index 00000000..7879bbbb --- /dev/null +++ b/widget__ColorBar.html @@ -0,0 +1,217 @@ + + + + + ewol Library + + + + +
+

Class: widget::ColorBar

+
+

Synopsis:

+
++                ColorBar             (void);
+ ~ColorBar (void);
+ etk::Color<> getCurrentColor (void);
+ void setCurrentColor (etk::Color<> _newOne);
+ void calculateMinMaxSize (void);
+ void onRegenerateDisplay (void);
+ bool onEventInput (const ewol::EventInput & _event);
# void onDraw (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::ColorBar
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::ColorBar ()

+ +
+ColorBar(void);
+
+
+ +
+

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::EventInput & _event);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+
+ + diff --git a/widget__ColorChooser.html b/widget__ColorChooser.html new file mode 100644 index 00000000..a0b32197 --- /dev/null +++ b/widget__ColorChooser.html @@ -0,0 +1,203 @@ + + + + + ewol Library + + + + +
+

Class: widget::ColorChooser

+
+

Synopsis:

+
++                ColorChooser      (void);
+ ~ColorChooser (void);
+ void onReceiveMessage (const ewol::EMessage & _msg);
+ void onObjectRemove (ewol::EObject * _removeObject);
+ void setColor (etk::Color<> _newColor);
+ etk::Color<> getColor (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::ContainerN
+            +--> widget::Sizer
+                +--> widget::ColorChooser
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::ColorChooser ()

+ +
+ColorChooser(void);
+
+
+ +
+

widget::~ColorChooser ()

+ +
+~ColorChooser(void);
+
+
+ +
+

onReceiveMessage ()

+ +
+void onReceiveMessage(const ewol::EMessage & _msg);
+
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _removeObject);
+
+
+ +
+

setColor ()

+ +
+void setColor(etk::Color<> _newColor);
+
+
+ +
+

getColor ()

+ +
+etk::Color<> getColor(void);
+
+
+ +
+
+ + diff --git a/widget__Composer.html b/widget__Composer.html new file mode 100644 index 00000000..df8f12f1 --- /dev/null +++ b/widget__Composer.html @@ -0,0 +1,253 @@ + + + + + ewol Library + + + + +
+

Class: widget::Composer

+
+

Synopsis:

+
++        Composer                   (void);
+ Composer (enum composerMode _mode,
const std::string & _data);
+ ~Composer (void);
+ 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::EObject * _destinationObject,
const std::string & _subWidgetName,
const char * _eventId,
const char * _eventIdgenerated,
const std::string & _overloadData);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> 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:

+

widget::Composer ()

+ +
+Composer(void);
+
+Constructor +

+ +
+

widget::Composer ()

+ +
+Composer(enum composerMode _mode,
+         const std::string & _data);
+
+Constructor +
    +Parameter [input]: _mode mode of parsing the string +
    Parameter [input]: _data file/directString data to generate compositing of the widget.. +
+
+ +
+

widget::~Composer ()

+ +
+~Composer(void);
+
+Destructor +

+ +
+

loadFromFile ()

+ +
+bool loadFromFile(const std::string & _fileName);
+
+load a composition with a file +
    +Parameter [input]: _fileName Name of the file +
    Return: true == > all done OK +
    Return: false == > some error occured +
+
+ +
+

loadFromString ()

+ +
+bool loadFromString(const std::string & _composerXmlString);
+
+load a composition with a file +
    +Parameter [input]: _composerXmlString xml to parse directly +
    Return: true == > all done OK +
    Return: false == > some error occured +
+
+ +
+

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. +
    +Parameter [input]: _subWidgetName Name of the subWidget. +
    Parameter [input]: _eventId Event generate inside the object. +
    Parameter [input]: _eventIdgenerated event generated when call the distant EObject.onReceiveMessage(...) +
    Parameter [input]: _overloadData When the user prever to receive a data specificly for this event ... +
+
+ +
+

registerOnEventNameWidget ()

+ +
+void registerOnEventNameWidget(ewol::EObject * _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. +
    +Parameter [input]: _destinationObject pointer on the object that might be call when an event is generated +
    Parameter [input]: _subWidgetName Name of the subWidget. +
    Parameter [input]: _eventId Event generate inside the object. +
    Parameter [input]: _eventIdgenerated event generated when call the distant EObject.onReceiveMessage(...) +
    Parameter [input]: _overloadData When the user prever to receive a data specificly for this event ... +
+
+ +
+
+ + diff --git a/widget__Container.html b/widget__Container.html new file mode 100644 index 00000000..cb8ccd01 --- /dev/null +++ b/widget__Container.html @@ -0,0 +1,290 @@ + + + + + ewol Library + + + + +
+

Class: widget::Container

+
+

Synopsis:

+
++                  Container               (ewol::Widget * _subElement);
+ ~Container (void);
+ 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::EObject * _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::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> widget::PopUp
+            +--> widget::Composer
+            +--> widget::Scroll
+            +--> widget::ContextMenu
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +* @brief the Cotainer widget is a widget that have an only one subWidget +*/

Detail:

+

widget::Container ()

+ +
+Container(ewol::Widget * _subElement);
+
+Constructor +

+ +
+

widget::~Container ()

+ +
+~Container(void);
+
+Destructor +

+ +
+

getSubWidget ()

+ +
+ewol::Widget * getSubWidget(void);
+
+get the main node widget +
    +Return: the requested pointer on the node +
+
+ +
+

setSubWidget ()

+ +
+void setSubWidget(ewol::Widget * _newWidget);
+
+set the subWidget node widget. +
    +Parameter [input]: _newWidget The widget to add. +
+
+ +
+

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::EObject * _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/widget__ContainerN.html b/widget__ContainerN.html new file mode 100644 index 00000000..fd03cf5f --- /dev/null +++ b/widget__ContainerN.html @@ -0,0 +1,359 @@ + + + + + ewol Library + + + + +
+

Class: widget::ContainerN

+
+

Synopsis:

+
++                  ContainerN                 (void);
+ ~ContainerN (void);
+ 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::EObject * _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::EObject
+    +--> ewol::Widget
+        +--> widget::ContainerN
+            +--> widget::Sizer
+            +--> widget::WSlider
+            +--> widget::Layer
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +* @brief the Cotainer widget is a widget that have an only one subWidget +*/

Detail:

+

widget::ContainerN ()

+ +
+ContainerN(void);
+
+Constructor +

+ +
+

widget::~ContainerN ()

+ +
+~ContainerN(void);
+
+Destructor +

+ +
+

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 ()

+ +
+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) +
    +Parameter [input]: _newWidget the element pointer +
    Return: the ID of the set element +
+
+ +
+

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) +
    +Parameter [input]: _newWidget the element pointer +
    Return: the ID of the set element +
+
+ +
+

subWidgetAddFront ()

+ +
+int32_t subWidgetAddFront(ewol::Widget * _newWidget);
+
+
+ +
+

subWidgetRemove ()

+ +
+void subWidgetRemove(ewol::Widget * _newWidget);
+
+remove definitly a widget from the system and this layer. +
    +Parameter [input]: _newWidget the element pointer. +
+
+ +
+

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 ...) +
    +Parameter [input]: _newWidget the element pointer. +
+
+ +
+

systemDraw ()

+ +
+void systemDraw(const ewol::DrawProperty & _displayProp);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _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/widget__ContextMenu.html b/widget__ContextMenu.html new file mode 100644 index 00000000..61400852 --- /dev/null +++ b/widget__ContextMenu.html @@ -0,0 +1,264 @@ + + + + + ewol Library + + + + +
+

Class: widget::ContextMenu

+
+

Synopsis:

+
++  static void     init                 (ewol::WidgetManager & _widgetManager);
+ ContextMenu (const std::string & _shaperName);
+ ~ContextMenu (void);
+ void setShaperName (const std::string & _shaperName);
+ void setPositionMark (enum markPosition position,
vec2 arrowPos);
+ void onRegenerateDisplay (void);
+ bool onEventInput (const ewol::EventInput & _event);
+ void calculateSize (const vec2 & availlable);
+ void calculateMinMaxSize (void);
+ ewol::Widget * getWidgetAtPos (const vec2 & pos);
# void onDraw (void);
# bool onSetConfig (const ewol::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> widget::ContextMenu
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::ContextMenu ()

+ +
+ContextMenu(const std::string & _shaperName);
+
+
+ +
+

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) +
    +Parameter [input]: _shaperName The new shaper filename +
+
+ +
+

setPositionMark ()

+ +
+void setPositionMark(enum markPosition position,
+                     vec2 arrowPos);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _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::EConfig & _conf);
+
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+
+ +
+
+ + diff --git a/widget__Entry.html b/widget__Entry.html new file mode 100644 index 00000000..52492f6c --- /dev/null +++ b/widget__Entry.html @@ -0,0 +1,504 @@ + + + + + ewol Library + + + + +
+

Class: widget::Entry

+
+

Synopsis:

+
++  static void           init                      (ewol::WidgetManager & _widgetManager);
+ Entry (std::string _newData);
+ ~Entry (void);
+ 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::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::EventInput & _event);
+ bool onEventEntry (const ewol::EventEntry & _event);
+ void onReceiveMessage (const ewol::EMessage & _msg);
+ void onEventClipboard (enum ewol::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::EventTime & _event);
# bool onSetConfig (const ewol::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Entry
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +* @brief Entry box display : +* +* ~~~~~~~~~~~~~~~~~~~~~~ +* ---------------------------------------------- +* | Editable Text | +* ---------------------------------------------- +* ~~~~~~~~~~~~~~~~~~~~~~ +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::Entry ()

+ +
+Entry(std::string _newData);
+
+Contuctor +
    +Parameter [input]: _newData The USting that might be set in the Entry box (no event generation!!) +
+
+ +
+

widget::~Entry ()

+ +
+~Entry(void);
+
+Destuctor +

+ +
+

setValue ()

+ +
+void setValue(const std::string & _newData);
+
+set a new value on the entry. +
    +Parameter [input]: _newData the new string to display. +
+
+ +
+

getValue ()

+ +
+std::string getValue(void);
+
+get the current value in the entry +
    +Return: The current display value +
+
+ +
+

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);
+
+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 "*") +
    +Parameter: _expression New regular expression +
+
+ +
+

getRegExp ()

+ +
+std::string getRegExp(void);
+
+get the regualar expression limitation +
    +Parameter: The regExp string +
+
+ +
+

copySelectionToClipBoard ()

+ +
+void copySelectionToClipBoard(enum ewol::clipBoard::clipboardListe _clipboardID);
+
+Copy the selected data on the specify clipboard +
    +Parameter [input]: _clipboardID Selected 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. +
    +Parameter: _color Color that is selected. +
+
+ +
+

getColorText ()

+ +
+const etk::Color<> & getColorText(void);
+
+get the color for the text. +
    +Return: The color requested. +
+
+ +
+

setColorTextSelected ()

+ +
+void setColorTextSelected(const etk::Color<> & _color);
+
+set text backgroung color when selected. +
    +Parameter: _color Color that is selected. +
+
+ +
+

getColorTextSelected ()

+ +
+const etk::Color<> & getColorTextSelected(void);
+
+get the selected color for the text in selection mode. +
    +Return: The color requested. +
+
+ +
+

setEmptyText ()

+ +
+void setEmptyText(const std::string & _text);
+
+set The text displayed when nothing is in the entry. +
    +Parameter: _text Text to display when the entry box is empty (this text can be decorated). +
+
+ +
+

getEmptyText ()

+ +
+const std::string & getEmptyText(void);
+
+get The text displayed when nothing is in the entry. +
    +Return: Text display when nothing +
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+

onEventEntry ()

+ +
+bool onEventEntry(const ewol::EventEntry & _event);
+
+
+ +
+

onReceiveMessage ()

+ +
+void onReceiveMessage(const ewol::EMessage & _msg);
+
+
+ +
+

onEventClipboard ()

+ +
+void onEventClipboard(enum ewol::clipBoard::clipboardListe _clipboardID);
+
+
+ +
+

calculateMinMaxSize ()

+ +
+void calculateMinMaxSize(void);
+
+
+ +
+

setInternalValue ()

+ +
+void setInternalValue(const std::string & _newData);
+
+internal check the value with RegExp checking +
    +Parameter [input]: _newData The new string to display +
+
+ +
+

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. +
    +Parameter [input]: _pos Absolute position of the event +
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

onGetFocus ()

+ +
+void onGetFocus(void);
+
+
+ +
+

onLostFocus ()

+ +
+void onLostFocus(void);
+
+
+ +
+

changeStatusIn ()

+ +
+void changeStatusIn(int32_t _newStatusId);
+
+
+ +
+

periodicCall ()

+ +
+void periodicCall(const ewol::EventTime & _event);
+
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _conf);
+
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+
+ +
+
+ + diff --git a/widget__FileChooser.html b/widget__FileChooser.html new file mode 100644 index 00000000..4166ec18 --- /dev/null +++ b/widget__FileChooser.html @@ -0,0 +1,243 @@ + + + + + ewol Library + + + + +
+

Class: widget::FileChooser

+
+

Synopsis:

+
++               FileChooser           (void);
+ ~FileChooser (void);
+ 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::EMessage & _msg);
+ void onObjectRemove (ewol::EObject * _removeObject);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> widget::PopUp
+                +--> widget::FileChooser
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::FileChooser ()

+ +
+FileChooser(void);
+
+
+ +
+

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::EMessage & _msg);
+
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _removeObject);
+
+
+ +
+
+ + diff --git a/widget__Gird.html b/widget__Gird.html new file mode 100644 index 00000000..87a78899 --- /dev/null +++ b/widget__Gird.html @@ -0,0 +1,409 @@ + + + + + ewol Library + + + + +
+

Class: widget::Gird

+
+

Synopsis:

+
++  static void    init                (ewol::WidgetManager & _widgetManager);
+ Gird (int32_t _colNumber);
+ ~Gird (void);
+ 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::EObject * _removeObject);
+ void calculateSize (const vec2 & _availlable);
+ void calculateMinMaxSize (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Gird
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::Gird ()

+ +
+Gird(int32_t _colNumber);
+
+Constructor +

+ +
+

widget::~Gird ()

+ +
+~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 ()

+ +
+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) +
    +Parameter [input]: _colId Id of the colomn [0..x]. +
    Parameter [input]: _rowId Id of the row [0..y]. +
    Parameter [input]: _newWidget the element pointer +
+
+ +
+

subWidgetRemove ()

+ +
+void subWidgetRemove(ewol::Widget * _newWidget);
+
+remove definitly a widget from the system and this Gird. +
    +Parameter [input]: _newWidget the element pointer. +
+
+ +
+

subWidgetRemove ()

+ +
+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 ()

+ +
+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 ...). +
    +Parameter [input]: _newWidget the element pointer. +
+
+ +
+

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 ...). +
    +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 ()

+ +
+void systemDraw(const ewol::DrawProperty & _displayProp);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

getWidgetAtPos ()

+ +
+ewol::Widget * getWidgetAtPos(const vec2 & pos);
+
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _removeObject);
+
+
+ +
+

calculateSize ()

+ +
+void calculateSize(const vec2 & _availlable);
+
+
+ +
+

calculateMinMaxSize ()

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

Class: widget::Gird::GirdProperties

+
+

Synopsis:

+
+
+ + +

Detail:

+

+ + diff --git a/widget__Image.html b/widget__Image.html new file mode 100644 index 00000000..950976d9 --- /dev/null +++ b/widget__Image.html @@ -0,0 +1,349 @@ + + + + + ewol Library + + + + +
+

Class: widget::Image

+
+

Synopsis:

+
++  static void              init                 (ewol::WidgetManager & _widgetManager);
+ Image (const std::string & _file,
const ewol::Dimension & _border,
ewol::Dimension:: Millimeter));
+ ~Image (void);
+ 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::EventInput & _event);
+ bool loadXML (exml::Element * _node);
# void onDraw (void);
# bool onSetConfig (const ewol::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Image
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+Main call of recording the widget on the List of "widget named creator" +

+ +
+

widget::Image ()

+ +
+Image(const std::string & _file,
+      const ewol::Dimension & _border,
+      ewol::Dimension:: Millimeter));
+
+ +

+ +
+

widget::~Image ()

+ +
+~Image(void);
+
+ +

+ +
+

set ()

+ +
+void set(const std::string & _file,
+         const ewol::Dimension & _border);
+
+set All the configuration of the current image +
    +Parameter [input]: _file Filaneme of the new image +
    Parameter [input]: _border New border size to set +
+
+ +
+

setFile ()

+ +
+void setFile(const std::string & _file);
+
+set the new filename +
    +Parameter [input]: _file Filaneme of the new image +
+
+ +
+

getFile ()

+ +
+const std::string & getFile(void);
+
+get the file displayed +
    +Return: the filename of the image +
+
+ +
+

setBorder ()

+ +
+void setBorder(const ewol::Dimension & _border);
+
+set tge Border size around the image +
    +Parameter [input]: _border New border size to set +
+
+ +
+

getBorder ()

+ +
+const ewol::Dimension & getBorder(void);
+
+get the current border request at the image +
    +Return: the border size +
+
+ +
+

setImageSize ()

+ +
+void setImageSize(const ewol::Dimension & _size);
+
+set tge Border size around the image +
    +Parameter [input]: _size New border size to set +
+
+ +
+

getImageSize ()

+ +
+const ewol::Dimension & getImageSize(void);
+
+get the current border request at the image +
    +Return: the border size +
+
+ +
+

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);
+
+get the current status of keeping ratio. +
    +Return: The status of keeping the ratio of this image. +
+
+ +
+

calculateMinMaxSize ()

+ +
+void calculateMinMaxSize(void);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+

loadXML ()

+ +
+bool loadXML(exml::Element * _node);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _conf);
+
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+
+ +
+
+ + diff --git a/widget__Joystick.html b/widget__Joystick.html new file mode 100644 index 00000000..6db180a9 --- /dev/null +++ b/widget__Joystick.html @@ -0,0 +1,261 @@ + + + + + ewol Library + + + + +
+

Class: widget::Joystick

+
+

Synopsis:

+
++        Joystick             (void);
+ ~Joystick (void);
+ 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::EventInput & _event);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Joystick
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::Joystick ()

+ +
+Joystick(void);
+
+
+ +
+

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 +
    +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 +
    +Parameter [input]: _imageNameInData the new rbackground that might be set +
    Parameter [input]: _display +
+
+ +
+

foreground ()

+ +
+void foreground(std::string _imageNameInData);
+
+set the Foreground of the widget joystick +
    +Parameter [input]: _imageNameInData the new Foreground that might be set +
+
+ +
+

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 ()

+ +
+void calculateSize(const vec2 & _availlable);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+
+ + diff --git a/widget__Label.html b/widget__Label.html new file mode 100644 index 00000000..ec2241f9 --- /dev/null +++ b/widget__Label.html @@ -0,0 +1,263 @@ + + + + + ewol Library + + + + +
+

Class: widget::Label

+
+

Synopsis:

+
++  static void         init                 (ewol::WidgetManager & _widgetManager);
+ Label (std::string _newLabel);
+ ~Label (void);
+ 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::EventInput & _event);
+ bool loadXML (exml::Element * _node);
# void onDraw (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Label
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+Main call of recording the widget on the List of "widget named creator" +

+ +
+

widget::Label ()

+ +
+Label(std::string _newLabel);
+
+Constructor +
    +Parameter [input]: _newLabel The displayed decorated text. +
+
+ +
+

widget::~Label ()

+ +
+~Label(void);
+
+destructor +

+ +
+

setLabel ()

+ +
+void setLabel(const std::string & _newLabel);
+
+change the label displayed +
    +Parameter [input]: _newLabel The displayed decorated text. +
+
+ +
+

setValue ()

+ +
+void setValue(const std::string & _newLabel);
+
+
+ +
+

getLabel ()

+ +
+std::string getLabel(void);
+
+get the current displayed label +
    +Return: The displayed decorated text. +
+
+ +
+

getValue ()

+ +
+std::string getValue(void);
+
+
+ +
+

calculateMinMaxSize ()

+ +
+void calculateMinMaxSize(void);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+

loadXML ()

+ +
+bool loadXML(exml::Element * _node);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+
+ + diff --git a/widget__Layer.html b/widget__Layer.html new file mode 100644 index 00000000..82be0a71 --- /dev/null +++ b/widget__Layer.html @@ -0,0 +1,189 @@ + + + + + ewol Library + + + + +
+

Class: widget::Layer

+
+

Synopsis:

+
++  static void     init            (ewol::WidgetManager & _widgetManager);
+ Layer (void);
+ ~Layer (void);
+ ewol::Widget * getWidgetAtPos (const vec2 & _pos);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::ContainerN
+            +--> widget::Layer
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+Main call of recording the widget on the List of "widget named creator" +

+ +
+

widget::Layer ()

+ +
+Layer(void);
+
+Constructor +

+ +
+

widget::~Layer ()

+ +
+~Layer(void);
+
+Desstructor +

+ +
+

getWidgetAtPos ()

+ +
+ewol::Widget * getWidgetAtPos(const vec2 & _pos);
+
+
+ +
+
+ + diff --git a/widget__List.html b/widget__List.html new file mode 100644 index 00000000..02399ba9 --- /dev/null +++ b/widget__List.html @@ -0,0 +1,316 @@ + + + + + ewol Library + + + + +
+

Class: widget::List

+
+

Synopsis:

+
++                List                 (void);
+ ~List (void);
+ 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::EventInput & _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::keyEvent::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::EObject
+    +--> ewol::Widget
+        +--> widget::WidgetScrooled
+            +--> widget::List
+                +--> widget::ListFileSystem
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::List ()

+ +
+List(void);
+
+
+ +
+

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::EventInput & _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::keyEvent::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 ()

+ +
+void onGetFocus(void);
+
+
+ +
+

onLostFocus ()

+ +
+void onLostFocus(void);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+
+ + diff --git a/widget__ListFileSystem.html b/widget__ListFileSystem.html new file mode 100644 index 00000000..e3f00d01 --- /dev/null +++ b/widget__ListFileSystem.html @@ -0,0 +1,303 @@ + + + + + ewol Library + + + + +
+

Class: widget::ListFileSystem

+
+

Synopsis:

+
++                ListFileSystem         (void);
+ ~ListFileSystem (void);
+ 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::keyEvent::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::EObject
+    +--> ewol::Widget
+        +--> widget::WidgetScrooled
+            +--> widget::List
+                +--> widget::ListFileSystem
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::ListFileSystem ()

+ +
+ListFileSystem(void);
+
+
+ +
+

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::keyEvent::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/widget__Menu.html b/widget__Menu.html new file mode 100644 index 00000000..fba97030 --- /dev/null +++ b/widget__Menu.html @@ -0,0 +1,258 @@ + + + + + ewol Library + + + + +
+

Class: widget::Menu

+
+

Synopsis:

+
++           Menu                (void);
+ ~Menu (void);
+ 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::EMessage & _msg);
+ void onObjectRemove (ewol::EObject * _removeObject);
- void subWidgetRemoveAll (void);
- int32_t subWidgetAdd (ewol::Widget * _newWidget);
- void subWidgetRemove (ewol::Widget * _newWidget);
- void subWidgetUnLink (ewol::Widget * _newWidget);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::ContainerN
+            +--> widget::Sizer
+                +--> widget::Menu
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::Menu ()

+ +
+Menu(void);
+
+
+ +
+

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::EMessage & _msg);
+
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _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/widget__MenuElement.html b/widget__MenuElement.html new file mode 100644 index 00000000..29b748d8 --- /dev/null +++ b/widget__MenuElement.html @@ -0,0 +1,151 @@ + + + + + ewol Library + + + + +
+

Class: widget::MenuElement

+
+

Synopsis:

+
++        MenuElement  (void);
+ + +

Detail:

+

widget::MenuElement ()

+ +
+MenuElement(void);
+
+
+ +
+
+ + diff --git a/widget__Mesh.html b/widget__Mesh.html new file mode 100644 index 00000000..28c37381 --- /dev/null +++ b/widget__Mesh.html @@ -0,0 +1,269 @@ + + + + + ewol Library + + + + +
+

Class: widget::Mesh

+
+

Synopsis:

+
++        Mesh                 (const std::string & filename);
+ ~Mesh (void);
+ void onRegenerateDisplay (void);
+ void systemDraw (const ewol::DrawProperty & displayProp);
+ void onDraw (void);
+ bool onEventInput (const ewol::EventInput & _event);
+ void periodicCall (const ewol::EventTime & _event);
+ void setFile (const std::string & filename);
+ void setPosition (const vec3 & pos);
+ void setAngle (const vec3 & angle);
+ void setAngleSpeed (const vec3 & speed);
+ void setDistance (float distance);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Mesh
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::Mesh ()

+ +
+Mesh(const std::string & filename);
+
+
+ +
+

widget::~Mesh ()

+ +
+~Mesh(void);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

systemDraw ()

+ +
+void systemDraw(const ewol::DrawProperty & displayProp);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+

periodicCall ()

+ +
+void periodicCall(const ewol::EventTime & _event);
+
+
+ +
+

setFile ()

+ +
+void setFile(const std::string & filename);
+
+set a mesh name file +
    +Parameter [input]: filename Name of the new mesh +
+
+ +
+

setPosition ()

+ +
+void setPosition(const vec3 & pos);
+
+set the mesh position +
    +Parameter [input]: pos The new position of the mesh +
+
+ +
+

setAngle ()

+ +
+void setAngle(const vec3 & angle);
+
+set the mesh angle of view +
    +Parameter [input]: angle view angle of the mesh +
+
+ +
+

setAngleSpeed ()

+ +
+void setAngleSpeed(const vec3 & speed);
+
+set the mesh angle speed +
    +Parameter [input]: spped radian speed of the mesh +
+
+ +
+

setDistance ()

+ +
+void setDistance(float distance);
+
+set the camera distance of the mesh +
    +Parameter [input]: dist Diatance of the mesh +
+
+ +
+
+ + diff --git a/widget__Parameter.html b/widget__Parameter.html new file mode 100644 index 00000000..3b18d404 --- /dev/null +++ b/widget__Parameter.html @@ -0,0 +1,229 @@ + + + + + ewol Library + + + + +
+

Class: widget::Parameter

+
+

Synopsis:

+
++        Parameter         (void);
+ ~Parameter (void);
+ void onReceiveMessage (const ewol::EMessage & _msg);
+ void onObjectRemove (ewol::EObject * _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::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> widget::PopUp
+                +--> widget::Parameter
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::Parameter ()

+ +
+Parameter(void);
+
+
+ +
+

widget::~Parameter ()

+ +
+~Parameter(void);
+
+
+ +
+

onReceiveMessage ()

+ +
+void onReceiveMessage(const ewol::EMessage & _msg);
+
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _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/widget__ParameterList.html b/widget__ParameterList.html new file mode 100644 index 00000000..138f1c40 --- /dev/null +++ b/widget__ParameterList.html @@ -0,0 +1,277 @@ + + + + + ewol Library + + + + +
+

Class: widget::ParameterList

+
+

Synopsis:

+
++        ParameterList        (void);
+ ~ParameterList (void);
+ 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::EventInput & _event);
+ void calculateMinMaxSize (void);
# void onGetFocus (void);
# void onLostFocus (void);
# void onDraw (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::WidgetScrooled
+            +--> widget::ParameterList
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::ParameterList ()

+ +
+ParameterList(void);
+
+
+ +
+

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::EventInput & _event);
+
+
+ +
+

calculateMinMaxSize ()

+ +
+void calculateMinMaxSize(void);
+
+
+ +
+

onGetFocus ()

+ +
+void onGetFocus(void);
+
+
+ +
+

onLostFocus ()

+ +
+void onLostFocus(void);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+
+ + diff --git a/widget__PopUp.html b/widget__PopUp.html new file mode 100644 index 00000000..b43c0656 --- /dev/null +++ b/widget__PopUp.html @@ -0,0 +1,323 @@ + + + + + ewol Library + + + + +
+

Class: widget::PopUp

+
+

Synopsis:

+
++  static void     init                    (ewol::WidgetManager & _widgetManager);
+ PopUp (const std::string & _shaperName);
+ ~PopUp (void);
+ void setShaperName (const std::string & _shaperName);
+ void lockExpand (const bvec2 & _lockExpand);
+ void setRemoveOnExternClick (bool _state);
+ bool getRemoveOnExternClick (void);
+ void periodicCall (const ewol::EventTime & _event);
+ void systemDraw (const ewol::DrawProperty & _displayProp);
+ void onRegenerateDisplay (void);
+ void calculateSize (const vec2 & _available);
+ bool onEventInput (const ewol::EventInput & _event);
+ ewol::Widget * getWidgetAtPos (const vec2 & pos);
# void onDraw (void);
# bool onSetConfig (const ewol::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
# bool onStartAnnimation (enum ewol::Widget::annimationMode _mode);
# void onStopAnnimation (void);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> widget::PopUp
+                +--> widget::FileChooser
+                +--> widget::StdPopUp
+                +--> widget::Parameter
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::PopUp ()

+ +
+PopUp(const std::string & _shaperName);
+
+Constructor +
    +Parameter [input]: _shaperName Shaper file properties +
+
+ +
+

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) +
    +Parameter [input]: _shaperName The new shaper filename +
+
+ +
+

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);
+
+get the status of the request the Auto-remove when the event input is set outside the widget. +
    +Return: the status of the removing +
+
+ +
+

periodicCall ()

+ +
+void periodicCall(const ewol::EventTime & _event);
+
+
+ +
+

systemDraw ()

+ +
+void systemDraw(const ewol::DrawProperty & _displayProp);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

calculateSize ()

+ +
+void calculateSize(const vec2 & _available);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+

getWidgetAtPos ()

+ +
+ewol::Widget * getWidgetAtPos(const vec2 & pos);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _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/widget__ProgressBar.html b/widget__ProgressBar.html new file mode 100644 index 00000000..c0540641 --- /dev/null +++ b/widget__ProgressBar.html @@ -0,0 +1,242 @@ + + + + + ewol Library + + + + +
+

Class: widget::ProgressBar

+
+

Synopsis:

+
++  static void  init                 (ewol::WidgetManager & _widgetManager);
+ ProgressBar (void);
+ ~ProgressBar (void);
+ 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::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::ProgressBar
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::ProgressBar ()

+ +
+ProgressBar(void);
+
+
+ +
+

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::EConfig & _conf);
+
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+
+ +
+
+ + diff --git a/widget__Scroll.html b/widget__Scroll.html new file mode 100644 index 00000000..c4fd120b --- /dev/null +++ b/widget__Scroll.html @@ -0,0 +1,268 @@ + + + + + ewol Library + + + + +
+

Class: widget::Scroll

+
+

Synopsis:

+
++  static void     init                 (ewol::WidgetManager & _widgetManager);
+ Scroll (void);
+ ~Scroll (void);
+ void setLimit (const vec2 & _limit);
+ const vec2 & getLimit (void);
+ void calculateMinMaxSize (void);
+ void onRegenerateDisplay (void);
+ bool onEventInput (const ewol::EventInput & _event);
+ void systemDraw (const ewol::DrawProperty & _displayProp);
+ ewol::Widget * getWidgetAtPos (const vec2 & _pos);
# void onDraw (void);
# bool onSetConfig (const ewol::EConfig & _conf);
# bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> widget::Scroll
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::Scroll ()

+ +
+Scroll(void);
+
+
+ +
+

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 +
    +Parameter [input]: _limit scrolling limit [0..1] (represent a pourcent) +
+
+ +
+

getLimit ()

+ +
+const vec2 & getLimit(void);
+
+get the limit of scrolling +
    +Return: scrolling limit +
+
+ +
+

calculateMinMaxSize ()

+ +
+void calculateMinMaxSize(void);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _event);
+
+
+ +
+

systemDraw ()

+ +
+void systemDraw(const ewol::DrawProperty & _displayProp);
+
+
+ +
+

getWidgetAtPos ()

+ +
+ewol::Widget * getWidgetAtPos(const vec2 & _pos);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _conf);
+
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+
+ +
+
+ + diff --git a/widget__Sizer.html b/widget__Sizer.html new file mode 100644 index 00000000..2b27d747 --- /dev/null +++ b/widget__Sizer.html @@ -0,0 +1,314 @@ + + + + + ewol Library + + + + +
+

Class: widget::Sizer

+
+

Synopsis:

+
++  static void              init                 (ewol::WidgetManager & _widgetManager);
+ Sizer (enum displayMode _mode);
+ ~Sizer (void);
+ 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::EObject
+    +--> ewol::Widget
+        +--> widget::ContainerN
+            +--> widget::Sizer
+                +--> widget::ColorChooser
+                +--> widget::Menu
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+Main call of recording the widget on the List of "widget named creator" +

+ +
+

widget::Sizer ()

+ +
+Sizer(enum displayMode _mode);
+
+Constructor +
    +Parameter [input]: _mode The mode to display the elements +
+
+ +
+

widget::~Sizer ()

+ +
+~Sizer(void);
+
+Desstructor +

+ +
+

setMode ()

+ +
+void setMode(enum displayMode _mode);
+
+set the mode to display elements. +
    +Parameter [input]: _mode The mode to display the elements. +
+
+ +
+

setBorderSize ()

+ +
+void setBorderSize(const ewol::Dimension & _newBorderSize);
+
+set the current border size of the current element: +
    +Parameter [input]: _newBorderSize The border size to set (0 if not used) +
+
+ +
+

getBorderSize ()

+ +
+const ewol::Dimension & getBorderSize(void);
+
+get the current border size of the current element: +
    +Return: the border size (0 if not used) +
+
+ +
+

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. +
+
+ +
+

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 ()

+ +
+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/widget__Slider.html b/widget__Slider.html new file mode 100644 index 00000000..63e286de --- /dev/null +++ b/widget__Slider.html @@ -0,0 +1,249 @@ + + + + + ewol Library + + + + +
+

Class: widget::Slider

+
+

Synopsis:

+
++  static void  init                 (ewol::WidgetManager & _widgetManager);
+ Slider (void);
+ ~Slider (void);
+ 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::EventInput & _event);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Slider
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::Slider ()

+ +
+Slider(void);
+
+
+ +
+

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::EventInput & _event);
+
+
+ +
+
+ + diff --git a/widget__Spacer.html b/widget__Spacer.html new file mode 100644 index 00000000..8c596fa9 --- /dev/null +++ b/widget__Spacer.html @@ -0,0 +1,232 @@ + + + + + ewol Library + + + + +
+

Class: widget::Spacer

+
+

Synopsis:

+
++  static void     init                 (ewol::WidgetManager & _widgetManager);
+ Spacer (void);
+ ~Spacer (void);
+ void setColor (etk::Color<> _newColor);
+ ewol::Widget * getWidgetAtPos (const vec2 & _pos);
+ void onRegenerateDisplay (void);
+ void onDraw (void);
+ bool onSetConfig (const ewol::EConfig & _conf);
+ bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Spacer
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::Spacer ()

+ +
+Spacer(void);
+
+Main constructer +

+ +
+

widget::~Spacer ()

+ +
+~Spacer(void);
+
+Main destructer +

+ +
+

setColor ()

+ +
+void setColor(etk::Color<> _newColor);
+
+Spziby the background color (basicly transparent) +
    +Parameter [input]: newColor the display background color +
+
+ +
+

getWidgetAtPos ()

+ +
+ewol::Widget * getWidgetAtPos(const vec2 & _pos);
+
+
+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onDraw ()

+ +
+void onDraw(void);
+
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _conf);
+
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+
+ +
+
+ + diff --git a/widget__StdPopUp.html b/widget__StdPopUp.html new file mode 100644 index 00000000..f9a7d452 --- /dev/null +++ b/widget__StdPopUp.html @@ -0,0 +1,248 @@ + + + + + ewol Library + + + + +
+

Class: widget::StdPopUp

+
+

Synopsis:

+
++                    StdPopUp          (void);
+ ~StdPopUp (void);
+ void setTitle (const std::string & _text);
+ void setComment (const std::string & _text);
+ widget::Button * addButton (const std::string & _text,
bool _autoExit);
+ void onObjectRemove (ewol::EObject * _removeObject);
+ void onReceiveMessage (const ewol::EMessage & _msg);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::Container
+            +--> widget::PopUp
+                +--> widget::StdPopUp
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +* @brief The std pop up widget is a siple message widget to notyfy user of some simple things, like: +* +* ~~~~~~~~~~~~~~~~~~~~~ +* +---------------------------------+---+---+---+ +* | Windows name... | _ | O | X | +* +---------------------------------+---+---+---+ +* | | +* | | +* | | +* | +-------------------+ | +* | | Erreur: | | +* | | | | +* | | Message to diplay | | +* | | to user | | +* | | | | +* | | Close | | +* | +-------------------+ | +* | | +* | | +* | | +* +---------------------------------------------+ +* ~~~~~~~~~~~~~~~~~~~~~ +*/

Detail:

+

widget::StdPopUp ()

+ +
+StdPopUp(void);
+
+std-pop-up constructor. +

+ +
+

widget::~StdPopUp ()

+ +
+~StdPopUp(void);
+
+std-pop-up destructor. +

+ +
+

setTitle ()

+ +
+void setTitle(const std::string & _text);
+
+Set the title string. +
    +Parameter [input]: _text Decorated text to diplay in title. +
+
+ +
+

setComment ()

+ +
+void setComment(const std::string & _text);
+
+Set the commentary string. +
    +Parameter [input]: _text Decorated text to diplay in Comment. +
+
+ +
+

addButton ()

+ +
+widget::Button * addButton(const std::string & _text,
+                           bool _autoExit);
+
+Add a buttom button. +
    +Parameter [input]: _text Decorated text to diplay in button. +
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::EObject * _removeObject);
+
+
+ +
+

onReceiveMessage ()

+ +
+void onReceiveMessage(const ewol::EMessage & _msg);
+
+
+ +
+
+ + diff --git a/widget__WSlider.html b/widget__WSlider.html new file mode 100644 index 00000000..00a660ad --- /dev/null +++ b/widget__WSlider.html @@ -0,0 +1,307 @@ + + + + + ewol Library + + + + +
+

Class: widget::WSlider

+
+

Synopsis:

+
++  static void     init                (ewol::WidgetManager & _widgetManager);
+ WSlider (void);
+ ~WSlider (void);
+ 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::EventTime & _event);
+ bool onSetConfig (const ewol::EConfig & _conf);
+ bool onGetConfig (const char * _config,
std::string & _result);
+ + +

Object Hierarchy:

+
+ewol::EObject
+    +--> ewol::Widget
+        +--> widget::ContainerN
+            +--> widget::WSlider
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::init ()

+ +
+static void init(ewol::WidgetManager & _widgetManager);
+
+
+ +
+

widget::WSlider ()

+ +
+WSlider(void);
+
+
+ +
+

widget::~WSlider ()

+ +
+~WSlider(void);
+
+
+ +
+

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 +
    +Parameter [input]: _widgetPointer Pointer on the widget selected (must be added before) +
+
+ +
+

subWidgetSelectSet ()

+ +
+void subWidgetSelectSet(const std::string & _widgetName);
+
+Select a new subwidget to display +
    +Parameter [input]: _widgetName Name of the subwidget name +
+
+ +
+

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 +
+
+ +
+

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::EventTime & _event);
+
+
+ +
+

onSetConfig ()

+ +
+bool onSetConfig(const ewol::EConfig & _conf);
+
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+
+ +
+
+ + diff --git a/widget__WidgetScrooled.html b/widget__WidgetScrooled.html new file mode 100644 index 00000000..062fbf61 --- /dev/null +++ b/widget__WidgetScrooled.html @@ -0,0 +1,269 @@ + + + + + ewol Library + + + + +
+

Class: widget::WidgetScrooled

+
+

Synopsis:

+
++        WidgetScrooled               (void);
+ ~WidgetScrooled (void);
+ void onRegenerateDisplay (void);
+ bool onEventInput (const ewol::EventInput & _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::EObject
+    +--> ewol::Widget
+        +--> widget::WidgetScrooled
+            +--> widget::ParameterList
+            +--> widget::List
+
+
+

Description:

+/** +* @ingroup ewolWidgetGroup +*/

Detail:

+

widget::WidgetScrooled ()

+ +
+WidgetScrooled(void);
+
+Scroll Widget main constructor to be herited from an other widget (this is not a stand-alone widget) +

+ +
+

widget::~WidgetScrooled ()

+ +
+~WidgetScrooled(void);
+
+Scroll widget destructor. +

+ +
+

onRegenerateDisplay ()

+ +
+void onRegenerateDisplay(void);
+
+
+ +
+

onEventInput ()

+ +
+bool onEventInput(const ewol::EventInput & _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 +
    +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/widget__elementPL.html b/widget__elementPL.html new file mode 100644 index 00000000..1bde965b --- /dev/null +++ b/widget__elementPL.html @@ -0,0 +1,162 @@ + + + + + ewol Library + + + + +
+

Class: widget::elementPL

+
+

Synopsis:

+
++        elementPL  (std::string & _label,
int32_t _refId,
std::string & _image,
bool _isGroup);
+ ~elementPL (void);
+ + +

Detail:

+

widget::elementPL ()

+ +
+elementPL(std::string & _label,
+          int32_t _refId,
+          std::string & _image,
+          bool _isGroup);
+
+
+ +
+

widget::~elementPL ()

+ +
+~elementPL(void);
+
+
+ +
+
+ +