diff --git a/001_bases.html b/001_bases.html new file mode 100644 index 00000000..6e0e7517 --- /dev/null +++ b/001_bases.html @@ -0,0 +1,161 @@ + + + + + ewol Library + + + + + +
+

EWOL: Bases

+
Next: Tutorals

+

Overview:

+EWOL is an OpenGL library for creating graphical user interfaces. +It works on many UNIX-like platforms, Windows, and OS X and some mobile platforms Android, iOs(soon). +EWOL is released under the BSD 3 clauses license (BSD v3), which allows for very flexible licensing of client applications. +EWOL has a C++ architecture that allows for maximum flexibility.
+The main idea of EWOL is to create a complete abstraction of the platforms. +This generate some restriction that you will see an overwiew in the under section.
+

User requires:

+To use ewol you need to know only C++ language. It could be usefull to know: + +

Architecture:

+One of the important point to know in this framwork is some of absurd things came from the multiple architecture type.
+I will Explain the main points: + +
+ + diff --git a/base.css b/base.css index aa94d74e..22c4ee25 100644 --- a/base.css +++ b/base.css @@ -55,8 +55,8 @@ body { text-shadow: 0 1px 0 #ce4213; padding: 10px 20px 10px; margin-left: -20px; - overflow:scroll; - overflow-x:hidden; + //overflow:scroll; + //overflow-x:hidden; } /* .navbar ul { @@ -128,4 +128,67 @@ pre { .code-storage-keyword { text-decoration:none; color:#466cb4; -} \ No newline at end of file +} + +.code-doxygen { + text-decoration:none; + color:#bf3e00; + font-weight:bold; +} + +.code-comment { + text-decoration:none; + color:#b704b5; +} + +.code-preproc { + text-decoration:none; + color:#ac0000; +} + +.code-text-quote { + text-decoration:none; + color:#008e00; +} +.code-number { + text-decoration:none; + color:#007b00; +} +.code-member { + text-decoration:none; + color:#7c5406; +} +.code-input-function { + text-decoration:none; + color:#B80000; + font-weight:bold; +} +.code-function-name { + text-decoration:none; + color:#09857e; + font-weight:bold; +} +.code-function-system { + text-decoration:none; + color:#acaa00; +} +.code-generic-define { + text-decoration:none; + color:#3c850b; +} +.code-macro { + text-decoration:none; + color:#3c850b; +} +.code-operator { + text-decoration:none; + color:#1633a3; +} +.code-keyword { + text-decoration:none; + color:#466cb4; +} +.code-class { + text-decoration:none; + color:#006cb4; +} diff --git a/eSystemMessage.html b/eSystemMessage.html deleted file mode 100644 index 5c104b79..00000000 --- a/eSystemMessage.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - 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 deleted file mode 100644 index d17b5d49..00000000 --- a/ewol__Area.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - 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 deleted file mode 100644 index a9051bf1..00000000 --- a/ewol__Colored3DObject.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - 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 deleted file mode 100644 index 5f32a179..00000000 --- a/ewol__CommandLine.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - 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 index e403f1a6..dc429816 100644 --- a/ewol__Compositing.html +++ b/ewol__Compositing.html @@ -4,147 +4,159 @@ ewol Library +

Class: ewol::Compositing


+

Constructor and Destructor:

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

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);
++ 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
+    +--> ewol::compositing::Shaper
+    +--> ewol::compositing::Area
+    +--> ewol::compositing::Image
+    +--> ewol::compositing::Drawing
+    +--> ewol::compositing::Text
 

Detail:

diff --git a/ewol__ConfigFile.html b/ewol__ConfigFile.html deleted file mode 100644 index 67a955cc..00000000 --- a/ewol__ConfigFile.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - 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... -
    -Parameter [input]: _filename Name of the configuration file. -
    Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::ConfigFile * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

ewol::ConfigFile ()

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

ewol::~ConfigFile ()

- -
-~ConfigFile(void);
-
-
- -
-
- - diff --git a/ewol__ConfigFont.html b/ewol__ConfigFont.html deleted file mode 100644 index cdb3332b..00000000 --- a/ewol__ConfigFont.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - 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) -
    -Parameter [input]: _folder basic folder of the font (ex: DATA:fonts) -
-
- -
-

getFolder ()

- -
-const std::string & getFolder(void);
-
-get the default font folder. -
    -Return: 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. -
    -Parameter [input]: _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". -
    Parameter [input]: _size The default size of the font default=10. -
-
- -
-

getName ()

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

- -
-

getSize ()

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

setUseExternal ()

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

getUseExternal ()

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

Class: ewol::Context

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

getCmd ()

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

getFontDefault ()

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

getWidgetManager ()

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

getEObjectManager ()

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

getResourcesManager ()

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

ewol::Context ()

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

ewol::~Context ()

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

setArchiveDir ()

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

OS_SetInputMotion ()

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

OS_SetInputState ()

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

OS_SetMouseMotion ()

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

OS_SetMouseState ()

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

OS_SetKeyboard ()

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

OS_SetKeyboardMove ()

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

OS_Suspend ()

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

+ +
+

OS_Resume ()

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

+ +
+

requestUpdateSize ()

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

OS_Draw ()

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

onObjectRemove ()

+ +
+void onObjectRemove(ewol::Object * _removeObject);
+
+Inform object that an other object is removed ... +
Notes: : Sub classes must call this class +
    +Parameter [input]: removeObject Pointer on the EObject removed == > the user must remove all reference on this EObject +
+
+ +
+

resetIOEvent ()

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

+ +
+

OS_OpenGlContextDestroy ()

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

+ +
+

OS_Stop ()

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

+ +
+

stop ()

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

+ +
+

setWindows ()

+ +
+void setWindows(ewol::widget::Windows * _windows);
+
+set the current windows to display : +
    +Parameter: _windows Windows that might be displayed +
+
+ +
+

getWindows ()

+ +
+ewol::widget::Windows * getWindows(void);
+
+get the current windows that is displayed +
    +Return: the current handle on the windows (can be null) +
+
+ +
+

getSize ()

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

OS_Resize ()

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

setSize ()

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

OS_Move ()

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

setPos ()

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

OS_Hide ()

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

+ +
+

hide ()

+ +
+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 +
    +Parameter: source the widget where the event came from +
    Parameter: destination the widget where the event mitgh be generated now +
+
+ +
+

inputEventGrabPointer ()

+ +
+void inputEventGrabPointer(ewol::Widget * _widget);
+
+This fonction lock the pointer properties to move in relative instead of absolute +
    +Parameter [input]: widget The widget that lock the pointer events +
+
+ +
+

inputEventUnGrabPointer ()

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

+ +
+

keyboardShow ()

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

+ +
+

keyboardHide ()

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

+ +
+

clipBoardGet ()

+ +
+void clipBoardGet(enum ewol::context::clipBoard::clipboardListe _clipboardID);
+
+Inform the Gui that we want to have a copy of the clipboard +
    +Parameter [input]: _clipboardID ID of the clipboard (STD/SELECTION) only apear here +
+
+ +
+

clipBoardSet ()

+ +
+void clipBoardSet(enum ewol::context::clipBoard::clipboardListe _clipboardID);
+
+Inform the Gui that we are the new owner of the clipboard +
    +Parameter [input]: _clipboardID ID of the clipboard (STD/SELECTION) only apear here +
+
+ +
+

OS_ClipBoardArrive ()

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

setTitle ()

+ +
+void setTitle(const std::string & _title);
+
+set the new title of the windows +
    +Parameter [input]: title New desired title +
+
+ +
+

forceOrientation ()

+ +
+void forceOrientation(enum ewol::orientation _orientation);
+
+force the screen orientation (availlable on portable elements ... +
    +Parameter [input]: _orientation Selected orientation. +
+
+ +
+

grabPointerEvents ()

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

setCursor ()

+ +
+void setCursor(enum ewol::context::cursorDisplay _newCursor);
+
+set the cursor display type. +
    +Parameter [input]: _newCursor selected new cursor. +
+
+ +
+

setIcon ()

+ +
+void setIcon(const std::string & _inputFile);
+
+set the Icon of the program +
    +Parameter [input]: _inputFile new filename icon of the curent program. +
+
+ +
+

ewol::getTime ()

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

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 +
    +Parameter [input]: _argc Standard argc +
    Parameter [input]: _argv Standard argv +
    Return: normal error int for the application error management +
+
+ +
+

lockContext ()

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

+ +
+

unLockContext ()

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

+ +
+

processEvents ()

+ +
+void processEvents(void);
+
+Processing all the event arrived ... (commoly called in draw function) +

+ +
+
+ + diff --git a/ewol__Dimension.html b/ewol__Dimension.html index 796a0282..d646808d 100644 --- a/ewol__Dimension.html +++ b/ewol__Dimension.html @@ -4,137 +4,149 @@ ewol Library +

Class: ewol::Dimension


+

Constructor and Destructor:

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

Synopsis:

-+                     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);
++ void string (void);
+ vec2 get (enum distance _type);
+ void set (const vec2 & _size,
enum distance _type);
+ vec2 getPixel (void);
+ vec2 getPourcent (void);
+ vec2 getMeter (void);
+ vec2 getCentimeter (void);
+ vec2 getMillimeter (void);
+ vec2 getKilometer (void);
+ vec2 getInch (void);
+ vec2 getFoot (void);
+ const Dimension & operator= (const Dimension & _obj);
+ bool operator== (const Dimension & _obj);
+ bool operator!= (const Dimension & _obj);
+ static void init (void);
+ static void unInit (void);
+ static void setPixelRatio (const vec2 & _ratio,
enum ewol::Dimension::distance _type);
+ static void setPixelWindowsSize (const vec2 & _size);
+ static vec2 getWindowsSize (enum ewol::Dimension::distance _type);
+ static float getWindowsDiag (enum ewol::Dimension::distance _type);
- void set (std::string _config);

Description:

@@ -353,6 +365,76 @@ get the current dimention in Foot

+
+

ewol::init ()

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

+ +
+

ewol::unInit ()

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

+ +
+

ewol::setPixelRatio ()

+ +
+static void setPixelRatio(const vec2 & _ratio,
+                          enum ewol::Dimension::distance _type);
+
+set the Milimeter ratio for calculation +
    +Parameter [input]: Ratio Milimeter ration for the screen calculation interpolation +
    Parameter [input]: type Unit type requested. +
+
+ +
+

ewol::setPixelWindowsSize ()

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

ewol::getWindowsSize ()

+ +
+static vec2 getWindowsSize(enum ewol::Dimension::distance _type);
+
+get the Windows size in the request unit +
    +Parameter [input]: type Unit type requested. +
    Return: the requested size +
+
+ +
+

ewol::getWindowsDiag ()

+ +
+static float getWindowsDiag(enum ewol::Dimension::distance _type);
+
+get the Windows diagonal size in the request unit +
    +Parameter [input]: type Unit type requested. +
    Return: the requested size +
+
+

set ()

diff --git a/ewol__DrawProperty.html b/ewol__DrawProperty.html index 4c142784..1840b8f1 100644 --- a/ewol__DrawProperty.html +++ b/ewol__DrawProperty.html @@ -4,140 +4,155 @@ ewol Library +

Class: ewol::DrawProperty


+

Constructor and Destructor:

+
+

Synopsis:

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

Detail:

+

Description:

+/** +* @not-in-doc +*/

Detail:

limit ()

diff --git a/ewol__EConfig.html b/ewol__EConfig.html
deleted file mode 100644
index 91682bf9..00000000
--- a/ewol__EConfig.html
+++ /dev/null
@@ -1,184 +0,0 @@
-
-
-
-	
-	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 deleted file mode 100644 index 9c6be745..00000000 --- a/ewol__EConfigElement.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - 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 deleted file mode 100644 index c4f112bb..00000000 --- a/ewol__EMessage.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - 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 deleted file mode 100644 index 9938289e..00000000 --- a/ewol__EMultiCast.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - 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 deleted file mode 100644 index 0cf40c5b..00000000 --- a/ewol__EMultiCast__MessageList.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - 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 deleted file mode 100644 index 38aa8d58..00000000 --- a/ewol__EObject.html +++ /dev/null @@ -1,617 +0,0 @@ - - - - - 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. -
    -Parameter [input]: _name Name of the EObject. -
-
- -
-

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 -
    -Return: the last type name of the element -
-
- -
-

getTypeDescription ()

- -
-std::string getTypeDescription(void);
-
-Get the herarchie of the EObject type. -
    -Return: descriptive string. -
-
- -
-

isTypeCompatible ()

- -
-bool isTypeCompatible(const std::string & _type);
-
-check if the element herited from a specific type -
    -Parameter [input]: _type Type to check. -
    Return: true if the element is compatible. -
-
- -
-

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 -
    -Return: true if it might not be removed == > usefull for conficuration class -
-
- -
-

getId ()

- -
-int32_t getId(void);
-
-get the UniqueId of the EObject -
    -Return: the requested ID -
-
- -
-

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... -
    -Parameter [input]: _destinationObject pointer on the object that might be call when an event is generated -
    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 ... -
-
- -
-

unRegisterOnEvent ()

- -
-void unRegisterOnEvent(ewol::EObject * _destinationObject,
-                       const char * _eventId);
-
-Un-Register an EObject over an other. -
    -Parameter [input]: _destinationObject pointer on the object that might be call when an event is generated -
    Parameter [input]: _eventId Event generate inside the object (NULL to remove all event on this object) -
-
- -
-

onObjectRemove ()

- -
-void onObjectRemove(ewol::EObject * _removeObject);
-
-Inform object that an other object is removed ... -
Notes: : Sub classes must call this class -
    -Parameter [input]: _removeObject Pointer on the EObject remeved == > the user must remove all reference on this EObject -
-
- -
-

onReceiveMessage ()

- -
-void onReceiveMessage(const ewol::EMessage & _msg);
-
-Receive a message from an other EObject with a specific eventId and data -
    -Parameter [input]: _msg Message handle -
-
- -
-

getConfigList ()

- -
-const std::vector & getConfigList(void);
-
-get all the configuration list -
    -Return: The list of all parameter availlable in the widget -
-
- -
-

setConfig ()

- -
-bool setConfig(const ewol::EConfig & _conf);
-
-Configuration requested to the curent EObject (systrem mode) -
    -Parameter [input]: _conf Configuration handle. -
    Return: true if config set correctly... -
-
- -
-

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) -
    -Parameter [input]: _config Configuration name. -
    Return: the config properties -
-
- -
-

getConfig ()

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

getName ()

- -
-const std::string & getName(void);
-
-get the eObject name -
    -Return: The requested name -
-
- -
-

setName ()

- -
-void setName(const std::string & _name);
-
-get the Widget name -
    -Parameter [input]: _name The new name -
-
- -
-

loadXML ()

- -
-bool loadXML(exml::Element * _node);
-
-load properties with an XML node. -
    -Parameter [input]: _node Pointer on the tinyXML node. -
    Return: true : All has been done corectly. -
    Return: false : An error occured. -
-
- -
-

storeXML ()

- -
-bool storeXML(exml::Element * _node);
-
-store properties in this XML node. -
    -Parameter [input] [output]: _node Pointer on the tinyXML node. -
    Return: true : All has been done corectly. -
    Return: false : An error occured. -
-
- -
-

getEObjectManager ()

- -
-ewol::EObjectManager & getEObjectManager(void);
-
-
    -Return: the requested object manager. -
-
- -
-

getMultiCast ()

- -
-ewol::EMultiCast & getMultiCast(void);
-
-
    -Return: the requested object manager. -
-
- -
-

getContext ()

- -
-eContext & getContext(void);
-
-get the curent the system inteface. -
    -Return: current reference on the instance. -
-
- -
-

setStatusResource ()

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

getStatusResource ()

- -
-bool getStatusResource(void);
-
-Get the resource status of the element. -
    -Return: the resource status. -
-
- -
-

autoDestroy ()

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

- -
-

addObjectType ()

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

addEventId ()

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

generateEventId ()

- -
-void generateEventId(const char * _generateEventId,
-                     const std::string & _data);
-
-generate event on all registered EObject -
    -Parameter [input]: _generateEventId event Id that is curetly generated -
    Parameter [input]: _data data associated with the event -
-
- -
-

sendMultiCast ()

- -
-void sendMultiCast(const char * const _messageId,
-                   const std::string & _data);
-
-generate Multicast event on all EObject requested the event -
    -Parameter [input]: _messageId Event Id that is generated -
    Parameter [input]: _data String that is send at all the destinations -
-
- -
-

registerMultiCast ()

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

registerConfig ()

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

onSetConfig ()

- -
-bool onSetConfig(const ewol::EConfig & _conf);
-
-Configuration requested to the curent EObject -
    -Parameter [input]: _conf Configuration handle. -
    Return: true if the parametere has been used -
-
- -
-

onGetConfig ()

- -
-bool onGetConfig(const char * _config,
-                 std::string & _result);
-
-Receive a configuration message from an other element system or from the curent EObject -
    -Parameter [input]: _config Configuration name. -
    Parameter [output]: _result Result of the request. -
    Return: true if the config is set -
-
- -
-
- - diff --git a/ewol__EObjectManager.html b/ewol__EObjectManager.html deleted file mode 100644 index 458253a3..00000000 --- a/ewol__EObjectManager.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - 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 deleted file mode 100644 index eda334e8..00000000 --- a/ewol__EventEntry.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - 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 deleted file mode 100644 index 7b95ccf6..00000000 --- a/ewol__EventEntrySystem.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - 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 deleted file mode 100644 index db333f3e..00000000 --- a/ewol__EventExtGen.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - ewol Library - - - - -
-

Class: ewol::EventExtGen

-
-

Synopsis:

-
-
- - -

Description:

-/** -* local class for event generation -*/

Detail:

-

- - diff --git a/ewol__EventInput.html b/ewol__EventInput.html deleted file mode 100644 index 372c9ef8..00000000 --- a/ewol__EventInput.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - 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 deleted file mode 100644 index 03104344..00000000 --- a/ewol__EventInputSystem.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - 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 index f7784f21..7cf4cbf5 100644 --- a/ewol__EventShortCut.html +++ b/ewol__EventShortCut.html @@ -4,140 +4,155 @@ ewol Library +

Class: ewol::EventShortCut


-

Synopsis:

+

Constructor and Destructor:

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

Synopsis:

+
+
-

Detail:

+

Description:

+/** +* @not-in-doc +*/

Detail:

ewol::EventShortCut ()

diff --git a/ewol__EventTime.html b/ewol__EventTime.html
deleted file mode 100644
index 9f5f4e92..00000000
--- a/ewol__EventTime.html
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-	
-	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 deleted file mode 100644 index ed030534..00000000 --- a/ewol__Face.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - 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 deleted file mode 100644 index cca1bd9d..00000000 --- a/ewol__FaceIndexing.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - ewol Library - - - - -
-

Class: ewol::FaceIndexing

-
-

Synopsis:

-
-
- - -

Detail:

-

- - diff --git a/ewol__FontBase.html b/ewol__FontBase.html deleted file mode 100644 index 24ce6ccf..00000000 --- a/ewol__FontBase.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - 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 deleted file mode 100644 index b59726a9..00000000 --- a/ewol__FontFreeType.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - 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... -
    -Parameter [input]: _filename Name of the base font. -
    Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::FontBase * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

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 deleted file mode 100644 index c8475ad2..00000000 --- a/ewol__Fps.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - 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 -
    -Parameter [input]: displayTime display curent time of the frame. -
-
- -
-

incrementCounter ()

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

- -
-

draw ()

- -
-void draw(void);
-
-draw debug display ... -

- -
-
- - diff --git a/ewol__GlyphProperty.html b/ewol__GlyphProperty.html index dc8d8e45..5ba7fdb3 100644 --- a/ewol__GlyphProperty.html +++ b/ewol__GlyphProperty.html @@ -4,140 +4,155 @@ ewol Library +

Class: ewol::GlyphProperty


+

Constructor and Destructor:

+
++        GlyphProperty  (void);

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);
++ float kerningGet (const char32_t _charcode);
+ void kerningAdd (const char32_t _charcode,
float _value);
+ void kerningClear (void);
+ bool exist (void);
+ void setNotExist (void);
-

Detail:

+

Description:

+/** +* @not-in-doc +*/

Detail:

ewol::GlyphProperty ()

diff --git a/ewol__Image.html b/ewol__Image.html
deleted file mode 100644
index 4cb7c371..00000000
--- a/ewol__Image.html
+++ /dev/null
@@ -1,416 +0,0 @@
-
-
-
-	
-	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 -
    -Parameter [input]: _imageName Name of the file that might be loaded -
-
- -
-

ewol::~Image ()

- -
-~Image(void);
-
-generic destructor -

- -
-

draw ()

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

clear ()

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

- -
-

getPos ()

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

setPos ()

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

setPos ()

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

setRelPos ()

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

setRelPos ()

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

setColor ()

- -
-void setColor(const etk::Color<> & _color);
-
-set the Color of the current foreground font -
    -Parameter [input]: _color Color to set on foreground (for next print) -
-
- -
-

setClippingWidth ()

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

setClippingWidth ()

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

setClipping ()

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

setClipping ()

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

setClippingMode ()

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

- -
-

setAngle ()

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

print ()

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

print ()

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

printPart ()

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

setSource ()

- -
-void setSource(const std::string & _newFile,
-               int32_t _size);
-
-change the image Source == > can not be done to display 2 images at the same time ... -
    -Parameter [input]: _newFile New file of the Image -
    Parameter [input]: _size for the image when Verctorial image loading is requested -
-
- -
-

setSource ()

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

hasSources ()

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

getRealSize ()

- -
-vec2 getRealSize(void);
-
-get the source image registered size in the file (<0 when multiple size image) -
    -Return: tre image registered size -
-
- -
-

loadProgram ()

- -
-void loadProgram(void);
-
-load the openGL program and get all the ID needed -

- -
-
- - diff --git a/ewol__Kerning.html b/ewol__Kerning.html index 31932303..cce841c1 100644 --- a/ewol__Kerning.html +++ b/ewol__Kerning.html @@ -4,141 +4,154 @@ ewol Library +

Class: ewol::Kerning


-

Synopsis:

+

Constructor and Destructor:

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

Synopsis:

+
+

Description:

/** +* @not-in-doc * @brief Kerning properties of one specific Glyph with an other * @note The "Kerning" is the methode to provide a better display for some string like * the "VA" has 2 letter that overlap themself. This name Kerning diff --git a/ewol__Light.html b/ewol__Light.html deleted file mode 100644 index cac807c0..00000000 --- a/ewol__Light.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - 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 deleted file mode 100644 index 656b8f85..00000000 --- a/ewol__Material.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - 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 deleted file mode 100644 index da1c8030..00000000 --- a/ewol__MaterialGlId.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - 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 deleted file mode 100644 index 20ac8790..00000000 --- a/ewol__Mesh.html +++ /dev/null @@ -1,333 +0,0 @@ - - - - - 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 -
    -Parameter [input]: _status New state. -
-
- -
-

getCheckNormal ()

- -
-bool getCheckNormal(void);
-
-get the check value of normal position befor sending it to the openGl card -
    -Return: get the chcking stus of normal or not -
-
- -
-

getPhysicalProperties ()

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

setShape ()

- -
-void setShape(void * _shape);
-
-set the shape pointer (no type == > user might know it ...) -
    -Parameter [input]: _shape The new shape (this remove the previous one) -
-
- -
-

getShape ()

- -
-void * getShape(void);
-
-get the pointer on the shame (no type) -
    -Return: Pointer on shape. -
-
- -
-

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... -
    -Parameter [input]: _filename Name of the ewol mesh file. -
    Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::Mesh * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

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__Object.html b/ewol__Object.html new file mode 100644 index 00000000..b10f9e4d --- /dev/null +++ b/ewol__Object.html @@ -0,0 +1,629 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::Object

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Description:

+//!< sometimes the user prefer to receive some specific data on an event (instead of the one sed by the widget)/** +* @brief Basic message classes for ewol system +* this class mermit at every Object to communicate between them. +*/

Detail:

+

ewol::Object ()

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

+ +
+

ewol::Object ()

+ +
+Object(const std::string & _name);
+
+Constructor. +
    +Parameter [input]: _name Name of the Object. +
+
+ +
+

ewol::~Object ()

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

+ +
+

removeObject ()

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

+ +
+

getObjectType ()

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

getTypeDescription ()

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

isTypeCompatible ()

+ +
+bool isTypeCompatible(const std::string & _type);
+
+check if the element herited from a specific type +
    +Parameter [input]: _type Type to check. +
    Return: true if the element is compatible. +
+
+ +
+

getStatic ()

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

getId ()

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

registerOnEvent ()

+ +
+void registerOnEvent(ewol::Object * _destinationObject,
+                     const char * _eventId,
+                     const char * _eventIdgenerated,
+                     const std::string & _overloadData);
+
+Register an Object over an other to get event on the second... +
    +Parameter [input]: _destinationObject pointer on the object that might be call when an event is generated +
    Parameter [input]: _eventId Event generate inside the object +
    Parameter [input]: _eventIdgenerated event generated when call the distant Object.onReceiveMessage(...) +
    Parameter [input]: _overloadData When the user prever to receive a data specificly for this event ... +
+
+ +
+

unRegisterOnEvent ()

+ +
+void unRegisterOnEvent(ewol::Object * _destinationObject,
+                       const char * _eventId);
+
+Un-Register an Object over an other. +
    +Parameter [input]: _destinationObject pointer on the object that might be call when an event is generated +
    Parameter [input]: _eventId Event generate inside the object (NULL to remove all event on this object) +
+
+ +
+

onObjectRemove ()

+ +
+void onObjectRemove(ewol::Object * _removeObject);
+
+Inform object that an other object is removed ... +
Notes: : Sub classes must call this class +
    +Parameter [input]: _removObject Pointer on the Object remeved == > the user must remove all reference on this Object +
+
+ +
+

onReceiveMessage ()

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

getConfigList ()

+ +
+const std::vector & getConfigList(void);
+
+get all the configuration list +
    +Return: The list of all parameter availlable in the widget +
+
+ +
+

setConfig ()

+ +
+bool setConfig(const ewol::object::Config & _conf);
+
+Configuration requested to the curent Object (systrem mode) +
    +Parameter [input]: _conf Configuration handle. +
    Return: true if config set correctly... +
+
+ +
+

setConfig ()

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

setConfigNamed ()

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

setConfigNamed ()

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

getConfig ()

+ +
+std::string getConfig(const char * _config);
+
+Configuration get from the curent Object (systrem mode) +
    +Parameter [input]: _config Configuration name. +
    Return: the config properties +
+
+ +
+

getConfig ()

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

getName ()

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

setName ()

+ +
+void setName(const std::string & _name);
+
+get the Widget name +
    +Parameter [input]: _name The new name +
+
+ +
+

loadXML ()

+ +
+bool loadXML(exml::Element * _node);
+
+load properties with an XML node. +
    +Parameter [input]: _node Pointer on the tinyXML node. +
    Return: true : All has been done corectly. +
    Return: false : An error occured. +
+
+ +
+

storeXML ()

+ +
+bool storeXML(exml::Element * _node);
+
+store properties in this XML node. +
    +Parameter [input] [output]: _node Pointer on the tinyXML node. +
    Return: true : All has been done corectly. +
    Return: false : An error occured. +
+
+ +
+

getObjectManager ()

+ +
+ewol::object::Manager & getObjectManager(void);
+
+
    +Return: the requested object manager. +
+
+ +
+

getMultiCast ()

+ +
+ewol::object::MultiCast & getMultiCast(void);
+
+
    +Return: the requested object manager. +
+
+ +
+

getContext ()

+ +
+ewol::Context & getContext(void);
+
+get the curent the system inteface. +
    +Return: current reference on the instance. +
+
+ +
+

setStatusResource ()

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

getStatusResource ()

+ +
+bool getStatusResource(void);
+
+Get the resource status of the element. +
    +Return: the resource status. +
+
+ +
+

autoDestroy ()

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

+ +
+

addObjectType ()

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

addEventId ()

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

generateEventId ()

+ +
+void generateEventId(const char * _generateEventId,
+                     const std::string & _data);
+
+generate event on all registered Object +
    +Parameter [input]: _generateEventId event Id that is curetly generated +
    Parameter [input]: _data data associated with the event +
+
+ +
+

sendMultiCast ()

+ +
+void sendMultiCast(const char * const _messageId,
+                   const std::string & _data);
+
+generate Multicast event on all Object requested the event +
    +Parameter [input]: _messageId Event Id that is generated +
    Parameter [input]: _data String that is send at all the destinations +
+
+ +
+

registerMultiCast ()

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

registerConfig ()

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

onSetConfig ()

+ +
+bool onSetConfig(const ewol::object::Config & _conf);
+
+Configuration requested to the curent Object +
    +Parameter [input]: _conf Configuration handle. +
    Return: true if the parametere has been used +
+
+ +
+

onGetConfig ()

+ +
+bool onGetConfig(const char * _config,
+                 std::string & _result);
+
+Receive a configuration message from an other element system or from the curent Object +
    +Parameter [input]: _config Configuration name. +
    Parameter [output]: _result Result of the request. +
    Return: true if the config is set +
+
+ +
+
+ + diff --git a/ewol__PhysicsBox.html b/ewol__PhysicsBox.html deleted file mode 100644 index 3943f887..00000000 --- a/ewol__PhysicsBox.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - 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 deleted file mode 100644 index 7882e11d..00000000 --- a/ewol__PhysicsCapsule.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - 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 deleted file mode 100644 index db6a87c5..00000000 --- a/ewol__PhysicsCone.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - 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 deleted file mode 100644 index 81c37a81..00000000 --- a/ewol__PhysicsConvexHull.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - 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 deleted file mode 100644 index c9fc9855..00000000 --- a/ewol__PhysicsCylinder.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - 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 deleted file mode 100644 index ecadc77f..00000000 --- a/ewol__PhysicsShape.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - 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 deleted file mode 100644 index e0726909..00000000 --- a/ewol__PhysicsSphere.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - 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__Resource.html b/ewol__Resource.html index e071005d..f89bd307 100644 --- a/ewol__Resource.html +++ b/ewol__Resource.html @@ -4,151 +4,162 @@ ewol Library +

Class: ewol::Resource


+

Constructor and Destructor:

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

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);
++ void increment (void);
+ bool decrement (void);
+ int32_t getCounter (void);
+ uint8_t getResourceLevel (void);
+ void updateContext (void);
+ void removeContext (void);
+ void removeContextToLate (void);
+ void reload (void);
+ static ewol::resource::Manager & getManager (void);

Object Hierarchy:

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

Detail:

@@ -243,7 +254,7 @@

ewol::getManager ()

-static ewol::ResourceManager & getManager(void);
+static ewol::resource::Manager & getManager(void);


diff --git a/ewol__ResourceManager.html b/ewol__ResourceManager.html deleted file mode 100644 index 2a393dd6..00000000 --- a/ewol__ResourceManager.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - 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 ... -
    -Parameter [input]: _object The resources that might be updated -
-
- -
-

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. -
    -Parameter [input] [output]: _object element to realease == > is return at NULL value. -
    Return: true, if element is removed, and false for just decreasing counter -
-
- -
-
- - diff --git a/ewol__Shader.html b/ewol__Shader.html deleted file mode 100644 index 636ea4a4..00000000 --- a/ewol__Shader.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - 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. -
    -Return: The define char of his name. -
-
- -
-

getGL_ID ()

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

getShaderType ()

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

updateContext ()

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

- -
-

removeContext ()

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

- -
-

removeContextToLate ()

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

- -
-

reload ()

- -
-void reload(void);
-
-Relode the shader from the file. used when a request of resouces reload is done. -
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... -
    -Parameter [input]: _filename Name of the openGL Shader. -
    Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::Shader * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

ewol::Shader ()

- -
-Shader(const std::string & _filename);
-
-Contructor of an opengl Shader -
    -Parameter [input]: filename Standard file name format. see
-
- -
-

ewol::~Shader ()

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

- -
-
- - diff --git a/ewol__Shaper.html b/ewol__Shaper.html deleted file mode 100644 index 1f82bd7d..00000000 --- a/ewol__Shaper.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - 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 -
    -Parameter [input]: _shaperName Name of the file that might be loaded -
-
- -
-

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 -
    -Parameter [input]: _newStatusId the next new status requested -
    Return: true The widget must call this fuction periodicly (and redraw itself) -
    Return: false No need to request the periodic call. -
-
- -
-

getCurrentDisplayedStatus ()

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

getNextDisplayedStatus ()

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

getTransitionStatus ()

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

periodicCall ()

- -
-bool periodicCall(const ewol::EventTime & _event);
-
-Same as the widfget periodic call (this is for change display) -
    -Parameter [input]: _event The current time of the call. -
    Return: true The widget must call this fuction periodicly (and redraw itself) -
    Return: false No need to request the periodic call. -
-
- -
-

setOrigin ()

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

setSize ()

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

setInsideSize ()

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

setInsidePos ()

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

getPadding ()

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

setSource ()

- -
-void setSource(const std::string & _newFile);
-
-change the shaper Source -
    -Parameter [input]: _newFile New file of the shaper -
-
- -
-

getSource ()

- -
-const std::string & getSource(void);
-
-get the shaper file Source -
    -Return: the shapper file name -
-
- -
-

hasSources ()

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

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 deleted file mode 100644 index 12a45717..00000000 --- a/ewol__SimpleConfigElement.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - 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 deleted file mode 100644 index f9c8a562..00000000 --- a/ewol__SpecialKey.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - 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 -
    -Return: The status value -
-
- -
-

isSetShift ()

- -
-bool isSetShift(void);
-
-get the current Shift key status -
    -Return: The status value -
-
- -
-

isSetCtrl ()

- -
-bool isSetCtrl(void);
-
-get the Current Control key status -
    -Return: The status value -
-
- -
-

isSetMeta ()

- -
-bool isSetMeta(void);
-
-get the current Meta key status (also named windows or apple key) -
    -Return: The status value -
-
- -
-

isSetAlt ()

- -
-bool isSetAlt(void);
-
-get the current Alt key status -
    -Return: The status value -
-
- -
-

isSetAltGr ()

- -
-bool isSetAltGr(void);
-
-get the current Alt-Gr key status -
    -Return: The status value -
-
- -
-

isSetNumLock ()

- -
-bool isSetNumLock(void);
-
-get the current Ver-num key status -
    -Return: The status value -
-
- -
-

isSetInsert ()

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

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

-
-

Synopsis:

-
-
- - -

Detail:

-

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

Class: ewol::SpecialKey::union

-
-

Synopsis:

-
-
- - -

Detail:

-

- - diff --git a/ewol__Sprite.html b/ewol__Sprite.html deleted file mode 100644 index b863986e..00000000 --- a/ewol__Sprite.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - 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__TextDecoration.html b/ewol__TextDecoration.html deleted file mode 100644 index 3644f297..00000000 --- a/ewol__TextDecoration.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - 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 deleted file mode 100644 index f7d1935e..00000000 --- a/ewol__Texture.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - 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... -
    -Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::Texture * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

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 deleted file mode 100644 index 0750dedc..00000000 --- a/ewol__TextureFile.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - 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... -
    -Parameter [input]: _filename Name of the image file. -
    Parameter [input]: _requested size of the image (usefull when loading .svg to automatic rescale) -
    Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::TextureFile * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

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 deleted file mode 100644 index 7ac0f52d..00000000 --- a/ewol__TexturedFont.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - 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 -
    -Parameter [input]: _displayMode Mode to display the currrent font -
    Return: Dimention of the font need between 2 lines -
-
- -
-

getFontSize ()

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

getIndex ()

- -
-int32_t getIndex(char32_t _charcode,
-                 const enum ewol::font::mode _displayMode);
-
-get the ID of a unicode charcode -
    -Parameter [input]: _charcode The unicodeValue -
    Parameter [input]: _displayMode Mode to display the currrent font -
    Return: The ID in the table (if it does not exist : return 0) -
-
- -
-

getGlyphPointer ()

- -
-ewol::GlyphProperty * getGlyphPointer(const char32_t & _charcode,
-                                      const enum ewol::font::mode _displayMode);
-
-get the pointer on the coresponding glyph -
    -Parameter [input]: _charcode The unicodeValue -
    Parameter [input]: _displayMode Mode to display the currrent font -
    Return: The pointer on the glyph == > never NULL -
-
- -
-

ewol::keep ()

- -
-static ewol::TexturedFont * keep(const std::string & _filename);
-
-keep the resource pointer. -
Notes: Never free this pointer by your own... -
    -Parameter [input]: _filename Name of the texture font. -
    Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::TexturedFont * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

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. -
    -Parameter [input]: _val Char value to add. -
    Return: true if the image size have change, false otherwise -
-
- -
-
- - diff --git a/ewol__VirtualBufferObject.html b/ewol__VirtualBufferObject.html deleted file mode 100644 index ff9dfa05..00000000 --- a/ewol__VirtualBufferObject.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - 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. -
    -Return: The define char of his name. -
-
- -
-

getGL_ID ()

- -
-GLuint getGL_ID(int32_t id);
-
-get the real openGL ID. -
    -Return: the Ogl id reference of this VBO. -
-
- -
-

getRefBuffer ()

- -
-std::vector<float> & getRefBuffer(int32_t id);
-
-get a reference on hte buffer data for this VBO. -
    -Parameter [input]: id Id of the buffer requested -
    Return: A reference on the data. -
-
- -
-

pushOnBuffer ()

- -
-void pushOnBuffer(int32_t id,
-                  const vec3 & data);
-
-push data on a buffer with a custum type : -
    -Parameter [input]: id Id of the buffer requested. -
    Parameter [input]: data Direct data that might be set. -
-
- -
-

getOnBufferVec3 ()

- -
-vec3 getOnBufferVec3(int32_t id,
-                     int32_t elementID);
-
-
- -
-

sizeOnBufferVec3 ()

- -
-int32_t sizeOnBufferVec3(int32_t id);
-
-
- -
-

pushOnBuffer ()

- -
-void pushOnBuffer(int32_t id,
-                  const vec2 & data);
-
-push data on a buffer with a custum type : -
    -Parameter [input]: id Id of the buffer requested. -
    Parameter [input]: data Direct data that might be set. -
-
- -
-

getOnBufferVec2 ()

- -
-vec2 getOnBufferVec2(int32_t id,
-                     int32_t elementID);
-
-
- -
-

sizeOnBufferVec2 ()

- -
-int32_t sizeOnBufferVec2(int32_t id);
-
-
- -
-

retreiveData ()

- -
-void retreiveData(void);
-
-get the data from the graphic card. -

- -
-

flush ()

- -
-void flush(void);
-
-Send the data to the graphic card. -

- -
-

updateContext ()

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

- -
-

removeContext ()

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

- -
-

removeContextToLate ()

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

- -
-

reload ()

- -
-void reload(void);
-
-Relode the shader from the file. used when a request of resouces reload is done. -
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... -
    -Parameter [input]: _number Number of VBO needed -
    Return: pointer on the resource or NULL if an error occured. -
-
- -
-

ewol::release ()

- -
-static void release(ewol::VirtualBufferObject * & _object);
-
-release the keeped resources -
    -Parameter [input] [output]: reference on the object pointer -
-
- -
-

ewol::VirtualBufferObject ()

- -
-VirtualBufferObject(int32_t _number);
-
-Constructor of this VBO. -
    -Parameter [input]: accesMode Acces mode : ??? -
-
- -
-

ewol::~VirtualBufferObject ()

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

- -
-
- - diff --git a/ewol__Widget.html b/ewol__Widget.html index 6aaa3489..010e86ba 100644 --- a/ewol__Widget.html +++ b/ewol__Widget.html @@ -4,160 +4,171 @@ ewol Library +

Class: ewol::Widget


+

Constructor and Destructor:

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

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

Object Hierarchy:

-ewol::EObject
+ewol::Object
     +--> 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
+        +--> ewol::widget::ProgressBar
+        +--> ewol::widget::ContainerN
+        +--> ewol::widget::Image
+        +--> ewol::widget::WidgetScrooled
+        +--> ewol::widget::Slider
+        +--> ewol::widget::ColorBar
+        +--> ewol::widget::Button
+        +--> ewol::widget::Spacer
+        +--> ewol::widget::Joystick
+        +--> ewol::widget::Label
+        +--> ewol::widget::Container
+        +--> ewol::widget::ButtonColor
+        +--> ewol::widget::Windows
+        +--> ewol::widget::CheckBox
+        +--> ewol::widget::Entry
+        +--> ewol::widget::Gird
 

Description:

@@ -726,7 +737,7 @@ get the keyboard repeating event supporting.

periodicCall ()

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

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 deleted file mode 100644 index 031c190e..00000000 --- a/ewol__Windows.html +++ /dev/null @@ -1,404 +0,0 @@ - - - - - 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. -
    -Return: A reference on the 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. -
    -Parameter [input]: _type Type of the error. -
    Parameter [input]: _message message to display (decorated text) -
-
- -
-

displayInfoMessage ()

- -
-void displayInfoMessage(const std::string & _message);
-
-Create a simple information message -
    -Parameter [input]: _message message to display (decorated text) -
-
- -
-

displayWarningMessage ()

- -
-void displayWarningMessage(const std::string & _message);
-
-Create a simple warning message -
    -Parameter [input]: _message message to display (decorated text) -
-
- -
-

displayErrorMessage ()

- -
-void displayErrorMessage(const std::string & _message);
-
-Create a simple error message -
    -Parameter [input]: _message message to display (decorated text) -
-
- -
-

displayCriticalMessage ()

- -
-void displayCriticalMessage(const std::string & _message);
-
-Create a simple critical message -
    -Parameter [input]: _message message to display (decorated text) -
-
- -
-

systemDraw ()

- -
-void systemDraw(const ewol::DrawProperty & _displayProp);
-
-
- -
-
- - diff --git a/ewol__clipBoard__clipboardListe.html b/ewol__clipBoard__clipboardListe.html deleted file mode 100644 index 8cf9fda8..00000000 --- a/ewol__clipBoard__clipboardListe.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - ewol Library - - - - -
-

Enum: ewol::clipBoard::clipboardListe

-
-Value :
-
    -
  • clipboard0
  • clipboard1
  • clipboard2
  • clipboard3
  • clipboard4
  • clipboard5
  • clipboard6
  • clipboard7
  • clipboard8
  • clipboard9
  • clipboardStd
  • clipboardSelection
  • clipboardCount
-
- - diff --git a/ewol__compositing__Area.html b/ewol__compositing__Area.html new file mode 100644 index 00000000..d0e212e6 --- /dev/null +++ b/ewol__compositing__Area.html @@ -0,0 +1,289 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::compositing::Area

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Detail:

+

ewol::compositing::Area ()

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

ewol::compositing::~Area ()

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

+ +
+

draw ()

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

+ +
+

clear ()

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

+ +
+

getPos ()

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

setPos ()

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

setPos ()

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

setRelPos ()

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

setRelPos ()

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

print ()

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

get ()

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

flush ()

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

loadProgram ()

+ +
+void loadProgram(void);
+
+load the openGL program and get all the ID needed +

+ +
+
+ + diff --git a/ewol__Drawing.html b/ewol__compositing__Drawing.html similarity index 50% rename from ewol__Drawing.html rename to ewol__compositing__Drawing.html index 925326de..85d222a6 100644 --- a/ewol__Drawing.html +++ b/ewol__compositing__Drawing.html @@ -4,147 +4,159 @@ ewol Library +
-

Class: ewol::Drawing

+

Class: ewol::compositing::Drawing


+

Constructor and Destructor:

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

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);
++ 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
+    +--> ewol::compositing::Drawing
 

Detail:

-

ewol::Drawing ()

+

ewol::compositing::Drawing ()

 Drawing(void);
@@ -153,7 +165,7 @@ Basic constructor


-

ewol::~Drawing ()

+

ewol::compositing::~Drawing ()

 ~Drawing(void);
diff --git a/ewol__compositing__Image.html b/ewol__compositing__Image.html new file mode 100644 index 00000000..b6e938a0 --- /dev/null +++ b/ewol__compositing__Image.html @@ -0,0 +1,428 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::compositing::Image

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Detail:

+

ewol::compositing::Image ()

+ +
+Image(const std::string & _imageName);
+
+generic constructor +
    +Parameter [input]: _imageName Name of the file that might be loaded +
+
+ +
+

ewol::compositing::~Image ()

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

+ +
+

draw ()

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

clear ()

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

+ +
+

getPos ()

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

setPos ()

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

setPos ()

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

setRelPos ()

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

setRelPos ()

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

setColor ()

+ +
+void setColor(const etk::Color<> & _color);
+
+set the Color of the current foreground font +
    +Parameter [input]: _color Color to set on foreground (for next print) +
+
+ +
+

setClippingWidth ()

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

setClippingWidth ()

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

setClipping ()

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

setClipping ()

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

setClippingMode ()

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

+ +
+

setAngle ()

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

print ()

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

print ()

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

printPart ()

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

setSource ()

+ +
+void setSource(const std::string & _newFile,
+               int32_t _size);
+
+change the image Source == > can not be done to display 2 images at the same time ... +
    +Parameter [input]: _newFile New file of the Image +
    Parameter [input]: _size for the image when Verctorial image loading is requested +
+
+ +
+

setSource ()

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

hasSources ()

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

getRealSize ()

+ +
+vec2 getRealSize(void);
+
+get the source image registered size in the file (<0 when multiple size image) +
    +Return: tre image registered size +
+
+ +
+

loadProgram ()

+ +
+void loadProgram(void);
+
+load the openGL program and get all the ID needed +

+ +
+
+ + diff --git a/ewol__compositing__Shaper.html b/ewol__compositing__Shaper.html new file mode 100644 index 00000000..20e8b4a9 --- /dev/null +++ b/ewol__compositing__Shaper.html @@ -0,0 +1,390 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::compositing::Shaper

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Description:

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

Detail:

+

ewol::compositing::Shaper ()

+ +
+Shaper(const std::string & _shaperName);
+
+generic constructor +
    +Parameter [input]: _shaperName Name of the file that might be loaded +
+
+ +
+

ewol::compositing::~Shaper ()

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

+ +
+

draw ()

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

+ +
+

clear ()

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

+ +
+

changeStatusIn ()

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

getCurrentDisplayedStatus ()

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

getNextDisplayedStatus ()

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

getTransitionStatus ()

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

periodicCall ()

+ +
+bool periodicCall(const ewol::event::Time & _event);
+
+Same as the widfget periodic call (this is for change display) +
    +Parameter [input]: _event The current time of the call. +
    Return: true The widget must call this fuction periodicly (and redraw itself) +
    Return: false No need to request the periodic call. +
+
+ +
+

setOrigin ()

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

setSize ()

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

setInsideSize ()

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

setInsidePos ()

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

getPadding ()

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

setSource ()

+ +
+void setSource(const std::string & _newFile);
+
+change the shaper Source +
    +Parameter [input]: _newFile New file of the shaper +
+
+ +
+

getSource ()

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

hasSources ()

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

loadProgram ()

+ +
+void loadProgram(void);
+
+load the openGL program and get all the ID needed +

+ +
+

unLoadProgram ()

+ +
+void unLoadProgram(void);
+
+Un-Load the openGL program and get all the ID needed +

+ +
+

updateVertex ()

+ +
+void updateVertex(void);
+
+update the internal vertex table. +

+ +
+
+ + diff --git a/ewol__compositing__Sprite.html b/ewol__compositing__Sprite.html new file mode 100644 index 00000000..4ac93100 --- /dev/null +++ b/ewol__compositing__Sprite.html @@ -0,0 +1,197 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::compositing::Sprite

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Detail:

+

ewol::compositing::Sprite ()

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

ewol::compositing::~Sprite ()

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

printSprite ()

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

printSprite ()

+ +
+void printSprite(const ivec2 & _spriteID,
+                 const vec3 & _size);
+
+
+ +
+
+ + diff --git a/ewol__Text.html b/ewol__compositing__Text.html similarity index 55% rename from ewol__Text.html rename to ewol__compositing__Text.html index feab342a..bd11e42f 100644 --- a/ewol__Text.html +++ b/ewol__compositing__Text.html @@ -4,155 +4,167 @@ ewol Library +
-

Class: ewol::Text

+

Class: ewol::compositing::Text


+

Constructor and Destructor:

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

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);
++ ewol::compositing::Drawing & getDrawing (void);
+ void translate (const vec3 & _vect);
+ void rotate (const vec3 & _vect,
float _angle);
+ void scale (const vec3 & _vect);
+ void draw (bool _disableDepthTest);
+ void draw (const mat4 & _transformationMatrix,
bool _enableDepthTest);
+ void clear (void);
+ void reset (void);
+ const vec3 & getPos (void);
+ void setPos (const vec3 & _pos);
+ void setPos (const vec2 & _pos);
+ void setRelPos (const vec3 & _pos);
+ void setRelPos (const vec2 & _pos);
+ void setColor (const etk::Color<> & _color);
+ void setColorBg (const etk::Color<> & _color);
+ void setClippingWidth (const vec3 & _pos,
const vec3 & _width);
+ void setClippingWidth (const vec2 & _pos,
const vec2 & _width);
+ void setClipping (const vec3 & _pos,
const vec3 & _posEnd);
+ void setClipping (const vec2 & _pos,
const vec2 & _posEnd);
+ void setClippingMode (bool _newMode);
+ void setFontSize (int32_t _fontSize);
+ void setFontName (const std::string & _fontName);
+ void setFont (std::string _fontName,
int32_t _fontSize);
+ void setFontMode (enum ewol::font::mode _mode);
+ void setFontBold (bool _status);
+ void setFontItalic (bool _status);
+ void setKerningMode (bool _newMode);
+ void setDistanceFieldMode (bool _newMode);
+ void print (const std::string & _text);
+ void print (const std::u32string & _text);
+ void printDecorated (const std::string & _text);
+ void printHTML (const std::string & _text);
+ void print (const std::string & _text,
const std::vector & _decoration);
+ void print (const std::u32string & _text,
const std::vector & _decoration);
+ void print (const char32_t & _charcode);
+ void forceLineReturn (void);
+ void setTextAlignement (float _startTextpos,
float _stopTextPos,
enum ewol::compositing::Text::aligneMode _alignement);
+ void disableAlignement (void);
+ vec3 calculateSizeHTML (const std::string & _text);
+ vec3 calculateSizeDecorated (const std::string & _text);
+ vec3 calculateSize (const std::string & _text);
+ vec3 calculateSize (const char32_t & _charcode);
+ void printCursor (bool _isInsertMode,
float _cursorSize);
+ void disableCursor (void);
+ void setCursorPos (int32_t _cursorPos);
+ void setCursorSelection (int32_t _cursorPos,
int32_t _selectionStartPos);
+ void setSelectionColor (const etk::Color<> & _color);
+ void setCursorColor (const etk::Color<> & _color);
- void loadProgram (void);
- void parseHtmlNode (exml::Element * _element);
- bool extrapolateLastId (const std::string & _text,
const int32_t _start,
int32_t & _stop,
int32_t & _space,
int32_t & _freeSpace);
- bool extrapolateLastId (const std::u32string & _text,
const int32_t _start,
int32_t & _stop,
int32_t & _space,
int32_t & _freeSpace);
- void htmlAddData (const std::string & _data);
- void htmlFlush (void);

Object Hierarchy:

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

Detail:

getDrawing ()

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


-

ewol::Text ()

+

ewol::compositing::Text ()

 Text(const std::string & _fontName,
@@ -166,7 +178,7 @@ generic constructor
 

-

ewol::~Text ()

+

ewol::compositing::~Text ()

 ~Text(void);
@@ -606,7 +618,7 @@ This generate the line return == > it return to the alignement position start a
 void setTextAlignement(float _startTextpos,
                        float _stopTextPos,
-                       enum ewol::Text::aligneMode _alignement);
+ enum ewol::compositing::Text::aligneMode _alignement);

This generate the possibility to generate the big text property
Notes: The text align in center change of line every display done (even if it was just a char) diff --git a/ewol__compositing__TextDecoration.html b/ewol__compositing__TextDecoration.html new file mode 100644 index 00000000..8895afbf --- /dev/null +++ b/ewol__compositing__TextDecoration.html @@ -0,0 +1,167 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::compositing::TextDecoration

+
+

Constructor and Destructor:

+
++        TextDecoration  (void);
+

Synopsis:

+
+
+ + +

Description:

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

Detail:

+

ewol::compositing::TextDecoration ()

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

Class: ewol::context::CommandLine

+
+

Constructor and Destructor:

+
+
+

Synopsis:

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

Detail:

+

parse ()

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

+ +
+

size ()

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

get ()

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

add ()

+ +
+void add(const std::string & _newElement);
+
+add one element at the Command line +
    +Parameter [input]: _newElement String in the input that might be added. +
+
+ +
+

remove ()

+ +
+void remove(int32_t _id);
+
+remove an element +
    +Parameter [input]: _id Id of the element +
+
+ +
+
+ + diff --git a/ewol__context__ConfigFont.html b/ewol__context__ConfigFont.html new file mode 100644 index 00000000..c6b1b5ff --- /dev/null +++ b/ewol__context__ConfigFont.html @@ -0,0 +1,254 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::context::ConfigFont

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::context::ConfigFont ()

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

ewol::context::~ConfigFont ()

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

setFolder ()

+ +
+void setFolder(const std::string & _folder);
+
+Specify the default font folder for the Ewol search system (only needed when embended font) +
    +Parameter [input]: _folder basic folder of the font (ex: DATA:fonts) +
+
+ +
+

getFolder ()

+ +
+const std::string & getFolder(void);
+
+get the default font folder. +
    +Return: 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. +
    +Parameter [input]: _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". +
    Parameter [input]: _size The default size of the font default=10. +
+
+ +
+

getName ()

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

+ +
+

getSize ()

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

setUseExternal ()

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

getUseExternal ()

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

Class: ewol::context::Fps

+
+

Constructor and Destructor:

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

Synopsis:

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

Description:

+/** +* @brief This class is designed to count the number of frame per second in the main renderer system +* @not-in-doc +*/

Detail:

+

ewol::context::Fps ()

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

+ +
+

ewol::context::~Fps ()

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

+ +
+

tic ()

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

+ +
+

toc ()

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

incrementCounter ()

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

+ +
+

draw ()

+ +
+void draw(void);
+
+draw debug display ... +

+ +
+
+ + diff --git a/ewol__context__InputLimit.html b/ewol__context__InputLimit.html new file mode 100644 index 00000000..94cbe12a --- /dev/null +++ b/ewol__context__InputLimit.html @@ -0,0 +1,159 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::context::InputLimit

+
+

Constructor and Destructor:

+
+
+

Synopsis:

+
+
+ + +

Description:

+/** +* @brief internal structure +* @not-in-doc +*/

Detail:

+

+ + diff --git a/ewol__context__InputManager.html b/ewol__context__InputManager.html new file mode 100644 index 00000000..24488b44 --- /dev/null +++ b/ewol__context__InputManager.html @@ -0,0 +1,324 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::context::InputManager

+
+

Constructor and Destructor:

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

Synopsis:

+
++  void     setDpi                 (int32_t newDPI);
+ void motion (enum ewol::key::type _type,
int _pointerID,
vec2 _pos);
+ void state (enum ewol::key::type _type,
int _pointerID,
bool _isDown,
vec2 _pos);
+ void onObjectRemove (ewol::Object * _removeObject);
+ void newLayerSet (void);
+ void transfertEvent (ewol::Widget * _source,
ewol::Widget * _destination);
+ void grabPointer (ewol::Widget * _widget);
+ void unGrabPointer (void);
- void calculateLimit (void);
- void abortElement (InputPoperty * _eventTable,
int32_t _idInput,
enum ewol::key::type _type);
- void cleanElement (InputPoperty * _eventTable,
int32_t _idInput);
- bool localEventInput (enum ewol::key::type _type,
ewol::Widget * _destWidget,
int32_t _IdInput,
enum ewol::key::status _typeEvent,
vec2 _pos);
- int32_t localGetDestinationId (enum ewol::key::type _type,
ewol::Widget * _destWidget,
int32_t _realInputId);
+ + +

Detail:

+

ewol::context::InputManager ()

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

ewol::context::~InputManager ()

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

setDpi ()

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

motion ()

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

state ()

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

onObjectRemove ()

+ +
+void onObjectRemove(ewol::Object * _removeObject);
+
+Inform object that an other object is removed ... +
Notes: : Sub classes must call this class +
    +Parameter [input]: removeObject Pointer on the Object remeved == > the user must remove all reference on this Object +
+
+ +
+

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 +
    +Parameter: _source the widget where the event came from +
    Parameter: _destination the widget where the event mitgh be generated now +
+
+ +
+

grabPointer ()

+ +
+void grabPointer(ewol::Widget * _widget);
+
+This fonction lock the pointer properties to move in relative instead of absolute +
    +Parameter [input]: _widget The widget that lock the pointer events +
+
+ +
+

unGrabPointer ()

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

+ +
+

calculateLimit ()

+ +
+void calculateLimit(void);
+
+
+ +
+

abortElement ()

+ +
+void abortElement(InputPoperty * _eventTable,
+                  int32_t _idInput,
+                  enum ewol::key::type _type);
+
+
+ +
+

cleanElement ()

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

localEventInput ()

+ +
+bool localEventInput(enum ewol::key::type _type,
+                     ewol::Widget * _destWidget,
+                     int32_t _IdInput,
+                     enum ewol::key::status _typeEvent,
+                     vec2 _pos);
+
+generate the event on the destinated widget. +
    +Parameter [input]: _type Type of the event that might be sended. +
    Parameter [input]: _destWidget Pointer on the requested widget that element might be sended +
    Parameter [input]: _IdInput Id of the event (PC : [0..9] and touch : [1..9]) +
    Parameter [input]: _typeEvent type of the eventg generated +
    Parameter [input]: _pos position of the event +
    Return: true if event has been greped +
+
+ +
+

localGetDestinationId ()

+ +
+int32_t localGetDestinationId(enum ewol::key::type _type,
+                              ewol::Widget * _destWidget,
+                              int32_t _realInputId);
+
+convert the system event id in the correct EWOL id depending of the system management mode + This function find the next input id unused on the specifiic widget + == > on PC, the ID does not change (GUI is not the same) +
    +Parameter [input]: _type Type of the kay event. +
    Parameter [input]: _destWidget Pointer of the widget destination +
    Parameter [input]: _realInputId system Id +
    Return: the ewol input id +
+
+ +
+
+ + diff --git a/ewol__context__InputPoperty.html b/ewol__context__InputPoperty.html new file mode 100644 index 00000000..e784c69a --- /dev/null +++ b/ewol__context__InputPoperty.html @@ -0,0 +1,159 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::context::InputPoperty

+
+

Constructor and Destructor:

+
+
+

Synopsis:

+
+
+ + +

Description:

+/** +* @brief internal structure +* @not-in-doc +*/

Detail:

+

+ + diff --git a/ewol__context__clipBoard__clipboardListe.html b/ewol__context__clipBoard__clipboardListe.html new file mode 100644 index 00000000..88907994 --- /dev/null +++ b/ewol__context__clipBoard__clipboardListe.html @@ -0,0 +1,149 @@ + + + + + ewol Library + + + + + +
+

Enum: ewol::context::clipBoard::clipboardListe

+
+Value :
+
    +
  • clipboard0
  • clipboard1
  • clipboard2
  • clipboard3
  • clipboard4
  • clipboard5
  • clipboard6
  • clipboard7
  • clipboard8
  • clipboard9
  • clipboardStd
  • clipboardSelection
  • clipboardCount
+
+ + diff --git a/ewol__context__cursorDisplay.html b/ewol__context__cursorDisplay.html new file mode 100644 index 00000000..ffcd827c --- /dev/null +++ b/ewol__context__cursorDisplay.html @@ -0,0 +1,149 @@ + + + + + ewol Library + + + + + +
+

Enum: ewol::context::cursorDisplay

+
+Value :
+
    +
  • cursorArrow
  • cursorLeftArrow
  • cursorInfo
  • cursorDestroy
  • cursorHelp
  • cursorCycle
  • cursorSpray
  • cursorWait
  • cursorText
  • cursorCrossHair
  • cursorSlideUpDown
  • cursorSlideLeftRight
  • cursorResizeUp
  • cursorResizeDown
  • cursorResizeLeft
  • cursorResizeRight
  • cursorCornerTopLeft
  • cursorCornerTopRight
  • cursorCornerButtomLeft
  • cursorCornerButtomRight
  • cursorNone
  • cursorCount
+
+ + diff --git a/ewol__cursorDisplay.html b/ewol__cursorDisplay.html deleted file mode 100644 index 65b5e672..00000000 --- a/ewol__cursorDisplay.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - ewol Library - - - - -
-

Enum: ewol::cursorDisplay

-
-Value :
-
    -
  • cursorArrow
  • cursorLeftArrow
  • cursorInfo
  • cursorDestroy
  • cursorHelp
  • cursorCycle
  • cursorSpray
  • cursorWait
  • cursorText
  • cursorCrossHair
  • cursorSlideUpDown
  • cursorSlideLeftRight
  • cursorResizeUp
  • cursorResizeDown
  • cursorResizeLeft
  • cursorResizeRight
  • cursorCornerTopLeft
  • cursorCornerTopRight
  • cursorCornerButtomLeft
  • cursorCornerButtomRight
  • cursorNone
  • cursorCount
-
- - diff --git a/ewol__eContext.html b/ewol__eContext.html deleted file mode 100644 index 8df693db..00000000 --- a/ewol__eContext.html +++ /dev/null @@ -1,695 +0,0 @@ - - - - - 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 -
    -Parameter [input]: removeObject Pointer on the EObject removed == > the user must remove all reference on this EObject -
-
- -
-

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 : -
    -Parameter: _windows Windows that might be displayed -
-
- -
-

getWindows ()

- -
-ewol::Windows * getWindows(void);
-
-get the current windows that is displayed -
    -Return: the current handle on the windows (can be null) -
-
- -
-

getSize ()

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

OS_Resize ()

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

setSize ()

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

OS_Move ()

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

setPos ()

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

OS_Hide ()

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

- -
-

hide ()

- -
-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 -
    -Parameter: source the widget where the event came from -
    Parameter: destination the widget where the event mitgh be generated now -
-
- -
-

inputEventGrabPointer ()

- -
-void inputEventGrabPointer(ewol::Widget * _widget);
-
-This fonction lock the pointer properties to move in relative instead of absolute -
    -Parameter [input]: widget The widget that lock the pointer events -
-
- -
-

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 -
    -Parameter [input]: _clipboardID ID of the clipboard (STD/SELECTION) only apear here -
-
- -
-

clipBoardSet ()

- -
-void clipBoardSet(enum ewol::clipBoard::clipboardListe _clipboardID);
-
-Inform the Gui that we are the new owner of the clipboard -
    -Parameter [input]: _clipboardID ID of the clipboard (STD/SELECTION) only apear here -
-
- -
-

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) -
    -Parameter [input]: Id of the clipboard -
-
- -
-

setTitle ()

- -
-void setTitle(const std::string & _title);
-
-set the new title of the windows -
    -Parameter [input]: title New desired title -
-
- -
-

forceOrientation ()

- -
-void forceOrientation(enum ewol::orientation _orientation);
-
-force the screen orientation (availlable on portable elements ... -
    -Parameter [input]: _orientation Selected orientation. -
-
- -
-

grabPointerEvents ()

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

setCursor ()

- -
-void setCursor(enum ewol::cursorDisplay _newCursor);
-
-set the cursor display type. -
    -Parameter [input]: _newCursor selected new cursor. -
-
- -
-

setIcon ()

- -
-void setIcon(const std::string & _inputFile);
-
-set the Icon of the program -
    -Parameter [input]: _inputFile new filename icon of the curent program. -
-
- -
-

ewol::getTime ()

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

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 -
    -Parameter [input]: _argc Standard argc -
    Parameter [input]: _argv Standard argv -
    Return: normal error int for the application error management -
-
- -
-

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 deleted file mode 100644 index 5ed6566a..00000000 --- a/ewol__eInput.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - 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 -
    -Parameter [input]: removeObject Pointer on the EObject remeved == > the user must remove all reference on this EObject -
-
- -
-

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 -
    -Parameter: _source the widget where the event came from -
    Parameter: _destination the widget where the event mitgh be generated now -
-
- -
-

grabPointer ()

- -
-void grabPointer(ewol::Widget * _widget);
-
-This fonction lock the pointer properties to move in relative instead of absolute -
    -Parameter [input]: _widget The widget that lock the pointer events -
-
- -
-

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. -
    -Parameter [input]: _type Type of the event that might be sended. -
    Parameter [input]: _destWidget Pointer on the requested widget that element might be sended -
    Parameter [input]: _IdInput Id of the event (PC : [0..9] and touch : [1..9]) -
    Parameter [input]: _typeEvent type of the eventg generated -
    Parameter [input]: _pos position of the event -
    Return: true if event has been greped -
-
- -
-

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) -
    -Parameter [input]: _type Type of the kay event. -
    Parameter [input]: _destWidget Pointer of the widget destination -
    Parameter [input]: _realInputId system Id -
    Return: the ewol input id -
-
- -
-
- - diff --git a/ewol__event__Entry.html b/ewol__event__Entry.html new file mode 100644 index 00000000..4dd88a29 --- /dev/null +++ b/ewol__event__Entry.html @@ -0,0 +1,230 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::event::Entry

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::event::Entry ()

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

setType ()

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

getType ()

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

setStatus ()

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

getStatus ()

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

setSpecialKey ()

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

getSpecialKey ()

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

setChar ()

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

getChar ()

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

Class: ewol::event::EntrySystem

+
+

Constructor and Destructor:

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

Synopsis:

+
+
+ + +

Detail:

+

ewol::event::EntrySystem ()

+ +
+EntrySystem(enum ewol::key::keyboard _type,
+            enum ewol::key::status _status,
+            ewol::key::Special _specialKey,
+            char32_t _char);
+
+
+ +
+
+ + diff --git a/ewol__event__Input.html b/ewol__event__Input.html new file mode 100644 index 00000000..a53b8396 --- /dev/null +++ b/ewol__event__Input.html @@ -0,0 +1,230 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::event::Input

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::event::Input ()

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

setType ()

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

getType ()

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

setStatus ()

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

getStatus ()

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

setId ()

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

getId ()

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

setPos ()

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

getPos ()

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

Class: ewol::event::InputSystem

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::event::InputSystem ()

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

setDestWidget ()

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

getDestWidget ()

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

setRealId ()

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

getRealId ()

+ +
+int32_t getRealId(void);
+
+
+ +
+
+ + diff --git a/ewol__event__Time.html b/ewol__event__Time.html new file mode 100644 index 00000000..f78c48c1 --- /dev/null +++ b/ewol__event__Time.html @@ -0,0 +1,238 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::event::Time

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::event::Time ()

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

setTime ()

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

getTime ()

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

setApplWakeUpTime ()

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

getApplWakeUpTime ()

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

getApplUpTime ()

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

setDelta ()

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

getDelta ()

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

setDeltaCall ()

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

getDeltaCall ()

+ +
+float getDeltaCall(void);
+
+
+ +
+
+ + diff --git a/ewol__font__mode.html b/ewol__font__mode.html index f53d3cc8..0db433d4 100644 --- a/ewol__font__mode.html +++ b/ewol__font__mode.html @@ -4,129 +4,138 @@ ewol Library +
diff --git a/ewol__gravity.html b/ewol__gravity.html index d2870239..574adac9 100644 --- a/ewol__gravity.html +++ b/ewol__gravity.html @@ -4,129 +4,138 @@ ewol Library +
diff --git a/ewol__keyEvent__keyboard.html b/ewol__keyEvent__keyboard.html deleted file mode 100644 index e7e53742..00000000 --- a/ewol__keyEvent__keyboard.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - ewol Library - - - - -
-

Enum: ewol::keyEvent::keyboard

-
-Value :
-
    -
  • keyboardUnknow
  • keyboardChar
  • keyboardLeft
  • keyboardRight
  • keyboardUp
  • keyboardDown
  • keyboardPageUp
  • keyboardPageDown
  • keyboardStart
  • keyboardEnd
  • keyboardPrint
  • keyboardStopDefil
  • keyboardWait
  • keyboardInsert
  • keyboardF1
  • keyboardF2
  • keyboardF3
  • keyboardF4
  • keyboardF5
  • keyboardF6
  • keyboardF7
  • keyboardF8
  • keyboardF9
  • keyboardF10
  • keyboardF11
  • keyboardF12
  • keyboardCapLock
  • keyboardShiftLeft
  • keyboardShiftRight
  • keyboardCtrlLeft
  • keyboardCtrlRight
  • keyboardMetaLeft
  • keyboardMetaRight
  • keyboardAlt
  • keyboardAltGr
  • keyboardContextMenu
  • keyboardNumLock
  • keyboardCount
-
- - diff --git a/ewol__keyEvent__status.html b/ewol__keyEvent__status.html deleted file mode 100644 index 2b12ada3..00000000 --- a/ewol__keyEvent__status.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - ewol Library - - - - -
-

Enum: ewol::keyEvent::status

-
-Value :
-
    -
  • statusUnknow
  • statusDown
  • statusMove
  • statusSingle
  • statusDouble
  • statusTriple
  • statusQuad
  • statusQuinte
  • statusUp
  • statusEnter
  • statusLeave
  • statusAbort
  • statusTransfert
  • statusCount
-
- - diff --git a/ewol__keyEvent__type.html b/ewol__keyEvent__type.html deleted file mode 100644 index 2ee93ef9..00000000 --- a/ewol__keyEvent__type.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - ewol Library - - - - -
-

Enum: ewol::keyEvent::type

-
-Value :
-
    -
  • typeUnknow
  • typeMouse
  • typeFinger
  • typeStylet
  • typeCount
-
- - diff --git a/ewol__key__Special.html b/ewol__key__Special.html new file mode 100644 index 00000000..eafb415c --- /dev/null +++ b/ewol__key__Special.html @@ -0,0 +1,359 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::key::Special

+
+

Constructor and Destructor:

+
++        Special      (void);
+

Synopsis:

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

Description:

+/** +* @brief This class consider generic special keyborad key (insert, control, shift ...) +*/

Detail:

+

ewol::key::Special ()

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

+ +
+

getCapsLock ()

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

setCapsLock ()

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

getShift ()

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

setShift ()

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

getCtrl ()

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

setCtrl ()

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

getMeta ()

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

setMeta ()

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

getAlt ()

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

setAlt ()

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

getAltGr ()

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

setAltGr ()

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

getNumLock ()

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

setNumLock ()

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

getInsert ()

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

setInsert ()

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

Enum: ewol::key::keyboard

+
+Value :
+
    +
  • keyboardUnknow
  • keyboardChar
  • keyboardLeft
  • keyboardRight
  • keyboardUp
  • keyboardDown
  • keyboardPageUp
  • keyboardPageDown
  • keyboardStart
  • keyboardEnd
  • keyboardPrint
  • keyboardStopDefil
  • keyboardWait
  • keyboardInsert
  • keyboardF1
  • keyboardF2
  • keyboardF3
  • keyboardF4
  • keyboardF5
  • keyboardF6
  • keyboardF7
  • keyboardF8
  • keyboardF9
  • keyboardF10
  • keyboardF11
  • keyboardF12
  • keyboardCapLock
  • keyboardShiftLeft
  • keyboardShiftRight
  • keyboardCtrlLeft
  • keyboardCtrlRight
  • keyboardMetaLeft
  • keyboardMetaRight
  • keyboardAlt
  • keyboardAltGr
  • keyboardContextMenu
  • keyboardNumLock
  • keyboardCount
+
+ + diff --git a/ewol__key__status.html b/ewol__key__status.html new file mode 100644 index 00000000..b1eb7dd2 --- /dev/null +++ b/ewol__key__status.html @@ -0,0 +1,149 @@ + + + + + ewol Library + + + + + +
+

Enum: ewol::key::status

+
+Value :
+
    +
  • statusUnknow
  • statusDown
  • statusMove
  • statusSingle
  • statusDouble
  • statusTriple
  • statusQuad
  • statusQuinte
  • statusUp
  • statusEnter
  • statusLeave
  • statusAbort
  • statusTransfert
  • statusCount
+
+ + diff --git a/ewol__key__type.html b/ewol__key__type.html new file mode 100644 index 00000000..5ba3e81d --- /dev/null +++ b/ewol__key__type.html @@ -0,0 +1,149 @@ + + + + + ewol Library + + + + + +
+

Enum: ewol::key::type

+
+Value :
+
    +
  • typeUnknow
  • typeMouse
  • typeFinger
  • typeStylet
  • typeCount
+
+ + diff --git a/ewol__object__Config.html b/ewol__object__Config.html new file mode 100644 index 00000000..e7a77b0a --- /dev/null +++ b/ewol__object__Config.html @@ -0,0 +1,196 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::object::Config

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::object::Config ()

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

setConfig ()

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

getConfig ()

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

setData ()

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

getData ()

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

Class: ewol::object::ConfigElement

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::object::ConfigElement ()

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

getConfig ()

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

getType ()

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

getControl ()

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

getDescription ()

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

getDefault ()

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

Class: ewol::object::EventExtGen

+
+

Constructor and Destructor:

+
+
+

Synopsis:

+
+
+ + +

Description:

+/** +* local class for event generation +* @not-in-doc +*/

Detail:

+

+ + diff --git a/ewol__object__Manager.html b/ewol__object__Manager.html new file mode 100644 index 00000000..dcf02bb4 --- /dev/null +++ b/ewol__object__Manager.html @@ -0,0 +1,244 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::object::Manager

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::object::Manager ()

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

ewol::object::~Manager ()

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

unInit ()

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

+ +
+

add ()

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

rm ()

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

getNumberObject ()

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

autoRemove ()

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

removeAllAutoRemove ()

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

get ()

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

multiCast ()

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

informOneObjectIsRemoved ()

+ +
+void informOneObjectIsRemoved(ewol::Object * _object);
+
+
+ +
+
+ + diff --git a/ewol__object__Message.html b/ewol__object__Message.html new file mode 100644 index 00000000..622b77f4 --- /dev/null +++ b/ewol__object__Message.html @@ -0,0 +1,213 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::object::Message

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::object::Message ()

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

setCaller ()

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

getCaller ()

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

setMessage ()

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

getMessage ()

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

setData ()

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

getData ()

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

Class: ewol::object::MultiCast

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::object::MultiCast ()

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

ewol::object::~MultiCast ()

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

anonymousSend ()

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

send ()

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

rm ()

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

add ()

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

Class: ewol::object::MultiCast::MessageList

+
+

Constructor and Destructor:

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

Synopsis:

+
+
+ + +

Detail:

+

ewol::object::MultiCast::MessageList ()

+ +
+MessageList(const char * _message,
+            ewol::Object * _object);
+
+
+ +
+
+ + diff --git a/ewol__openGL__openGlFlags.html b/ewol__openGL__openGlFlags.html index f3c33328..cb20e0fb 100644 --- a/ewol__openGL__openGlFlags.html +++ b/ewol__openGL__openGlFlags.html @@ -4,129 +4,138 @@ ewol Library +
diff --git a/ewol__orientation.html b/ewol__orientation.html index 495e80f9..e2a1a0d4 100644 --- a/ewol__orientation.html +++ b/ewol__orientation.html @@ -4,129 +4,138 @@ ewol Library +
diff --git a/ewol__progAttributeElement.html b/ewol__progAttributeElement.html deleted file mode 100644 index 80dcf8ee..00000000 --- a/ewol__progAttributeElement.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - 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/ewol__resource__Colored3DObject.html b/ewol__resource__Colored3DObject.html new file mode 100644 index 00000000..8ea707be --- /dev/null +++ b/ewol__resource__Colored3DObject.html @@ -0,0 +1,238 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::resource::Colored3DObject

+
+

Constructor and Destructor:

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

Synopsis:

+
++  void                                      draw             (std::vector & _vertices,
const etk::Color<float> & _color,
bool _updateDepthBuffer,
bool _depthtest);
+ void draw (std::vector & _vertices,
const etk::Color<float> & _color,
mat4 & _transformationMatrix,
bool _updateDepthBuffer,
bool _depthtest);
+ void drawLine (std::vector & _vertices,
const etk::Color<float> & _color,
mat4 & _transformationMatrix,
bool _updateDepthBuffer,
bool _depthtest);
+ static ewol::resource::Colored3DObject * keep (void);
+ static void release (ewol::resource::Colored3DObject * & _object);
+ + +

Object Hierarchy:

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

Detail:

+

draw ()

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

draw ()

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

drawLine ()

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

ewol::resource::keep ()

+ +
+static ewol::resource::Colored3DObject * keep(void);
+
+keep the resource pointer. +
Notes: Never free this pointer by your own... +
    +Return: pointer on the resource or NULL if an error occured. +
+
+ +
+

ewol::resource::release ()

+ +
+static void release(ewol::resource::Colored3DObject * & _object);
+
+release the keeped resources +
    +Parameter [input] [output]: reference on the object pointer +
+
+ +
+

ewol::resource::Colored3DObject ()

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

ewol::resource::~Colored3DObject ()

+ +
+~Colored3DObject(void);
+
+
+ +
+
+ + diff --git a/ewol__resource__ConfigFile.html b/ewol__resource__ConfigFile.html new file mode 100644 index 00000000..665b9197 --- /dev/null +++ b/ewol__resource__ConfigFile.html @@ -0,0 +1,244 @@ + + + + + ewol Library + + + + + +
+

Class: ewol::resource::ConfigFile

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Detail:

+

reload ()

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

request ()

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

getInteger ()

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

getFloat ()

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

getString ()

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

ewol::resource::keep ()

+ +
+static ewol::resource::ConfigFile * keep(const std::string & _filename);
+
+keep the resource pointer. +
Notes: Never free this pointer by your own... +
    +Parameter [input]: _filename Name of the configuration file. +
    Return: pointer on the resource or NULL if an error occured. +
+
+ +
+

ewol::resource::release ()

+ +
+static void release(ewol::resource::ConfigFile * & _object);
+
+release the keeped resources +
    +Parameter [input] [output]: reference on the object pointer +
+
+ +
+

ewol::resource::ConfigFile ()

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

ewol::resource::~ConfigFile ()

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

Class: ewol::resource::FontBase

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Detail:

+

ewol::resource::FontBase ()

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

ewol::resource::~FontBase ()

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

getGlyphProperty ()

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

drawGlyph ()

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

getSize ()

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

getHeight ()

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

generateKerning ()

+ +
+void generateKerning(int32_t _fontSize,
+                     std::vector & _listGlyph);
+
+
+ +
+

display ()

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

Class: ewol::resource::FontFreeType

+
+

Constructor and Destructor:

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

Synopsis:

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

Object Hierarchy:

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

Detail:

+

getGlyphProperty ()

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

drawGlyph ()

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

getSize ()

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

getHeight ()

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

generateKerning ()

+ +
+void generateKerning(int32_t _fontSize,
+                     std::vector & _listGlyph);
+
+
+ +
+

ewol::resource::keep ()

+ +
+static ewol::resource::FontBase * keep(const std::string & _filename);
+
+keep the resource pointer. +
Notes: Never free this pointer by your own... +
    +Parameter [input]: _filename Name of the base font. +
    Return: pointer on the resource or NULL if an error occured. +
+
+ +
+

ewol::resource::release ()

+ +
+static void release(ewol::resource::FontBase * & _object);
+
+release the keeped resources +
    +Parameter [input] [output]: reference on the object pointer +
+
+ +
+

ewol::resource::FontFreeType ()

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

ewol::resource::~FontFreeType ()

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

display ()

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

Class: ewol::resource::Manager

+
+

Constructor and Destructor:

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

Synopsis:

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

Detail:

+

ewol::resource::Manager ()

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

+ +
+

ewol::resource::~Manager ()

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

+ +
+

unInit ()

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

+ +
+

display ()

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

+ +
+

reLoadResources ()

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

+ +
+

update ()

+ +
+void update(ewol::Resource * _object);
+
+Call by the system to send all the needed data on the graphic card chen they change ... +
    +Parameter [input]: _object The resources that might be updated +
+
+ +
+

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. +
    +Parameter [input] [output]: _object element to realease == > is return at NULL value. +
    Return: true, if element is removed, and false for just decreasing counter +
+
+ +
+
+ + diff --git a/ewol__Program.html b/ewol__resource__Program.html similarity index 56% rename from ewol__Program.html rename to ewol__resource__Program.html index 260e594c..21e431ff 100644 --- a/ewol__Program.html +++ b/ewol__resource__Program.html @@ -4,144 +4,156 @@ ewol Library +
-

Class: ewol::Program

+

Class: ewol::resource::Program


+

Constructor and Destructor:

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

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

Object Hierarchy:

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

Description:

@@ -158,18 +170,6 @@ * filename4.frag * */

Detail:

-

getType ()

- -
-const char * getType(void);
-
-Generic function that get the resouces name of his type. -
    -Return: The define char of his name. -
-
- -

getAttribute ()

@@ -207,7 +207,7 @@ Send attribute table to the spefified ID attribure (not send if does not really
 
 void sendAttributePointer(int32_t _idElem,
                           int32_t _nbElement,
-                          ewol::VirtualBufferObject * _vbo,
+                          ewol::resource::VirtualBufferObject * _vbo,
                           int32_t _index,
                           int32_t _jumpBetweenSample,
                           int32_t _offset);
@@ -643,10 +643,10 @@ Relode the shader from the file. used when a request of resouces reload is done.


-

ewol::keep ()

+

ewol::resource::keep ()

-static ewol::Program * keep(const std::string & _filename);
+static ewol::resource::Program * keep(const std::string & _filename);

keep the resource pointer.
Notes: Never free this pointer by your own... @@ -657,10 +657,10 @@ keep the resource pointer.

-

ewol::release ()

+

ewol::resource::release ()

-static void release(ewol::Program * & _object);
+static void release(ewol::resource::Program * & _object);
release the keeped resources
diff --git a/menu.css b/menu.css new file mode 100644 index 00000000..26ed3897 --- /dev/null +++ b/menu.css @@ -0,0 +1,146 @@ +/* CSS Document */ + +/*----------------MENU-----------------*/ +div#menu div{ + margin-top: 0px; + background: #6699FF; +} +/* permet l'affichage du haut du menu*/ +div#menu h2{ + color: #000000; + FONT-FAMILY: Arial; + FONT-SIZE: 9pt; + text-align:left; + margin: 0; + padding: 3px; + padding-left: 6px; + background: #1a62db; +} +div#menu h3{ + margin: 0; + padding: 6px; + background: #6699FF; +} + +div#menu a{ + color: #000000; + bgcolor=#6699FF; + FONT-FAMILY: Arial; + FONT-SIZE: 9pt; +} +div#menu li { + position: relative; + list-style:none; + margin:0px; + border-bottom: 1px solid #0008ab; +} +div#menu li.sousmenu { + background: url(sous_menu.gif) 95% 50% no-repeat; +} +div#menu li:hover { + background: #0008ab; +} +div#menu li.sousmenu:hover { + background: #0008ab; +} +div#menu ul ul { + position: absolute; + top: 0px; +} + +/*TAILLE PREMIERE COLONNE*/ +div#menu { + float: center; + width: 200px; + text-align:left; +} +div#menu ul { + margin: 0; + padding: 0; + width: 200px; + background: #6699FF; + border: 0px solid; +} +div#menu ul ul { + left: 199px; + display:none; + background: #FFFFFF; +} +div#menu li a { + display: block; + padding: 2px 0px 2px 4px; + text-decoration: none; + width: 191px; + border-left: 3px solid #6699FF; +} +div#menu form { + border-left: 8px solid #6699FF; + background: #6699FF; + FONT-FAMILY: Arial; + margin:0px; + FONT-SIZE: 8pt; +} +div#menu texte { + border-left: 8px solid #6699FF; + FONT-FAMILY: Arial; + FONT-SIZE: 9pt; + font-weight:bold; + border-bottom: 1px solid #6699FF; +} + +/*TAILLE DEUXIEME COLONE*/ + +div#menu ul.niveau1 ul { + left: 200px; + height: 500px; + border: 1px solid #0008ab; + background: #1a62db; + /* + overflow:scroll; + overflow-y:auto; + overflow-x:hidden; + */ +} +div#menu ul.niveau1 li { + background: #6699FF; +} +div#menu ul.niveau1 li.sousmenu:hover ul.niveau2 { + width:219px; + display:block; +} + + + +/*TAILLE TROISIEME COLONNE*/ +div#menu ul.niveau2 ul { + left: 219px; + height: 500px; +} +div#menu ul.niveau2 li a { + width: 200px; +} +div#menu ul.niveau2 li.sousmenu:hover ul.niveau3 { + width:10em; + display:block; +} + +/*TAILLE Quatrieme COLONNE*/ +div#menu ul.niveau3 ul { + left: 369px; + height: 500px; +} +div#menu ul.niveau3 li a { + width: 200px; +} +div#menu ul.niveau3 li.sousmenu:hover ul.niveau4 { + width:10em; + display:block; +} +/*TAILLE DEUXIEME COLONE BIS????*/ + +/*COULEUR DES BORDURES*/ +div#menu li a:hover { + border-left-color: #000ADE; + background: #6699FF; + font-weight:bold; +} \ No newline at end of file diff --git a/tutorial_000_Build.html b/tutorial_000_Build.html new file mode 100644 index 00000000..45eb2bec --- /dev/null +++ b/tutorial_000_Build.html @@ -0,0 +1,210 @@ + + + + + ewol Library + + + + + +
+

Ewol extract and build examples

+

+All developpement software will start by getting the dependency and the sources.
+

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

+ +

Download instructions


+Download the software : +
+	# create a working directory path
+	mkdir your_workspace_path
+	cd your_workspace_path
+	# clone ewol and all sub-library
+	git clone git://github.com/HeeroYui/ewol.git
+	cd ewol
+	git submodule init
+	git submodule update
+	cd ..
+	# clone the exemple repository
+	git clone git://github.com/HeeroYui/example.git
+

+[note] +The full build tool documentation is availlable here : lutin +[/note]
+

Common build instructions


+Compile software in debug for the curent platform : +
+	./ewol/build/lutin.py -mdebug
+

+You can specify the platform with: +
+	./ewol/build/lutin.py -mdebug -tAndroid
+

+It coud be usefull to disable the package generation in local debug : +
+	./ewol/build/lutin.py -mdebug -p
+

+Build with clang instead of gcc: +
+	./ewol/build/lutin.py -C -cclang
+

+Display the build in color : +
+	./ewol/build/lutin.py -C -mdebug -p
+

+Build in realease and install the program named 'edn' +
+	./ewol/build/lutin.py -C edn-install
+

+To run an application you will find it directly on the out 'staging' tree : +
+	./out/Linux/debug/staging/clang/edn/usr/bin/edn
+

+

Simple explanation :


+The workspace is a simple folder that contain all the modules ans sub module. +It will create a tree like this :
+
  • workspace
    • ewol
      • external (ewol external dependency sub-lib)
        • agg
        • bullet
        • date
        • egami
        • ege
        • ejson
        • etk
        • exml
        • freetype
        • glew
        • lua
        • ogg
        • png
        • portaudio
        • z
      • souces
        • ewol
    • example
+ + diff --git a/tutorial_001_HelloWord.html b/tutorial_001_HelloWord.html new file mode 100644 index 00000000..00a400c0 --- /dev/null +++ b/tutorial_001_HelloWord.html @@ -0,0 +1,277 @@ + + + + + ewol Library + + + + + +
+

Tutorial 1: Hello Word

+

+

Objectif

+
  • Understand basis of ewol
  • Create a simple windows with a label "Hello Word"
+

Application Sources:


+

Main Windows:


+

Application "main()":


+

Build declaration:


+ +

Build your application


+
+In all the application we need to have a main, for some reason this main is stored by the application and only call the EWOL main:
+
+	int main(int argc, const char *argv[]) {
+		// only one things to do : 
+		return ewol::run(argc, argv);
+	}
+

+Then the first question, is where is the input of the application:
+
+	// application start:
+	bool APP_Init(ewol::Context& _context) {
+		return true;
+	}
+	// application stop:
+	void APP_UnInit(ewol::Context& _context) {
+	}
+

+The input ewol::eContext is the main application context. +All the application globals have a reference in this element. +It is important to note that the system can call you some time in parallele, the basic exemple of this is the Wallpaper on Android. +When selected, it create an intance and when it is apply Android create a new instance and remove the previous one...
+
+Now we will create some generic property:
+In first: set the font availlagle on the global font property (system font). +This can be a problem when you designe an application for some other operating system (OS), They do not have the same default font. +and we select an order to search the font names and the system basic size. +
+	_context.getFontDefault().setUseExternal(true);
+	_context.getFontDefault().set("FreeSerif;DejaVuSansMono", 19);
+

+ +In second: we will create a windows.
+For this point we will create a class that herited form the basic windows class:
+Windows.h +
+	#ifndef __APPL_WINDOWS_H__
+	#define __APPL_WINDOWS_H__
+	
+	#include <ewol/widget/Windows.h>
+	
+	namespace appl {
+		class Windows : public ewol::widget::Windows {
+			public:
+				Windows(void);
+			public:
+		};
+	};
+	#endif
+

+Windows.cpp +
+	#include <ewol/ewol.h>
+	#include <appl/debug.h>
+	#include <appl/Windows.h>
+	#include <ewol/widget/Label.h>
+	
+	#undef __class__
+	#define __class__ "Windows"
+	
+	appl::Windows::Windows(void) {
+		setTitle("example 001_HelloWord");
+		ewol::widget::Label* tmpWidget = new ewol::widget::Label();
+		if (NULL == tmpWidget) {
+			APPL_ERROR("Can not allocate widget ==> display might be in error");
+		} else {
+			tmpWidget->setLabel("Hello <font color=\"blue\">Word</font>");
+			tmpWidget->setExpand(bvec2(true,true));
+			setSubWidget(tmpWidget);
+		}
+	}
+

+The fist basic property to set is the Title: +
+	setTitle("example 001_HelloWord");
+

+After we simple create a widget::Label in the main windows constructor. +And we set the widget property (label). +
+	ewol::widget::Label* tmpWidget = new ewol::widget::Label();
+	tmpWidget->setLabel("Hello <font color=\"blue\">Word</font>");
+	tmpWidget->setExpand(bvec2(true,true));
+
+We can se in this example that the label have some other property like the font color.
+The label can have decorated text based on the html generic writing but it is composed with really simple set of balise. +I will take a really long time to create a real html parser, the the availlable property is: +
  • <br/> : New line
  • <font color="#FF0000\"> ... </font> : change the font color.
  • <center> ... </center> : center the text.
  • <left> ... </left> : Set the text on the left.
  • <right> ... </right> : Set the text on the right.
  • <justify> ... </justify> : Set the text mode in justify.
+[note] The xml parser is a little strict on the case and end node, but it support to not have a main node.[/note]
+ +The last step is to add the widget on the windows : +
+	setSubWidget(tmpWidget);
+

+ +At this point we have created the basic windows. +But the system does not know it. +Then we create windows and set it in the main contect main (in the APPL_init()): +
+	ewol::Windows* basicWindows = new appl::Windows();
+	// create the specific windows
+	_context.setWindows(basicWindows);
+

+ +Then the init fuction is : +
+bool APP_Init(ewol::Context& _context) {
+	// select internal data for font ...
+	_context.getFontDefault().setUseExternal(true);
+	_context.getFontDefault().set("FreeSerif;DejaVuSansMono", 19);
+	
+	ewol::Windows* basicWindows = new appl::Windows();
+	// create the specific windows
+	_context.setWindows(basicWindows);
+	return true;
+}
+

+To un-init the application, the context call a generic function APP_UnInit. +In this function we just need to remove the windows and un-init all needed by the system. +
+void APP_UnInit(ewol::Context& _context) {
+	// The main windows will be auto-remove after this call if it is not done...
+}
+
+
+ + diff --git a/widget__Button.html b/widget__Button.html deleted file mode 100644 index 4b8d6ddd..00000000 --- a/widget__Button.html +++ /dev/null @@ -1,423 +0,0 @@ - - - - - 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 deleted file mode 100644 index 8be9be11..00000000 --- a/widget__ButtonColor.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - 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 deleted file mode 100644 index 5cd67e1b..00000000 --- a/widget__CheckBox.html +++ /dev/null @@ -1,241 +0,0 @@ - - - - - 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 deleted file mode 100644 index 7879bbbb..00000000 --- a/widget__ColorBar.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - 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 deleted file mode 100644 index a0b32197..00000000 --- a/widget__ColorChooser.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - 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 deleted file mode 100644 index df8f12f1..00000000 --- a/widget__Composer.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - 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 deleted file mode 100644 index cb8ccd01..00000000 --- a/widget__Container.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - 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 deleted file mode 100644 index fd03cf5f..00000000 --- a/widget__ContainerN.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - 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 deleted file mode 100644 index 61400852..00000000 --- a/widget__ContextMenu.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - 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 deleted file mode 100644 index 52492f6c..00000000 --- a/widget__Entry.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - 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 deleted file mode 100644 index 4166ec18..00000000 --- a/widget__FileChooser.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - 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 deleted file mode 100644 index 87a78899..00000000 --- a/widget__Gird.html +++ /dev/null @@ -1,409 +0,0 @@ - - - - - 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 deleted file mode 100644 index 629153b4..00000000 --- a/widget__Gird__GirdProperties.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - ewol Library - - - - -
-

Class: widget::Gird::GirdProperties

-
-

Synopsis:

-
-
- - -

Detail:

-

- - diff --git a/widget__Image.html b/widget__Image.html deleted file mode 100644 index 950976d9..00000000 --- a/widget__Image.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - 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 deleted file mode 100644 index 6db180a9..00000000 --- a/widget__Joystick.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - 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 deleted file mode 100644 index ec2241f9..00000000 --- a/widget__Label.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - 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 deleted file mode 100644 index 82be0a71..00000000 --- a/widget__Layer.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - 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 deleted file mode 100644 index 02399ba9..00000000 --- a/widget__List.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - 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 deleted file mode 100644 index e3f00d01..00000000 --- a/widget__ListFileSystem.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - 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 deleted file mode 100644 index fba97030..00000000 --- a/widget__Menu.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - 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 deleted file mode 100644 index 29b748d8..00000000 --- a/widget__MenuElement.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - ewol Library - - - - -
-

Class: widget::MenuElement

-
-

Synopsis:

-
-+        MenuElement  (void);
- - -

Detail:

-

widget::MenuElement ()

- -
-MenuElement(void);
-
-
- -
-
- - diff --git a/widget__Mesh.html b/widget__Mesh.html deleted file mode 100644 index 28c37381..00000000 --- a/widget__Mesh.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - 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 deleted file mode 100644 index 3b18d404..00000000 --- a/widget__Parameter.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - 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 deleted file mode 100644 index 138f1c40..00000000 --- a/widget__ParameterList.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - 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 deleted file mode 100644 index b43c0656..00000000 --- a/widget__PopUp.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - 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 deleted file mode 100644 index c0540641..00000000 --- a/widget__ProgressBar.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - 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 deleted file mode 100644 index c4fd120b..00000000 --- a/widget__Scroll.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - 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 deleted file mode 100644 index 2b27d747..00000000 --- a/widget__Sizer.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - 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 deleted file mode 100644 index 63e286de..00000000 --- a/widget__Slider.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - 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 deleted file mode 100644 index 8c596fa9..00000000 --- a/widget__Spacer.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - 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 deleted file mode 100644 index f9a7d452..00000000 --- a/widget__StdPopUp.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - 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 deleted file mode 100644 index 00a660ad..00000000 --- a/widget__WSlider.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - 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 deleted file mode 100644 index 062fbf61..00000000 --- a/widget__WidgetScrooled.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - 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 deleted file mode 100644 index 1bde965b..00000000 --- a/widget__elementPL.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - 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);
-
-
- -
-
- -